Querying Proxy Instance Specifications

Function

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

This API will be unavailable on March 31, 2025. You are advised to switch workloads to the new API (Querying Proxy Instance Specifications) before then.

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

• Database proxy is unavailable for DB instances in a DeC.

URI

• URI format

  GET https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/proxy/flavors

• Example

  GET https://{endpoint}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/436aaafb689c4250a9a5bb33cb271e8cin07/proxy/flavors

• Parameter description

  Table 1 Parameter description

  Name	Type	Mandatory	Description
  project_id	String	Yes	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.
  instance_id	String	Yes	DB instance ID.

Request

None

Response

• Normal response

  Table 2 Parameter description

  Name	Type	Description
  proxy_flavor_groups	Array of Object	Proxy specification groups. For details, see Table 3.

  Table 3 proxy_flavor_groups field data structure description

  Name	Type	Description
  group_type	String	Specification group type. It can be x86 or arm.
  proxy_flavors	Array of Object	Proxy specifications. For details, see Table 4.

  Table 4 proxy_flavors field data structure description

  Name	Type	Description
  id	String	Proxy specification ID.
  spec_code	String	Proxy specification code.
  vcpus	String	Number of vCPUs. For example, the value 1 indicates 1 vCPU.
  ram	String	Memory size in GB.
  db_type	String	Database type.
  az_status	Map<String, String>	key indicates the AZ ID and value indicates the status of the AZ where the proxy specifications reside. It can be normal or unsupported.

• Example normal response

  {

  "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":{

  "az1xahz":"normal"

  }

  }

  ]

  },

  {

  "group_type":"arm",

  "proxy_flavors":[

  {

  "id":"2ff9a704-f238-3e7a-9ed2-208c2542c8b9",

  "spec_code":"gaussdb.proxy.large.arm.2",

  "vcpus":"2",

  "ram":"4",

  "db_type":"Proxy",

  "az_status":{

  "az1xahz":"normal"

  }

  }

  ]

  }

  ]

  }

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.