Configures snapshot callbacks.

QPS limit

You can call this operation up to 30 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 an API operation in ApsaraVideo Live.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes AddLiveSnapshotNotifyConfig

The operation that you want to perform. Set the value to AddLiveSnapshotNotifyConfig.

DomainName String Yes www.yourdomain***.com

The main streaming domain.

NotifyUrl String Yes http://callback.yourdomain***.com

The callback URL. Specify a valid URL that is up to 500 characters in length.

NotifyReqAuth String No yes

Specifies whether to enable callback authentication. Valid values:

  • yes: enables callback authentication.
  • no: disables callback authentication.
Note Default value: no. If you set this parameter to yes, the NotifyAuthKey parameter is required.
NotifyAuthKey String No yourkey

The callback authentication key. The key can be 16 to 32 characters in length and can contain only letters and digits.

Note This parameter is required if you set the NotifyReqAuth parameter to yes.

Response parameters

Parameter Type Example Description
RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F3EC5

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=AddLiveSnapshotNotifyConfig
&DomainName=www.yourdomain***.com
&NotifyUrl=http://callback.yourdomain***.com
&NotifyReqAuth=yes
&NotifyAuthKey=yourkey
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<AddLiveSnapshotNotifyConfigResponse>
    <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F3EC5</RequestId>
</AddLiveSnapshotNotifyConfigResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "16A96B9A-F203-4EC5-8E43-CB92E68F3EC5"
}

Error codes

For a list of error codes, see Service error codes.