Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Database Proxy/ Querying Proxy Instance Specifications by AZ
Updated on 2025-09-09 GMT+08:00

Querying Proxy Instance Specifications by AZ

Function

This API is used to query proxy instance specifications by AZ. Before calling this API:

URI

GET /v3/{project_id}/proxy/flavors

Table 1 URI parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

Table 2 Query parameters

Parameter

Mandatory

Type

Description

az_codes

Yes

String

Definition

AZs.

Constraints

N/A

Range

N/A

Default Value

N/A

proxy_engine_name

Yes

String

Definition

Proxy engine name.

Constraints

N/A

Range

taurusproxy

Default Value

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

proxy_flavor_groups

Array of ProxyFlavorGroup objects

Definition

Proxy specification groups.

Table 5 ProxyFlavorGroup

Parameter

Type

Description

group_type

String

Definition

Specification group type.

Range

N/A

proxy_flavors

Array of ProxyFlavor objects

Definition

Specification list.

Table 6 ProxyFlavor

Parameter

Type

Description

spec_code

String

Definition

Specification code.

Range

N/A

vcpus

String

Definition

Number of vCPUs.

Range

N/A

ram

String

Definition

Memory.

Range

N/A

db_type

String

Definition

Database type.

Range

N/A

az_status

Object

Definition

AZ status.

supported_ipv6

Boolean

Definition

Whether IPv6 is supported.

Range

  • true: IPv6 is supported.

  • false: IPv6 is not supported.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Querying proxy instance specifications by AZ

GET https://{endpoint}/v3/04f70afb5080d24e2f9cc0128f1d5ebf/proxy/flavors?az_codes=cn-north-7c&proxy_engine_name=taurusproxy

Example Response

Status code: 200

Success.

{
  "proxy_flavor_groups" : [ {
    "group_type" : "x86",
    "proxy_flavors" : [ {
      "id" : "2058dfba-58aa-4869-833b-8a0717c7d06f",
      "spec_code" : "gaussdb.proxy.large.x86.2",
      "vcpus" : "2",
      "ram" : "4",
      "db_type" : "Proxy",
      "az_status" : {
        "cn-north-7c" : "normal"
      },
      "supported_ipv6" : false
    }, {
      "id" : "ad903fda-ee54-4ad6-87e6-23000c21de78",
      "spec_code" : "gaussdb.proxy.xlarge.x86.2",
      "vcpus" : "4",
      "ram" : "8",
      "db_type" : "Proxy",
      "az_status" : {
        "cn-north-7c" : "normal"
      },
      "supported_ipv6" : false
    } ]
  } ]
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.