統合カタログ エンティティタイプの変更¶

POST /api/v1/unified_catalog/entity_type_cfg/{entity_type_uuid}/modify

概要¶

統合カタログのエンティティタイプを変更します。

ルートパラメータ¶

Body リクエストパラメータ¶

パラメータ補足説明¶

ルートパラメータの説明

リクエストボディパラメータの説明

呼び出し時の注意事項

• デフォルトタイプは extraConfig と customProperties の変更をサポートします。
• すべてのエンティティタイプは常に healthConfig の変更をサポートします。system は default/func/disabled をサポート、その他のタイプは func/disabled をサポート。バックエンドの readiness クリーンアップの進行状況に依存しません。
• カスタムタイプは name、description、schemaDefine、viewDefine、extend を変更でき、同時に extraConfig と customProperties も変更できます。
• extraConfig は完全なオブジェクトを渡すことを推奨し、部分的な patch としての値渡しは推奨しません。
• customProperties はトップレベルに custom_properties 配列を含む YAML テキストを推奨します。互換性のため、トップレベル YAML 配列も受け付けます。
• customProperties のフィールド名は、現在のエンティティタイプの DataSchema properties 内のフィールドと重複してはいけません。フィールドは YAML テキストとして保存され、コメントはそのまま保持されます。

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/unified_catalog/entity_type_cfg/cate_xxxx/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"healthConfig":{"mode":"disabled"}}'

レスポンス¶

{
    "code": 200,
    "content": {
        "uuid": "sys_system",
        "entityType": "system",
        "name": "システム",
        "extraConfig": {},
        "healthConfig": {
            "mode": "disabled"
        }
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}