DescribeTransformStatus - 查询实例升级状态 - 云原生数据库 PolarDB

该接口主要用于查询标准版实例向企业版实例升级（或转换）任务的当前状态。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID。	cn-hangzhou
DBInstanceName	string	否	实例名称。	pxc-xxx
QueryReport	boolean	否	校验报告。	true

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	173CA69A-3513-591D-8A09-C1EA37CBE2D9
Data	object	监控数据。
EnterpriseInsName	string	企业版企业名称。	pxc-*****
StandardInsName	string	标准版实例名称。	pxc-*****
Phase	string	当前迁移/升级阶段。	none
CanSwitch	boolean	是否可以进行迁移切换，返回值为： true：是。 false：否。说明此参数供云原生数据库 PolarDB 产品的一键升级功能使用。
CanUndoSwitch	boolean	是否可以撤销切换操作。
CanCancel	boolean	是否可取消	true
CanFinish	boolean	当前任务是否已完成。	true
ReportTime	long	数据报表生成日期。	2025-09-02 16:52:47.0
ReportSummary	object	报表摘要信息。

示例

正常返回示例

JSON格式

{
  "RequestId": "173CA69A-3513-591D-8A09-C1EA37CBE2D9",
  "Data": {
    "EnterpriseInsName": "pxc-*****",
    "StandardInsName": "pxc-*****",
    "Phase": "none",
    "CanSwitch": true,
    "CanUndoSwitch": true,
    "CanCancel": true,
    "CanFinish": true,
    "ReportTime": 0,
    "ReportSummary": {
      "test": "test",
      "test2": 1
    }
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	IncorrectDBInstance	Current DB instance does not support this operation.	当前实例不支持这个操作
400	IncorrectDBInstanceState	Current DB instance state does not support this operation.	当前的实例状态不支持此操作
400	InvalidParam	Invalid Parameter.	参数有误
400	InvalidDBInstance.NotFound	The specified DB instance does not exist or is not supported.	指定实例不存在
400	Transform.UnSupportedDbVersion	Only database engine version 5.7 is supported.	只有数据库引擎版本为5.7的是支持的。
403	Transform.IncorrectEngineVersion	The current engine version is not the latest. Please upgrade to the latest version.	当前实例版本不是最新版本，请升级到最新版本。

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

变更历史

变更时间	变更内容概要	操作
2025-10-10	新增 OpenAPI	查看变更详情