文档

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

更新时间:

该接口用于查询一键上云前检查报告详细信息。

接口说明

适用引擎

  • RDS PostgreSQL

调试

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

授权信息

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

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

每页记录数,取值:30~100。 默认值:30。

30
PageNumberlong

页码,取值:大于 0 且不超过 Integer 的最大值。默认值:1

1

返回参数

名称类型描述示例值
object

返回参数详情。

TotalSizeinteger

查询结果统计。

1
RequestIdstring

请求 ID。

7E4A6E1B-789B-5F16-9736-39AA57FC7374
Itemsobject []

一键上云检查报告列表。

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错误码错误信息描述
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0,请先充值后再尝试购买。
400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。
400RegionDissolvedEOMDear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.客户您好,阿里云计划对当前地域进行优化调整,该区域云服务将停止运营,为确保您的业务连续性及数据迁移工作的平稳过渡,您目前无法操作新购类型的订单,感谢理解与支持。
400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.您购买的模块不合法,请重新购买。
400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.客户您好,印度地域裁撤,购买的服务效期不能超过2024.07.15。
400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.客户您好,澳洲地域裁撤,购买的服务效期不能超过2024.09.30
400Price.CommoditySysCommodity system call exception.商品系统调用异常。
400Pay.InsufficientBalanceInsufficient available balance.可用金不足。
400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.您选购的周期有问题,请重新选购。
400pay.noCreditCardAccount not bound to credit card.账户未绑定信用卡。
400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.您选购的服务存在未支付订单,请支付或作废后再下单。
400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.没有为您的帐户指定付款方式。我们建议您添加一种付款方式。
400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.您的基本信息未完善,请在操作前先完善您的基本信息。
400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.您的账户出现异常,详情请联系客服。
400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.您的信息不完整,请在操作前填写您的信息。
400System.SaleValidateFailedSales expression validation system error.销售表达式校验系统错误。
403OrderStatus.UnPaidThe specified db instance has unpaid order.实例当前存在未支付订单,请支付后重试。
404InvalidDBInstanceName.NotFoundThe database instance does not exist.数据库实例名称不存在。请确认数据名称是否正确。

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

  • 本页导读 (1)
文档反馈