SetLiveStreamsNotifyUrlConfig - ApsaraVideo Live - Alibaba Cloud Documentation Center

Sets the callback configuration for stream ingest.

Operation description

This operation configures the webhook address and authentication information for an ingest domain.
Real-time stream status callbacks provide prompt notifications about stream ingest and interruption events. For more information, see Stream ingest callback format.

QPS limit

Each user can make up to 15 queries per second (QPS). If you exceed the limit, API calls are throttled, which can affect your business. 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:SetLiveStreamsNotifyUrlConfig

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The ingest domain.	demo.aliyundoc.com
SwitchNotifyUrl	string	No	The callback URL for receiving stream switching notifications.	http://guide.aliyundoc.com/switchnotify
NotifyUrl	string	No	The callback URL for receiving live stream information.	http://guide.aliyundoc.com/notify
ExceptionNotifyUrl	string	No	The callback URL for receiving notifications about exception events.	https://4a7e5f08.r37.cpolar.top/live/Rsssd/call-back/streamStart
NotifyReqAuth	string	No	Specifies whether to enable authentication. Valid values: yes: Enables authentication. If enabled, NotifyAuthKey is required. no: Disables authentication. Note The default value is no.	yes
NotifyAuthKey	string	No	The authentication key. Note This parameter is required when NotifyReqAuth is set to yes. Requirements: 16 to 64 characters in length. Supports letters and digits.	123456

Response elements

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

Examples

Success response

JSON format

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

Error response

JSON format

{
    "Code":"InternalError",
    "HostId":"live.aliyuncs.com",
    "Message":"The request processing has failed due to some unknown error.",
    "RequestId":"6EBD1AC4-C34D-4AE1-963E-B688A228BE31"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParam	Parameter invalid.	Illegal input parameters
400	ConfigAlreadyExists	Config has already exist.
400	CodeGetMainPlaybackDomainError	Failed to obtain the main playback domain name.	Failed to get primary playback domain name.
400	CodeNotPushDomain	The domain name is not a push domain name.	The domain name is not a push domain name.
500	InternalError	The request processing has failed due to backend service exception.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.