Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to get the carousel playlist list.
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 | On-demand application ID. For customers who activate on-demand services from December 25, 2023, if they access resources in on-demand applications (whether the default application or a newly created application), they must fill in this field with the app ID. |
| RoundPlayIds.N | No | Array of String | Filter criteria: carousel playlist identifiers. The array can contain up to 100 identifiers. |
| Status | No | String | Filter criteria, carousel playlist status. Available values: |
| CreateTime | No | TimeRange | Filter criteria: Carousel Playlist Creation Time. |
| UpdateTime | No | TimeRange | Filter criteria: carousel playlist update time. |
| ScrollToken | No | String | Scrolling identifier which is used for pulling in batches. If a single request cannot pull all the data entries, the API will return |
| Limit | No | Integer | Number of returned entries. Default value: 10. Maximum value: 100. |
| Parameter Name | Type | Description |
|---|---|---|
| RoundPlaySet | Array of RoundPlayInfo | Carousel playlist details list. |
| ScrollToken | String | Pagination identifier. If a request does not return all the data entries, this field indicates the ID of the next entry. If this field is empty, there is no more data. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Retrieve the playlist, name, description, and other detailed information of all carousel playlists.
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRoundPlays
<Common request parameters>
{}{
"Response": {
"RequestId": "6xxxxe3a-6b8e-4b4e-9256-fdc700064ef3",
"RoundPlaySet": [
{
"Name": "Demo",
"RoundPlayId": "bffb15f07530b57bc1aabb01fac74bca",
"StartTime": "2022-06-01T00:00:00+08:00",
"Desc": "Demo",
"Url": "http://example.com/rplay/v1/xxxx/playlist.m3u8",
"Status": "Enabled",
"PlayBackMode": "Loop",
"RoundPlaylist": [
{
"ItemId": "a01",
"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 | Parameter error. |
| InvalidParameterValue | Parameter value error. |
| ResourceNotFound | The resource does not exist. |
文档反馈