调用DescribeDBInstanceAttribute接口查询MongoDB实例详情。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDBInstanceAttribute

系统规定参数。取值:DescribeDBInstanceAttribute

RegionId String cn-hangzhou

地域ID,您可以调用DescribeRegions查询。

Engine String MongoDB

数据库引擎,取值:MongoDB

DBInstanceId String dds-bp1a7009eb24****

实例ID。

ResourceGroupId String rg-acfmyiu4ekp****

资源组ID。资源组详情请参见查看资源组基本信息

返回数据

名称 类型 示例值 描述
RequestId String 4D22A5D2-32CF-57D4-9357-2DD68ECDCC59

请求ID。

DBInstances Array of DBInstance

实例详细信息。

DBInstance
CreationTime String 2021-12-09T09:06:01Z

实例创建的时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

ReplicaSets Array of ReplicaSet

副本集实例信息。

说明 当实例类型为副本集实例时,返回该参数。
ReplicaSet
VSwitchId String vpc-bp1jk5vwkcri27qme****

交换机ID。

说明 当实例的网络类型为专有网络时,返回该参数。
ConnectionPort String 3717

节点的连接端口。

ReplicaSetRole String Primary

节点的角色。取值如下:

  • Primary:主节点。
  • Secondary:从节点。
ConnectionDomain String dds-bp12c5b040dc5****.mongodb.rds.aliyuncs.com

节点的连接地址。

VPCCloudInstanceId String dds-bp12c5b040dc5d****

实例ID。

说明 当实例的网络类型为专有网络时,返回该参数。
NetworkType String VPC

网络类型。取值如下:

  • Classic:经典网络。
  • VPC:专有网络。
VPCId String vpc-bp1jk5vwkcri27qme****

专有网络ID。

说明 当实例的网络类型为专有网络时,返回该参数。
ReplacateId String bls-m****

全球多活实例的逻辑ID。

说明 MongoDB当前不支持新购该类型实例,该参数仅适用于老版本全球多活实例。
ChargeType String PostPaid

实例的付费类型。 取值如下:

  • PrePaid:预付费,包年包月。
  • PostPaid:后付费,按量付费。
Tags Array of Tag

实例的标签信息列表。

Tag
Key String test

实例的标签键。

Value String api

实例的标签值。

VpcAuthMode String Open

内网免密访问模式。取值如下:

  • Open:内网免密访问处于开启状态。
  • Close:内网免密访问处于关闭状态,需要使用密码访问。
  • NotSupport :不支持该功能。
NetworkType String VPC

实例的网络类型。 取值如下:

  • Classic:经典网络。
  • VPC:专有网络。
LockMode String Unlock

实例的锁定状态。取值如下:

  • Unlock:正常,没有被锁定。
  • ManualLock:手动触发锁定。
  • LockByExpiration:实例过期自动锁定。
  • LockByRestoration:实例回滚前自动锁定。
  • LockByDiskQuota:实例空间满自动锁定。
  • Released:实例已释放。
EngineVersion String 4.2

数据库版本。

MaxIOPS Integer 1000

实例最大IOPS。

VPCCloudInstanceIds String dds-bp1a7009eb24****

实例ID。

说明 当实例的网络类型为专有网络时,返回该参数。
MongosList Array of MongosAttribute

Mongos节点信息列表。

说明 当实例类型为分片集群实例时返回该参数。
MongosAttribute
VpcCloudInstanceId String s-bp1d8c262a158****

Mongos节点的ID。

说明NetworkType参数传入值为VPC(专有网络)时,返回该参数。
MaxIOPS Integer 800

Mongos节点的最大IOPS。

VSwitchId String vsw-bp1vj604nj5a9zz74****

交换机ID。

说明NetworkType参数传入值为VPC(专有网络)时,返回该参数。
NodeClass String dds.mongos.mid

Mongos节点的规格。

MaxConnections Integer 1000

Mongos节点的最大连接数。

Port Integer 3717

Mongos节点的连接端口。

VPCId String vpc-bp1n3i15v90el48nx****

专有网络ID。

说明NetworkType参数传入值为VPC(专有网络)时,返回该参数。
ConnectSting String s-bp1d8c262a15****.mongodb.rds.aliyuncs.com

Mongos节点的连接地址。

NodeDescription String mongos1

Mongos节点的名称。

NodeId String s-bp1d8c262a15****

Mongos节点的ID。

Status String Running

Mongos节点的状态。具体请参见实例状态表

