コンテンツにスキップ

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



GET /api/v1/unified_catalog/topology/entity_fields

概要

現在のワークスペースで参照可能な型の base フィールドとカスタムフィールド定義を読み取ります。

呼び出し前の準備と使用手順

entityType を渡すとその型の fields を返します。省略または空文字列の場合は entityType=""、fields=[]、および型ごとに整理された entityTypes を返し、マージ・重複排除された 1 枚のフィールド表ではありません。単一型が存在しない場合は通常 [] を返します。host/service は予約された entityStatus オプションを付加するため、非空であっても型の存在検証の代わりにはなりません。まず型一覧を確認してください。

フィールド順序は base properties の後に現在のワークスペースの customProperties、さらに entityType の組み込みフィールドを補います。host/service は同名フィールドが存在しない場合に entityStatus(online/offline)を補います。タイトルはリクエストで解決済みの言語に基づいてローカライズ値を選択し、返却テキストはリクエストのフィールド名として使用しません。このページはすべての Schema 機能/列挙の詳細を返しません。完全な編集情報は型詳細の元の YAML を使用してください。同じエンコーディングでは現在のワークスペース設定が優先され、他のワークスペースのカスタム型は読み取りません。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証情報。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

Query リクエストパラメータ

パラメータ名 型 必須 説明
entityType string 一覧/集計では任意。トップレベルのヘルスフィールドでフィルタ、集計、またはソートする場合は業務上必須。作成/変更では必須で、空白除去後に非空であること。エクスポートでは必須。
null 許容: True
例: database
取得または入力方法: エンティティタイプ一覧の items[].entityType からコードを取得します。型 UUID/表示名ではありません。

パラメータ補足説明

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

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

呼び出し時の注意事項

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

リクエスト例

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

レスポンス

HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。

フィールド 型 説明
content.entityType string リクエストの型コード。全型モードでは空文字列。
content.fields array<object> 単一型のフィールド配列。全型モードでは固定で []。
content.fields[].key string フィールドコード。以降 fields/filters/groupByFields で各インターフェースの規則に従って使用します。
content.fields[].title string ローカライズされたタイトル。UIView title が base タイトルより優先され、省略時はフィールド名にフォールバックします。
content.fields[].type string DataSchema のフィールド型。省略時は string。合成された entityStatus は enum。
content.fields[].required boolean フィールド Schema の必須マーク。現在のクエリインターフェースでこの属性が必須であることを意味しません。
content.fields[].systemReserved boolean 合成された entityStatus のみ存在し、true。
content.fields[].options array<object> 合成された entityStatus などが返すオプションのみ。通常のフィールドは allowed_values のすべての設定を返すことを保証しません。
content.fields[].options[].value string entityStatus は online/offline。
content.fields[].options[].label string ローカライズされたオプションテキスト。
content.entityTypes array<object> 全型モードのみ存在し、型ごとにフィールドを列挙します。
content.entityTypes[].entityType string 現在参照可能な型コード。
content.entityTypes[].fields array<object> その型のフィールド。
content.entityTypes[].fields[].key string フィールドコード。以降 fields/filters/groupByFields で各インターフェースの規則に従って使用します。
content.entityTypes[].fields[].title string ローカライズされたタイトル。UIView title が base タイトルより優先され、省略時はフィールド名にフォールバックします。
content.entityTypes[].fields[].type string DataSchema のフィールド型。省略時は string。合成された entityStatus は enum。
content.entityTypes[].fields[].required boolean フィールド Schema の必須マーク。現在のクエリインターフェースでこの属性が必須であることを意味しません。
content.entityTypes[].fields[].systemReserved boolean 合成された entityStatus のみ存在し、true。
content.entityTypes[].fields[].options array<object> 合成された entityStatus などが返すオプションのみ。通常のフィールドは allowed_values のすべての設定を返すことを保証しません。
content.entityTypes[].fields[].options[].value string entityStatus は online/offline。
content.entityTypes[].fields[].options[].label string ローカライズされたオプションテキスト。
content.declaration object 外側の共通宣言。
{
  "code": 200,
  "content": {
    "entityType": "database",
    "fields": [
      {
        "key": "env",
        "title": "环境",
        "type": "string",
        "required": false
      },
      {
        "key": "entityType",
        "title": "实体类型",
        "type": "string",
        "required": true
      }
    ],
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

entityType を渡さない場合の成功構造:

{
  "code": 200,
  "content": {
    "entityType": "",
    "fields": [],
    "entityTypes": [
      {
        "entityType": "database",
        "fields": [
          {
            "key": "env",
            "title": "环境",
            "type": "string",
            "required": false
          },
          {
            "key": "entityType",
            "title": "实体类型",
            "type": "string",
            "required": true
          }
        ]
      }
    ],
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラー応答

認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。

このインターフェースは型定義を読み取るのみで、エンティティデータはクエリしません。存在しないコードは空の fields を返すことがあり、フィールド配列が空であることを 404 と見なさないでください。過去の YAML/metadata の破損やデータベース異常により 500 が返る可能性があり、traceId を保存し管理者が型の元の定義を確認してください。

HTTP ステータス errorCode 発生条件 メッセージまたは応答説明 対処方法
406 ft.ParameterValidationFailed リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反 パラメータ解析失敗 パラメータの位置、フィールド名、型、値を確認してください。
406 ft.InvalidParameter 現在のワークスペースの customProperties フィールドが base フィールドと競合、またはフィールド YAML が無効 パラメータ {} が無効 管理者が型のカスタムフィールドを修正し、同名を避けてください。読み取りパラメータ自体が正しい場合は、フィールド名を繰り返し変更しないでください。
500 ft.InternalServerError 下流クエリの失敗/タイムアウト、成功データ形状の異常、またはタグ/チーム/時間のフォーマット失敗 内部エラー クエリ範囲を絞ってから適切にリトライしてください。継続的に失敗する場合は traceId とフィルタ条件を保存して調査し、今回の書き込みに起因すると見なさないでください。

フィードバック

このページは役に立ちましたか?