全部产品
Search
文档中心

云数据库 MongoDB:DescribeDBInstanceAttribute - 查询云数据库MongoDB实例的信息

更新时间:Mar 15, 2024

查询云数据库MongoDB实例的信息。

调试

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

授权信息

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

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

请求参数

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

数据库引擎,固定取值:MongoDB

MongoDB
DBInstanceIdstring

实例 ID。

dds-bp11483712c1****
ResourceGroupIdstring

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

说明 目前仅中国站支持配置该参数。
rg-acfmyiu4ekp****
IsDeleteboolean

实例是否已删除,取值说明:

  • false:实例正常运行,查询运行中实例信息。
  • true:实例已删除,查询被删除实例的信息。
false

返回参数

名称类型描述示例值
object

实例详细信息。

RequestIdstring

请求 ID。

A935A8EE-A6CC-53DE-98BA-20ABAA7E632B
DBInstancesobject []

实例详细信息。

CreationTimestring

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

2022-01-02T07:43:59Z
ReplicaSetsobject []

副本集实例信息。

说明 当实例类型为副本集实例时,返回该参数。
VSwitchIdstring

交换机 ID。

说明 当实例的网络类型为专有网络时,返回该参数。
vpc-bp1jk5vwkcri27qme****
ConnectionPortstring

节点的连接端口。

3717
ReplicaSetRolestring

节点的角色,取值说明:

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

节点的连接地址。

dds-bp11483712c1****.mongodb.rds.aliyuncs.com
VPCCloudInstanceIdstring

实例 ID。

说明 当实例的网络类型为专有网络时,返回该参数。
dds-bp11483712c1****
NetworkTypestring

网络类型,取值说明:

  • Classic:经典网络。
  • VPC:专有网络。
VPC
VPCIdstring

专有网络 ID。

说明 当实例的网络类型为专有网络时,返回该参数。
vpc-bp1jk5vwkcri27qme****
ReplacateIdstring

全球多活实例的逻辑 ID。

说明 MongoDB 当前不支持新购该类型实例,该参数仅适用于老版本全球多活实例。
bls-m****
Tagsobject []

实例的标签信息列表。

Keystring

实例的标签键。

test
Valuestring

实例的标签值。

api
VpcAuthModestring

私网免密访问模式,取值说明:

  • Open:开启私网免密访问。
  • Close:关闭私网免密访问,需要使用密码访问。
  • NotSupport:不支持该功能。
Open
NetworkTypestring

实例的网络类型,取值说明:

  • Classic:经典网络。
  • VPC:专有网络。
VPC
LockModestring

实例的锁定状态,取值说明:

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

数据库大版本。

4.4
MaxIOPSinteger

实例最大 IOPS。

1000
MaxMBPSinteger

实例的最大云盘吞吐量,单位 MB/s。

350
VPCCloudInstanceIdsstring

实例 ID。

说明 当实例的网络类型为专有网络时,返回该参数。
dds-bp11483712c1****
MongosListobject []

Mongos 节点信息列表。

说明 当实例类型为分片集群实例时,返回该参数。
VpcCloudInstanceIdstring

Mongos 节点的 ID。

s-bp1d8c262a158****
MaxIOPSinteger

Mongos 节点的最大 IOPS。

800
VSwitchIdstring

交换机 ID。

说明 当实例的网络类型为专有网络时,返回该参数。
vsw-bp1vj604nj5a9zz74****
NodeClassstring

Mongos 节点的规格。

dds.mongos.mid
MaxConnectionsinteger

Mongos 节点的最大连接数。

1000
Portinteger

Mongos 节点的连接端口。

3717
VPCIdstring

专有网络 ID。

说明 当实例的网络类型为专有网络时,返回该参数。
vpc-bp1n3i15v90el48nx****
ConnectStingstring

Mongos 节点的连接地址。

s-bp1d8c262a15****.mongodb.rds.aliyuncs.com
NodeDescriptionstring

Mongos 节点的名称。

mongos1
NodeIdstring

Mongos 节点的 ID。

s-bp1d8c262a15****
Statusstring

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

Running
ProtocolTypestring

实例的访问协议类型,取值说明:

  • mongodb:MongoDB 协议。
  • dynamodb:DynamoDB 协议。
说明 当实例类型为分片集群实例时,返回该参数。
mongodb
DBInstanceDescriptionstring

实例名称。

测试数据库
CurrentKernelVersionstring

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

5.0.5-20220721143518_0
DBInstanceReleaseProtectionboolean

是否开启实例释放保护,取值说明:

  • true:已开启。
  • false:未开启。
false
ExpireTimestring

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

说明 当实例的付费类型为包年包月时返回该参数。
2022-02-05T16:00Z
MaintainStartTimestring

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

18:00Z
DBInstanceTypestring

实例类型,取值说明:

  • replicate:副本集实例。
  • sharding:分片集群实例。
replicate
LastDowngradeTimestring

实例最近一次降配时间。

2022-01-08
ShardListobject []

Shard 节点信息列表。

说明 当实例类型为分片集群实例时返回该参数。
MaxIOPSinteger

