ListCategory-阿里云帮助中心

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

Operation description

This API does not support querying data tables.
To call this API, a RAM user must first obtain the required API permission for Model Studio and join a workspace. This requires the AliyunBailianDataFullAccess permission, which includes the sfm:ListCategory permission. Alibaba Cloud accounts can call this API directly. Use the latest version of the 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

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

sfm:ListCategory

list

*All Resource

*

None

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 details, 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. Note 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.	产品清单

Response elements

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.	类目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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.