Queries the configuration of 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 DescribeLiveSnapshotNotifyConfig

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

DomainName String Yes www.yourdomain***.com

The main streaming domain.

Response parameters

Parameter Type Example Description
NotifyReqAuth String yes

Indicates whether callback authentication is enabled. Valid values:

  • yes: Callback authentication is enabled.
  • no: Callback authentication is disabled.
RequestId String 5056369B-D337-499E-B8B7-B761BD37B08A

The ID of the request.

NotifyAuthKey String yourkey

The callback authentication key.

DomainName String www.yourdomain***.com

The main streaming domain.

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

The callback URL.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeLiveSnapshotNotifyConfig
&DomainName=www.yourdomain***.com
&<Common request parameters>

Sample success responses

XML format 

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

<DescribeLiveSnapshotNotifyConfigResponse>
    <NotifyReqAuth>yes</NotifyReqAuth>
    <RequestId>5056369B-D337-499E-B8B7-B761BD37B08A</RequestId>
    <NotifyAuthKey>yourkey</NotifyAuthKey>
    <DomainName>www.yourdomain***.com</DomainName>
    <NotifyUrl>http://callback.yourdomain***.com</NotifyUrl>
</DescribeLiveSnapshotNotifyConfigResponse>

JSON format 

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

{
  "NotifyReqAuth" : "yes",
  "RequestId" : "5056369B-D337-499E-B8B7-B761BD37B08A",
  "NotifyAuthKey" : "yourkey",
  "DomainName" : "www.yourdomain***.com",
  "NotifyUrl" : "http://callback.yourdomain***.com"
}

Error codes

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