SetEventCallback - Intelligent Media Services - Alibaba Cloud Documentation Center

Configures a callback method for one or more events.

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
ice:SetEventCallback	update	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
CallbackType	string	No	The callback method. Valid values: HTTP MNS	HTTP
CallbackQueueName	string	No	The name of the Simple Message Queue (SMQ) queue in the region. The name must start with ice-callback-.	ice-callback-queue
CallbackURL	string	No	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://xxx.yyy/callback
EventTypeList	string	No	The type of the callback event. You can specify multiple values separated with commas (,). ProduceMediaComplete: indicates that the editing and production task is complete.	ProduceMediaComplete
AuthSwitch	string	No	Specifies whether to enable callback authentication. This parameter takes effect only if you set CallbackType to HTTP. Valid values: on off	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 takes effect only if you set CallbackType to HTTP.	TestKey001

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	****11-DB8D-4A9A-875B-275798****
Success	boolean	Indicates whether the configuration was successful. Valid values: true and false.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "Success": true
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2021-06-25	Add Operation	View Change Details