首页 云数据库 RDS API参考 API目录 PostgreSQL一键上云 DescribeCloudMigrationPrecheckResult - 查询RDS PostgreSQL一键上云前检查报告

DescribeCloudMigrationPrecheckResult - 查询RDS PostgreSQL一键上云前检查报告

调用DescribeCloudMigrationPrecheckResult接口查询一键上云前检查报告。

接口说明

前提条件

已调用CreateCloudMigrationPrecheckTask接口创建RDS PostgreSQL一键上云前检查任务。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:DescribeCloudMigrationPrecheckResultRead
  • RDS
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag

请求参数

名称类型必填描述示例值
DBInstanceNamestring

目标实例ID。可调用DescribeDBInstances接口查询。

pgm-bp102g323jd4****
TaskIdlong

任务ID。调用CreateCloudMigrationPrecheckTask接口创建一键上云前检查任务时响应消息中获取。

439946016
TaskNamestring

任务名称。调用CreateCloudMigrationPrecheckTask接口创建一键上云前检查任务时响应消息中获取

slf7w7wj3g
SourceIpAddressstring

自建PostgreSQL数据库的内网IP或公网IP。

  • ECS自建PostgreSQL数据库一键上云场景,配置ECS实例的私网IP。获取方法请参见查看IP地址
  • IDC自建PostgreSQL数据库一键上云场景,配置为IDC的内网IP。
172.2.XX.XX
SourcePortlong

自建PostgreSQL数据库的端口。可通过netstat -a | grep PGSQL命令查看。

5432
PageSizelong

每页最大记录数。

10
PageNumberlong

页数。

1

返回参数

名称类型描述示例值
object
TotalSizeinteger

查询结果统计。

1
RequestIdstring

请求ID。

7E4A6E1B-789B-5F16-9736-39AA57FC7374
Itemsarray

一键上云检查报告列表。

object
GmtCreatedstring

任务创建时间。

2022-02-25T06:57:41Z
GmtModifiedstring

任务修改时间。

2022-02-25T06:58:00Z
TaskIdlong

任务ID。

440420798
TaskNamestring

任务名称。

lxbv6rtxno8
SourceCategorystring

自建PostgreSQL的类型。

  • idcOnVpc:线下IDC自建PostgreSQL(IDC与VPC打通)
  • ecsOnVpc:阿里云ECS自建PostgreSQL
ecsonvpc
SourceIpAddressstring

自建PostgreSQL数据库的内网IP。

172.2.XX.XX
SourcePortlong

自建PostgreSQL数据库的端口。

5432
SourceAccountstring

用户名。

migratetest
SourcePasswordstring

密码。

123456
TargetEipstring

预留参数,查询结果为空。

null
TargetInstanceNamestring

目标实例ID。

pgm-bp102g323jd4****
Detailstring

上云前检查报告内容。

[Check rds empty]\nCheck rds databases: success\n[Check source connectivity]\nCheck ip connectable: success\nCheck port connectable: success\nCheck database connectable: success\nCheck account replication privilege: success\nCheck account createrole privilege: success\nCheck account monitor privilege: success\n[Check source version]\nCheck major version consistent: success\n[Check source glibc version]\nCheck source glibc version compatible: warning(warning:source glibc version is not compatible with rds pg)\n[Check disk size]\nCheck disk size enough: success\n[Check wal keep size]\nCheck wal keep size large enough: success\n[Check spec params]\nCheck if spec params too large: success\n [Check triggers]\nCheck triggers compatible: success\n[Check user functions]\nCheck user functions compatible: success\n*Migrate check success*
PageNumberlong

页数。

1
PageSizelong

每页最大记录数

10

示例

正常返回示例

JSON格式

{
  "TotalSize": 1,
  "RequestId": "7E4A6E1B-789B-5F16-9736-39AA57FC7374",
  "Items": [
    {
      "GmtCreated": "2022-02-25T06:57:41Z",
      "GmtModified": "2022-02-25T06:58:00Z",
      "TaskId": 440420798,
      "TaskName": "lxbv6rtxno8",
      "SourceCategory": "ecsonvpc",
      "SourceIpAddress": "172.2.XX.XX",
      "SourcePort": 5432,
      "SourceAccount": "migratetest",
      "SourcePassword": "123456",
      "TargetEip": "null",
      "TargetInstanceName": "pgm-bp102g323jd4****",
      "Detail": "[Check rds empty]\\nCheck rds databases: success\\n[Check source connectivity]\\nCheck ip connectable: success\\nCheck port connectable: success\\nCheck database connectable: success\\nCheck account replication privilege: success\\nCheck account createrole privilege: success\\nCheck account monitor privilege: success\\n[Check source version]\\nCheck major version consistent: success\\n[Check source glibc version]\\nCheck source glibc version compatible: warning(warning:source glibc version is not compatible with rds pg)\\n[Check disk size]\\nCheck disk size enough: success\\n[Check wal keep size]\\nCheck wal keep size large enough: success\\n[Check spec params]\\nCheck if spec params too large: success\\n [Check triggers]\\nCheck triggers compatible: success\\n[Check user functions]\\nCheck user functions compatible: success\\n*Migrate check success*"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10
}

错误码

HTTP status code错误码错误信息描述
404InvalidDBInstanceName.NotFoundThe database instance does not exist.数据库实例名称不存在。请确认数据名称是否正确。

访问错误中心查看更多错误码。

阿里云首页 关系型数据库 相关技术圈