All Products
Search

This Product

    PolarDB:UpgradeDBClusterVersion

    Document Center

    PolarDB:UpgradeDBClusterVersion

    Last Updated:Apr 01, 2024

    Upgrades the kernel version of a PolarDB for MySQL cluster.

    Operation description

    Note
  • You can update only the revision version of a PolarDB for MySQL cluster, for example, from 8.0.1.1.3 to 8.0.1.1.4.
  • You can use only your Alibaba Cloud account to create scheduled tasks that update the kernel version of a PolarDB for MySQL cluster. RAM users are not authorized to update the kernel version of a PolarDB for MySQL cluster.
    •

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    polardb:UpgradeDBClusterVersionWRITE
    • dbcluster
      acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBClusterIdstringYes

    The ID of cluster.

    		pc-****************
    UpgradePolicystringNo

    The upgrade policy. Valid values:

    • HOT: hot upgrade.
    • COLD: cold upgrade. Only PolarDB for MySQL Cluster Edition that runs MySQL 8.0 supports this upgrade method.
    		HOT
    UpgradeLabelstringNo

    The upgrade tag. The value is fixed as INNOVATE.

    Note
  • This parameter is applicable only when you upgrade PolarDB for MySQL 8.0.1 to PolarDB for MySQL 8.0.2.
  • If you specify this parameter, you must set UpgradePolicy to COLD.
    •
    		INNOVATE
    PlannedStartTimestringNo

    The earliest start time to run the task that updates the kernel version of the cluster. Specify the time in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.

    Note
  • The earliest start time of the task can be a point in time within the next 24 hours. For example, if the current time is 2021-01-14T09:00:00Z, you can specify a point in time between 2021-01-14T09:00:00Z and 2021-01-15T09:00:00Z.
  • If you do not specify this parameter, the kernel update task runs immediately after you submit the request.
    •
    		2021-01-14T09:00:00Z
    PlannedEndTimestringNo

    The latest start time to run the task that updates the kernel version of the cluster. Specify the time in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.

    Note
  • The value of this parameter must be at least 30 minutes later than the value of PlannedStartTime.
  • If you specify PlannedStartTime but do not specify PlannedEndTime, the latest start time of the task is PlannedEndTime + 30 minutes. For example, if you set PlannedStartTime to 2021-01-14T09:00:00Z and do not specify PlannedEndTime, the latest start time of the task is set to 2021-01-14T09:30:00Z.
    •
    		2021-01-14T09:30:00Z
    FromTimeServicebooleanNo

    Specifies whether to immediately run the kernel upgrade task. Valid values:

    • false (default)
    • true
    Note This parameter is not required when you call the operation.
    		false
    UpgradeTypestringNo

    The update type. Valid values:

    • PROXY: specifies to upgrade PloarProxy.
    • DB: specifies to upgrade the kernel version.
    • ALL: specifies to upgrade both PloarProxy and kernel version.
    		PROXY
    TargetDBRevisionVersionCodestringNo

    The code of the version to which you want to upgrade the cluster. You can call the DescribeDBClusterVersion operation to query the version code.

    		20230707

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		CAE6755F-B79A-4861-B227-801FE8******

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "CAE6755F-B79A-4861-B227-801FE8******"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400ScheduleTaskExistThe specified dbCluster already has a scheduled task.The specified cluster already has a scheduled task.
    400InvalidUpgradeLabel.MalformedThe specified parameter UpgradeLabel is not valid.The specified UpgradeLabel parameter is invalid.
    400InvalidEngine.UnsupportedThe specified Engine does not support this feature.This feature is not supported by the specified engine.
    400InvalidEngineMinorVersion.MalformedThe specified parameter MinorVersion is not valid.The specified MinorVersion parameter is invalid.
    400InvalidEngineVersion.UnsupportedThe specified engineVersion is not supported.The specified engineVersion parameter is not supported.
    400InvalidUpgradePolicy.MalformedThe specified parameter UpgradePolicy is not valid.The specified UpgradePolicy parameter is invalid.
    400InvalidSwitchTimeMode.MalformedThe specified parameter SwitchTimeMode is not valid.The specified SwitchTimeMode parameter is invalid.
    403OperationDenied.UpgradeTypeThe operation is not permitted due to gdn limitThe current upgrade is not supported due to GDN limits.
    403IncorrectGdnStandbyDBVersionCurrent gdn standby cluster is not the latest db version.The current secondary cluster of the GDN does not run the latest database version.
    404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.
    404InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.The specified DBClusterId parameter is invalid.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-09-12The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      Error Codes 404 change
      delete Error Codes: 403
    2023-07-25The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: TargetDBRevisionVersionCode
    2022-07-14The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 404
      Added Error Codes: 403
    2022-07-06The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 404
    2022-07-04The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 404
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: UpgradePolicy
      Added Input Parameters: UpgradeLabel