DescribeLiveStreamsNotifyUrlConfig - ApsaraVideo Live - Alibaba Cloud Documentation Center

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

Operation description

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.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
live:DescribeLiveStreamsNotifyUrlConfig	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The ingest domain.	demo.aliyundoc.com

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	40A4F36D-A7CC-473A-88E7-154F92242566
LiveStreamsNotifyConfig	object	The callback configuration.
NotifyReqAuth	string	Indicates whether callback authentication is enabled. Valid values: yes no	yes
NotifyUrl	string	The callback URL.	http://guide.aliyundoc.com/notify
NotifyAuthKey	string	The authentication key.	123456
DomainName	string	The ingest domain.	demo.aliyundoc.com

Examples

Sample success responses

JSONformat

{
  "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, visit the Service error codes.