Updated on 2024-06-07 GMT+08:00

Querying Database Proxy Specifications

Function

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

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

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

    Project ID of a tenant in a region.

    To obtain it, refer to Obtaining a Project ID.

    instance_id

    Yes

    Instance ID.

    Table 2 Request parameters

    Parameter

    Mandatory

    Type

    Description

    offset

    No

    Integer

    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 must be a number but cannot be a negative number.

    limit

    No

    Integer

    Number of query records. The default value is 100. The value must be a positive integer. The minimum value is 1 and the maximum value is 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

    Specification group information.

    For details, see Table 4.

    Table 4 compute_flavor_groups element structure description

    Parameter

    Type

    Description

    group_type

    String

    Specification group type.

    Enumerated values:

    • X86
    • ARM

    compute_flavors

    Array of objects

    Specification information.

    For details, see Table 5.

    Table 5 compute_flavors element structure description

    Parameter

    Type

    Description

    id

    String

    Specification ID of the database proxy.

    code

    String

    Specification code of the database proxy.

    cpu

    String

    Number of vCPUs. For example, the value 1 indicates one vCPU.

    mem

    String

    Memory size in GB.

    db_type

    String

    Database type.

    az_status

    Object

    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.

    Valid values:

    • 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.