コンテンツにスキップ

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

POST /api/v1/unified_catalog/entity/modify

概要¶

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

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

パラメータ名	型	必須	説明
urn	string		エンティティ URN。変更対象を正確に特定するために指定することを推奨します。空を許可: False
entityType	string	Y	エンティティタイプコード空を許可: False
name	string	Y	エンティティ名空を許可: False
attributes	json		エンティティ属性オブジェクト空を許可: False
telemetrySelectors	array		関連クエリ情報設定空を許可: False

パラメータ補足説明¶

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

パラメータ名	type	必須	説明
urn	string	いいえ	エンティティ URN。エンティティを正確に特定するために指定することを推奨します。
entityType	string	はい	エンティティタイプコード
name	string	はい	エンティティ名
attributes	json	いいえ	更新するエンティティ属性オブジェクト
telemetrySelectors	array	いいえ	更新するエンティティ関連クエリ設定

関係フィールドの使用説明

attributes.depends_on は links として書き込まれます。
attributes.component_of は contains として書き込まれます。方向は parent/system → 現在のエンティティです。
attributes.components も contains として書き込まれます。方向は現在のエンティティ → component です。
関係をクリアする場合は、明示的に空の配列を渡してください（例：{"component_of":[]} または {"components":[]}）。

呼び出し時の注意事項

urn、entityType、name を同時に指定することを推奨します。
変更が成功すると、対象エンティティの urn が返されます。
タグフィールドに新しいタグ名を指定すると、対応するタグも自動的に作成されます。

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/unified_catalog/entity/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"urn":"urn:system:default:core","entityType":"system","name":"core","attributes":{"project":"demo","env":"test","components":[]}}'

レスポンス¶

{
    "code": 200,
    "content": {
        "urn": "urn:mysql:default:demo"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}