SetMessageCallback - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Operation description

HTTP and MNS callbacks are supported. For more information, see Event notifications.

QPS limit

The queries per second (QPS) limit for a single user on this operation is 15. If this limit is exceeded, API calls are throttled, which may affect your business. We recommend that you call this operation at a reasonable rate. For more information, see QPS limits.

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 support 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 webhook address. This parameter is required if you set CallbackType to HTTP. The webhook address can be a maximum of 256 bytes in length. You cannot specify multiple webhook addresses.	http://developer.aliyundoc.com
EventTypeList	string	No	The type of the callback event. If you leave this parameter empty, all event notifications are disabled. If you set this parameter to ALL, all event notifications are enabled. You can also specify event types to enable notifications. Separate multiple event types with commas (,). For information about the valid values, see Event types.	FileUploadComplete
AuthSwitch	string	No	The authentication switch for HTTP callbacks. This parameter is valid only when CallbackType is set to HTTP. Valid values: on: enabled off: disabled	on
AuthKey	string	No	The authentication key. It can be up to 32 characters in length and must contain uppercase letters, lowercase letters, and digits. You can set this parameter when CallbackType is set to HTTP.	Dsf346dvet
MnsEndpoint	string	No	The public endpoint of the MNS queue. This parameter is required if you set CallbackType to Simple Message Queue (formerly MNS). You can log on to the Message Service console and click Get Endpoint 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 MNS queue. You can log on to the Message Service console and view the queue name in the Queue List. This parameter is required if you set CallbackType to Simple Message Queue (formerly MNS).	quene_name
AppId	string	No	The ID of the application. If you do not set this parameter, the ID of the default application is used, which is app-1000000.	app-1000000

Response parameters

Parameter	Type	Description	Example
	object	The returned results.
RequestId	string	The ID of the request.	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.