Use SetMessageCallback to configure event notifications - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Operation description

HTTP callbacks and Simple Message Queue (formerly MNS) callbacks are supported. For more information, see Event notifications.

QPS limit

The single-user QPS limit for this operation is 15 calls per second. If the limit is exceeded, the API call is throttled, which may affect your business. Call this operation appropriately. For more information, see QPS limit.

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

vod:SetMessageCallback

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CallbackType	string	No	The callback method. Valid values: HTTP Simple Message Queue (formerly MNS)	HTTP
CallbackURL	string	No	The callback URL. This parameter is required when the callback method is set to HTTP. The callback URL cannot exceed 256 bytes in length. Multiple callback URLs are not supported.	http://developer.aliyundoc.com
EventTypeList	string	No	The event types for callbacks. If this parameter is left empty, all notifications are disabled. If this parameter is set to ALL, all notifications are enabled. You can also specify specific event types, separated by commas (,). For the valid event types, see Event types.	FileUploadComplete
AuthSwitch	string	No	The authentication switch for HTTP callbacks. This parameter takes effect only when the callback method is set to HTTP. Valid values: on: enabled. off: disabled.	on
AuthKey	string	No	The authentication key. The key can be up to 32 characters in length and must contain uppercase letters, lowercase letters, and digits. This parameter can be set when the callback method is HTTP.	Dsf346dvet
MnsEndpoint	string	No	The public endpoint of Simple Message Queue (formerly MNS). This parameter is required when the callback method is set to Simple Message Queue (formerly MNS). Log on to the Simple Message Queue (formerly MNS) console and click the Get Endpoint button in the upper-right corner to obtain the endpoint. For more information, see Endpoint.	http://****.mns.cn-shanghai.aliyuncs.com/
MnsQueueName	string	No	The name of the message queue. Log on to the Simple Message Queue (formerly MNS) console and view the queue in the Queue List. This parameter is required when the callback method is set to Simple Message Queue (formerly MNS).	quene_name
AppId	string	No	The application ID. If this parameter is not specified, the ID of the default application is used, which is the fixed value: app-1000000.	app-1000000

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	25818875-5F78-4AF6-D7393642CA58****

Examples

Success response

JSON format

{
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.