Querying Database Proxy Specifications¶

Function¶

This API is used to query database proxy specifications. Before using this API:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.
Database proxy is unavailable for DB instances in a DeC.

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	DB instance ID.

Request Parameters¶

**Table 2** Request header parameters¶
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token.
X-Language	No	String	Language.

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.
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	Proxy specification ID.
spec_code	String	Proxy specification code.
az_status	Object	AZ status. key indicates the AZ ID and value indicates the status of the AZ where the proxy specifications reside. The value can be normal or unsupported.

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¶

GET https://gaussdb-mysql.eu-de.otc.t-systems.com/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"
      },
      "region_status" : "normal"
    }
  }
}

Status Code¶

For details, see Status Codes.

Error Code¶

For details, see Error Codes.

last updated: 2024-05-20 01:10