产品动态
公告
Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to modify a playlist.
The modification will only take effect for new playback requests. For ongoing playback, the old playlist will be playable for seven days after the modification.
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: ModifyRoundPlay. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| RoundPlayId | Yes | String | The unique identifier of the playlist. |
| SubAppId | No | Integer | VOD subapplication id. starting from december 25, 2023, for customers who enable vod, if you want to access resources in the vod application (whether it is the default application or a newly created application), you must enter the application id in this field.. |
| StartTime | No | String | The playback start time, in iso 8601 date format. |
| RoundPlaylist.N | No | Array of RoundPlayListItemInfo | The program list. |
| Name | No | String | The playlist name (not longer than 64 characters). |
| Desc | No | String | The playlist description (not longer than 256 characters). |
| Status | No | String | Playback status, optional values: |
| PlayBackMode | No | String | Play mode, optional values:. |
| ExpiredTime | No | String | Expiration time, in iso 8601 format. for details, see iso date format. the playback will stop after expiration. "9999-12-31t23:59:59+08:00" means no expiration. |
| Parameter Name | Type | Description |
|---|---|---|
| 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. |
This example shows you how to modify carousel information. You can use this API to modify the playlist file, the playlist name, the description, etc.
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyRoundPlay
<Common request parameters>
{
"RoundPlayId": "bffb15f07530b57bc1aabb01fac74bca",
"RoundPlaylist": [
{
"FileId": "528xxx5487985271487",
"AudioVideoType": "Transcode",
"Definition": 100210
}
]
}{
"Response": {
"RequestId": "7b9d6abb-4ec1-4ef3-b904-2b11e24012f3"
}
}Change the expiration time of the playlist bffb15f07530b57bc1aabb01fac74bca to 2024-12-10T23:00:00+08:00.
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyRoundPlay
<Common request parameters>
{
"RoundPlayId": "bffb15f07530b57bc1aabb01fac74bca",
"ExpiredTime": "2024-12-10T23:00:00+08:00"
}{
"Response": {
"RequestId": "7b9d6abb-4ec1-4ef3-b904-2b11e24012f5"
}
}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. |
| LimitExceeded.PlayList | Playlist length too large. |
| LimitExceeded.RoundPlays | Exceeds broadcast playlist total limit. |
| LimitExceeded.RunningRoundPlays | Running broadcast playlists exceed maximum quantity. |
| ResourceNotFound | The resource does not exist. |
文档反馈