コンテンツにスキップ

統合カタログトポロジーエンティティフィールド定義¶

GET /api/v1/unified_catalog/topology/entity_fields

概要¶

統合カタログトポロジーで利用可能なフィールド定義を取得します。

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

パラメータ名	タイプ	必須	説明
entityType	string		エンティティタイプコード。空の場合、全エンティティタイプのフィールドを返します。空を許可: True

パラメータ補足説明¶

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

パラメータ名	type	必須	説明
entityType	string	いいえ	エンティティタイプコード

呼び出し時の注意事項

entityType を指定しない、または空文字列を渡した場合、現在のワークスペースの全エンティティタイプのフィールドを返します。
特定のエンティティタイプのフィールド定義のみが必要な場合は、対応する entityType を指定して返却範囲を絞ることを推奨します。

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/unified_catalog/topology/entity_fields?entityType=service' \
-H 'DF-API-KEY: <DF-API-KEY>'

レスポンス¶

{
    "code": 200,
    "content": {
        "items": [
            {
                "field": "project",
                "title": "プロジェクト",
                "entityTypes": [
                    "service",
                    "database"
                ]
            },
            {
                "field": "env",
                "title": "環境",
                "entityTypes": [
                    "service"
                ]
            }
        ]
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}