DescribeLiveStreamsNotifyUrlConfig - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

You can call this API to query the webhook address and callback authentication information.

QPS limits

The queries per second (QPS) limit for this API is 1,000 calls per minute for each user. If you exceed this limit, API calls are throttled, which can affect your business. We recommend that you call this API at a reasonable rate.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:DescribeLiveStreamsNotifyUrlConfig

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	Yes	Your ingest domain.	demo.aliyundoc.com

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	40A4F36D-A7CC-473A-88E7-154F92242566
LiveStreamsNotifyConfig	object	The callback configuration.
DomainName	string	Your ingest domain.	demo.aliyundoc.com
NotifyUrl	string	The webhook address.	http://guide.aliyundoc.com/notify
ExceptionNotifyUrl	string	The webhook URL for anomalous activities.	https://4a7e5f08.r37.cpolar.top/live/Record/call-back/streamException
NotifyReqAuth	string	Indicates whether authentication is enabled. Valid values: yes no	yes
NotifyAuthKey	string	The authentication key.	123456

Examples

Success response

JSON format

{
  "RequestId": " 40A4F36D-A7CC-473A-88E7-154F92242566",
  "LiveStreamsNotifyConfig": {
    "DomainName": "demo.aliyundoc.com",
    "NotifyUrl": "http://guide.aliyundoc.com/notify",
    "ExceptionNotifyUrl": "https://4a7e5f08.r37.cpolar.top/live/Record/call-back/streamException",
    "NotifyReqAuth": "yes",
    "NotifyAuthKey": "123456"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	%s.	error on the live liveapi server.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.