UpgradeCDCVersion - 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:UpgradeCDCVersion

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceName	string	No	The instance ID. > You can call the DescribeDBInstances operation to query the details of all instances in the specified region, including instance IDs.	pxc-hzrp****3p72fi
CdcMinorVersion	string	No	The target version number to which you want to upgrade.	polarx-cdc-kernel-5.4.19-20240928_17274884
CdcDbVersion	string	No	The target database version to which you want to upgrade. > You can call the DescribeDBClusterVersion operation to query the upgrade instructions for all database versions in the specified region.	2.343
RegionId	string	No	The region in which the instance resides. > You can call the DescribeRegions operation to query the regions supported by PolarDB-X, including region IDs.	cn-hangzhou
InstanceName	string	No	The instance name.	pxc-shrvdc****wtf5uk-cdc
SwitchMode	string	No	The switch mode. Valid values: 0: immediately switches. 1: switches within the O&M window.	0

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	CB4307F5-3D04-51E8-ABAD-49E0B3F962FC
Message	string	The response message.	success
Success	boolean	Indicates whether the request was successful.	True
Data	object	The returned result.
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": "CB4307F5-3D04-51E8-ABAD-49E0B3F962FC",
  "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.