Queries the callback configuration for stream ingest under an ingest domain.

Usage note

Both the callback address and the callback authentication information (if available) are returned by calling this operation.

QPS limit

A single user can perform a maximum of 30 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 DescribeLiveStreamsNotifyUrlConfig

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

DomainName String Yes demo.aliyundoc.com

The ingest domain.

Response parameters

Parameter Type Example Description
RequestId String 40A4F36D-A7CC-473A-88E7-154F92242566

The ID of the request.

LiveStreamsNotifyConfig Struct

The callback configuration for stream ingest.

DomainName String demo.aliyundoc.com

The ingest domain.

NotifyUrl String http://guide.aliyundoc.com/notify

The callback URL.

NotifyAuthKey String 123***

The cryptographic key.

NotifyReqAuth String yes

Specifies whether to enable authentication. Valid values:

  • yes
  • no

Examples

Sample requests

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

Sample success responses

XML format 

<DescribeLiveStreamsNotifyUrlConfigResponse>
      <RequestId>40A4F36D-A7CC-473A-88E7-154F92242566</RequestId>
      <LiveStreamsNotifyConfig>
            <DomainName>www.example.com</DomainName>
            <NotifyUrl>http://guide.aliyundoc.com/notify</NotifyUrl>
            <NotifyReqAuth>yes</NotifyReqAuth>
            <NotifyAuthKey>123***</NotifyAuthKey>
      </LiveStreamsNotifyConfig>
</DescribeLiveStreamsNotifyUrlConfigResponse>

JSON format 

{
    "RequestId":"40A4F36D-A7CC-473A-88E7-154F92242566",
    "LiveStreamsNotifyConfig":
    {
        "DomainName":"www.example.com",
        "NotifyUrl":"http://guide.aliyundoc.com/notify",
        "NotifyReqAuth":"yes",
        "NotifyAuthKey":"123***"
    }
}

Error codes

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

Special error codes

Error code

Error message

HTTP status code

Description

InternalError

The request processing has failed due to some unknown error.

500

The error message returned because an unknown error occurred.

InvalidDomain.NotFound

The domain provided does not exist in our records.

404

The error message returned because the domain name does not belong to your Alibaba Cloud account.

IllegalOperation

Illegal domain operate is not permitted.

403

The error message returned because the current operation is not supported. For example, the specified domain name is not a live domain.

InvalidConfig.NotFound

Config does not exist.

404

The error message returned because the callback configuration is not found under the specified domain name.