AddLiveRecordNotifyConfig - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

Before you add a domain-level callback configuration, query the existing callback configurations for live recording. For more information, see Query callback configurations for live recording.

QPS limit

The queries per second (QPS) limit for a single user is 30 calls per second. If you exceed this limit, API calls are throttled. This may affect your business. We recommend that you call this operation 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:AddLiveRecordNotifyConfig

create

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The ingest streaming domain.	example.com
NotifyUrl	string	Yes	The URL for recording callbacks. These callbacks include recording events and status updates. Note The URL must start with `http://` or `https://`. For more information, see Recording event callbacks.	http://demo.aliyundoc.com/examplecallback.action
NeedStatusNotify	boolean	No	Specifies whether to receive callbacks for the status of recording tasks. Valid values: true: Yes. You will receive callbacks for the status of recording tasks. false (default): No.	false
OnDemandUrl	string	No	The callback URL for on-demand recording. Note The URL must start with `http://` or `https://`. For more information, see On-demand recording callbacks.	http://learn.aliyundoc.com/ondemandcallback.action
NotifyReqAuth	boolean	No	Specifies whether to enable callback authentication. Valid values: yes: Enabled. no (default): Disabled. Note This parameter is required if you set NotifyReqAuth to yes.	yes
NotifyAuthKey	string	No	The authentication key for callbacks. The key must be 16 to 32 characters in length and can contain only uppercase letters, lowercase letters, and digits. Note This parameter is required if you set the NotifyReqAuth parameter to yes.	chenhuanxin249088

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

Examples

Success response

JSON format

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidNotifyUrl.Malformed	Specified NotifyUrl is invalid.	Invalid value of notifyurl. Check whether the notifyurl parameter that you specified is correct.
400	InvalidNotifyUrl.Unsafe	Specified NotifyUrl is not safe.	Invalid value of notifyurl. Check whether the notifyurl parameter that you specified is correct.
400	ConfigAlreadyExists	Config has already exist.
400	InvalidOnDemandUrl.Malformed	Specified OnDemandUrl is invalid.
400	InvalidOnDemandUrl.Unsafe	Specified OnDemandUrl is not safe.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.