DescribeTransformStatus - PolarDB - Alibaba Cloud Documentation Center

Queries the current status of a task that upgrades or converts a standard instance to an Enterprise instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
DBInstanceName	string	No	The instance name.	pxc-xxx
QueryReport	boolean	No	The verification report.	true

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	173CA69A-3513-591D-8A09-C1EA37CBE2D9
Data	object	The monitoring data.
EnterpriseInsName	string	The Enterprise Edition instance name.	pxc-*****
StandardInsName	string	The standard instance name.	pxc-*****
Phase	string	The current migration or upgrade phase.	none
CanSwitch	boolean	Indicates whether the migration switchover can be performed. Valid values: true: The migration switchover can be performed. false: The migration switchover cannot be performed. Note This parameter is used by the one-click upgrade feature of PolarDB.
CanUndoSwitch	boolean	Indicates whether the switchover operation can be reverted.
CanCancel	boolean	Indicates whether the task can be canceled.	true
CanFinish	boolean	Indicates whether the current task is completed.	true
ReportTime	integer	The date when the data report was generated.	2025-09-02 16:52:47.0
ReportSummary	object	The report summary.

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectDBInstance	Current DB instance does not support this operation.	The current instance does not support this operation.
400	IncorrectDBInstanceState	Current DB instance state does not support this operation.	The current instance state does not support this operation
400	InvalidParam	Invalid Parameter.	Parameter error
400	InvalidDBInstance.NotFound	The specified DB instance does not exist or is not supported.	english description1
400	Transform.UnSupportedDbVersion	Only database engine version 5.7 is supported.	Only database engine version 5.7 is supported.
403	Transform.IncorrectEngineVersion	The current engine version is not the latest. Please upgrade to the latest version.	The current instance version is not the latest version. Upgrade to the latest version.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.