DescribeLiveRecordNotifyConfig - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

You can call this operation to query the recording callback configuration for a streaming domain name.

QPS limit

This operation supports up to 50 queries per second (QPS) per user. If you exceed this limit, your API calls are throttled. Throttling may affect your business operations, so make sure to stay within the specified limit.

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:DescribeLiveRecordNotifyConfig

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The streaming domain name.	example.com

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	5056369B-D337-499E-B8B7-B761BD37B08A
LiveRecordNotifyConfig	object	The recording callback configuration for the domain name.
NotifyReqAuth	boolean	Specifies whether to enable callback authentication. Valid values: yes: enabled. no: disabled.	no
NotifyAuthKey	string	The authentication key for the callback.	KbT8mN2pQ9rS4vX7wZ1aB3cE5fG6hJ8kL
DomainName	string	The streaming domain name.	example.com
NotifyUrl	string	The webhook address for recording callbacks.	http://learn.aliyundoc.com/examplecallback.action
NeedStatusNotify	boolean	Specifies whether to receive callbacks for the status of recording tasks. Valid values: true: Yes. false (default): No.	false
OnDemandUrl	string	The callback URL for on-demand recording.	http://guide.aliyundoc.com/ondemandcallback.action

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidConfig.NotFound	Config does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.