文档首页/ 云数据库 RDS/ API参考/ API v3（推荐）/ 发布订阅（SQL Server）/ 批量修改发布 - BatchModifyPublication
更新时间：2025-12-02 GMT+08:00
查看PDF
分享

批量修改发布 - BatchModifyPublication

功能介绍

批量修改发布。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

rds:instance:update

write

-

-

rds:instance:modify

-

URI

  • URI格式

    PUT

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

    参数解释：

    租户在某一region下的project ID。

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

    约束限制：

    非空。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

    instance_id

    是

    参数解释：

    实例ID。

    约束限制：

    非空。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

请求参数

表2 参数说明

名称

是否必选

参数类型

说明

publication_ids

是

Array of String

参数解释：

修改的发布ID列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

job_schedule

是

Object

参数解释：

快照策略。详情见表3 job_schedule要素说明。

约束限制：

不涉及。
表3 job_schedule要素说明

名称

是否必选

参数类型

说明

id

是

String

参数解释：

策略ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

job_schedule_type

否

String

参数解释：

代理计划类型。

约束限制：

不涉及。

取值范围：

  • automatically：SQL Server代理启动时自动启动。
  • cpu_idle：CPU空闲时启动。
  • recurring：重复执行。
  • one_time：执行一次。

默认取值：

recurring

one_time_occurrence

否

Object

参数解释：

执行一次执行时间。

详情请参见表4 one_time_occurrence要素说明。

约束限制：

不涉及。

frequency

否

Object

参数解释：

策略间隔周期。

详情请参见表5 frequency要素说明。

约束限制：

仅当策略ID为空时该参数必填。

daily_frequency

否

Object

参数解释：

策略每日频率。

详情请参见表6 daily_frequency要素说明。

约束限制：

仅当策略ID为空时该参数必填。

duration

否

Object

参数解释：

策略有效期。

详情请参见表7 duration要素说明。

约束限制：

仅当策略ID为空时该参数必填。
表4 one_time_occurrence要素说明

名称

是否必选

参数类型

说明

active_start_date

否

Boolean

参数解释：

执行日期，格式：yyyy-MM-dd。

约束限制：

不涉及。

取值范围：

1990-01-01~2099-12-31

默认取值：

不涉及。

active_start_time

否

Boolean

参数解释：

执行时间，格式：HH:mm:ss。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表5 frequency要素说明

名称

是否必选

参数类型

说明

freq_type

否

String

参数解释：

策略频率类型。

约束限制：

不涉及。

取值范围：

  • daily：按天。
  • weekly：按周。
  • monthly_day：按月、每月按天。
  • monthly_week：按月、每月按周。

默认取值：

不涉及。

freq_interval

否

String

参数解释：

执行间隔。

约束限制：

不涉及。

取值范围：

1~99

默认取值：

不涉及。

freq_interval_weekly

否

Array of String

参数解释：

每周执行哪几天。

约束限制：

频率类型为按周时该参数必传，不为按周时不生效。

取值范围：

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。

默认取值：

不涉及。
表6 daily_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：时。

默认取值：

不涉及。
表7 duration要素说明

名称

是否必选

参数类型

说明

active_start_date

否

String

参数解释：

第一次执行日期，格式：yyyy-MM-dd。

约束限制：

不涉及。

取值范围：

1990-01-01~2099-12-31

默认取值：

不涉及。

active_end_date

否

String

参数解释：

最后一次执行日期，不传时表示不会结束，格式：yyyy-MM-dd。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求示例

创建发布订阅中的分发服务器。 
PUT https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/72ee4cc4607347049df9ad50f615bbd8in04/replication/publications
{
      "publication_ids": [
        "959d6fd2-c32f-47fe-a209-7fb6b261a6bb"
      ],
      "job_schedule": {
        "id": "569d69c2-53e5-4bef-a356-d7ea2ff6fa04",
        "user_defined": false,
        "schedule_type": "snapshot",
        "job_schedule_type": "recurring",
        "one_time_occurrence": {},
        "frequency": {
          "freq_type": "daily",
          "freq_interval": 1
        },
        "daily_frequency": {
          "freq_subday_type": "once",
          "active_start_time": "02:00:00"
        },
        "duration": {
          "active_start_date": "1990-01-01",
          "active_end_date": "2099-12-31"
        }
      }
}

响应消息

  • 正常响应要素说明
    表8 要素说明

    名称

    参数类型

    说明

    subscriptions

    Array of Object

    参数解释：

    批量修改订阅结果。详情请参见表9。
    表9 subscriptions要素说明

    名称

    参数类型

    说明

    id

    Array of Object

    参数解释：

    批量修改订阅结果。详情请参见表9。

    result

    String

    参数解释：

    执行结果。

    取值范围：

    • success：成功。
    • failure：失败。

    error_message

    String

    参数解释：

    失败报错信息。执行结果为失败时，返回的报错信息。

    取值范围：

    不涉及。
  • 正常响应样例 
    {
    "subscriptions":[
      {
        "id":"a59096a6-143c-4478-bec6-92b6b516d138",
         "result":"success "              
      }
     ]
}

状态码

错误码

请参见错误码。

相关文档