Queries the recording callback configurations of a streaming domain.

Usage note

This operation is applicable to the main streaming domains.

QPS limit

A single user can perform a maximum of 50 queries per second (QPS). Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, 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 DescribeLiveRecordNotifyConfig

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

DomainName String Yes example.com

The main streaming domain name.

Response parameters

Parameter Type Example Description
RequestId String 5056369B-D337-499E-B8B7-B761BD37B08A

The ID of the request.
LiveRecordNotifyConfig Struct

The recording callback configurations of the streaming domain.
DomainName String example.com

The main streaming domain name.
NotifyUrl String http://learn.aliyundoc.com/examplecallback.action

The recording callback URL.
NeedStatusNotify Boolean false

Indicates whether the callbacks for recording status were enabled. Valid values:

  • true: The callbacks for recording status were enabled.
  • false: The callbacks for recording status were disabled. This is the default value.
OnDemandUrl String http://guide.aliyundoc.com/ondemandcallback.action

The callback URL for on-demand recordings.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeLiveRecordNotifyConfig
&DomainName=example.com
&<Common request parameters>

Sample success responses

XML format 

<DescribeLiveRecordNotifyConfigResponse>
  <RequestId>5056369B-D337-499E-B8B7-B761BD37B08A</RequestId>
  <LiveRecordNotifyConfig>
        <NeedStatusNotify>false</NeedStatusNotify>
        <OnDemandUrl>http://guide.aliyundoc.com/ondemandcallback.action</OnDemandUrl>
        <DomainName>example.com</DomainName>
        <NotifyUrl>http://learn.aliyundoc.com/examplecallback.action</NotifyUrl>
  </LiveRecordNotifyConfig>
</DescribeLiveRecordNotifyConfigResponse>

JSON format 

{
    "DescribeLiveRecordNotifyConfigResponse": {
        "RequestId": "5056369B-D337-499E-B8B7-B761BD37B08A",
        "LiveRecordNotifyConfig": {
            "NeedStatusNotify": false,
            "OnDemandUrl": "http://guide.aliyundoc.com/ondemandcallback.action",
            "DomainName": "example.com",
            "NotifyUrl": "http://learn.aliyundoc.com/examplecallback.action"
        }
    }
}

Error codes

HTTP status code Error code Error message Description
404 InvalidConfig.NotFound Config does not exist. The error message returned because no configuration can be found based on the request parameters. Check whether the request parameters are correct.

For a list of error codes, visit the API Error Center.