Query category and subcategory information with GetCategories - Intelligent Media Services - Alibaba Cloud - Intelligent Media Services

Queries the information about a category and its subcategories.

Operation description

Query the information about a category and its subcategories based on the category ID and category type.

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

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CateId	integer	No	The category ID. You can use one of the following methods to obtain the ID: Log on to the Intelligent Media Services (IMS) console and choose Media Asset Management > Category Management to view the category ID. View the value of CateId returned by the AddCategory operation that you called to create a category. View the value of CateId returned by the GetCategories operation that you called to query a category.	33
PageNo	integer	No	The page number. Default value: 1	1
PageSize	integer	No	The number of entries per page. Valid values: 10 to 100.	10
SortBy	string	No	The sorting rule of results. Valid values: - CreationTime:Desc (default): The results are sorted in reverse chronological order based on the creation time. - CreationTime:Asc: The results are sorted in chronological order based on the creation time.	CreationTime:Desc
Type	string	No	The type of the category. Valid values: default and material. A value of default indicates audio, video, and image files. This is the default value. A value of material indicates short video materials.	default

Response elements

Element	Type	Description	Example
	object
SubTotal	integer	The total number of subcategories.	100
RequestId	string	The request ID.	****3B-0E1A-586A-AC29-742247****
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
CateName	string	The category name.	Primary category
ParentId	integer	The ID of the parent category.	-1
CateId	integer	The category ID.	46
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
SubCategories	object
Category	array<object>	The subcategories in the category.
	object	The subcategory in 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
CateName	string	The category name. The value can be up to 64 bytes in length. The value is encoded in UTF-8.	Secondary subcategory
ParentId	integer	The ID of the parent category.	46
CateId	integer	The category ID.	129
SubTotal	integer	The total number of subcategories.	100
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.	1

Examples

Success response

JSON format

{
  "SubTotal": 100,
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "Category": {
    "Type": "default",
    "CateName": "Primary category",
    "ParentId": -1,
    "CateId": 46,
    "Level": 0
  },
  "SubCategories": {
    "Category": [
      {
        "Type": "default",
        "CateName": "Secondary subcategory",
        "ParentId": 46,
        "CateId": 129,
        "SubTotal": 100,
        "Level": 1
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.