GetCategoryList-Documentation

Applicable Products

Cloud VoD

API Description

Get category list

API URL: https://api.cdnetworks.com/vod/videoCategory/getCategoryList
Method: POST

Call frequency

Single user trigger frequency: 300/5min

The API Explorer provides the ability of visual interface online call API, code examples generation, and API documents quickly search .Try it

Request parameter(s)

Body Params

Name	Description
parentNodeIdString	Id of the parent node. If empty, finds all first-level category tags
pageSizeInteger	Number of items per page The value ranges from 1 to 100. The default value is 10
pageIndexInteger	Index of page The value starts from 1. The default value is 1

Response parameter(s)

Body Params

Name	Description
codeInteger	Result status code, 200 indicates success
messageString	Return message
- dataList	Return data
totalLong	Total number of data items
pageSizeLong	Returns the number of data bars
pageIndexLong	Return to page number
- categoryListList	Data detail list
labelNameString	Label name
parentNodeIdInteger	ID of the upper-layer node. A Tier 1 node has no upper-level node. Only secondary nodes have parent nodes
nodeIdInteger	Tag node ID
createUserString	Create a user

Error code

Error code(code)	Description(message)	HTTP status	Semantic
24112000	Parameter error	400	Parameter error
1000	The parent classification node ID does not exist or has been deleted	200	The parent classification node ID does not exist or has been deleted

Example

JSON

Request example Copy Copy success#!/bin/bash username='example_username' apiKey='example_apiKey' date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"` password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64` curl -i --url "https://api.cdnetworks.com/vod/videoCategory/getCategoryList" \ -X "POST" \ -u "$username:$password" \ -H "Date: $date" \ -H "x-cnc-auth-method: BASIC" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "parentNodeId": "id1", "pageSize": 10, "pageIndex": 1 }'

#!/bin/bash
username='example_username'
apiKey='example_apiKey'
date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"`
password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64`
curl -i --url "https://api.cdnetworks.com/vod/videoCategory/getCategoryList" \
-X "POST" \
-u "$username:$password" \
-H "Date: $date" \
-H "x-cnc-auth-method: BASIC" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
	"parentNodeId": "id1",
        "pageSize": 10,
        "pageIndex": 1
}'

Response example Copy Copy success{ "code": 200, "message": "操作成功" "data": { "total":2 "pageSize":10 "pageIndex":1 "categoryList": [ { "labelName":"电影1", "parentNodeId":1, "nodeId":2, "createUser":"vcloudtest" }, { "labelName":"电影2", "parentNodeId":1, "nodeId":3, "createUser":"vcloudtest" } ] } }

{
    "code": 200,
    "message": "操作成功"
    "data": {
        "total":2
        "pageSize":10
        "pageIndex":1
        "categoryList": [
            {
                "labelName":"电影1",
                "parentNodeId":1,
                "nodeId":2,
                "createUser":"vcloudtest"
            },
            {
                "labelName":"电影2",
                "parentNodeId":1,
                "nodeId":3,
                "createUser":"vcloudtest"
            }
        ]
    }
}

Is the content of this document helpful to you?

Yes

I have suggestion

GetCategoryList

Applicable Products

API Description

Call frequency

Request parameter(s)

Body Params

Response parameter(s)

Body Params

Error code

Example

Directory