UpdateEventSub - ApsaraVideo Live - Alibaba Cloud Documentation Center

Updates a callback that is used to subscribe to channel or user events.

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.

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:UpdateEventSub	none	*Rtc `acs:live::{#accountId}:rtc/{#AppId}`	none	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 parameters

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

Examples

Sample success responses

JSONformat

{
  "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.
403	NoAuth	%s.	No permission
404	ResourceNotExist	%s.	The requested resource does not exist, please check and try again
500	ServerError	%s.	Unknown error, please try again later or submit a ticket for consultation.

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

Change history

Change time	Summary of changes	Operation

No change history