ProtocolType String mongodb

实例的访问协议类型。取值如下:

  • mongodb:MongoDB协议
  • dynamodb:DynamoDB协议
DBInstanceDescription String 测试数据库

实例名称。

CurrentKernelVersion String mongodb_20211014_3.0.38

实例当前数据库的小版本号。

DBInstanceReleaseProtection Boolean false

是否开启了实例释放保护。取值如下:

  • true:开启
  • false:关闭
ExpireTime String 2022-02-05T16:00Z

包年包月实例的到期时间,格式为yyyy-MM-ddTHH:mmZ(UTC时间)。

说明 当实例的付费类型为包年包月时返回该参数。
MaintainStartTime String 18:00Z

实例可维护时间段的开始时间,格式为HH:mmZ(UTC时间)。

DBInstanceType String replicate

实例类型。取值如下:

  • replicate:副本集实例。
  • sharding:分片集群实例。
LastDowngradeTime String 2022-01-08

实例最近一次降配时间。

ShardList Array of ShardAttribute

Shard节点信息列表。

说明 当实例类型为分片集群实例时返回该参数。
ShardAttribute
MaxIOPS Integer 8000

Shard节点的最大IOPS。

ConnectString String d-bp1af0680a9c6d3****.mongodb.rds.aliyuncs.com:****

Shard节点的连接地址。

NodeClass String dds.shard.mid

Shard节点的规格。

MaxConnections Integer 8000

Shard节点的最大连接数。

Port Integer 3717

Shard节点的端口。

NodeDescription String testshard

Shard节点的名称。

NodeId String d-bp16e09d9c5d****

Shard节点的ID。

NodeStorage Integer 10

Shard节点的存储空间。

ReadonlyReplicas Integer 0

Shard节点中只读节点的个数。取值范围为0~5

Status String Running

Shard节点的状态。具体请参见实例状态表

MaintainEndTime String 03:00Z

实例可维护时间段的结束时间,格式为HH:mmZ(UTC时间)。

DBInstanceStatus String Running

实例状态,具体请参见实例状态表

VPCId String vpc-bp1n3i15v90el48nx****

专有网络ID。

说明 当实例的网络类型为专有网络时,返回该参数。
RegionId String cn-hangzhou

实例所属地域ID。

DBInstanceStorage Integer 10

实例存储空间。

ReplicaSetName String mgset-10ace****

副本集实例的名称。

说明 当实例类型为副本集实例时,返回该参数。
VSwitchId String vsw-bp1oo2a7isyrb8igf****

交换机ID。

说明 当实例的网络类型为专有网络时,返回该参数。
StorageEngine String WiredTiger

实例的存储引擎类型。

ConfigserverList Array of ConfigserverAttribute

Configserver节点信息列表。

说明 当实例类型为分片集群实例时返回该参数。
ConfigserverAttribute
MaxIOPS Integer 1000

Configserver节点的最大IOPS。

ConnectString String dds-bp18b0934e7053e4-cs****.mongodb.rds.aliyuncs.com

Configserver节点的连接地址。

NodeClass String dds.cs.mid

Configserver节点的规格。

MaxConnections Integer 1000

Configserver节点的最大连接数。

Port Integer 3717

Configserver节点的端口。

NodeDescription String testConfigserver

Configserver节点的名称。

NodeId String dds-bp11483712c1****-cs

Configserver节点ID。

NodeStorage Integer 20

Configserver节点的存储空间。

Status String Running

ConfigServer节点的状态。具体请参见实例状态表

ResourceGroupId String rg-acfmyiu4ekp****

实例所属资源组ID。

ZoneId String cn-hangzhou-b

实例所属可用区ID。

MaxConnections Integer 500

实例最大连接数。

DBInstanceId String dds-bp11483712c1****

实例ID。

DBInstanceClass String dds.mongo.mid

实例规格。

Engine String MongoDB

数据库引擎。

ReadonlyReplicas String 1

实例的只读节点个数。

ReplicationFactor String 3

实例节点数量。

说明 实例类型为副本集实例时返回该参数。
KindCode String 1

表示实例的类型。取值如下:

  • 0:物理机
  • 1:ECS
  • 2:DOCKER
  • 18:k8s新架构实例
CapacityUnit String 100

实例消耗的读写吞吐量。

说明
  • 当实例类型为Serverless实例时返回该参数。
  • 仅中国站支持Serverless实例。

示例

请求示例

