You can call the UpgradeDBProxyInstanceKernelVersion operation to upgrade the dedicated proxy version of an ApsaraDB RDS instance.

The dedicated proxy of an instance provides advanced features, such as read/write splitting and connection pool. For more information, see Introduction to dedicated proxies.

Before you call this operation, make sure that the following requirements are met:

  • The dedicated proxy feature must be enabled for the instance.
  • The instance must run one of the following database engine versions and RDS editions:
    • MySQL 8.0 on RDS Enterprise Edition (The minor engine version is 20191204 or later.)
    • MySQL 8.0 on RDS High-availability Edition (The minor engine version is 20190915 or later.)
    • MySQL 5.7 on RDS Enterprise Edition (The minor engine version is 20191128 or later.)
    • MySQL 5.7 on RDS High-availability Edition (The minor engine version is 20190925 or later.)
    • MySQL 5.6 on RDS High-availability Edition (The minor engine version is 20200229 or later.)

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes UpgradeDBProxyInstanceKernelVersion

The operation that you want to perform. Set the value to UpgradeDBProxyInstanceKernelVersion.

DBInstanceId String Yes rm-uf6wjk5xxxxxxx

The ID of the instance.

UpgradeTime String No MaintainTime

The time when you want to perform the upgrade. Valid values:

  • MaintainTime: ApsaraDB RDS performs the upgrade during the specified maintenance window. This is the default value. For more information, see Modify maintenance window.
  • Immediate: ApsaraDB RDS immediately performs the upgrade.
  • SpecificTime: ApsaraDB RDS performs the upgrade at the specified date and time.
SwitchTime String No 2019-07-10T13:15:12Z

The date and time when you want to perform the upgrade. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

Note If you set the UpgradeTime parameter to SpecificTime, you must specify the SwitchTime parameter.

Response parameters

Parameter Type Example Description
DBInstanceName String bu9xxxxxx

The ID of the proxy instance.

RequestId String 44537EC8-DFA2-4745-B579-E733FF2C5B9A

The ID of the request.

TaskId String 334362871

The ID of the upgrade task.

Examples

Sample requests

http(s)://rds.aliyuncs.com/?Action=UpgradeDBProxyInstanceKernelVersion
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<Common request parameters>

Sample success responses

XML format

<UpgradeDBProxyInstanceKernelVersionResponse>
  <TaskId>334362871</TaskId>
  <RequestId>44537EC8-DFA2-4745-B579-E733FF2C5B9A</RequestId>
  <DBInstanceName>bu9xxxxxx</DBInstanceName>
</UpgradeDBProxyInstanceKernelVersionResponse>

JSON format

{
    "TaskId": "334362871",
    "RequestId": "44537EC8-DFA2-4745-B579-E733FF2C5B9A",
    "DBInstanceName": "bu9xxxxxx"
}

Error codes

For a list of error codes, visit the API Error Center.