AddCategory - Alibaba Cloud Model Studio - Alibaba Cloud Documentation Center

Operation description

You cannot create structured data tables using an API. You can create them on the Application Data page in the console. You can associate a knowledge base with ApsaraDB RDS to automatically synchronize structured data. For more information, see Knowledge base.
Before you call this operation, a RAM user must obtain database permissions for Alibaba Cloud Model Studio and join a workspace. The AliyunBailianDataFullAccess permission, which includes the sfm:AddCategory permission, is required. An Alibaba Cloud account can call this operation directly without authorization. Use the latest version of the Alibaba Cloud Model Studio SDK to call this operation.
This operation is not idempotent.

Throttling: Frequent calls to this operation are throttled. Do not make more than 5 calls per second. If a call is throttled, retry it later.

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:AddCategory

create

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	The ID of the workspace where you want to add the category. For information about how to obtain the workspace ID, see How to use workspaces.	llm-3z7uw7fwz0vxxxx
CategoryName	string	Yes	The category name. The name must be 1 to 20 characters long. It can contain letters (including Chinese characters), digits, colons (:), underscores (_), periods (.), and hyphens (-).	产品清单
CategoryType	string	Yes	The category type. Only unstructured categories are supported. Valid value: UNSTRUCTURED: unstructured data.	UNSTRUCTURED
ParentCategoryId	string	No	The ID of the parent category under which you want to create the new category. If you leave this parameter empty, a level-1 category is created.	cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx

Response elements

Parameter	Type	Description	Example
	object	The response schema.
Code	string	The error code.	success
Data	object	The data returned.
CategoryId	string	The category ID. Save this ID for subsequent API operations that involve this category.	cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx
CategoryName	string	The category name.	类目名称
Message	string	The error message.	Requests throttling triggered.
RequestId	string	The request ID.	778C0B3B-xxxx-5FC1-A947-36EDD13606AB
Status	string	The status code returned.	200
Success	boolean	Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.	true

Examples

Success response

JSON format

{
  "Code": "success",
  "Data": {
    "CategoryId": "cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx",
    "CategoryName": "类目名称"
  },
  "Message": "Requests throttling triggered.",
  "RequestId": "778C0B3B-xxxx-5FC1-A947-36EDD13606AB",
  "Status": "200",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.