跳转至

统一目录拓扑字段筛选项



POST /api/v1/unified_catalog/topology/filter_options

概述

获取指定字段的可筛选值列表。

Body 请求参数

参数名 类型 必选 说明
entityType string 实体类型编码
允许为空: False
fields array Y 需要返回筛选项的字段列表
允许为空: False
例子: ['project', 'owner']
filters json 已选择的过滤条件
允许为空: False
search string 搜索关键词
允许为空: False

参数补充说明

请求参数说明

参数名 type 必选 说明
entityType string 实体类型编码
fields array[string] 需要返回筛选项的字段列表
filters json 已选择的过滤条件
search string 搜索关键词

调用注意事项

  • fields 支持传多个字段,接口会分别返回每个字段的可选值。
  • 若字段为 owner,返回结果会尽量解析成团队可读名称。
  • filters 可用于联动筛选场景。

请求例子

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"
} 

文档评价

文档内容是否对您有帮助? ×