All Products
Search

This Product

    ApsaraDB RDS:UpgradeDBProxyInstanceKernelVersion

    Document Center

    ApsaraDB RDS:UpgradeDBProxyInstanceKernelVersion

    Last Updated:May 29, 2023

    Upgrades the dedicated proxy version of an instance.

    Operation Description

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

    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
    rds:UpgradeDBProxyInstanceKernelVersionWRITE
    • RDS
      acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBInstanceIdstringYes

    rm-uf6wjk5****

    		rm-uf6wjk5****
    UpgradeTimestringNo

    The ID of the database proxy of the instance.

    		MaintainTime
    SwitchTimestringNo

    Upgrades the dedicated proxy version of an instance.

    		2019-07-10T13:15:12Z
    DBProxyEngineTypestringNo

    Before you call the ModifyDBProxyEndpoint 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?
    		normal

    Response parameters

    ParameterTypeDescriptionExample
    object
    DBInstanceNamestring

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

    		bu9***
    RequestIdstring

    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.

    		44537EC8-DFA2-4745-B579-E733FF2C5B9A
    TaskIdstring

    The specific point in 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.

    NoteIf you set UpgradeTime to SpecificTime, you must specify SwitchTime.
    		334362871

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidDBInstanceNameSpecified parameter DBInstanceName is not valid.The value of the DBInstanceName parameter is invalid. Check that the value of this parameter is not null or an empty string.
    403IncorrectDBInstanceStateThe proxy instance has not been activated.-

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

    Change history

    Change timeSummary of changesOperation
    2023-04-17The error codes of the API operation change.
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 403 change
      delete Error Codes: 400
    2022-06-23API Description Update,The error codes of the API operation change.
    Change itemChange content
    API DescriptionAPI Description Update
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
      delete Error Codes: 403
    2022-06-08The error codes of the API operation change.,The input parameters of the API operation change.
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
      delete Error Codes: 403
    Input ParametersThe input parameters of the API operation change.
      Added Input Parameters: DBProxyEngineType