Shard 节点的最大 IOPS。

8000
ConnectStringstring

Shard 节点的连接地址。

d-bp1af0680a9c6d3****.mongodb.rds.aliyuncs.com:****
NodeClassstring

Shard 节点的规格。

dds.shard.mid
MaxConnectionsinteger

Shard 节点的最大连接数。

8000
Portinteger

Shard 节点的端口。

3717
NodeDescriptionstring

Shard 节点的名称。

testshard
NodeIdstring

Shard 节点的 ID。

d-bp16e09d9c5d****
NodeStorageinteger

Shard 节点的存储空间,单位为 GB。

10
ReadonlyReplicasinteger

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

0
Statusstring

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

Running
MaxDiskMbpsstring

shard 节点的最大云盘吞吐量。

350
MaintainEndTimestring

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

03:00Z
DBInstanceStatusstring

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

Running
VPCIdstring

专有网络 ID。

说明 当实例的网络类型为专有网络时,返回该参数。
vpc-bp1n3i15v90el48nx****
RegionIdstring

实例所属地域 ID。

cn-hangzhou
DBInstanceStorageinteger

实例存储空间。

10
ReplicaSetNamestring

副本集实例的名称。

说明 当实例类型为副本集实例时,返回该参数。
mgset-10ace****
VSwitchIdstring

交换机 ID。

说明 当实例的网络类型为专有网络时,返回该参数。
vsw-bp1oo2a7isyrb8igf****
StorageEnginestring

实例的存储引擎类型。

WiredTiger
ConfigserverListobject []

Configserver 节点信息列表。

说明 当实例类型为分片集群实例时,返回该参数。
MaxIOPSinteger

Configserver 节点的最大 IOPS。

1000
ConnectStringstring

Configserver 节点的连接地址。

dds-bp18b0934e7053e4-cs****.mongodb.rds.aliyuncs.com
NodeClassstring

Configserver 节点的规格。

dds.cs.mid
MaxConnectionsinteger

Configserver 节点的最大连接数。

1000
Portinteger

Configserver 节点的端口。

3717
NodeDescriptionstring

Configserver 节点的名称。

testConfigserver
NodeIdstring

Configserver 节点 ID。

dds-bp11483712c1****-cs
NodeStorageinteger

Configserver 节点的存储空间,单位为 GB。

20
Statusstring

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

Running
ResourceGroupIdstring

实例所属资源组 ID。

说明 目前仅中国站支持返回该参数。
rg-acfmyiu4ekp****
ZoneIdstring

实例所属可用区 ID。

cn-hangzhou-b
MaxConnectionsinteger

实例最大连接数。

500
DBInstanceIdstring

实例 ID。

dds-bp11483712c1****
DBInstanceClassstring

实例规格。

dds.mongo.mid
Enginestring

数据库引擎。

MongoDB
ReadonlyReplicasstring

实例的只读节点个数。

1
ReplicationFactorstring

实例节点数量。

说明 实例类型为副本集实例时,返回该参数。
3
KindCodestring

实例的类型,取值说明:

  • 0:物理机。
  • 1:ECS。
  • 2:DOCKER。
  • 18:k8s 新架构实例。
1
CapacityUnitstring

实例消耗的读写吞吐量。

100
ChargeTypestring

实例的付费类型,取值说明:

  • PrePaid:预付费,包年包月。
  • PostPaid:后付费,按量付费。
PostPaid
StorageTypestring

存储类型,取值说明:

cloud_essd1:ESSD PL1 云盘。 cloud_essd2:ESSD PL2 云盘。 cloud_essd3:ESSD PL3 云盘。 local_ssd:SSD 本地盘。 cloud_essd_dbfs_s:DBFS 共享存储云盘。

cloud_essd1
DestroyTimestring

实例数据销毁时间,格式为 yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2021-12-10T16:00:00Z
DBInstanceOrderStatusstring

当前该实例已生成的订单状态,取值说明:

  • all_completed:所有订单均处于生产中或已经生产完成。
  • order_unpaid:当前有未支付的订单。
  • order_wait_for_produce:当前有正在下发生产的订单。
说明 订单生产流程依次为用户下单、支付订单、订单下发生产、进行生产和完成生产。
  • 如果订单状态长时间处于order_wait_for_produce,说明下发生产流程遇到了问题,系统会自动重试。
  • 订单在进行生产和完成生产时,实例状态才会发生变化,例如变配中和运行中。
all_completed
Encryptedboolean

是否开启云盘加密

true
EncryptionKeystring

云盘加密对应的 kms-key

07609cc3-3109-408f-a35e-c548e776da0b
SyncPercentstring

数据同步进度百分比。当实例处在变配中时,需要进行数据同步等操作,可以通过该字段判断同步进度。

0.8
UseClusterBackupboolean

是否使用集群备份模式。取值说明:

  • true:启用集群备份模式。
  • false 未启用集群备份模式。
true
BurstingEnabledboolean

是否已开启突发

true
ProvisionedIopslong

预配置性能

1960

示例

正常返回示例

