Updated on 2024-04-01 GMT+08:00

Changing the Instance Class of a DB Proxy Instance

Function

This API is used to change the instance class of a DB proxy instance.

This API will be unavailable on April 30, 2024.

  • Before calling an API, you need to understand the API in Authentication.

Constraints

  • You need to contact customer service to apply for the required permissions.
  • This API is supported only for RDS for PostgreSQL 11 and 12.
  • The database proxy must have been enabled for the DB instance.

URI

  • URI format

    POST /v3/{project_id}/instances/{instance_id}/proxy/scale

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID of a tenant in a region.

    For details about how to obtain the project ID, see Obtaining a Project ID.

    instance_id

    Yes

    Specifies the DB instance ID.

Request

Parameter description
Table 2 Parameter description

Name

Mandatory

Type

Description

flavor_ref

Yes

String

Specifies the ID of the new flavor.

delay

Yes

Boolean

Specifies whether to delay the change.

  • true: indicates that the change is delayed. It will be automatically performed in the maintenance window.
  • false: indicates that the change is performed immediately.

Example Request

https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/proxy/scale

{
  "flavor_ref" : "rds.pg.proxy.c6.xlarge.2.ha",
  "delay" : false
}

Response

  • Normal response
    Table 3 Parameter description

    Name

    Type

    Description

    job_id

    String

    Indicates the job ID.

  • Example normal response
    {
      "job_id" : "e7a7535b-eb9b-45ac-a83a-020dc5016d94"
    }
  • Abnormal response

    For details, see Abnormal Request Results.