# 批量配置异常通知 - BatchSetSmn #### 功能介绍 - 批量设置告警信息，已结束的任务不支持设置。 - 支持选择已有的SMN主题和手动输入手机号、邮箱两种方式，具体根据自己使用情况选择。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=DRS&api=BatchSetSmn)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-drs/drs_api_0035.html)。 #### URI POST /v3/{project_id}/jobs/batch-set-smn 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 租户在某一Region下的Project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-drs/drs_api_0106.html)。 | #### 请求参数 表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]。 | 表4jobs字段数据结构说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | job_id | 是 | String | 任务ID。 | | status | 是 | String | 任务状态。 取值范围： - **CREATING**：创建中 - **CREATE_FAILED**：创建失败 - **CONFIGURATION**：配置中 - **STARTJOBING**：启动中 - **WAITING_FOR_START**：等待启动中 - **START_JOB_FAILED**：启动失败 - **PAUSING**：已暂停 - **FULL_TRANSFER_STARTED**：全量开始，灾备场景下为初始化 - **FULL_TRANSFER_FAILED**：全量失败，灾备场景下为初始化失败 - **FULL_TRANSFER_COMPLETE**：全量完成,灾备场景下为初始化完成 - **INCRE_TRANSFER_STARTED**：增量开始,灾备场景下为灾备中 - **INCRE_TRANSFER_FAILED**：增量失败,灾备场景下为灾备异常 - **RELEASE_RESOURCE_STARTED**：结束任务中 - **RELEASE_RESOURCE_FAILED**：结束任务失败 - **RELEASE_RESOURCE_COMPLETE**：已结束 - **REBUILD_NODE_STARTED**：故障恢复中 - **REBUILD_NODE_FAILED**：故障恢复失败 - **CHANGE_JOB_STARTED**：任务变更中 - **CHANGE_JOB_FAILED**：任务变更失败 - **DELETED**：已删除 - **CHILD_TRANSFER_STARTING**：再编辑子任务启动中 - **CHILD_TRANSFER_STARTED**：再编辑子任务迁移中 - **CHILD_TRANSFER_COMPLETE**：再编辑子任务迁移完成 - **CHILD_TRANSFER_FAILED**：再编辑子任务迁移失败 - **RELEASE_CHILD_TRANSFER_STARTED**：再编辑子任务结束中 - **RELEASE_CHILD_TRANSFER_COMPLETE**：再编辑子任务已结束 - **NODE_UPGRADE_START**：升级开始 - **NODE_UPGRADE_COMPLETE**：升级完成 - **NODE_UPGRADE_FAILED**：升级失败 | | 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**：TaurusDB到Kafka同步。 - **gaussdbv5ha-to-kafka**：GaussDB集中式版到Kafka同步。 - **postgresql**：PostgreSQL到PostgreSQL同步。 - **oracle-to-gaussdbv5**：Oracle-GaussDB 分布式版。 - **oracle-to-gaussdbv5ha**：Oracle-GaussDB 集中式版。 - **gaussdbv5-to-oracle**：GaussDB 分布式版-Oracle。 - **gaussdbv5ha-to-oracle**：GaussDB 集中式版-Oracle。 - **gaussdbv5-to-kafka**：GaussDB 分布式版-Kafka。 详细取值可参考[引擎类型说明](https://support.huaweicloud.com/api-drs/drs_api_0159.html)。 | 表5alarm_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。 | 表6subscriptions字段数据结构说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | endpoints | 否 | Array of strings | 短信或者邮件列表。 | | protocol | 否 | String | 收件方式，sms：短信，email：邮件。 枚举值： - **sms** - **email** | #### 响应参数 **状态码：200** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | results | Array of objects | 录入SMN返回体。 详情请参见[表8]。 | | count | Integer | 录入SMN总数。 | 表8results字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 任务ID。 | | status | String | 状态。 枚举值： - **success**：成功 - **failed**：失败 | | 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-gaussdbv5" } ], "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 | 其他状态请参见[状态码](https://support.huaweicloud.com/api-drs/drs_api_0108.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-drs/drs_05_0004.html)。