调用DescribeRoleZoneInfo查询实例的各节点的角色和所属的可用区_云数据库 MongoDB 版(MongoDB)-阿里云帮助中心

查询MongoDB实例的各节点的角色和所属的可用区。

接口说明

说明更多详情请参见查看节点所属的可用区。

本接口适用于副本集实例和分片集群实例，暂不支持单节点实例。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
dds:DescribeRoleZoneInfo	get	dbinstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	无	无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例 ID。	dds-bpxxxxxxxx

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	728B9A96-E262-4AE5-915E-3A51CCE2FDA9
ZoneInfos	array<object>	节点在可用区中的分布信息列表。
	object
InsName	string	节点 ID。	dds-bpxxxxxxxx
NodeType	string	节点类型，返回值为： normal：普通节点。 configServer：配置服务器节点。 shard：Shard 节点。 mongos：Mongos 节点。说明当实例类型为副本集实例时，返回值为 normal；当实例类型为分片集群实例时，返回值中包含 configServer、shard 和 mongos。	normal
RoleType	string	节点的角色，返回值为： Primary：主节点。 Secondary：从节点。 Hidden：隐藏节点。	Primary
ZoneId	string	可用区 ID。	cn-hangzhou-e
RoleId	string	角色 ID。	83xxxxx

示例

正常返回示例

JSON格式

{
  "RequestId": "728B9A96-E262-4AE5-915E-3A51CCE2FDA9",
  "ZoneInfos": {
    "ZoneInfo": [
      {
        "InsName": "dds-bpxxxxxxxx",
        "NodeType": "normal",
        "RoleType": "Primary",
        "ZoneId": "cn-hangzhou-e",
        "RoleId": "83xxxxx"
      }
    ]
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史