Querying Available Instance Classes for a DB Proxy Instance (v3.1)

Function

This API is used to query available instance classes for 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.
Database proxy has been enabled for the DB instance.

URI

URI format
GET /v3/{project_id}/instances/{instance_id}/proxy/scale/flavors

GET /v3.1/{project_id}/instances/{instance_id}/proxy/scale/flavors
Example
https://{endpoint}/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/proxy/scale/flavors

Parameter description

**Table 1** Parameter description
Name	Mandatory	Description
project_id	Yes	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	Instance ID.
offset	No	Index offset. If offset is set to N, the resource query starts from the N+1 piece of data. The value is 0 by default, indicating that the query starts from the first piece of data. The value cannot be a negative number.
limit	No	Number of records to be queried. The default value is 100. The value cannot be a negative number. The minimum value is 1 and the maximum value is 100.

Request

None

Response

Normal response

**Table 2** Parameter description
Name	Type	Description
compute_flavor_groups	Array of objects	Compute flavor list objects. For details, see Table 3.

**Table 3** compute_flavor_groups element data structure description
Name	Type	Description
group_type	String	Group type X86: x86 architecture ARM: Arm architecture
compute_flavors	Array of objects	Compute flavor information For details, see Table 4.

**Table 4** ScaleFlavors element data structure description
Name	Type	Description
code	String	Specification code
cpu	String	Number of vCPUs
mem	String	Memory size in GB

Example normal response

{
  "compute_flavor_groups" : {
    "group_type" : "X86",
    "compute_flavors" : {
      "code" : "rds.pg.proxy.c6.large.2.ha",
      "cpu" : 2,
      "mem" : 4
    }
  }
}