文档首页/ 媒体处理 MPC/ API参考/ 授权与配置接口/ 查询转码服务端事件通知
更新时间:2024-09-14 GMT+08:00

查询转码服务端事件通知

功能介绍

查询消息订阅功能板块,SMN主题的订阅事件的启用状态和订阅消息的启用状态。

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/notification

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Authorization

String

使用AK/SK方式认证时必选,携带的鉴权信息。

X-Project_Id

String

使用AK/SK方式认证时必选,携带项目ID信息, 与路径参数中的项目ID相同。

X-Sdk-Date

String

使用AK/SK方式认证时必选,请求的发生时间。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

notifications

Array of Notification objects

事件通知模板信息

total

Integer

事件通知模板总数

表4 Notification

参数

参数类型

描述

event_name

String

消息事件的名称

status

String

事件通知模板选中状态

topic

String

事件通知主题的URN

msg_type

Integer

订阅消息类型

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

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

响应示例

状态码: 200

查询转码服务端事件通知配置成功。

{
  "total" : 7,
  "notifications" : [ {
    "event_name" : "RemuxComplete",
    "status" : "on",
    "topic" : "urn: smn:region1:tenantId:topic",
    "msg_type" : 3
  }, {
    "event_name" : "AnimatedGraphicsComplete",
    "status" : "on",
    "topic" : "urn: smn:region1:tenantId:topic",
    "msg_type" : 3
  }, {
    "event_name" : "TranscodeComplete",
    "status" : "on",
    "topic" : "urn: smn:region1:tenantId:topic",
    "msg_type" : 3
  }, {
    "event_name" : "ThumbnailComplete",
    "status" : "off",
    "topic" : "urn: smn:region1:tenantId:topic",
    "msg_type" : 3
  }, {
    "event_name" : "TranscodeStart",
    "status" : "on",
    "topic" : "urn: smn:region1:tenantId:topic",
    "msg_type" : 3
  }, {
    "event_name" : "ParseComplete",
    "status" : "on",
    "topic" : "urn: smn:region1:tenantId:topic",
    "msg_type" : 3
  }, {
    "event_name" : "EditingComplete",
    "status" : "on",
    "topic" : "urn: smn:region1:tenantId:topic",
    "msg_type" : 3
  } ]
}

状态码: 400

查询转码服务端事件通知配置失败。

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

状态码

状态码

描述

200

查询转码服务端事件通知配置成功。

400

查询转码服务端事件通知配置失败。

错误码

请参见错误码