DescribeDBClusterProxy - 获取集群实例代理详情_云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

查询代理详情

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardb:DescribeDBClusterProxy

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

无

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	集群 ID。	pc-2zek76tdi709m6mf4
RegionId	string	否	地域 ID。说明可通过接口 DescribeRegions 查看地域信息详情。	cn-hangzhou
ResourceGroupId	string	否	资源组 ID。	rg-acfm4ifnqnun3zq

返回参数

名称	类型	描述	示例值
	object
ChildInstances	array<object>	云企业网实例加载的网络实例信息列表。
	object	云企业网实例加载的网络实例信息列表。
DBNodeClass	string	节点规格，详情请参见如下文档： PolarDB MySQL 引擎：计算节点规格。 PolarDB O 引擎：计算节点规格。 PolarDB PostgreSQL 引擎：计算节点规格。	polar.mysql.g4.medium
DBNodeIP	string	数据库集群节点私有 IP	10..10
DBNodeId	string	数据库集群节点 ID。	pi-wz97h479y364g9du7
DBNodePort	string	数据库集群节点端口	2450
DBNodeStatus	string	节点状态，取值范围如下： Creating：创建中 Running：运行中 Deleting：删除中 Rebooting：重启中 DBNodeCreating：正在增加节点 DBNodeDeleting：正在删除节点 ClassChanging：正在变更节点规格 NetAddressCreating：正在创建网络连接 NetAddressDeleting：正在删除网络连接 NetAddressModifying：正在修改网络连接 MinorVersionUpgrading：小版本升级中 Maintaining：实例维护中 Switching：切换中	Running
HostName	string	主机名称。	sh-lsf01-144-37
DBProxyClusterId	string	代理集群 ID	pe-xxxxxxxxx
DBProxyClusterNum	integer	代理节点个数	2
DBProxyClusterStatus	string	代理集群状态	ClassChanging
RequestId	string	请求 ID。	30E11ED2-C922-5B96-BCC6-11EE8C484AC6

示例

正常返回示例

JSON格式

{
  "ChildInstances": [
    {
      "DBNodeClass": "polar.mysql.g4.medium",
      "DBNodeIP": "10.*.*10",
      "DBNodeId": "pi-wz97h479y364g9du7",
      "DBNodePort": "2450",
      "DBNodeStatus": "Running",
      "HostName": "sh-lsf01-144-37"
    }
  ],
  "DBProxyClusterId": "pe-xxxxxxxxx",
  "DBProxyClusterNum": 2,
  "DBProxyClusterStatus": "ClassChanging",
  "RequestId": "30E11ED2-C922-5B96-BCC6-11EE8C484AC6"
}

错误码

HTTP status code	错误码	错误信息	描述
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	当前的记录中不存在提供的DBClusterId。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。