Domain name for API request: vod.tencentcloudapi.com.
This API is used to query playlists.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: DescribeRoundPlays. |
Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
Region | No | String | Common Params. This parameter is not required. |
SubAppId | No | Integer | The VOD subapplication ID. If you need to access a resource in a subapplication, set this parameter to the subapplication ID; otherwise, leave it empty. |
RoundPlayIds.N | No | Array of String | The playlist IDs. Array length limit: 100. |
Offset | No | Integer | |
Limit | No | Integer | The number of records to return. Default value: 10. Maximum value: 100. |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | The total number of records that meet the conditions. |
RoundPlaySet | Array of RoundPlayInfo | The information of the playlists. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
Get the playlist, name, description and other detailed information of all carousel playlists.
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRoundPlays
<Public Request Parameter>
{}
{
"Response": {
"TotalCount": 0,
"RequestId": "6xxxxe3a-6b8e-4b4e-9256-fdc700064ef3",
"RoundPlaySet": [
{
"Name": "Demo",
"RoundPlayId": "bffb15f07530b57bc1aabb01fac74bca",
"StartTime": "2022-06-01T00:00:00+08:00",
"Desc": "Demo",
"Url": "http://123.vod-qcloud.com/rplay/v1/xxxx/playlist.m3u8",
"Status": "Enabled",
"PlayBackMode": "Loop",
"RoundPlaylist": [
{
"AudioVideoType": "Transcode",
"Definition": 100,
"FileId": "528xxx5487985271487"
}
]
}
]
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
FailedOperation | Operation failed. |
InvalidParameter | Invalid parameter. |
InvalidParameterValue | Incorrect parameter value. |
ResourceNotFound | The resource does not exist. |
Was this page helpful?