文档首页/ 数据复制服务 DRS/ API参考/ API v3（不再推广）/ 公共接口管理/ 批量配置异常通知
更新时间：2023-11-15 GMT+08:00
在线调试
CLI示例
查看PDF
分享

批量配置异常通知

功能介绍

  • 批量设置告警信息，已结束的任务不支持设置。
  • 支持选择已有的SMN主题和手动输入手机号、邮箱两种方式，具体根据自己使用情况选择。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v3/{project_id}/jobs/batch-set-smn

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的Project ID。

获取方法请参见获取项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

从IAM服务获取的用户Token。

X-Language

否

String

请求语言类型。

缺省值：en-us

枚举值：

  • en-us
  • zh-cn

Content-Type

是

String

Content-Type，指定类型为application/json。

缺省值：application/json
表3 请求Body参数

参数

是否必选

参数类型

描述

jobs

是

Array of objects

任务信息。

详情请参见表4。

alarm_notify_info

是

Object

收件方式与信息。

详情请参见表5。
表4 jobs字段数据结构说明

参数

是否必选

参数类型

描述

job_id

是

String

任务ID。

status

是

String

任务状态。

engine_type

是

String

DRS任务引擎类型，取值：

  • mysql：MySQL到MySQL迁移，MySQL到MySQL同步
  • mongodb：MongoDB到DDS迁移
  • cloudDataGuard-mysql：MySQL到MySQL灾备
  • gaussdbv5：GaussDB同步
  • mysql-to-kafka：MySQL到Kafka同步
  • taurus-to-kafka：GaussDB(for MySQL)到Kafka同步
  • gaussdbv5ha-to-kafka：GaussDB主备版到Kafka同步
  • postgresql：PostgreSQL到PostgreSQL同步

详细取值可参考引擎类型说明。
表5 alarm_notify_info字段数据结构说明

参数

是否必选

参数类型

描述

subscriptions

否

Array of objects

手动输入手机号、邮箱模式时填写。

详情请参见表6。

topic_urn

否

String

主题资源标识。

delay_time

否

Long

订阅延迟时间。

rto_delay

否

Long

RTO延迟时间。

rpo_delay

否

Long

RPO延迟时间。

alarm_to_user

否

Boolean

异常告警是否通知用户，不填默认为false。
表6 subscriptions字段数据结构说明

参数

是否必选

参数类型

描述

endpoints

否

Array of strings

短信或者邮件列表。

protocol

否

String

收件方式，sms：短信，email：邮件。

枚举值：

  • sms
  • email

响应参数

状态码： 200

表7 响应Body参数

参数

参数类型

描述

results

Array of objects

录入SMN返回体。

详情请参见表8。

count

Integer

录入SMN总数。
表8 results字段数据结构说明

参数

参数类型

描述

id

String

任务ID。

status

String

状态。

error_code

String

错误码。

error_msg

String

错误信息。

请求示例

  • 配置中的MySQL任务通过关联已有的SMN主题方式配置异常通知 
    https://{endpoint}/v3/0ac6eb2c8000d2ee2fd9c006dededbe6/jobs/batch-set-smn

{
  "jobs" : [ {
    "job_id" : "c7296a3b-0d9f-424c-8d74-816ca62jb2a2",
    "status" : "CONFIGURATION",
    "engine_type" : "mysql"
  } ],
  "alarm_notify_info" : {
    "topic_urn" : "urn:smn:cn-north-7:04f9aca88c00d3202fd4c01ed679daf0:drs-zw",
    "delay_time" : 1200
  }
}
  • 增量中的任务通过手动输入手机号、邮箱方式配置异常通知 
    https://{endpoint}/v3/0ac6eb2c8000d2ee2fd9c006dededbe6/jobs/batch-set-smn

{
  "jobs" : [ {
    "job_id" : "2b36da5c-44a7-41af-8889-247b14djb2a2",
    "status" : "INCRE_TRANSFER_STARTED",
    "engine_type" : "oracle-to-dws"
  } ],
  "alarm_notify_info" : {
    "subscriptions" : [ {
      "protocol" : "sms",
      "endpoints" : [ "12345678910" ]
    }, {
      "protocol" : "email",
      "endpoints" : [ "123456@abc.com" ]
    } ],
    "delay_time" : 100
  }
}

响应示例

状态码： 200

OK

{
  "count" : 1,
  "results" : [ {
    "id" : "ed3723ca-d34a-42b0-9829-0baef12jb20b",
    "status" : "success"
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 公共接口管理