Queries the credential required for media playback.
Operation Description
- You can call this operation to obtain a playback credential when you use ApsaraVideo Player SDK to play a media file based on PlayAuth. The credential is used to obtain the playback URL.
- You cannot obtain the playback URL of a video by using a credential that has expired. A new credential is required.
Authorization information
The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action
Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All resources
is used in the Resource type column of the operation.
- Condition keyword: refers to the condition keyword defined by the cloud product itself.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operate | access level | Resource type | conditional keyword | Association operation |
---|---|---|---|---|
vod:GetVideoPlayAuth | Read |
|
| without |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
VideoId | string | Yes | The ID of the audio or video file. You can use one of the following methods to obtain the ID of the file:
| dfde02284a5c46622a097adaf44a**** |
AuthInfoTimeout | long | No | The time when the playback credential expires. Unit: seconds. You cannot obtain the playback URL of a video by using a credential that has expired. A new credential is required.
| 100 |
ApiVersion | string | No | The API version number. Set the value to 1.0.0. | 1.0.0 |
Response parameters
Example
Normal return example
JSON
Format
{
"PlayAuth": "sstyYuew6789000000xtt7TYUh****",
"RequestId": "E4EBD2BF-5EB0-4476-8829-9D94E1B1****",
"VideoMeta": {
"Status": "Normal",
"Duration": 120,
"Title": "VOD",
"VideoId": "dfde02284a5c46622a097adaf44a****",
"CoverURL": "https://example.aliyundoc.com/****.jpg"
}
}
Error codes
For a list of error codes, visit the API error center.
Change history
Change time | Summary of changes | Operate | ||||
---|---|---|---|---|---|---|
2021-11-02 | The input parameters of the API operation has changed | |||||
|
Common errors
The following table describes the common errors that this operation can return.
Error code | Error message | HTTP status code | Description |
---|---|---|---|
Forbidden.IllegalStatus | Status of the video is illegal. | 403 | The error message returned because the video status is invalid. |
InvalidVideo.NotFound | The video does not exist. | 404 | The error message returned because the video does not exist. |
MissingVideoId | VideoId is mandatory for this action. | 400 | The error message returned because the VideoId parameter is not specified. |