DeleteCategory

Operation description

Resource Access Management (RAM) users must first obtain API permissions for Alibaba Cloud Model Studio (requiring AliyunBailianDataFullAccess, which includes the sfm:DeleteCategory permission), and join a workspace before calling this operation. Alibaba Cloud accounts can call this operation directly without authorization. Use the latest Alibaba Cloud Model Studio SDK to call this operation.
This operation is idempotent.

Rate limiting: This operation is subject to rate limiting. Do not exceed 5 calls per second. If you are throttled, retry 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:DeleteCategory

delete

*All Resource

*

None

Request syntax

DELETE /{WorkspaceId}/datacenter/category/{CategoryId}/ HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
CategoryId	string	Yes	The category ID, which is the `CategoryId` returned by the AddCategory operation. You can also obtain it on the Application Data > File tab by clicking the ID icon next to the category name. .	cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx
WorkspaceId	string	Yes	The ID of the workspace to which the category belongs. For information about how to obtain the workspace ID, see How to use a workspace.	llm-3shx2gu255oqxxxx

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	17204B98-xxxx-4F9A-8464-2446A84821CA
Data	object	The data field returned by the operation.
CategoryId	string	The ID of the deleted category.	cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx
Status	string	The status code returned by the operation.	200
Success	boolean	Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.	true
Message	string	The error message.	workspace id is null or invalid.
Code	string	The error code.	success

Examples

Success response

JSON format

{
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Data": {
    "CategoryId": "cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx"
  },
  "Status": "200",
  "Success": true,
  "Message": "workspace id is null or invalid.",
  "Code": "success"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.