Updated on 2025-08-20 GMT+08:00

Querying Database Proxy Specifications

Function

This API is used to query database proxy specifications of a DB instance.

Constraints

This operation cannot be performed when the instance is in the abnormal or frozen state.

URI

  • URI format

    GET /v3/{project_id}/instances/{instance_id}/proxy/flavors

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Definition

    Project ID of a tenant in a region.

    To obtain the value, see Obtaining a Project ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

    instance_id

    Yes

    Definition

    Instance ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

    Table 2 Request parameters

    Parameter

    Mandatory

    Type

    Description

    offset

    No

    Integer

    Definition

    Index offset. The query starts from the next piece of data indexed by this parameter.

    Constraints

    N/A

    Range

    The value must be a non-negative number.

    Default Value

    The default value is 0, indicating that the query starts from the first data record.

    limit

    No

    Integer

    Definition

    Number of records to be queried.

    Constraints

    N/A

    Range

    1–100

    Default Value

    100

Request

  • Request parameters

    None

  • URI example

    GET https://rds.ap-southeast-1.myhuaweicloud.com/v3/23a50154cf494ec9ad6883979a12db0a/instances/ba0fd7c13cca4655820e0f858d5d467bin01/proxy/flavors?offset=0&limit=100

Response

  • Normal response
    Table 3 Parameters

    Parameter

    Type

    Description

    compute_flavor_groups

    Array of objects

    Definition

    Specification group information.

    For details, see Table 4.

    Table 4 compute_flavor_groups element structure description

    Parameter

    Type

    Description

    group_type

    String

    Definition

    Specification group type.

    Range

    • X86
    • ARM

    compute_flavors

    Array of objects

    Definition

    Specification information.

    For details, see Table 5.

    Table 5 compute_flavors element structure description

    Parameter

    Type

    Description

    id

    String

    Definition

    Specification ID of the database proxy.

    Range

    N/A

    code

    String

    Definition

    Specification code of the database proxy.

    Range

    N/A

    cpu

    String

    Definition

    Number of vCPUs.

    Range

    For example, the value 1 indicates one vCPU.

    mem

    String

    Definition

    Memory size in GB.

    Range

    N/A

    db_type

    String

    Definition

    Database type.

    Range

    N/A

    az_status

    Object

    Definition

    AZ information. key indicates the AZ associated with the specification, and value indicates the specification status in the AZ. Only the specification status in the AZ where the primary instance is located is displayed.

    Range

    • normal: The specification is normal.
    • abandon: The specification is abandoned.
  • Example normal response
    { 
       "compute_flavor_groups" : [ { 
         "group_type" : "X86", 
         "compute_flavors" : [ { 
           "id" : "3208f282-7815-4ff8-9466-90a6fedd6b52", 
           "code" : "rds.proxy.large.2", 
           "cpu" : "2", 
           "mem" : "4", 
           "db_type" : "Proxy", 
           "az_status" : { 
             "aaa" : "normal" 
           } 
         } ] 
       } ] 
     }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.