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

Updated on 2024-09-11 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	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID, which is compliant with the UUID format.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the token value.
X-Language	No	String	Request language type. The default value is en-us. Values: en-us zh-cn

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
proxy_flavor_groups	Array of MysqlProxyFlavorGroups objects	Specification group information.

**Table 4** MysqlProxyFlavorGroups
Parameter	Type	Description
group_type	String	Specification group type. It can be x86 or arm. arm: exclusive Arm x86: exclusive x86
proxy_flavors	Array of MysqlProxyComputeFlavor objects	Proxy specifications.

**Table 5** MysqlProxyComputeFlavor
Parameter	Type	Description
vcpus	String	Number of vCPUs. For example, the value 1 indicates 1 vCPU.
ram	String	Memory size in GB.
db_type	String	Database type.
id	String	Specification ID of the proxy instance.
spec_code	String	Specification code of the proxy instance.
az_status	Object	key indicates the AZ ID, and value indicates the specification status in the AZ. Values: normal unsupported: indicates that the specifications are not supported.

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"
      }

    }
  }
}