SyncDtsStatus - 设置是否限制实例变配

在使用DTS迁移或同步云数据库 Tair(兼容 Redis)实例的数据前,您可以调用本接口限制该实例执行变配操作,避免因变配引起的数据迁移或同步任务失败。

接口说明

  • 本接口仅适用于经典版实例。
  • 数据迁移或同步任务完成后,您可以再次调用本接口,解除变配限制。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
kvstore:SyncDtsStatusupdate
  • DBInstance
    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

请求参数

名称类型必填描述示例值
RegionIdstring

实例所属的地域 ID。

cn-hangzhou
InstanceIdstring

实例 ID。

r-bp1zxszhcgatnx****
Statusstring

是否限制实例执行变配操作,取值:

  • 0:不限制。
  • 1:限制,执行变配时将提示用户。
0
TaskIdstring

DTS 的实例 ID,您可以登录 DTS 控制台查看。

说明 由于实例可能同时处于多个 DTS 的迁移或同步任务中时,当您需要取消对实例的变配限制时,您可以传入本参数以避免重复调用本接口。
dtss0611o8vv90****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

5D622714-AEDD-4609-9167-F5DDD3D1****

示例

正常返回示例

JSON格式

{
  "RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-07-20OpenAPI 描述信息更新查看变更详情
2023-03-02API 内部配置变更,不影响调用查看变更详情