コンテンツにスキップ

統合カタログエンティティ作成¶

POST /api/v1/unified_catalog/entity/create

概要¶

統合カタログエンティティを作成します。

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

パラメータ名	タイプ	必須	説明
entityType	string	Y	エンティティタイプコード空を許可: False 例: database
name	string	Y	エンティティ名空を許可: False 例: demo
attributes	json		エンティティ属性オブジェクト空を許可: False 例: {'project': 'demo', 'env': 'prod', 'custom_tags': ['mysql']}
telemetrySelectors	array		テレメトリセレクター設定空を許可: False

パラメータ補足説明¶

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

パラメータ名	type	必須	説明
entityType	string	はい	エンティティタイプコード
name	string	はい	エンティティ名
attributes	json	いいえ	エンティティ属性オブジェクト
telemetrySelectors	array	いいえ	エンティティ関連クエリ設定

attributes の一般的な拡張フィールドの説明

フィールド名	type	説明
depends_on	array[string]	依存関係を指定します。書き込み時に `links` に変換されます。
component_of	array[string]	所属関係を指定します。書き込み時に `contains` に変換され、方向は parent/system -> 現在のエンティティとなります。
components	array[json/string]	構成エンティティのリストを指定します。書き込み時にも `contains` に変換され、方向は現在のエンティティ -> component となります。
custom_tags	array/string	カスタムタグを指定します。タグが存在しない場合は自動的に作成されます。
owner	string/array	チーム名を指定します。バックエンドでチーム名に基づいてチーム情報が解析されます。

呼び出し時の注意事項

関係フィールドはすべて attributes 内にまとめて渡してください。relations を個別に指定する必要はありません。
attributes.components には文字列配列、または entity を含むオブジェクト配列を指定できます。オブジェクト内のその他のフィールドはエンティティの attributes に保持されます。
custom_tags を指定する場合は、タグ名の配列を使用することを推奨します。

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/unified_catalog/entity/create' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"entityType":"system","name":"core","attributes":{"project":"demo","env":"prod","components":[{"entity":"service:kodo-inner","health_impact_mode":"inherit"}]},"telemetrySelectors":[]}'

レスポンス¶

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