1. 接口描述
接口请求域名： dts.tencentcloudapi.com 。
本接口用于查询支持迁移的云数据库实例
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeMigrateDBInstances。 |
| Version | 是 | String | 公共参数，本接口取值：2021-12-06。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| DatabaseType | 是 | String | 数据库类型，如mysql 示例值：mysql |
| MigrateRole | 否 | String | 实例作为迁移的源还是目标,src(表示源)，dst(表示目标) 示例值：dst |
| InstanceId | 否 | String | 云数据库实例ID 示例值：cdb-ktexpqjo |
| InstanceName | 否 | String | 云数据库名称 示例值：cdb-name1 |
| Limit | 否 | Integer | 返回数量限制 示例值：20 |
| Offset | 否 | Integer | 偏移量 示例值：0 |
| AccountMode | 否 | String | 资源所属账号 为空值或self(表示本账号内资源)、other(表示其他账户资源) 示例值：self |
| TmpSecretId | 否 | String | 临时密钥Id，可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197，其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://cloud.tencent.com/document/product/571/54117)第4节中关于角色的定义。 示例值：AKIDJXXXXX |
| TmpSecretKey | 否 | String | 临时密钥Id，可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197，其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://cloud.tencent.com/document/product/571/54117)第4节中关于角色的定义。 示例值：vobJwXXXXX |
| TmpToken | 否 | String | 临时密钥Id，可通过申请扮演角色临时访问凭证获取临时密钥https://cloud.tencent.com/document/product/1312/48197，其中角色资源RoleArn的定义可参考DTS跨账号迁移文档(https://cloud.tencent.com/document/product/571/54117)第4节中关于角色的定义。 示例值：MvIVqXXXXX |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 符合筛选条件的数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| Instances | Array of MigrateDBItem | 实例列表 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询迁移实例列表
查询迁移实例列表
输入示例
POST / HTTP/1.1
Host: dts.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMigrateDBInstances
<公共请求参数>
{
"InstanceId": "cdb-eur39922",
"DatabaseType": "mysql",
"MigrateRole": "src"
}输出示例
{
"Response": {
"TotalCount": 1,
"RequestId": "cafebabe-848392-di98382-dfu9832",
"Instances": []
}
}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 | 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 | 不支持的操作。 |
