文档

DescribeReplicaSetRole - 查询实例中的角色信息及连接信息

更新时间:

查询MongoDB实例中的角色信息及连接信息。

接口说明

本接口适用于副本集实例和单节点实例,不适用于分片集群实例。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dds:DescribeReplicaSetRoleRead
  • Instance
    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例 ID。

dds-bpxxxxxxxx

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

DB4A0595-FCA9-437F-B2BB-25DBFC009D3E
DBInstanceIdstring

实例 ID。

dds-bpxxxxxxxx
ReplicaSetsobject []

副本集角色信息列表。

ConnectionPortstring

节点的连接端口。

3717
ReplicaSetRolestring

该节点在副本集中的角色。

  • Primary:主节点。
  • Secondary:从节点。
Primary
ExpiredTimestring

保留的经典网络地址剩余时长,单位为秒。

1209582
ConnectionDomainstring

节点的连接地址。

dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com
NetworkTypestring

网络类型。

  • VPC:专有网络。
  • Classic:经典网络。
  • Public:公网。
VPC
RoleIdstring

节点的角色 ID。

651xxxxx

示例

正常返回示例

JSON格式

{
  "RequestId": "DB4A0595-FCA9-437F-B2BB-25DBFC009D3E",
  "DBInstanceId": "dds-bpxxxxxxxx",
  "ReplicaSets": {
    "ReplicaSet": [
      {
        "ConnectionPort": "3717",
        "ReplicaSetRole": "Primary",
        "ExpiredTime": "1209582",
        "ConnectionDomain": "dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com",
        "NetworkType": "VPC",
        "RoleId": "651xxxxx"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
403ForbiddenUser not authorized to operate on the specified resource.用户未授权标签鉴权。

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

变更历史

变更时间变更内容概要操作
2023-05-18OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:403