文档首页/ 云数据库 GaussDB(for MySQL)/ API参考/ API（即将下线）/ 数据库代理/ 查询数据库代理信息
更新时间：2024-04-01 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询数据库代理信息

功能介绍

查询数据库代理信息。

该接口计划于2025-03-31下线，建议及时切换到新接口查询数据库代理信息列表。

  • DeC专属云账号暂不支持数据库代理。

URI

  • URI格式

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

  • URI样例

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

  • 参数说明
    表1 参数说明

    名称

    参数类型

    是否必选

    说明

    project_id

    String

    是

    租户在某一Region下的project ID。

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

    instance_id

    String

    是

    实例ID。

请求消息

无

响应消息

  • 正常响应要素说明
    表2 参数说明

    名称

    参数类型

    说明

    proxy

    Object

    数据库代理实例信息。

    详情请参见表3。

    master_node

    Object

    主节点信息。

    详情请参见表4。

    readonly_nodes

    Array of Object

    只读节点信息。

    详情请参见表5。
    表3 proxy字段数据结构说明

    名称

    参数类型

    说明

    pool_id

    String

    Proxy实例id。

    status

    String

    Proxy实例开启状态，取值范围：closed、open、frozen、opening、closing、enlarging、freezing和unfreezing。

    address

    String

    Proxy读写分离地址。

    port

    Integer

    Proxy端口信息。

    pool_status

    String

    Proxy实例状态，取值范围：abnormal、normal、creating、deleted。

    delay_threshold_in_seconds

    Integer

    延时阈值，单位：秒。

    elb_vip

    String

    Elb模式的虚拟ip信息。

    eip

    String

    弹性公网IP信息。

    vcpus

    String

    Proxy实例规格的CPU数量。

    ram

    String

    Proxy实例规格的内存数量。

    node_num

    Integer

    Proxy节点个数。

    mode

    String

    Proxy主备模式，取值范围：Cluster。

    nodes

    Object

    Proxy节点信息。

    详情请参见表6。

    flavor_ref

    String

    代理规格码。
    表4 master_node字段数据结构说明

    名称

    参数类型

    说明

    id

    String

    主节点id。

    instance_id

    String

    实例id

    status

    String

    主节点状态。

    name

    String

    主节点名称。

    weight

    Integer

    主节点读写分离权重。

    available_zones

    Array of object

    可用区信息。

    详情请参见表7。
    表5 readonly_nodes字段数据结构说明

    名称

    参数类型

    说明

    id

    String

    只读节点id。

    instance_id

    String

    实例id

    status

    String

    只读节点状态。

    name

    String

    只读节点名称。

    weight

    Integer

    只读节点读写分离权重。

    available_zones

    Array of object

    可用区信息。
    表6 nodes字段数据结构说明

    名称

    参数类型

    说明

    id

    String

    Proxy节点id。

    status

    String

    Proxy节点状态，取值范围：normal、abnormal、creating和deleted。

    name

    String

    Proxy节点名称。

    role

    String

    Proxy节点角色：master和slave。

    az_code

    String

    可用区。

    frozen_flag

    Integer

    Proxy节点是否被冻结：0-未冻结；1-冻结；2-冻结删除。
    表7 available_zones字段数据结构说明

    名称

    参数类型

    说明

    code

    String

    可用区编码。

    description

    String

    可用区描述。
  • 正常响应样例

    {

    "proxy":{

    "pool_id":null,

    "status":"closed",

    "address":null,

    "port":null,

    "pool_status":null,

    "delay_threshold_in_seconds":null,

    "elb_vip":null,

    "eip":null,

    "vcpus":null,

    "ram":null,

    "node_num":null,

    "mode":null,

    "nodes":[

    ],

    "flavor_ref": "gaussdb.proxy.xlarge.arm.2"

    },

    "master_node":{

    "id":"294daeb0ec9e4c4eacaf2c6dbd8246a9no07",

    "instance_id":"71215aadf19c428db088e51b157583f2in07",

    "status":"ACTIVE",

    "name":"BUG-gauss-dw_node01",

    "weight":null,

    "available_zones":[

    {

    "code":"az1xahz",

    "description":"az1xahz"

    }

    ]

    },

    "readonly_nodes":[

    {

    "id":"b36d70cc3c3b4ef680e34c5b25b168dano07",

    "instance_id":"71215aadf19c428db088e51b157583f2in07",

    "status":"ACTIVE",

    "name":"BUG-gauss-dw_node02",

    "weight":null,

    "available_zones":[

    {

    "code":"az1xahz",

    "description":"az1xahz"

    }

    ]

    }

    ]

    }

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 数据库代理