# 批量修改订阅 - BatchModifySubscription #### 功能介绍 批量修改订阅信息。 - 调用接口前，您需要了解API[认证鉴权](https://support.huaweicloud.com/api-rds/rds_03_0001.html)。 - 调用接口前，您需要了解[请求Header参数说明](https://support.huaweicloud.com/api-rds/rds_03_0005.html#rds_03_0005__section479119143310)。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/RDS/doc?api=BatchModifySubscription)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | rds:instance:update | write | - | - | rds:instance:modify | - | #### URI - URI格式 PUT /v3/{project_id}/instances/{instance_id}/replication/subscriptions - 参数说明 表1参数说明 | 名称 | 是否必选 | 说明 | |:---|:---|:---| | project_id | 是 | **参数解释：** 租户在某一region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **约束限制：** 非空。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | instance_id | 是 | **参数解释：** 实例ID。 **约束限制：** 非空。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求参数 表2参数说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | subscription_ids | 是 | Array of strings | **参数解释：** 修改的订阅ID列表。 **约束限制：** 每次修改的订阅必须属于同一实例。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | job_schedule | 是 | Object | **参数解释：** 快照策略。 详情请参见[表3] **约束限制：** 不涉及。 | 表3job_schedule元素结构说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | id | 否 | String | **参数解释：** 策略ID。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | job_schedule_type | 否 | String | **参数解释：** 计划类型。 **约束限制：** 不涉及。 **取值范围：** - automatically：SQL Server代理启动时自动启动。 - cpu_idle：CPU空闲时启动。 - recurring：重复执行。 - one_time：执行一次。 **默认取值：** recurring | | one_time_occurrence | 否 | Object | **参数解释：** 执行时间。 详情请参见[表4]。 **约束限制：** 不涉及。 | | frequency | 否 | Object | **参数解释：** 策略间隔周期。 详情请参见[表5] **约束限制：** 仅当策略ID为空时生效。 | | daily_frequency | 否 | Object | **参数解释：** 策略每日频率。 详情请参见[表6] **约束限制：** 仅当策略ID为空时生效。 | | duration | 否 | Object | **参数解释：** 策略有效期。 详情请参见[表7] **约束限制：** 仅当策略ID为空时生效。 | | schedule_type | 否 | String | **参数解释：** 策略类型。 **约束限制：** 不涉及。 **取值范围：** - snapshot：快照策略。 - sync：同步策略。 **默认取值：** 不涉及。 | | user_defined | 否 | Boolean | **参数解释：** 是否自定义策略。 **约束限制：** 不涉及。 **取值范围：** - false：系统默认。 - true：自定义。 **默认取值：** 不涉及。 | 表4one_time_occurrence元素结构说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | active_start_date | 否 | String | **参数解释：** 执行日期，格式：yyyy-MM-dd。 **约束限制：** 不涉及。 **取值范围：** 1990-01-01\~2099-12-31 **默认取值：** 不涉及。 | | active_start_time | 否 | String | **参数解释：** 执行时间，格式：HH:mm:ss。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表5frequency元素结构说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | freq_type | 否 | String | **参数解释：** 策略频率类型。 **约束限制：** 不涉及。 **取值范围：** - daily：按天。 - weekly：按周。 - monthly_day：按月、每月按天。 - monthly_week：按月、每月按周。 **默认取值：** 不涉及。 | | freq_interval | 否 | Integer | **参数解释：** 执行间隔。 **约束限制：** 不涉及。 **取值范围：** 1\~99 **默认取值：** 不涉及。 | | freq_interval_weekly | 否 | Array of strings | **参数解释：** 每周执行哪几天。 **约束限制：** 频率类型为按周时该参数必传，不为按周时不生效。 **取值范围：** Monday，Tuesday，Wednesday，Thursday，Friday，Saturday，Sunday。 **默认取值：** 不涉及。 | | freq_interval_day_monthly | 否 | Integer | **参数解释：** 每月执行的日期。 **约束限制：** 频率类型为按月、每月按天时该参数必传，不为按月、每月按天时不生效。 **取值范围：** 1\~当月总天数，例如1\~31。 **默认取值：** 不涉及。 | | freq_interval_monthly | 否 | String | **参数解释：** 当月按周执行哪几天。 **约束限制：** 频率类型为按月、每月按周时该参数必传，不为按月、每月按周时不生效。 **取值范围：** Sunday，Monday，Tuesday，Wednesday，Thursday，Friday，Saturday，day，weekday，weekend。 **默认取值：** 不涉及。 | | freq_relative_interval_monthly | 否 | String | **参数解释：** 每月在哪周执行。 **约束限制：** 频率类型为按月、每月按周时该参数必传，不为按月、每月按周时时不生效。 **取值范围：** first，second，third，fourth，last。 **默认取值：** 不涉及。 | 表6daily_frequency元素结构说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | freq_subday_type | 否 | String | **参数解释：** 每日频率类型。 **约束限制：** 不涉及。 **取值范围：** - once：每日一次。 - multiple：每日多次。 **默认取值：** 不涉及。 | | active_start_time | 否 | String | **参数解释：** 每日第一次执行时间。每日频率类型为每日一次时，则只执行这一次，格式：HH:mm:ss。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | active_end_time | 否 | String | **参数解释：** 最后一次执行时间，格式：HH:mm:ss。 **约束限制：** 每日执行多次时该参数必传，每日执行一次时不生效。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | freq_subday_interval | 否 | Integer | **参数解释：** 执行间隔。 **约束限制：** 每日执行多次时该参数必传，每日执行一次时不生效。 **取值范围：** 1\~99 **默认取值：** 不涉及。 | | freq_interval_unit | 否 | String | **参数解释：** 执行间隔的单位。 **约束限制：** 每日执行多次时该参数必传，每日执行一次时不生效。 **取值范围：** - second：秒。 - minute：分。 - hour：时。 **默认取值：** 不涉及。 | 表7duration元素结构说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | active_start_date | 否 | String | **参数解释：** 第一次执行日期，格式：yyyy-MM-dd。 **约束限制：** 不涉及。 **取值范围：** 1990-01-01\~2099-12-31 **默认取值：** 不涉及。 | | active_end_date | 否 | String | **参数解释：** 最后一次执行日期，默认不会结束，格式：yyyy-MM-dd。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求示例 批量修改订阅信息。 ``` PUT https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin04/replication/subscriptions { "subscription_ids": [ "5b7dfa4f-a16e-4588-9d4e-89353f823512" ], "job_schedule": { "id": "569d69c2-53e5-4bef-a356-d7ea2ff6fb98", "user_defined": false, "schedule_type": "sync", "job_schedule_type": "automatically", "one_time_occurrence": { }, "frequency": { }, "daily_frequency": { }, "duration": { } } } ``` #### 响应消息 - 正常响应要素说明 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | subscriptions | Array of objects | **参数解释：** 修改订阅结果。 详情请参见[表9]。 **取值范围：** 不涉及。 | 表9subscriptions元素结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 订阅ID。 **取值范围：** 不涉及。 | | result | String | **参数解释：** 执行结果。 **取值范围：** - success：成功。 - failure：失败。 | | error_message | String | **参数解释：** 失败报错。 **取值范围：** 不涉及。 | - 正常响应样例 ``` { "subscriptions": [ { "id": "5b7dfa4f-a16e-4588-9d4e-89353f823512", "result": "success" } ] } ``` - 异常响应 请参见[异常响应结果](https://support.huaweicloud.com/api-rds/rds_01_0010.html)。 #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-rds/rds_10_0200.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-rds/rds_10_0201.html)。