调用CreateCloudMigrationPrecheckTask接口创建RDS PostgreSQL一键上云前检查任务。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rds:CreateCloudMigrationPrecheckTask | Read |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceName | string | 是 | 目标实例ID。可调用DescribeDBInstances接口查询。 | pgm-bp102g323jd4**** |
| SourceIpAddress | string | 是 | 自建PostgreSQL数据库的内网IP。
| 172.2.XX.XX |
| SourcePort | long | 是 | 自建PostgreSQL的端口。可通过 | 5432 |
| SourceAccount | string | 是 | 用户名。创建迁移账号步骤创建的数据库账号。 | migratetest |
| SourcePassword | string | 是 | 密码。创建迁移账号步骤创建的数据库账号的密码。 | 123456 |
| TaskName | string | 否 | 任务名称。自定义，未设置时系统自动生成。 | slf7w7wj3g |
| SourceCategory | string | 是 | 自建PostgreSQL的类型。
| ecsOnVpc |
返回参数
示例
正常返回示例
JSON格式
{
"DBInstanceName": "pgm-bp102g323jd4****",
"RequestId": "60F9A12A-16B8-4728-B099-4CA38D32C31C",
"TaskId": 439946016,
"TaskName": "slf7w7wj3g"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | IncorrectDBInstanceState | The current instance state does not support this operation. | 当前实例状态不支持此操作。 |
| 403 | IncorrectDBInstance | The current DB instance does not support this operation. | 操作失败，当前实例不支持此操作。 |
| 403 | IncorrectDBInstanceType | The database instance type does not support the operation. | 操作失败，当前数据库类型不支持该操作。 |
| 404 | InvalidDBInstanceName.NotFound | The database instance does not exist. | 数据库实例名称不存在。请确认数据名称是否正确。 |
| 404 | IncorrectDBInstanceLockMode | Current DB instance lock mode does not support this operation. | 操作失败，实例处于锁定状态。 |
访问错误中心查看更多错误码。