List Categories

List categories under the current workspace. Filter by type or 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, obtained from the API Key page in the console.

Body

application/json

enum<string>

required

Category type. Only UNSTRUCTURED (unstructured data category) is supported.

Available options:UNSTRUCTURED

Example:UNSTRUCTURED

string

Parent category ID. Use to query child categories.

string

Category name. Supports fuzzy matching.

string

Connector ID. Filter categories by connector.

string

Pagination cursor. Omit it on the first request; on subsequent requests pass the nextToken value returned by the previous page.

integer

default20

Number of categories returned per page. Defaults to 20. Note the parameter name is maxResult (singular); maxResults (plural) is silently ignored.

Response

200-application/json

string

Response code. Success on success.

string

Error or informational message; an empty string on success.

string

Unique request identifier. Include this ID when reporting an issue.

object

Show child attributes

object[]

Category list.

Show child attributes

string

Category ID.

string

Category name.

enum<string>

Category type.

Available options:UNSTRUCTURED

boolean

Whether this is the default category.

boolean

Whether more pages are available.

integer

Page size used for this request.

integer

Total number of matching items.

integer

Business status code. 200 on success, 400 for failures such as invalid parameters. Note that the HTTP status code remains 200 even on failure, so rely on this field and code to determine the result.

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
}