查询数据库代理信息

功能介绍

查询指定实例的数据库代理详细信息。

该接口计划于2024-04-30下线。

• 调用接口前，您需要了解API 认证鉴权。

调试

您可以在API Explorer中调试该接口。

接口约束

• 该接口仅支持PostgreSQL 11、PostgreSQL 12查询数据库代理详情。
• 数据库实例必须已开启数据库代理。

URI

• URI格式

  GET /v3/{project_id}/instances/{instance_id}/proxy

• URI样例

  https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/proxy

• 参数说明

  表1 参数说明

  名称	是否必选	说明
  project_id	是	租户在某一region下的project ID。 获取方法请参见获取项目ID。
  instance_id	是	实例ID。

请求消息

无。

响应消息

• 正常响应要素说明

  表2 要素说明

  名称	参数类型	说明
  proxy	Object	Proxy实例信息。 详情请参见表3。
  master_instance	Object	主实例信息。 详情请参见表4。
  readonly_instances	Array of objects	只读实例信息。 详情请参见表5。

  表3 proxy元素数据结构说明

  名称	参数类型	说明
  pool_id	String	Proxy实例ID。
  status	String	Proxy实例开启状态，取值范围如下。 open：打开。 closed：关闭。 frozen：已冻结。 opening：打开中。 closing：关闭中。 freezing：冻结中。 unfreezing：解冻中。
  address	String	Proxy读写分离地址。
  elb_vip	String	elb模式的虚拟ip信息。
  eip	String	弹性公网IP信息。
  port	Integer	Proxy端口信息。
  pool_status	String	Proxy实例状态。 abnormal：异常。 normal：正常。 creating：创建中。 deleted：已删除。
  delay_threshold_in_kilobytes	Integer	延时阈值（单位：KB）。
  cpu	String	Proxy实例规格的CPU数量。
  mem	String	Proxy实例规格的内存数量。
  node_num	Integer	Proxy节点个数。
  nodes	Array of objects	Proxy节点信息。 详情请参见表6。
  mode	String	Proxy主备模式，取值范围：Ha。

  表4 master_instance元素数据结构说明

  名称	参数类型	说明
  id	String	主实例ID。
  status	String	主实例状态。
  name	String	主实例名称。
  weight	Integer	主实例读写分离权重。
  available_zones	Array of objects	可用区信息。 详情请参见表7。
  cpu_num	Integer	主实例CPU个数。

  表5 readonly_instances元素数据结构说明

  名称	参数类型	说明
  id	String	只读实例ID。
  status	String	只读实例状态。
  name	String	只读实例名称。
  weight	Integer	只读实例读写分离权重。
  available_zones	Array of objects	可用区信息。 详情请参见表7。
  cpu_num	Integer	只读实例CPU个数。

  表6 nodes元素数据结构说明

  名称	参数类型	说明
  id	String	Proxy节点ID。
  name	String	Proxy节点名称。
  role	String	Proxy节点角色。 master：主节点。 slave：备节点。
  az_code	String	可用区。
  status	String	Proxy节点状态。 normal：正常。 abnormal：异常。 creating：创建中。 deleted：已删除。
  frozen_flag	Integer	Proxy节点是否被冻结。 0：未冻结。 1：冻结。 2：冻结删除。

  表7 available_zones元素数据结构说明

  名称	参数类型	说明
  code	String	可用区编码。
  description	String	可用区描述。

• 正常响应样例

  {
      "proxy":{
          "pool_id":"c6ee492784b640e694f1da0201cd82c8po03",
          "status":"open",
          "address":"192.168.0.60",
          "elb_vip":null,
          "eip":null,
          "port":3306,
          "pool_status":"normal",
          "delay_threshold_in_kilobytes":30,
          "cpu":"4",
          "mem":"8",
          "node_num":2,
          "nodes":[
              {
                  "id":"4fb00607cffd42dc9583ca09863df93cpn03",
                  "name":"PROXY-c6ee492784b640e694f1da0201cd82c8po03_1",
                  "role":"slave",
                  "az_code":"az1xahz",
                  "status":"normal",
                  "frozen_flag":0
              },
              {
                  "id":"191f3164f918463bb6aedeb6ba742920pn03",
                  "name":"PROXY-c6ee492784b640e694f1da0201cd82c8po03_0",
                  "role":"master",
                  "az_code":"az1xahz",
                  "status":"normal",
                  "frozen_flag":0
              }
          ],
          "mode":"Ha"
      },
      "master_instance":{
          "id":"49fcbb94435c4d89930e91dcf5884909in03",
          "status":"normal",
          "name":"proxy-hwt-0922-3",
          "weight":0,
          "available_zones":[
              {
                  "code":"az1xahz",
                  "description":"可用区1"
              }
          ],
          "cpu_num":8
      },
      "readonly_instances":[
          {
              "id":"83251d1398594b9fbfc8f1ab8b8228b2in03",
              "status":"normal",
              "name":"replica-a392",
              "weight":100,
              "available_zones":[
                  {
                      "code":"az1xahz",
                      "description":"可用区1"
                  }
              ],
              "cpu_num":4
          }
      ]
  }

• 异常响应

  请参见异常请求结果。

状态码

• 正常

  200

• 异常

  请参见状态码。

错误码

请参见错误码。