All Products
Search
Document Center

Request parameters

Last Updated: Jul 11, 2019

PlayConfig

The custom configuration for media playback. The value is a JSON-formatted string. If multiple domain names are configured, you can specify a domain name.
The following table describes its parameters.

Parameter Type Required Description
PlayDomain String No The playback domain name. If multiple playback domain names are configured, you can specify a domain name to play the video. If the specified domain name does not exist, the default playback domain name corresponding to the storage location of the video is returned.
For example, "vod.test_domain".
XForwardedFor String No The real IP address of the client. This parameter can be used in various scenarios, such as verifying an IP address in a review security group. ApsaraVideo for VOD can use this parameter to obtain the IP address of the client even if it is hidden behind multiple layers of proxies. To ensure data security, the value of this parameter is encrypted by AES/ECB/PKCS5Padding. To obtain the key used for encryption, submit a ticket to ApsaraVideo for VOD technical support.
Sample value: "yqCD7Fp1uqChoVj/sl/p5Q==".

Example:

PlayConfig={"PlayDomain":"vod.test_domain","XForwardedFor":"yqCD7Fp1uqChoVj/sl/p5Q=="}

ReAuthInfo

The CDN reauthentication configuration for media playback. The value is a JSON-formatted string. If CDN reauthentication is enabled, you can use this parameter to set the uid and rand fields for URL signing.

The following table describes its parameters.

Parameter Type Required Description
uid String No The additional parameter. The value is generally set to 0. You can set this parameter as required.
rand String No The random number. The value is generally set to 0. To generate a different URL each time, you can use the UUID as the random number.

Example:

ReAuthInfo={"uid":"12345","rand":"abckljd"}

UserData

The custom configuration for media import, such as the callback configuration for event notifications. The value is a JSON-formatted string.
The following table describes its parameters.

Parameter Type Required Description
MessageCallback String No The callback configuration for event notifications. If you set this parameter, the specified configuration prevails. If you do not set this parameter, the callback configuration in Global Settings of the ApsaraVideo for VOD console prevails. For more information, see Overview.
For example, {"CallbackType":"http", "CallbackURL":"http://callback-host/addr"}
, where CallbackType indicates the callback method (default value: http) and CallbackURL indicates the callback URL.
Extend String No The user-defined extension parameter. The value is transparently transferred during the callback. Length constraint: Maximum length of 512 bytes.

Example:

UserData={"MessageCallback":"{"CallbackURL":"http://test.test.com"}", "Extend":"{"localId":"xxx", "test":"www"}"}

EncryptConfig

The standard encryption configuration.

Parameter Type Description
CipherText String The ciphertext key used to obtain the plaintext key.
DecryptKeyUri String The URL used to obtain the decryption key based on the ciphertext key. For example, http://decrypt.demo.com?CipherText=ZjJmZGViNzUtZWY1Mi00Y2RlLTk3MTMt.
KeyServiceType String The type of the key service. Default value: KMS.

SpriteSnapshotConfig

Parameter Type Description
CellWidth String The width of the original snapshots that compose the sprite snapshot. Default value: the width of the original normal snapshot. Unit: pixels.
CellHeight String The height of the original snapshots that compose the sprite snapshot. Default value: the height of the original normal snapshot. Unit: pixels.
Padding String The padding of the original snapshots that compose the sprite snapshot. Default value: 0. Unit: pixels.
Margin String The margin of the original snapshots that compose the sprite snapshot. Default value: 0. Unit: pixels.
Color String The background color of the sprite snapshot. Default value: Black.
Columns String The number of columns for the original snapshots that compose the sprite snapshot. Valid values: [1,10000]. Default value: 10.
Lines String The number of lines for the original snapshots that compose the sprite snapshot. Valid values: [1,10000]. Default value: 10.
KeepCellPic String Indicates whether to keep the original snapshots that compose the sprite snapshot. Valid values: keep and delete. Default value: keep.

Note: If you need to set all parameters of the SpriteSnapshotConfig parameter to their default values, enter an empty JSON-formatted string: {}.