All Products
Search
Document Center

ApsaraVideo VOD:SetMessageCallback

Last Updated:May 22, 2024

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

Operation description

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
vod:SetMessageCallbackRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CallbackTypestringNo

The callback method. Valid values:

  • HTTP
  • MNS
HTTP
CallbackURLstringYes

The callback URL. This parameter is required if you set CallbackType to HTTP. The callback URL cannot exceed 256 bytes in length. You can specify only one callback URL.

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 Overview .

FileUploadComplete
AuthSwitchstringNo

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

  • on
  • off
on
AuthKeystringNo

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

dsf346dvet
MnsEndpointstringNo

The public endpoint of Message Service (MNS). This parameter only takes effect when the CallbackType parameter is set to MNS. To obtain the public endpoint, log on to the MNS console and click Get Endpoint in the upper-right corner of the Topics page. For more information, see Endpoint .

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

The name of the MNS queue. You can obtain the name of the MNS queue on the Queues page in the MNS console. This parameter is required when you set CallbackType to MNS.

quene_name
AppIdstringNo

The ID of the application. If you leave this parameter empty, the default value app-1000000 is used.

app-1000000

Response parameters

ParameterTypeDescriptionExample
object

The returned results.

RequestIdstring

The ID of the request.

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

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
No change history