Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Database Proxy/ Querying Proxy Instance Specifications

Updated on 2025-09-04 GMT+08:00

View PDF

Querying Proxy Instance Specifications

Function

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

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI

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

**Table 1** URI parameters
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
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** 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 3** Response body parameters
Parameter	Type	Description
proxy_flavor_groups	Array of MysqlProxyFlavorGroups objects	Definition Specification group information.

**Table 4** MysqlProxyFlavorGroups
Parameter	Type	Description
group_type	String	Definition Specification group type. Range x86 arm
proxy_flavors	Array of MysqlProxyComputeFlavor objects	Definition Specification information.

**Table 5** MysqlProxyComputeFlavor
Parameter	Type	Description
vcpus	String	Definition Number of vCPUs. Range N/A
ram	String	Definition Memory size, in GB. Range N/A
db_type	String	Definition Database type. Range N/A
id	String	Definition Specification ID of the proxy instance. Range N/A
spec_code	String	Definition Specification code of the proxy instance. Range N/A
az_status	Object	Definition AZ status. key indicates the AZ ID, and value indicates the specification status in the AZ.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Querying proxy instance specifications

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/proxy/flavors

Example Response

Status code: 200

Success.

{
  "proxy_flavor_groups" : {
    "group_type" : "X86",
    "proxy_flavors" : {
      "id" : "19be4c5d-d363-3342-bdbc-0dd9dbf7fafe",
      "spec_code" : "gaussdb.proxy.large.x86.2",
      "vcpus" : 2,
      "ram" : 4,
      "db_type" : "Proxy",
      "az_status" : {
        "az1" : "normal"
      }

    }
  }
}