有奖捉虫:行业应用 & 管理与支持文档专题 HOT

1. 接口描述

接口请求域名: dts.tencentcloudapi.com 。

修改任务运行时属性,此接口不同于配置类接口,不会进行状态机判断。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyMigrateRuntimeAttribute。
Version String 公共参数,本接口取值:2021-12-06。
Region String 公共参数,详见产品支持的 地域列表
JobId String 迁移任务id,如:dts-2rgv0f09
示例值:dts-7itt1j4w
OtherOptions.N Array of KeyValuePairOption 需要修改的属性,此结构设计为通用结构,用于屏蔽多个业务的定制属性。
例如对于Redis:
{
"Key": "DstWriteMode", //目标库写入模式
"Value": "normal" //clearData(清空目标实例数据)、overwrite(以覆盖写的方式执行任务)、normal(跟正常流程一样,不做额外动作,默认为此值)
},
{
"Key": "IsDstReadOnly", //是否在迁移时设置目标库只读
"Value": "true" //true(设置只读)、false(不设置只读)
}

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改Redis目标库写入模式

修改Redis目标库写入模式,填写对应参数即可,也可同时修改多个参数。

输入示例

POST / HTTP/1.1
Host: dts.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyMigrateRuntimeAttribute
<公共请求参数>

{
    "JobId": "dts-2rgv0f09",
    "OtherOptions": [
        {
            "Key": "DstWriteMode",
            "Value": "clearData"
        }
    ]
}

输出示例

{
    "Response": {
        "RequestId": "14a719b5-ffb34ab6-816c43c1-8c6a23eb"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.FailedOperationError 操作失败。
InternalError 内部错误。
InternalError.ExecHttpRequestError http请求出错。
InternalError.InternalErrorError 内部错误。
InvalidParameter.InvalidParameterError 参数无效。
OperationDenied.OperationDeniedError 操作被拒绝。
ResourceNotFound 资源不存在。
ResourceNotFound.ResourceNotFoundError 资源未找到。
UnknownParameter.UnknownParameterError 未知参数。