AddCategory

更新时间:
复制 MD 格式

Creates a category.

Operation description

You can create at most three levels of categories. Each category level can contain a maximum of 100 subcategories.

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

ice:AddCategory

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

CateName

string

Yes

The category name.

  • The value can be up to 64 bytes in length.

  • The value must be encoded in UTF-8.

Third-level subcategory

ParentId

integer

No

The ID of the parent category.

5

Type

string

No

The type of the category. Valid values:

  • default: audio, video, and image files. This is the default value.

  • material: short video materials.

default

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

****63E8B7C7-4812-46AD-0FA56029AC86****

Category

object

The information about the category.

Type

string

The type of the category. Valid values:

  • default: audio, video, and image files. This is the default value.

  • material: short video materials.

default

ParentId

integer

The ID of the parent category. By default, if ParentId is left empty or less than 1, -1 is returned, which indicates that the created category is the root directory.

-1

CateName

string

The category name.

Category 1

CateId

integer

The ID of the created category.

45

Level

integer

The level of the category. A value of 0 indicates a level-1 category, a value of 1 indicates a level-2 category, and a value of 2 indicates a level-3 category.

0

Examples

Success response

JSON format

{
  "RequestId": "****63E8B7C7-4812-46AD-0FA56029AC86****",
  "Category": {
    "Type": "default",
    "ParentId": -1,
    "CateName": "Category 1",
    "CateId": 45,
    "Level": 0
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.