Help Center/ Media Processing Center/ API Reference/ Authorization and Configuration APIs/ Querying All Events on a Transcoding Server
Updated on 2023-12-25 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying All Events on a Transcoding Server

Function

Queries all subscription events of an SMN topic.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/notification/event

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token

The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Authorization

No

String

Authentication information. This parameter is mandatory when AK/SK-based authentication is used.

X-Project_Id

No

String

Project ID. This parameter is mandatory when AK/SK-based authentication is used. It is same as the project ID in path parameters.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory when AK/SK-based authentication is used.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

event_name

Array of strings

Event name

total

Integer

Total number of events notified to the server

Status code: 403

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Example Requests

GET https://{endpoint}/v1/{project_id}/notification/event

Example Responses

Status code: 200

All subscription events of an SMN topic have been queried.

{
  "total" : 7,
  "event_name" : [ "TranscodeComplete", "TranscodeStart", "ThumbnailComplete", "RemuxComplete", "AnimatedGraphicsComplete", "ParseComplete", "EditingComplete" ]
}

Status code: 403

All subscription events of an SMN topic cannot be queried.

{
  "error_code" : "MPC.10208",
  "error_msg" : "Failed to verify the tenant ID."
}

Status Codes

Status Code

Description

200

All subscription events of an SMN topic have been queried.

403

All subscription events of an SMN topic cannot be queried.

Error Codes

See Error Codes.

Parent Topic: Authorization and Configuration APIs