文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ 数据库代理/ 根据可用区查询数据库代理规格信息- ShowProxyFlavorsByAzCode
更新时间：2025-10-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

根据可用区查询数据库代理规格信息 - ShowProxyFlavorsByAzCode

功能介绍

根据可用区查询数据库代理规格信息。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:proxy:list

    List

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>
    • gaussdb:instance:list
    • gaussdb:proxy:list

    -

URI

GET /v3/{project_id}/proxy/flavors

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

az_codes

是

String

参数解释：

可用区。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

proxy_engine_name

是

String

参数解释：

代理引擎名称。

约束限制：

不涉及。

取值范围：

taurusproxy。

默认取值：

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us

  • zh-cn

默认取值：

en-us。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

proxy_flavor_groups

Array of ProxyFlavorGroup objects

参数解释：

代理规格分组信息。
表5 ProxyFlavorGroup

参数

参数类型

描述

group_type

String

参数解释：

规格分组类型。

取值范围：

不涉及。

proxy_flavors

Array of ProxyFlavor objects

参数解释：

规格列表。
表6 ProxyFlavor

参数

参数类型

描述

id

String

参数解释：

规格ID。

取值范围：

不涉及。

spec_code

String

参数解释：

规格码。

取值范围：

不涉及。

vcpus

String

参数解释：

CPU核数。

取值范围：

不涉及。

ram

String

参数解释：

内存。

取值范围：

不涉及。

db_type

String

参数解释：

数据库类型。

取值范围：

不涉及。

az_status

Object

参数解释：

AZ状态。

supported_ipv6

Boolean

参数解释：

是否支持IPV6。

取值范围：

  • true：支持IPV6。

  • false：不支持IPV6。

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码：500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

根据可用区查询数据库代理规格。

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

响应示例

状态码：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
    } ]
  } ]
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 数据库代理