コンテンツにスキップ

統合カタログトポロジフィールドフィルターオプション¶

POST /api/v1/unified_catalog/topology/filter_options

概要¶

指定されたフィールドのフィルタリング可能な値のリストを取得します。

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

パラメータ名	型	必須	説明
entityType	string		エンティティタイプコード空を許可: False
fields	array	Y	フィルターオプションを返すフィールドのリスト。最大64項目空を許可: False 例: ['project', 'owner'] $minLength: 1 最大長: 64
filters	json		選択済みのフィルター条件空を許可: False
search	string		候補値検索の互換パラメータ。新しい呼び出し元は fieldValue を使用することを推奨空を許可: False
fieldValue	string		候補値のみをフィルタリングします。search と同時に指定された場合は優先されます。空を許可: False

パラメータ補足説明¶

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

パラメータ名	type	必須	説明
entityType	string	いいえ	エンティティタイプコード。ヘルスフィールドのフィルターオプションを要求する場合、またはヘルスフィールドでフィルタリングする場合は必須
fields	array[string]	はい	フィルターオプションを返すフィールドのリスト。最大64項目
filters	json	いいえ	選択済みのフィルター条件
search	string	いいえ	候補値検索の互換パラメータ。新しい呼び出し元は fieldValue を使用することを推奨
fieldValue	string	いいえ	候補値のみをフィルタリングします。`search` と同時に指定された場合は優先されます。

呼び出し時の注意事項

fields は複数のフィールドを指定可能で、APIは各フィールドの選択可能な値を個別に返します。
フィールドが owner の場合、結果は可能な限りチームが読みやすい名前に解析されます。
filters は連動フィルタリングのシナリオで使用できます。
fields または filters がヘルスフィールドに関連する場合、entityType は必須です。タイプが disabled の場合は、有効な無効状態に従って候補値が生成されます。

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/unified_catalog/topology/filter_options' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"fields":["project","owner"],"entityType":"service"}'

レスポンス¶

{
    "code": 200,
    "content": {
        "project": [
            {
                "label": "demo",
                "value": "demo"
            }
        ],
        "owner": [
            {
                "label": "研发团队",
                "value": "研发团队"
            }
        ]
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}