计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
态势感知 SA
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive

查询数据库代理信息列表

更新时间:2024-05-27 GMT+08:00

功能介绍

查询数据库代理信息列表。

URI

  • URI格式

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

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    租户在某一Region下的项目ID。

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

    instance_id

    实例ID。

请求消息

  • 请求参数

    无。

  • URI样例

    GET https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/920ec36cef814a8b830a5bed50d9a088in01/proxy-list

响应消息

  • 正常响应要素说明
    表2 字段说明

    名称

    参数类型

    说明

    proxy_query_info_list

    Array of objects

    数据库实例下的数据库代理信息列表。

    请参见表3

    max_proxy_num

    Integer

    支持同时开启的数据库代理的最大数量。

    max_proxy_node_num

    Integer

    单个数据库代理支持选择的最大节点数量。

    support_balance_route_mode_for_favored_version

    Boolean

    是否支持创建数据库代理时设置负载均衡路由模式。

    表3 proxy_query_info_list字段数据结构说明

    名称

    参数类型

    说明

    proxy

    Object

    数据库代理信息。

    请参见表4

    master_instance

    Object

    数据库主实例信息。

    请参见表7

    readonly_instances

    Array of objects

    数据库只读实例信息。

    请参见表7

    proxy_security_group_check_result

    Boolean

    安全组是否放通该数据库代理到数据库的网络地址。

    表4 proxy字段数据结构说明

    参数

    参数类型

    描述

    pool_id

    String

    数据库代理实例ID。

    status

    String

    数据库代理状态。取值:

    • ENABLING:表示数据库代理正在开启。
    • DISABLING:表示数据库代理正在关闭。
    • CHANGING_NODE_NUM:表示数据库代理正在调整节点数量。
    • SCALING: 表示数据库代理正在规格变更。
    • UPGRADING: 表示数据库代理正在升级内核版本。
    • IPMODIFYING: 表示数据库代理正在修改读写分离地址。
    • RESTARTING: 表示数据库代理正在重启进程。
    • TRANSACTION_SPLITTING: 表示数据库代理正在变更事务拆分功能状态。
    • CONNECTION_POOL_SWITCH_OPERATING: 表示数据库代理正在变更会话连接池类型。
    • PORT_MODIFYING: 表示数据库代理正在修改端口。
    • PROXY_SSL_SWITCHING: 表示数据库代理正在变更SSL状态。
    • ALT_SWITCH_OPERATING: 表示数据库代理正在变更ALT状态。
    • CHANGING_RESOURCES: 表示数据库代理正在进行资源变更。
    • NORMAL: 表示数据库代理正常。
    • ABNORMAL: 表示数据库代理异常。
    • FAILED: 表示数据库代理创建失败。
    • FROZEN: 表示数据库代理已冻结。

    address

    String

    读写分离地址。

    port

    Integer

    端口号。

    delay_threshold_in_seconds

    Integer

    延时阈值,单位:秒。

    cpu

    String

    数据库代理规格的CPU大小。

    mem

    String

    数据库代理规格的内存大小。

    node_num

    Integer

    数据库代理节点个数。

    nodes

    Array of objects

    数据库代理节点信息列表。

    请参见表5

    mode

    String

    数据库代理集群模式。取值:

    • Cluster:集群模式
    • Ha:主备模式

    flavor_info

    Object

    数据库代理规格信息。

    请参见表6

    transaction_split

    String

    数据库代理事务拆分开关状态。

    • true:开启。
    • false:关闭。

    connection_pool_type

    String

    连接池类型。

    取值:

    • CLOSED:关闭连接池。
    • SESSION:开启会话级连接池。

    pay_mode

    String

    数据库代理计费模式。

    取值:

    • 0:按需计费
    • 1:包周期计费

    name

    String

    数据库代理名称。

    proxy_mode

    String

    数据库代理读写模式。取值:

    • readwrite:读写模式
    • readonly:只读模式

    dns_name

    String

    数据库代理读写分离地址内网域名。该字段为空表示未申请读写内网域名。

    subnet_id

    String

    数据库代理实例所属子网ID。

    seconds_level_monitor_fun_status

    String

    数据库代理秒级监控状态。

    枚举值:

    • off
    • on

    alt_flag

    Boolean

    ALT开关状态。

    force_read_only

    Boolean

    是否强制读路由到只读。

    route_mode

    Integer

    数据库代理路由模式。取值:

    • 0:表示权重负载模式。
    • 1:表示负载均衡模式(数据库主实例不接受读请求)。
    • 2:表示负载均衡模式(数据库主实例接受读请求)。

    ssl_option

    Boolean

    ssl开关状态。

    support_balance_route_mode

    Boolean

    数据库代理是否支持开启负载均衡路由模式。

    support_proxy_ssl

    Boolean

    数据库代理是否支持开启ssl功能。

    support_switch_connection_pool_type

    Boolean

    数据库代理是否支持切换会话连接池类型。

    support_transaction_split

    Boolean

    数据库代理是否支持开启事务拆分。

    表5 nodes字段数据结构说明

    参数

    参数类型

    描述

    id

    String

    数据库代理节点ID。

    status

    String

    数据库代理节点状态。

    取值:

    • NORMAL: 表示节点正常。
    • ABNORMAL: 表示节点节点状态异常。
    • CREATING: 表示节点正在创建中。
    • CREATEFAIL: 表示节点创建失败。

    role

    String

    数据库代理节点角色。

    • master:主节点。
    • slave:备节点。

    az_code

    String

    数据库代理节点所在可用区。

    frozen_flag

    Integer

    数据库代理节点是否被冻结。

    取值:

    • 0:未冻结。
    • 1:冻结。
    表6 flavor_info字段数据结构说明

    参数

    参数类型

    描述

    group_type

    String

    规格类型。

    枚举值:

    • X86
    • ARM

    code

    String

    规格码。

    表7 readonly_instances字段数据结构说明

    参数

    参数类型

    描述

    id

    String

    数据库主实例或只读实例ID。

    status

    String

    节点状态。

    name

    String

    数据库实例名称。

    weight

    Integer

    数据库实例读权重。

    available_zones

    Array of objects

    可用区信息。

    请参见表8

    表8 available_zones字段数据结构说明

    参数

    参数类型

    描述

    code

    String

    可用区编码。

    description

    String

    可用区描述。

  • 正常响应样例
    { 
      "proxy_query_info_list" : [ { 
        "proxy" : { 
          "pool_id" : "e06ecf4dfea8409690c87a9ee6582b0dpo01", 
          "status" : "NORMAL", 
          "address" : "192.168.0.1", 
          "port" : 3306, 
          "delay_threshold_in_seconds" : 30, 
          "cpu" : "2", 
          "mem" : "4", 
          "node_num" : 2, 
          "nodes" : [ { 
            "id" : "3079919890f24fb8ab284571fc409058pn01", 
            "status" : "NORMAL", 
            "role" : "master", 
            "az_code" : "aaa", 
            "frozen_flag" : 0 
          }, { 
            "id" : "804430ac9068419fa5e49d5ca0684172pn01", 
            "status" : "NORMAL", 
            "role" : "master", 
            "az_code" : "aaa", 
            "frozen_flag" : 0 
          } ], 
          "mode" : "Cluster", 
          "flavor_info" : { 
            "group_type" : "X86", 
            "code" : "rds.proxy.large.2" 
          }, 
          "transaction_split" : "false", 
          "connection_pool_type" : "CLOSED", 
          "pay_mode" : "0", 
          "name" : "test-hll", 
          "proxy_mode" : "readwrite", 
          "route_mode" : 1, 
          "dns_name" : "", 
          "subnet_id" : "2f75f35c-62ca-43b7-9954-8fd1e6be4641", 
          "ssl_option" : false, 
          "force_read_only" : false, 
          "seconds_level_monitor_fun_status" : "off", 
          "alt_flag" : false, 
          "support_transaction_split" : true, 
          "support_switch_connection_pool_type" : true, 
          "support_balance_route_mode" : true, 
          "support_proxy_ssl" : true 
        }, 
        "master_instance" : { 
          "id" : "920ec36cef814a8b830a5bed50d9a088in01", 
          "status" : "normal", 
          "name" : "rds-2c54", 
          "weight" : 0, 
          "available_zones" : [ { 
            "code" : "aaa", 
            "description" : "az3" 
          } ] 
        }, 
        "readonly_instances" : [ { 
          "id" : "f9462b58982d484fb64fd9880504d863in01", 
          "status" : "abnormal", 
          "name" : "replica-f966", 
          "weight" : 0, 
          "available_zones" : [ { 
            "code" : "aaa", 
            "description" : "az3" 
          } ] 
        } ], 
        "proxy_security_group_check_result" : false 
      } ], 
      "max_proxy_num" : 4, 
      "max_proxy_node_num" : 4, 
      "support_balance_route_mode_for_favored_version" : true 
    }
  • 异常响应

    请参见异常请求结果

状态码

错误码

请参见错误码

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容