ListCategory

Updated at:

Retrieves the details of one or more categories in a specified workspace.

Operation description

  • This API does not support querying data tables.
  • A RAM user must first obtain the API permissions for Alibaba Cloud Model Studio (the AliyunBailianDataFullAccess policy, which includes the sfm:ListCategory permission) and join a workspace before calling this operation. An Alibaba Cloud account can call this operation directly without authorization. We recommend that you call this operation by using the latest version of the Alibaba Cloud Model Studio SDK.
  • This operation supports pagination. When making your first request, set the MaxResults parameter to specify the maximum number of items to return. If more items are available, the response includes a NextToken. To retrieve the next page of results, set the NextToken parameter to the value from the previous response and specify MaxResults again. An empty NextToken indicates that no more results are available.
  • This operation is idempotent.

Rate limiting: This API is subject to rate limiting. Do not exceed 5 requests per second. If the system throttles a request, retry it after a short interval.

Try it now

You can call this operation in OpenAPI Explorer without calculating a signature. After a successful call, OpenAPI Explorer can automatically generate SDK code examples.

Authorization information

The following table describes the authorization information of the API. You can use it in the Action element of RAM permission policy statements to grant RAM users or RAM roles the permission to call this API. The details are as follows:

  • Action: the specific permission point.

  • Access level: the access level of each action. Valid values: Write, Read, and List.

  • Resource type: the resource types that support authorization for the action. The details are as follows:

    • Required resource types are marked with a prefixed asterisk (*).
    • For operations that do not support resource-level authorization, All Resources is used.
  • Condition key: the condition keys defined by the cloud service itself.

  • Dependent actions: the other permissions required to successfully perform the operation. The caller must have the permissions of all dependent actions for the operation to succeed.

Action

Access level

Resource type

Condition key

Dependent action

sfm:ListCategory

list

*All Resource

*

NoneNone

Request syntax

POST /{WorkspaceId}/datacenter/categories HTTP/1.1

Path parameters

Parameter

Type

Required

Description

Example

WorkspaceId

string

Yes

The ID of the workspace. For information about how to obtain a workspace ID, see Work with workspaces.

llm-3shx2gu255oqxxxx

Request parameters

Parameter

Type

Required

Description

Example

ConnectorId

string

No

The ID of the connector.

file_conn_xxxxx

CategoryType

string

Yes

The type of category to query. Valid value:

  • UNSTRUCTURED: A category for unstructured data.

This API does not support querying structured data tables.

UNSTRUCTURED

ParentCategoryId

string

No

The ID of the parent category.

cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx

NextToken

string

No

The pagination token. To retrieve the next page of results, pass the NextToken value from the previous response.

AAAAAdH70eOCSCKtacdomNzak4U=

MaxResults

integer

No

The maximum number of categories to return per page. The valid range is 1 to 200.

Default value: 20. If this parameter is not specified or is set to a value less than 1, the default value is used. If a value greater than 200 is specified, the maximum value of 200 is used.

20

CategoryName

string

No

Filters the results to include only the category with this exact name. If this parameter is omitted, no filtering is applied.

Product list

Response parameters

Element

Type

Description

Example

object

The response object.

Code

string

The error code.

success

Data

object

The response payload.

CategoryList

array<object>

The list of categories.

object

A category object.

CategoryId

string

The category ID.

cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx

CategoryName

string

The category name.

Category 1

CategoryType

string

The category type. The only valid value is:

  • UNSTRUCTURED: A standard category.

UNSTRUCTURED

IsDefault

boolean

Indicates whether the category is the default. Valid values:

  • true: The category is the default.

  • false: The category is not the default.

You cannot delete the default category.

true

ParentCategoryId

string

The parent category ID.

cate_addd11b1b79a74e8bbd675c356a91ee3xxxxxxxx

HasNext

boolean

Indicates whether more results are available for retrieval. Valid values:

  • true: More results are available.

  • false: This is the last page of results.

true

MaxResults

integer

The maximum number of results to return per page.

20

NextToken

string

The token used to retrieve the next page of results. This parameter is omitted when no more results are available.

AAAAALHWGpGoYCcYMxiFfmlhvh7Z4G8jiXR6IjHYd+M9WQVJ

TotalCount

integer

The total number of matching categories.

20

Message

string

The error message.

workspace id is null or invalid.

RequestId

string

The request ID.

17204B98-xxxx-4F9A-8464-2446A84821CA

Status

string

The status code for the request.

200

Success

boolean

Indicates whether the request succeeded. Valid values:

  • true: The request succeeded.

  • false: The request failed.

true

Examples

Success response

JSON format

{
  "Code": "success",
  "Data": {
    "CategoryList": [
      {
        "CategoryId": "cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx",
        "CategoryName": "类目1",
        "CategoryType": "UNSTRUCTURED",
        "IsDefault": true,
        "ParentCategoryId": "cate_addd11b1b79a74e8bbd675c356a91ee3xxxxxxxx"
      }
    ],
    "HasNext": true,
    "MaxResults": 20,
    "NextToken": "AAAAALHWGpGoYCcYMxiFfmlhvh7Z4G8jiXR6IjHYd+M9WQVJ",
    "TotalCount": 20
  },
  "Message": "workspace id is null or invalid.",
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Status": "200",
  "Success": true
}

Error codes

For more error codes, see Error Center.

Change history

For more information, see Change details.