コンテンツにスキップ

統合カタログエンティティフィールド値の件数統計¶

POST /api/v1/unified_catalog/entity/field_value/count

概要¶

指定されたフィールドの現在のクエリ範囲内での各値に対応するエンティティ数をカウントし、ヒットしたエンティティの総数を返します。

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

パラメータ名	型	必須	説明
fieldList	array	Y	統計が必要なフィールドのリスト、最大64項目。エンティティ基本フィールドと attributes フィールドをサポートします。空を許可: False $minLength: 1 最大長: 64 例: ['entityType', 'provider', 'attributes.env']
urn	string		エンティティ URN で正確にフィルタリング空を許可: False
entityType	string		エンティティタイプコード空を許可: False
provider	string		単一のソースタイプ空を許可: False
providers	array		ソースタイプのリスト空を許可: False
search	string		検索キーワード。urn / name / display_name に一致空を許可: False
fieldValue	string		候補バケットのみをフィルタリング。search と併用可能。search でエンティティ全体をフィルタリングした後、fieldValue で候補値をフィルタリング空を許可: False
filters	json		attributes フィールドのフィルタリング空を許可: False

パラメータ補足説明¶

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

パラメータ名	type	必須	説明
fieldList	array[string]	はい	統計が必要なフィールドのリスト、最大64項目
urn	string	いいえ	エンティティ URN で正確にフィルタリング
entityType	string	いいえ	エンティティタイプでフィルタリング
provider	string	いいえ	単一のソースタイプ
providers	array[string]	いいえ	複数のソースタイプのリスト
search	string	いいえ	あいまい検索条件
fieldValue	string	いいえ	候補バケットのみをフィルタリング。`search` と併用可能。それぞれエンティティ全体と候補値に作用します。
filters	json	いいえ	`attributes` フィールドのフィルタリング

fieldList フィールドの説明

エンティティ基本フィールドをサポートします。例: entityType、provider、urn、name、displayName。
attributes フィールドをサポートします。例: env、project、attributes.env、attributes.project。
env と attributes.env は同等です。

呼び出し時の注意事項

レスポンスの totalCount は現在のフィルタ条件にヒットしたエンティティの総数を示し、fieldList の影響を受けません。
配列型の属性は複数の値に分割してそれぞれカウントされます。
fieldList または filters に健康フィールドが含まれる場合は entityType を指定する必要があります。タイプが disabled の場合、unknown/null の有効な無効状態としてカウントされ、過去の健康値は読み取られません。

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/unified_catalog/entity/field_value/count' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"fieldList":["entityType","provider","attributes.env"],"providers":["discovery"]}'

レスポンス¶

{
    "code": 200,
    "content": {
        "totalCount": 1562,
        "items": [
            {
                "field": "entityType",
                "values": [
                    {
                        "value": "cloud_resource",
                        "count": 1435
                    },
                    {
                        "value": "service",
                        "count": 52
                    }
                ]
            },
            {
                "field": "env",
                "values": [
                    {
                        "value": "prod",
                        "count": 20
                    }
                ]
            }
        ]
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}