コンテンツにスキップ

統合カタログエンティティ詳細¶

POST /api/v1/unified_catalog/entity/get

概要¶

単一の統合カタログエンティティの詳細を取得します。

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

パラメータ名	型	必須	説明
urn	string	Y	エンティティ URN 空を許可: False 例: urn:mysql:default:demo

パラメータ補足説明¶

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

パラメータ名	type	必須	説明
urn	string	はい	対象エンティティの一意の URN

レスポンス結果の説明

エンティティの基本情報、attributes、teamInfo、tagsInfo を返します。
systemRelationInfo は、現在のエンティティの1ホップの直接的なシステム関係のリストです。
healthConfig、healthEnabled、healthScore、healthStatus、healthUpdateAt は常に返却されます。すべてのエンティティタイプに対して、バックグラウンドの readiness クリーンアップの進行状況に依存せず、常に有効な設定に従って返却されます。

呼び出し時の注意事項

systemRelationInfo は再帰的に展開されません。直接の関係のみを返します。
systemRelationInfo 内の関係の両端にあるエンティティサマリーの attributes は、全量が返却されます。

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/unified_catalog/entity/get' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"urn":"urn:mysql:default:demo"}'

レスポンス¶

{
    "code": 200,
    "content": {
        "urn": "urn:mysql:default:demo",
        "entityType": "database",
        "name": "demo",
        "attributes": {
            "project": "demo",
            "env": "prod"
        },
        "healthConfig": {},
        "healthEnabled": false,
        "healthScore": null,
        "healthStatus": "unknown",
        "healthUpdateAt": null,
        "teamInfo": [],
        "tagsInfo": [],
        "systemRelationInfo": []
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}