1. 接口描述
接口请求域名: dts.tencentcloudapi.com 。
配置迁移服务,配置成功后可通过CreateMigrationCheckJob
创建迁移校验任务接口发起校验任务,只有校验通过才能启动迁移任务。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyMigrationJob。 |
Version | 是 | String | 公共参数,本接口取值:2021-12-06。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
JobId | 是 | String | 任务id 示例值:dts-1ewjspuw |
RunMode | 是 | String | 运行模式,取值如:immediate(表示立即运行)、timed(表示定时运行) 示例值:immediate |
MigrateOption | 是 | MigrateOption | 迁移任务配置选项,描述任务如何执行迁移等一系列配置信息;字段下的RateLimitOption不可配置、如果需要修改任务的限速信息、请在任务运行后通过ModifyMigrateRateLimit接口修改 |
SrcInfo | 是 | DBEndpointInfo | 源实例信息 |
DstInfo | 是 | DBEndpointInfo | 目标实例信息 |
JobName | 否 | String | 迁移任务名称,最大长度128 示例值:migrate_test |
ExpectRunTime | 否 | String | 期待启动时间,当RunMode取值为timed时,此值必填,形如:"2006-01-02 15:04:05" 示例值:2022-07-11 17:20:56 |
Tags.N | 否 | Array of TagItem | 标签信息 |
AutoRetryTimeRangeMinutes | 否 | Integer | 自动重试的时间段、可设置5至720分钟、0表示不重试 示例值:5 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 配置迁移任务
输入示例
POST / HTTP/1.1
Host: dts.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyMigrationJob
<公共请求参数>
{
"JobId": "abc",
"JobName": "abc",
"RunMode": "abc",
"ExpectRunTime": "abc",
"MigrateOption": {
"MigrateType": "abc",
"Consistency": {
"Mode": "abc"
},
"DatabaseTable": {
"ObjectMode": "abc",
"Databases": [
{
"DbName": "abc",
"NewDbName": "abc",
"SchemaName": "abc",
"NewSchemaName": "abc",
"DBMode": "abc",
"SchemaMode": "abc",
"TableMode": "abc",
"Tables": [
{
"TableName": "abc",
"NewTableName": "abc",
"TmpTables": [
"abc"
],
"TableEditMode": "abc"
}
],
"ViewMode": "abc",
"Views": [
{
"ViewName": "abc",
"NewViewName": "abc"
}
],
"RoleMode": "abc",
"Roles": [
{
"RoleName": "abc",
"NewRoleName": "abc"
}
],
"FunctionMode": "abc",
"TriggerMode": "abc",
"EventMode": "abc",
"ProcedureMode": "abc",
"Functions": [
"abc"
],
"Procedures": [
"abc"
],
"Events": [
"abc"
],
"Triggers": [
"abc"
]
}
],
"AdvancedObjects": [
"abc"
]
},
"IsMigrateAccount": true,
"IsOverrideRoot": true,
"IsDstReadOnly": true,
"ExtraAttr": [
{
"Key": "abc",
"Value": "abc"
}
]
},
"SrcInfo": {
"Supplier": "abc",
"Region": "abc",
"AccessType": "abc",
"DatabaseType": "abc",
"NodeType": "abc",
"Info": [
{
"Role": "abc",
"DbKernel": "abc",
"Host": "abc",
"Port": 1,
"User": "abc",
"Password": "abc",
"CvmInstanceId": "abc",
"UniqVpnGwId": "abc",
"UniqDcgId": "abc",
"InstanceId": "abc",
"CcnGwId": "abc",
"VpcId": "abc",
"SubnetId": "abc",
"EngineVersion": "abc",
"Account": "abc",
"AccountRole": "abc",
"AccountMode": "abc",
"TmpSecretId": "abc",
"TmpSecretKey": "abc",
"TmpToken": "abc"
}
],
"ExtraAttr": [
{
"Key": "abc",
"Value": "abc"
}
],
"DatabaseNetEnv": "abc"
},
"DstInfo": {
"Supplier": "abc",
"Region": "abc",
"AccessType": "abc",
"DatabaseType": "abc",
"NodeType": "abc",
"Info": [
{
"Role": "abc",
"DbKernel": "abc",
"Host": "abc",
"Port": 1,
"User": "abc",
"Password": "abc",
"CvmInstanceId": "abc",
"UniqVpnGwId": "abc",
"UniqDcgId": "abc",
"InstanceId": "abc",
"CcnGwId": "abc",
"VpcId": "abc",
"SubnetId": "abc",
"EngineVersion": "abc",
"Account": "abc",
"AccountRole": "abc",
"AccountMode": "abc",
"TmpSecretId": "abc",
"TmpSecretKey": "abc",
"TmpToken": "abc"
}
],
"ExtraAttr": [
{
"Key": "abc",
"Value": "abc"
}
],
"DatabaseNetEnv": "abc"
},
"Tags": [
{
"TagKey": "abc",
"TagValue": "abc"
}
],
"AutoRetryTimeRangeMinutes": 0
}
输出示例
{
"Response": {
"RequestId": "abc"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure.AuthFailureError | 认证失败。 |
AuthFailure.AuthorizedOperationDenyError | 认证拒绝错误。 |
AuthFailure.UnauthorizedOperationError | 鉴权失败,当前用户不允许执行该操作。 |
DryRunOperation.DryRunOperationError | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation.FailedOperationError | 操作失败。 |
InternalError | 内部错误。 |
InternalError.InternalErrorError | 内部错误。 |
InternalError.InternalHttpServerError | http请求访问出错。 |
InternalError.UnknownError | 未知的内部错误。 |
InvalidParameter.InvalidParameterError | 参数无效。 |
InvalidParameterValue.DataConvertError | 数据转换错误。 |
InvalidParameterValue.InvalidParameterValueError | 非法参数。 |
LimitExceeded.LimitExceededError | 数量超出限制。 |
MissingParameter.MissingParameterError | 参数丢失。 |
OperationDenied.OperationDeniedError | 操作被拒绝。 |
RequestLimitExceeded.RequestLimitExceededError | 请求次数超限。 |
ResourceInUse.ResourceInUseError | 资源在使用中。 |
ResourceInsufficient.ResourceInsufficientError | 资源短缺。 |
ResourceNotFound.ResourceNotFoundError | 资源未找到。 |
ResourceUnavailable.ResourceUnavailableError | 资源不可用。 |
ResourcesSoldOut.ResourcesSoldOutError | 资源售罄。 |
UnauthorizedOperation.UnauthorizedOperationError | 未授权的操作。 |
UnknownParameter.UnknownParameterError | 未知参数。 |
UnsupportedOperation.UnsupportedOperationError | 不支持的操作。 |