All Products
Search
Document Center

Intelligent Media Services:GetEventCallback

Last Updated:Dec 16, 2024

Queries event callback configurations.

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.

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
ice:GetEventCallbackget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

******11-DB8D-4A9A-875B-275798******
CallbackTypestring

The callback method. Valid values:

  • HTTP
  • MNS
HTTP
CallbackQueueNamestring

The name of the Simple Message Queue (SMQ) queue to which callback messages are sent.

ice-callback-queue
CallbackURLstring

The callback URL to which event notifications are sent.

http://xxx.yyy/callback
EventTypeListstring

The type of the callback event. Multiple values are separated with commas (,). For more information about callback event types, see Event notification content.

ProduceMediaComplete,TranscodeComplete
AuthSwitchstring

Specifies whether callback authentication is enabled. This parameter is returned only for HTTP callbacks. Valid values:

  • on
  • off
on
AuthKeystring

The authentication key. This parameter is returned only for HTTP callbacks.

TestKey001

Examples

Sample success responses

JSONformat

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "CallbackType": "HTTP",
  "CallbackQueueName": "ice-callback-queue",
  "CallbackURL": "http://xxx.yyy/callback",
  "EventTypeList": "ProduceMediaComplete,TranscodeComplete",
  "AuthSwitch": "on",
  "AuthKey": "TestKey001"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2021-06-25Add OperationView Change Details