DescribeLiveStreamsNotifyUrlConfig - ApsaraVideo Live

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

Usage notes

You can call this operation to query the callback URL and callback authentication information.

QPS limit

You can call this operation up to 1,000 times per minute 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 limits.

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 request ID.
LiveStreamsNotifyConfig	Object		The callback configuration.
NotifyReqAuth	String	yes	Indicates whether callback authentication is enabled. Valid values: yes no
NotifyUrl	String	http://guide.aliyundoc.com/notify	The callback URL.
NotifyAuthKey	String	123456	The authentication key.
DomainName	String	demo.aliyundoc.com	The ingest domain.

Examples

Sample requests

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

Sample success responses

XML format

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

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

JSON format

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

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

Error codes

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

Special error codes

Error code	Error message	HTTP status code	Description
InternalError	The request processing has failed due to some unknown error.	500	An unknown error occurred.
InvalidDomain.NotFound	The domain provided does not exist in our records.	404	The domain name is not found within your Alibaba Cloud account.
IllegalOperation	Illegal domain operate is not permitted.	403	The current operation is not supported because, for example, the specified domain name is not a domain name in ApsaraVideo Live.
InvalidConfig.NotFound	Config does not exist.	404	The callback configuration is not found under the specified domain name.