http(s)://mongodb.aliyuncs.com/?Action=DescribeDBInstanceAttribute
&DBInstanceId=dds-bp1a7009eb24****
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBInstanceAttributeResponse>
    <RequestId>4D22A5D2-32CF-57D4-9357-2DD68ECDCC59</RequestId>
    <DBInstances>
        <DBInstance>
            <ResourceGroupId>rg-acfm22cdcgc****</ResourceGroupId>
            <CapacityUnit/>
            <DBInstanceType>sharding</DBInstanceType>
            <StorageEngine>WiredTiger</StorageEngine>
            <ReplicaSets>
            </ReplicaSets>
            <MaintainEndTime>22:00Z</MaintainEndTime>
            <DBInstanceId>dds-bp1a7009eb24****</DBInstanceId>
            <MongosList>
                <MongosAttribute>
                    <ConnectSting>s-bp1d8c262a15****.mongodb.rds.aliyuncs.com</ConnectSting>
                    <Status>Running</Status>
                    <NodeClass>dds.mongos.mid</NodeClass>
                    <NodeDescription/>
                    <MaxConnections>1000</MaxConnections>
                    <VPCId>vpc-bp1jk5vwkcri27qme****</VPCId>
                    <Port>3717</Port>
                    <NodeId>s-bp1d8c262a15****</NodeId>
                    <VpcCloudInstanceId>s-bp1d8c262a15****</VpcCloudInstanceId>
                    <MaxIOPS>800</MaxIOPS>
                </MongosAttribute>
                <MongosAttribute>
                    <ConnectSting>s-bp1428aecdea****.mongodb.rds.aliyuncs.com</ConnectSting>
                    <Status>Running</Status>
                    <NodeClass>dds.mongos.mid</NodeClass>
                    <NodeDescription/>
                    <MaxConnections>1000</MaxConnections>
                    <VPCId>vpc-bp1jk5vwkcri27qme****</VPCId>
                    <Port>3717</Port>
                    <NodeId>s-bp1428aecdea1674</NodeId>
                    <VpcCloudInstanceId>s-bp1428aecdea****</VpcCloudInstanceId>
                    <MaxIOPS>800</MaxIOPS>
                </MongosAttribute>
            </MongosList>
            <NetworkType>VPC</NetworkType>
            <MaintainStartTime>18:00Z</MaintainStartTime>
            <Engine>MongoDB</Engine>
            <Tags>
            </Tags>
            <DBInstanceReleaseProtection>false</DBInstanceReleaseProtection>
            <EngineVersion>4.0</EngineVersion>
            <DBInstanceStatus>Running</DBInstanceStatus>
            <ZoneId>cn-hangzhou-h</ZoneId>
            <MaxConnections>200</MaxConnections>
            <VPCId>vpc-bp1jk5vwkcri27qme****</VPCId>
            <DBInstanceClass>dds.mongo.logic</DBInstanceClass>
            <VSwitchId>vsw-bp1p9le7ibusmjf94****</VSwitchId>
            <ShardList>
                <ShardAttribute>
                    <Status>Running</Status>
                    <NodeClass>dds.shard.mid</NodeClass>
                    <NodeDescription/>
                    <MaxConnections>8000</MaxConnections>
                    <ReadonlyReplicas>0</ReadonlyReplicas>
                    <NodeId>d-bp128a003436****</NodeId>
                    <NodeStorage>10</NodeStorage>
                    <ConnectString/>
                    <MaxIOPS>8000</MaxIOPS>
                </ShardAttribute>
                <ShardAttribute>
                    <Status>Running</Status>
                    <NodeClass>dds.shard.mid</NodeClass>
                    <NodeDescription/>
                    <MaxConnections>8000</MaxConnections>
                    <ReadonlyReplicas>0</ReadonlyReplicas>
                    <NodeId>d-bp1ecfe9926b****</NodeId>
                    <NodeStorage>10</NodeStorage>
                    <ConnectString/>
                    <MaxIOPS>8000</MaxIOPS>
                </ShardAttribute>
            </ShardList>
            <LockMode>Unlock</LockMode>
            <MaxIOPS>800</MaxIOPS>
            <ChargeType>PostPaid</ChargeType>
            <VpcAuthMode>Close</VpcAuthMode>
            <ProtocolType>mongodb</ProtocolType>
            <CurrentKernelVersion>mongodb_20211014_3.0.38</CurrentKernelVersion>
            <CreationTime>2021-12-09T09:06:01Z</CreationTime>
            <ConfigserverList>
                <ConfigserverAttribute>
                    <Status>Running</Status>
                    <NodeClass>dds.cs.mid</NodeClass>
                    <NodeDescription/>
                    <NodeId>dds-bp1a7009eb24fec****</NodeId>
                    <NodeStorage>20</NodeStorage>
                    <ConnectString/>
                </ConfigserverAttribute>
            </ConfigserverList>
            <RegionId>cn-hangzhou</RegionId>
            <KindCode>0</KindCode>
        </DBInstance>
    </DBInstances>
</DescribeDBInstanceAttributeResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "4D22A5D2-32CF-57D4-9357-2DD68ECDCC59",
  "DBInstances" : {
    "DBInstance" : [ {
      "ResourceGroupId" : "rg-acfm22cdcgc****",
      "CapacityUnit" : "",
      "DBInstanceType" : "sharding",
      "StorageEngine" : "WiredTiger",
      "ReplicaSets" : {
        "ReplicaSet" : [ ]
      },
      "MaintainEndTime" : "22:00Z",
      "DBInstanceId" : "dds-bp1a7009eb24****",
      "MongosList" : {
        "MongosAttribute" : [ {
          "ConnectSting" : "s-bp1d8c262a15****.mongodb.rds.aliyuncs.com",
          "Status" : "Running",
          "NodeClass" : "dds.mongos.mid",
          "NodeDescription" : "",
          "MaxConnections" : 1000,
          "VPCId" : "vpc-bp1jk5vwkcri27qme****",
          "Port" : 3717,
          "NodeId" : "s-bp1d8c262a15****",
          "VpcCloudInstanceId" : "s-bp1d8c262a15****",
          "MaxIOPS" : 800
        }, {
          "ConnectSting" : "s-bp1428aecdea****.mongodb.rds.aliyuncs.com",
          "Status" : "Running",
          "NodeClass" : "dds.mongos.mid",
          "NodeDescription" : "",
          "MaxConnections" : 1000,
          "VPCId" : "vpc-bp1jk5vwkcri27qme****",
          "Port" : 3717,
          "NodeId" : "s-bp1428aecdea1674",
          "VpcCloudInstanceId" : "s-bp1428aecdea****",
          "MaxIOPS" : 800
        } ]
      },
      "NetworkType" : "VPC",
      "MaintainStartTime" : "18:00Z",
      "Engine" : "MongoDB",
      "Tags" : {
        "Tag" : [ ]
      },
      "DBInstanceReleaseProtection" : false,
      "EngineVersion" : "4.0",
      "DBInstanceStatus" : "Running",
      "ZoneId" : "cn-hangzhou-h",
      "MaxConnections" : 200,
      "VPCId" : "vpc-bp1jk5vwkcri27qme****",
      "DBInstanceClass" : "dds.mongo.logic",
      "VSwitchId" : "vsw-bp1p9le7ibusmjf94****",
      "ShardList" : {
        "ShardAttribute" : [ {
          "Status" : "Running",
          "NodeClass" : "dds.shard.mid",
          "NodeDescription" : "",
          "MaxConnections" : 8000,
          "ReadonlyReplicas" : 0,
          "NodeId" : "d-bp128a003436****",
          "NodeStorage" : 10,
          "ConnectString" : "",
          "MaxIOPS" : 8000
        }, {
          "Status" : "Running",
          "NodeClass" : "dds.shard.mid",
          "NodeDescription" : "",
          "MaxConnections" : 8000,
          "ReadonlyReplicas" : 0,
          "NodeId" : "d-bp1ecfe9926b****",
          "NodeStorage" : 10,
          "ConnectString" : "",
          "MaxIOPS" : 8000
        } ]
      },
      "LockMode" : "Unlock",
      "MaxIOPS" : 800,
      "ChargeType" : "PostPaid",
      "VpcAuthMode" : "Close",
      "ProtocolType" : "mongodb",
      "CurrentKernelVersion" : "mongodb_20211014_3.0.38",
      "CreationTime" : "2021-12-09T09:06:01Z",
      "ConfigserverList" : {
        "ConfigserverAttribute" : [ {
          "Status" : "Running",
          "NodeClass" : "dds.cs.mid",
          "NodeDescription" : "",
          "NodeId" : "dds-bp1a7009eb24fec****",
          "NodeStorage" : 20,
          "ConnectString" : ""
        } ]
      },
      "RegionId" : "cn-hangzhou",
      "KindCode" : 0
    } ]
  }
}

错误码

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