获取类目列表

接口描述

本接口用于展示指定类型的类目列表。通过指定类目类型，系统能够返回相应类目下的所有子类目详情。

接口URL

GET Http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/category/list?categoryType=xxx

anymetrics_host:anymetrics_port 获取方式请参考：调用方式

请求参数

公共请求参数(HEADERS)

参数	类型	是否必选	描述
tenant-id	String	是	租户ID，用于指标查询内容所在的租户
auth-type	String	是	认证方式，用于设置身份认证方式 UID：使用 UID 进行身份认证 TOKEN：使用 TOKEN 进行身份认证 ACCOUNT：使用ACCOUNT 进行身份认证 APIKEY：使用APIKEY 进行身份认证，详情见：API Key 管理
auth-value	String	是	UID、TOKEN值、ACCOUNT，与auth-type 类型选择一致

公共参数获取方式

tenant-id 与 auth-value：在 Aloudata CAN 顶部导航栏选择指标应用，左边菜单栏选择 API 集成。在 API 集成界面获取取到tenant-id 与auth-value。

请求参数

参数	类型	是否必选	最大长度	描述
categoryType	String	是	32	类目类型 ● 指标类目：CATEGORY_METRIC ● 维度类目：CATEGORY_DIMENSION ● 数据集类目：CATEGORY_DATASET

响应参数

响应参数说明

参数	类型	是否必选	最大长度	描述
code	String	是	32	响应状态码
message	String	是	512	消息体
traceId	String	是	128	跟踪ID，用于问题排查
data	List	是		请求响应的数据结构，具体参数说明参见：4.2data 参数说明

data 参数说明

参数	类型	是否必选	最大长度	描述
id	String	是	64	类目id
name	String	是	32	类目名称
parentId	String	是	64	父级类目 ID
frontId	String	是	64	上级类目 ID
categoryType	String	是	32	类目类型，与请求参数中的categoryType对应
type	String	是	32	类型，系统类目为 SYSTEM

请求示例

http://127.0.0.1/anymetrics/api/v1/category/list?categoryType=CATEGORY_METRIC

响应示例

{
    "data": [

        {
            "id": "ec2f703e-e44d-4961-be71-522c46720976",
            "name": "api创建的类目01",
            "parentId": null,
            "frontId": "113d93da-e265-479d-830e-2d253be7d1c2",
            "categoryType": "CATEGORY_METRIC",
            "type": null
        },
        {
            "id": "113d93da-e265-479d-830e-2d253be7d1c2",
            "name": "api创建的类目02",
            "parentId": null,
            "frontId": null,
            "categoryType": "CATEGORY_METRIC",
            "type": null
        },
        {
            "id": "6b7d79ae-065c-4d84-910c-555fbde685ba",
            "name": "api创建的子类目03",
            "parentId": "ec2f703e-e44d-4961-be71-522c46720976",
            "frontId": null,
            "categoryType": "CATEGORY_METRIC",
            "type": null
        },
        {
            "id": "-1",
            "name": "uncategorized",
            "parentId": null,
            "frontId": null,
            "categoryType": "CATEGORY_METRIC",
            "type": "SYSTEM"
        }
    ],
    "success": true,
    "code": "200",
    "errorMsg": null,
    "detailErrorMsg": null,
    "traceId": "202baf375f5d4791a9f9555ba33afe43.149.17193065125610157"
}