DeleteCategory

更新时间:
复制 MD 格式

Permanently deletes the specified category.

Operation description

  • A RAM user must obtain database permissions for Alibaba Cloud Model Studio and join a workspace before calling this operation. The required AliyunBailianDataFullAccess permission includes the sfm:DeleteCategory permission. 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 idempotent.

Throttling: Calls to this operation are throttled if the frequency exceeds 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:DeleteCategory

delete

*All Resource

*

None None

Request syntax

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

Request parameters

Parameter

Type

Required

Description

Example

CategoryId

string

Yes

The ID of the category. This is the CategoryId returned by the AddCategory operation. You can also obtain the ID on the Unstructured Data tab of the Application Data page by clicking the ID icon next to the category name.

cate_cdd11b1b79a74e8bbd675c356a91ee3510024405

WorkspaceId

string

Yes

The ID of the workspace where the category is located. For more information, see How to use workspaces.

ws_3AXoiweeTyTd03IN

Response elements

Parameter

Type

Description

Example

object

The response schema.

RequestId

string

The request ID.

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

Data

object

The data returned.

CategoryId

string

The ID of the deleted category.

cate_cdd11b1b79a74e8bbd675c356a91ee3XXXXXXXX

Status

string

The status code returned.

200

Success

boolean

Indicates whether the call was successful:

  • 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 for a complete list.

Release notes

See Release Notes for a complete list.