Query Category List

Query the category list under the current business space, supporting filtering by type and name.

POST

/api/v1/connector/dash/listCategory

cURL

curl -X POST "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/connector/dash/listCategory" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "UNSTRUCTURED"
  }'

{
  "code": "Success",
  "message": "",
  "messageUnmodified": false,
  "requestId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "data": {
    "hasNext": false,
    "maxResult": 20,
    "totalCount": 2,
    "maxId": 100602,
    "categoryList": [
      {
        "categoryId": "cate_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
        "categoryName": "cscd",
        "type": "UNSTRUCTURED",
        "isDefault": false
      }
    ]
  },
  "status": 200
}

Authorizations

string

header

required

DashScope API Key，在控制台 API Key 页面获取。

Body

application/json

enum<string>

required

类目类型。当前仅支持 UNSTRUCTURED（非结构化数据类目）。

Available options:UNSTRUCTURED

Example:UNSTRUCTURED

string

父类目 ID，用于查询子类目。

string

类目名称，精确匹配。

string

数据集 ID（接口字段名为 connectorId），用于按数据集过滤类目。

string

分页游标，首次查询不传；翻页时传入上一页响应返回的 nextToken 值。

integer

default20

每页返回的类目数量，默认 20。注意参数名为 maxResult（单数），传入 maxResults（复数）会被静默忽略。

Response

200-application/json

string

响应码，成功时为 Success。

string

错误或提示信息，成功时为空字符串。

string

请求唯一标识，排查问题时请提供此 ID。

object

Show child attributes

object[]

类目列表。

Show child attributes

string

类目 ID。

string

类目名称。

enum<string>

类目类型。

Available options:UNSTRUCTURED

boolean

是否为默认类目。

boolean

是否还有下一页。

integer

本次请求的每页条数。

integer

符合条件的总条数。

integer

业务状态码。成功为 200，参数错误等失败场景为 400。注意失败时 HTTP 状态码仍为 200，需根据本字段与 code 判断结果。

cURL

curl -X POST "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/connector/dash/listCategory" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "UNSTRUCTURED"
  }'

{
  "code": "Success",
  "message": "",
  "messageUnmodified": false,
  "requestId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "data": {
    "hasNext": false,
    "maxResult": 20,
    "totalCount": 2,
    "maxId": 100602,
    "categoryList": [
      {
        "categoryId": "cate_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
        "categoryName": "cscd",
        "type": "UNSTRUCTURED",
        "isDefault": false
      }
    ]
  },
  "status": 200
}