1. 接口描述
接口请求域名: sqlserver.tencentcloudapi.com 。
本接口(DescribeMigrationDatabases)的作用是查询待迁移数据库列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeMigrationDatabases。 |
Version | 是 | String | 公共参数,本接口取值:2018-03-28。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 迁移源实例的ID,格式如:mssql-si2823jyl 示例值:mssql-si2823jyl |
UserName | 是 | String | 迁移源实例用户名 示例值:sqlserver_admin |
Password | 是 | String | 迁移源实例密码 示例值:123456 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Amount | Integer | 数据库数量 示例值:3 |
MigrateDBSet | Array of String | 数据库名称数组 注意:此字段可能返回 null,表示取不到有效值。 示例值:["Biz-test1","Biz-test2","Biz-test3"] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询迁移数据库列表
输入示例
https://sqlserver.tencentcloudapi.com/?Action=DescribeMigrationDatabases
&InstanceId=mssql-si2823jyl
&UserName=sqlserver_admin
&Password=123456
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "4be5990d-a4b5-49dc-b2b4-e713b6aa7ba3",
"Amount": 3,
"MigrateDBSet": [
"Biz-test1",
"Biz-test2",
"Biz-test3"
]
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InternalError.DBConnectError | 数据库连接错误。 |
InternalError.DBError | 数据库错误。 |
InternalError.GcsError | GCS接口错误。 |
InternalError.SystemError | 系统错误。 |
InternalError.UnknownError | 未知错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.ParamsAssertFailed | 参数断言转换错误。 |
InvalidParameterValue.PasswordIsIllegal | 账号密码非法。 |
ResourceNotFound.AccountNotExist | 账号不存在。 |
ResourceNotFound.InstanceNotFound | 实例不存在。 |
UnauthorizedOperation.PermissionDenied | cam鉴权错误。 |