UpgradeColumnarVersion - PolarDB - Alibaba Cloud Documentation Center

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardbx:UpgradeColumnarVersion

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceName	string	No	The instance name.	pxc-xxx
ColumnarVersion	string	No	The column store version.	polarx-col-kernel-5.4.20-20250819_17555906
RegionId	string	No	The region in which the instance resides.	cn-hangzhou
InstanceName	string	No	The instance name.	pxc-hzrh51fze****pon-cdc
SwitchMode	string	No	The switch mode.	0

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	AE4F6C34-****-45AA-B5DC-4B8D816F6305
Message	string	The response message.	success
Success	boolean	Indicates whether the request was successful.	true
Data	object	The returned data.
MinorVersion	string	The target version number.	polardb-2.4.0_5.4.19-20250116_xcluster5.4.20-20241213
TaskList	array<object>	The list of upgrade tasks.
	object	The list of upgrade tasks.
DbInstanceName	string	The instance ID.	rm-uf68f345****88zf8
TaskId	integer	The target task ID.	1861190497624654848

Examples

Success response

JSON format

{
  "RequestId": "AE4F6C34-****-45AA-B5DC-4B8D816F6305",
  "Message": "success",
  "Success": true,
  "Data": {
    "MinorVersion": "polardb-2.4.0_5.4.19-20250116_xcluster5.4.20-20241213",
    "TaskList": [
      {
        "DbInstanceName": "rm-uf68f345****88zf8",
        "TaskId": 1861190497624654800
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.