JSON格式

{
  "RequestId": "A935A8EE-A6CC-53DE-98BA-20ABAA7E632B",
  "DBInstances": {
    "DBInstance": [
      {
        "CreationTime": "2022-01-02T07:43:59Z",
        "ReplicaSets": {
          "ReplicaSet": [
            {
              "VSwitchId": "vpc-bp1jk5vwkcri27qme****",
              "ConnectionPort": "3717",
              "ReplicaSetRole": "Primary",
              "ConnectionDomain": "dds-bp11483712c1****.mongodb.rds.aliyuncs.com",
              "VPCCloudInstanceId": "dds-bp11483712c1****",
              "NetworkType": "VPC",
              "VPCId": "vpc-bp1jk5vwkcri27qme****"
            }
          ]
        },
        "ReplacateId": "bls-m****",
        "Tags": {
          "Tag": [
            {
              "Key": "test",
              "Value": "api"
            }
          ]
        },
        "VpcAuthMode": "Open",
        "NetworkType": "VPC",
        "LockMode": "Unlock",
        "EngineVersion": "4.4",
        "MaxIOPS": 1000,
        "MaxMBPS": 350,
        "VPCCloudInstanceIds": "dds-bp11483712c1****",
        "MongosList": {
          "MongosAttribute": [
            {
              "VpcCloudInstanceId": "s-bp1d8c262a158****",
              "MaxIOPS": 800,
              "VSwitchId": "vsw-bp1vj604nj5a9zz74****",
              "NodeClass": "dds.mongos.mid",
              "MaxConnections": 1000,
              "Port": 3717,
              "VPCId": "vpc-bp1n3i15v90el48nx****",
              "ConnectSting": "s-bp1d8c262a15****.mongodb.rds.aliyuncs.com",
              "NodeDescription": "mongos1",
              "NodeId": "s-bp1d8c262a15****",
              "Status": "Running"
            }
          ]
        },
        "ProtocolType": "mongodb",
        "DBInstanceDescription": "测试数据库",
        "CurrentKernelVersion": "5.0.5-20220721143518_0",
        "DBInstanceReleaseProtection": false,
        "ExpireTime": "2022-02-05T16:00Z",
        "MaintainStartTime": "18:00Z",
        "DBInstanceType": "replicate",
        "LastDowngradeTime": "2022-01-08",
        "ShardList": {
          "ShardAttribute": [
            {
              "MaxIOPS": 8000,
              "ConnectString": "d-bp1af0680a9c6d3****.mongodb.rds.aliyuncs.com:****",
              "NodeClass": "dds.shard.mid",
              "MaxConnections": 8000,
              "Port": 3717,
              "NodeDescription": "testshard",
              "NodeId": "d-bp16e09d9c5d****",
              "NodeStorage": 10,
              "ReadonlyReplicas": 0,
              "Status": "Running",
              "MaxDiskMbps": "350"
            }
          ]
        },
        "MaintainEndTime": "03:00Z",
        "DBInstanceStatus": "Running",
        "VPCId": "vpc-bp1n3i15v90el48nx****",
        "RegionId": "cn-hangzhou",
        "DBInstanceStorage": 10,
        "ReplicaSetName": "mgset-10ace****",
        "VSwitchId": "vsw-bp1oo2a7isyrb8igf****",
        "StorageEngine": "WiredTiger",
        "ConfigserverList": {
          "ConfigserverAttribute": [
            {
              "MaxIOPS": 1000,
              "ConnectString": "dds-bp18b0934e7053e4-cs****.mongodb.rds.aliyuncs.com",
              "NodeClass": "dds.cs.mid",
              "MaxConnections": 1000,
              "Port": 3717,
              "NodeDescription": "testConfigserver",
              "NodeId": "dds-bp11483712c1****-cs",
              "NodeStorage": 20,
              "Status": "Running"
            }
          ]
        },
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "ZoneId": "cn-hangzhou-b",
        "MaxConnections": 500,
        "DBInstanceId": "dds-bp11483712c1****",
        "DBInstanceClass": "dds.mongo.mid",
        "Engine": "MongoDB",
        "ReadonlyReplicas": "1",
        "ReplicationFactor": "3",
        "KindCode": "1",
        "CapacityUnit": "100",
        "ChargeType": "PostPaid",
        "StorageType": "cloud_essd1",
        "SecondaryZoneId": "cn-hangzhou-i",
        "HiddenZoneId": "cn-hangzhou-h",
        "DestroyTime": "2021-12-10T16:00:00Z",
        "DBInstanceOrderStatus": "all_completed",
        "Encrypted": true,
        "EncryptionKey": "07609cc3-3109-408f-a35e-c548e776da0b",
        "SyncPercent": "0.8",
        "UseClusterBackup": true,
        "BurstingEnabled": true,
        "ProvisionedIops": 1960
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息
400VpcCloudInstanceIdNumErrorGet vpcCloudInstanceId number error.

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

变更历史

变更时间变更内容概要操作
2024-01-04OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2023-09-27OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2023-08-24OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2023-07-12OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2023-06-05OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更