Domain name for API request: vod.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 playlist ID, which is unique. |
SubAppId | No | Integer | The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID. |
StartTime | No | String | The playback start time, in ISO 8601 date format. |
RoundPlaylist.N | No | Array of RoundPlayListItemInfo | The files on the 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: |
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 a playlist. You can use this API to modify the videos on a list, the playlist name, and the description.
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyRoundPlay
&<Common Request Parameters>
{
"RoundPlayId": "bffb15f07530b57bc1aabb01fac74bca",
"RoundPlaylist": [
{
"FileId": "528xxx5487985271487",
"AudioVideoType": "Transcode",
"Definition": 100210
}
]
}
{
"Response": {
"RequestId": "6xxxxe3a-6b8e-4b4e-9256-fdc700064ef3"
}
}
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?