UpdateEventSub - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

Before you call this operation, make sure that you have called the CreateEventSub operation to create a callback that is used to subscribe to channel or user events.
An existing channel that you specify in this operation still uses its original callback configuration. The updated configuration can apply to the channel only if you restart the channel after it is closed for longer than 20 minutes.
If you only want to update specific parameters, you must also specify the other required parameters with their original values.

QPS limit

You can call this operation up to 50 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.

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

none

*Rtc

acs:live::{#accountId}:rtc/{#AppId}

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The application ID.	9qb1****
SubscribeId	string	Yes	The subscription ID. You can obtain the ID from the response to the CreateEventSub operation.	ad53276431c****
ChannelId	string	No	The channel ID. You can call the ListEventSub operation to query the channel ID. Note This parameter is required if you specify the Users.N parameter. If you set this parameter to * or do not specify this parameter, all channels are subscribed to. You can create up to 20 subscriptions for each application ID.	123333
Users	array	No	The user whose events you want to subscribe to.
	string	No	The user whose events you want to subscribe to. If you do not specify this parameter, the events of all users in the channel are subscribed to, including the events of the streamer and viewers.	user1
Events	array	Yes	The type of the events to which you want to subscribe.
	string	Yes	The type of the events to which you want to subscribe. Valid values: ChannelEvent: channel events UserEvent: user events in the channel	ChannelEvent
CallbackUrl	string	Yes	The callback URL. For more information about the callback content, see CreateEventSub.	http://****.com/callback

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	AE050E24-BE9B-1E79-BB30-7EA0BBAE7F08

Examples

Success response

JSON format

{
  "RequestId": "AE050E24-BE9B-1E79-BB30-7EA0BBAE7F08"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InputInvalid	%s.	Illegal input parameters
400	QuotaLimitError	%s.	For each AppId, a maximum of 20 subscriptions are allowed at the same time, and only one full channel subscription is allowed.
400	ErrorInvalidCallBackUrl	%s.	The CallBackURL is invalid, please check and try again.
500	ServerError	%s.	Unknown error, please try again later or submit a ticket for consultation.
403	NoAuth	%s.	No permission
404	ResourceNotExist	%s.	The requested resource does not exist, please check and try again

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.