All Products
Search
Document Center

ApsaraVideo VOD:GetVideoPlayAuth

Last Updated:Jan 29, 2024

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.

QPS limit

You can call this operation up to 360 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limit on API operations.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • 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 Key: the condition key that is defined by the cloud service.
  • 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.
OperationAccess levelResource typeCondition keyAssociated operation
vod:GetVideoPlayAuthRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
VideoIdstringYes

The ID of the media file. You can specify only one ID. You can use one of the following methods to obtain the ID of the file:

  • Log on to the ApsaraVideo VOD console. In the left-side navigation pane, choose Media Files > Audio/Video. On the Video and Audio page, view the ID of the media file. This method is applicable to files that are uploaded by using the ApsaraVideo VOD console.
  • Obtain the value of the VideoId parameter from the response to the CreateUploadVideo operation.
  • Obtain the value of the VideoId parameter from the response to the SearchMedia operation. This method is applicable to files that have been uploaded.
dfde02284a5c46622a097adaf44a****
AuthInfoTimeoutlongNo

The validity period of the playback credential. Unit: seconds. You cannot obtain the playback URL of a video by using a credential that has expired. A new credential is required.

  • Default value: 100.
  • Valid values: [100,3000].
100
ApiVersionstringNo

The API version. Set the value to 1.0.0.

1.0.0

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

PlayAuthstring

The credential for media playback.

sstyYuew6789000000xtt7TYUh****
RequestIdstring

The ID of the request.

E4EBD2BF-5EB0-4476-8829-9D94E1B1****
VideoMetaobject

The metadata of the media file.

Statusstring

The status of the media file. For more information about the value range and description, see Status: the status of a video.

Normal
Durationfloat

The duration of the media file. Unit: seconds.

120.0
Titlestring

The title of the media file.

VOD
VideoIdstring

The ID of the media file.

dfde02284a5c46622a097adaf44a****
CoverURLstring

The thumbnail URL of the media file.

https://example.aliyundoc.com/****.jpg

Examples

Sample success responses

JSONformat

{
  "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 Service error codes.

Change history

Change timeSummary of changesOperation
2021-11-02The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ApiVersion

Common errors

The following table describes the common errors that this operation can return.

Error codeError messageHTTP status codeDescription
Forbidden.IllegalStatusStatus of the video is illegal.403The error message returned because the video status is invalid.
InvalidVideo.NotFoundThe video does not exist.404The error message returned because the video does not exist.
MissingVideoIdVideoId is mandatory for this action.400The error message returned because the VideoId parameter is not specified.