GetCategories - Intelligent Media Services - Alibaba Cloud Documentation Center

Queries the information about a category and its subcategories.

Operation description

You can call this operation to query the information about a category and its subcategories based on the category ID and category type.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ice:GetCategories		All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
CateId	long	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	long	No	The page number. Default value: 1	1
PageSize	long	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 parameters

Parameter	Type	Description	Example
	object
SubTotal	long	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.
ParentId	long	The ID of the parent category.	-1
CateId	long	The category ID.	46
Level	long	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	array<object>	The subcategories in the category.
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.
ParentId	long	The ID of the parent category.	46
CateId	long	The category ID.	129
SubTotal	long	The total number of subcategories.	100
Level	long	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

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history