GetAppPlayKey - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	No	The application ID. The default value is app-1000000. For more information, see Multi-application.	app-1000000

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	25818875-5F78-4A*****F6-D7393642CA58
AppPlayKey	object	The information about the application playback key.
AppId	string	The application ID.	app-1000000
PlayKey	string	The playback key. The key can contain only uppercase letters, lowercase letters, and digits. It must be 8 to 20 characters in length. The key is encoded in UTF-8.	yzNgTUtAl6HAuosIA
CreationTime	string	The time when the key was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2025-03-18T03:59:01Z
ModificationTime	string	The time when the key was last updated. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2025-03-18T03:59:01Z

Examples

Success response

JSON format

{
  "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
  "AppPlayKey": {
    "AppId": "app-1000000",
    "PlayKey": "yzNgTUtAl6HAuosIA",
    "CreationTime": "2025-03-18T03:59:01Z",
    "ModificationTime": "2025-03-18T03:59:01Z"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.