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

Before you call the UpgradeDBProxyInstanceKernelVersion operation, make sure that the ModifyDBProxy operation is called to enable the database proxy feature for the instance.

  • The dedicated proxy feature of ApsaraDB RDS for MySQL provides capabilities such as read/write splitting and short-lived connection optimization. For more information, see What are database proxies?
  • The database proxy feature of ApsaraDB RDS for PostgreSQL supports read/write splitting. For more information, see What are database proxies?

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-uf6wjk5****

The ID of the instance. You can call the DescribeDBInstances operation to query the ID of the instance.

UpgradeTime String No MaintainTime

The time when you want to upgrade the database proxy version of the instance. Valid values:

  • MaintainTime: ApsaraDB RDS performs the upgrade during the maintenance window that you specified. This is the default value. For more information, see Modify the maintenance window.
  • Immediate: ApsaraDB RDS immediately performs the upgrade.
  • SpecificTime: ApsaraDB RDS performs the upgrade at a specified point in time.
Note
  • If the instance runs MySQL, you can set this parameter to MaintainTime, Immediate, or SpecificTime.
  • If the instance runs PostgreSQL, you can set this parameter to MaintainTime or Immediate.
SwitchTime String No 2019-07-10T13:15:12Z

The point in time at which you want to upgrade the database proxy version of the instance. 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 bu9***

The ID of the database proxy of the instance.

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

The ID of the request.

TaskId String 334362871

The ID of the task.

Examples

Sample requests

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

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HTTP status code Error code Error message Description
400 InvalidDBInstanceName Specified parameter DBInstanceName is not valid. The error message returned because the value of the DBInstanceName parameter is invalid. Check whether the value is null or an empty string.

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