SetLiveStreamsNotifyUrlConfig - ApsaraVideo Live - Alibaba Cloud Documentation Center

Configures stream ingest callbacks under an ingest domain.

Operation description

You can call this operation to configure the callback URL and authentication information of an ingest domain.

QPS limit

You can call this operation up to 15 times per second 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:SetLiveStreamsNotifyUrlConfig	update	Domain `acs:cdn::{#accountId}:domain/{#DomainName}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The ingest domain.	demo.aliyundoc.com
NotifyUrl	string	Yes	The URL to which the stream ingest callbacks are sent.	http://guide.aliyundoc.com/notify
NotifyReqAuth	string	No	Specifies whether to enable callback authentication. Valid values: yes: enables callback authentication. If you set this parameter to yes, you must also specify the NotifyAuthKey parameter. no: disables callback authentication. Note If you do not specify this parameter, the default value no is used. For information about the authentication logic, see Authentication for stream ingest callbacks.	yes
NotifyAuthKey	string	No	The authentication key. Note This parameter is required if you set the NotifyReqAuth parameter to yes. Value requirements: The key must be 16 to 64 characters in length. The key can contain letters and digits.	123456

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	40A4F36D-A7CC-473A-88E7-154F92242566

Examples

Sample success responses

JSONformat

{
  "RequestId": " 40A4F36D-A7CC-473A-88E7-154F92242566"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParam	Parameter invalid.	Illegal input parameters
400	ConfigAlreadyExists	Config has already exist.	-
500	InternalError	The request processing has failed due to backend service exception.	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history