接口请求域名： dts.intl.tencentcloudapi.com 。
本接口用于查询支持迁移的云数据库实例
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeMigrateDBInstances。 |
| Version | 是 | String | 公共参数，本接口取值：2021-12-06。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| DatabaseType | 是 | String | 数据库类型，如mysql,percona,mariadb,tdsqlmysql,mariadb,postgresql,cynosdbmysql,redis,tendis,keewidb,tdstore,mongodb,clickhouse,sqlserver等。 |
| MigrateRole | 否 | String | 实例作为迁移的源还是目标,src(表示源)，dst(表示目标) |
| InstanceId | 否 | String | 云数据库实例ID，可通过对应业务实例列表获取实例信息。 |
| InstanceName | 否 | String | 云数据库名称，可通过对应业务实例列表获取实例信息。 |
| Limit | 否 | Integer | 返回数量限制 |
| Offset | 否 | Integer | 偏移量 |
| AccountMode | 否 | String | 资源所属账号 为空值或self(表示本账号内资源)、other(表示其他账户资源) |
| TmpSecretId | 否 | String | 临时密钥Id，可通过申请扮演角色临时访问凭证获取临时密钥https://www.tencentcloud.com/document/product/1312/48197?from_cn_redirect=1，其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://www.tencentcloud.com/document/product/571/54117?from_cn_redirect=1)第4节中关于角色的定义。 |
| TmpSecretKey | 否 | String | 临时密钥Id，可通过申请扮演角色临时访问凭证获取临时密钥https://www.tencentcloud.com/document/product/1312/48197?from_cn_redirect=1，其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://www.tencentcloud.com/document/product/571/54117?from_cn_redirect=1)第4节中关于角色的定义。 |
| TmpToken | 否 | String | 临时密钥Id，可通过申请扮演角色临时访问凭证获取临时密钥https://www.tencentcloud.com/document/product/1312/48197?from_cn_redirect=1，其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://www.tencentcloud.com/document/product/571/54117?from_cn_redirect=1)第4节中关于角色的定义。 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 符合筛选条件的数量 |
| Instances | Array of MigrateDBItem | 实例列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
查询迁移实例列表
POST / HTTP/1.1
Host: dts.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMigrateDBInstances
<公共请求参数>
{
"InstanceId": "cdb-eur39922",
"DatabaseType": "mysql",
"MigrateRole": "src"
}
{
"Response": {
"Instances": [
{
"Hint": "ok",
"InstanceId": "cdb-chtaoop0",
"InstanceName": "evan-test2",
"Usable": 1,
"Vip": "172.21.0.31",
"Vport": 10086
},
{
"Hint": "ok",
"InstanceId": "cdb-o3dplch0",
"InstanceName": "evan-test1",
"Usable": 1,
"Vip": "172.21.0.37",
"Vport": 10086
},
{
"Hint": "ok",
"InstanceId": "cdb-hbfybwlq",
"InstanceName": "joyce-dts2",
"Usable": 1,
"Vip": "172.21.0.104",
"Vport": 3306
},
{
"Hint": "ok",
"InstanceId": "cdb-kgmdn6iq",
"InstanceName": "joyce-dts1",
"Usable": 1,
"Vip": "172.21.0.100",
"Vport": 3306
}
],
"RequestId": "a4a8f147-1898-4130-a1cf-f4bd3c92d083",
"TotalCount": 4
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.AuthFailureError | 认证失败。 |
| AuthFailure.UnauthorizedOperationError | 鉴权失败，当前用户不允许执行该操作。 |
| DryRunOperation.DryRunOperationError | DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。 |
| FailedOperation.FailedOperationError | 操作失败。 |
| InternalError | 内部错误。 |
| InternalError.InternalErrorError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InvalidParameterError | 参数无效。 |
| InvalidParameterValue.InvalidParameterValueError | 非法参数。 |
| LimitExceeded.LimitExceededError | 数量超出限制。 |
| MissingParameter | 缺少参数错误。 |
| MissingParameter.MissingParameterError | 参数丢失。 |
| OperationDenied.OperationDeniedError | 操作被拒绝。 |
| RequestLimitExceeded.RequestLimitExceededError | 请求次数超限。 |
| ResourceInUse.ResourceInUseError | 资源在使用中。 |
| ResourceInsufficient.ResourceInsufficientError | 资源短缺。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.BizResourceNotFoundError | 未找到资源。 |
| ResourceNotFound.ResourceNotFound | 实例未找到。 |
| ResourceNotFound.ResourceNotFoundError | 资源未找到。 |
| ResourceUnavailable.ResourceUnavailableError | 资源不可用。 |
| ResourcesSoldOut.ResourcesSoldOutError | 资源售罄。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.PermissionDenied | 操作未被授权。 |
| UnauthorizedOperation.UnauthorizedOperationError | 未授权的操作。 |
| UnknownParameter | 未知参数错误。 |
| UnknownParameter.UnknownParameterError | 未知参数。 |
| UnsupportedOperation | 操作不支持。 |
| UnsupportedOperation.UnsupportedOperationError | 不支持的操作。 |
文档反馈