GetCategories - ApsaraVideo VOD

Queries the information about a specific category and its subcategories based on the ID or type of the category.

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:
- The required resource types are displayed in bold characters.
- 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
vod:GetCategories	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
CateId	long	No	The ID of the category. If you specify this parameter, the system queries the category based on the ID. You can specify only one category ID. You can use one of the following methods to obtain the ID: Log on to the ApsaraVideo VOD console. Choose Configuration Management > Media Management > Categories. On the Audio and Video / Image Category or Short Video Material Category tab, view the category ID. Obtain the category ID from the response to the AddCategory operation.	49339****
PageNo	long	No	The number of the page where the subcategories to be returned are listed. Default value: 1.	1
PageSize	long	No	The number of entries to return on each page of the subcategory list. Default value: 10. Maximum value: 100.	10
SortBy	string	No	The sorting method of the 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. If you specify this parameter, the system queries the category based on the type. Valid values: default (default): audio, video, and image files material: short video materials	default

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
SubTotal	long	The total number of subcategories.	3795
RequestId	string	The ID of the request.	25818875-5F78-4AF6-D7393642CA58****
Category	object	The information about the category.
Type	string	The type of the category. Valid values: default: audio, video, and image files material: short video materials	default
ParentId	long	The ID of the parent category.	100012****
CateName	string	The name of the category.	film
CateId	long	The ID of the category.	100
Level	long	The level of the category. Valid values: 0: level 1 category 1: level 2 category 2: level 3 category	0
SubCategories	array<object>	The details of the subcategory.
Category	object	The list of subcategories.
Type	string	The type of the subcategory. Valid values: default: audio, video, and image files material: short video materials	default
CateName	string	The name of the category.	film
ParentId	long	The ID of the parent category.	10020****
CateId	long	The ID of the category.	100
SubTotal	long	The total number of subcategories.	1
Level	long	The level of the category. Valid values: 0: level 1 category 1: level 2 category 2: level 3 category	1

Examples

Sample success responses

JSONformat

{
  "SubTotal": 3795,
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "Category": {
    "Type": "default",
    "ParentId": 0,
    "CateName": "film",
    "CateId": 100,
    "Level": 0
  },
  "SubCategories": {
    "Category": [
      {
        "Type": "default",
        "CateName": "film",
        "ParentId": 0,
        "CateId": 100,
        "SubTotal": 1,
        "Level": 1
      }
    ]
  }
}

Error codes

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

Common errors

The following table describes the common errors that this operation can return.

Error code	Error message	HTTP status code	Description
InvalidCateId.NotFound	The CateId not exist.	404	The error message returned because the specified category ID does not exist.