All Products
Search
Document Center

ApsaraVideo VOD:SetMessageCallback

Last Updated:Nov 09, 2022

Sets the callback method, callback URL, and event type of an event notification.

Operation Description

Usage note

ApsaraVideo VOD supports the HTTP and MNS callback methods. For more information, see Event notification.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operateaccess levelResource typeconditional keywordAssociation operation
vod:SetMessageCallbackRead
  • VOD
    acs:vod:*:{#accountId}:*/*
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
CallbackTypestringNo

The callback method. Valid values:

  • HTTP
  • MNS
HTTP
CallbackURLstringYes

The callback URL. This parameter only takes effect when the CallbackType parameter is set to HTTP.

http://developer.aliyundoc.com
EventTypeListstringNo

The type of the callback event. If you do not set this parameter, notifications for all types of events are disabled. If you set this parameter to ALL, notifications for all types of events are enabled. You can specify the event types for which notifications are enabled. Separate multiple event types with commas (,). For more information about the valid values of this parameter, see Event type.

FileUploadComplete
AuthSwitchstringNo

Specifies whether to enable callback authentication. This parameter only takes effect when the CallbackType parameter is set to HTTP. Valid values:

  • on: enables authentication.
  • off: disables authentication.
on
AuthKeystringNo

The cryptographic key. This parameter only takes effect when the CallbackType parameter is set to HTTP. The key can be up to 32 characters in length and must contain uppercase letters, lowercase letters, and digits.

dsf346dvet
MnsEndpointstringNo

The public endpoint of Message Service (MNS). This parameter only takes effect when the CallbackType parameter is set to MNS. For more information, see Endpoint.

http://****.mns.cn-shanghai.aliyuncs.com/
MnsQueueNamestringNo

The name of the MNS queue. This parameter only takes effect when the CallbackType parameter is set to MNS.

quene_name
AppIdstringNo

The ID of the application. If you do not set this parameter, the default value app-1000000 is used.

app-1000000

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

RequestIdstring

The ID of the request.

25818875-5F78-4AF6-D7393642CA58****

Example

Normal return example

JSONFormat

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

Error codes

For a list of error codes, visit the API error center.