调用DescribeDBInstances接口查询MongoDB实例列表。

调试

前往【API Explorer】在线调试,API Explorer 提供在线调用 API、动态生成 SDK Example 代码和快速检索接口等能力,能显著降低使用云 API 的难度,强烈推荐使用。

请求参数

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

要执行的操作,取值:DescribeDBInstances

PageNumber Integer 1

页码,取值为大于0且不超过Integer数据类型的的最大值,默认值为1

PageSize Integer 30

每页记录数,取值: 30、50、100,默认值为30

DBInstanceId String dds-bpxxxxxxxx

实例ID。

ReplicationFactor String 3

副本集实例的节点数量,取值:3、5、7

DBInstanceDescription String 测试数据库

实例的描述或备注信息。

DBInstanceStatus String ACTIVATION

实例的状态信息,取值详情请参考实例状态表

DBInstanceType String replicate

实例类型,取值:

  • sharding:分片集群实例。
  • replicate:副本集实例和单节点实例,默认值为replicate。
DBInstanceClass String dds.mongo.mid

实例规格,取值详情请参考实例规格表

Engine String MongoDB

数据库引擎,取值为MongoDB

EngineVersion String 4.0

实例的数据库版本。

NetworkType String VPC

实例网络类型,取值:

  • Classic:经典网络。
  • VPC:VPC网络。
VpcId String vpc-bpxxxxxxxx

专有网络ID。

VSwitchId String vsw-bpxxxxxxxx

专有网络的交换机ID。

ChargeType String PrePaid

实例付费类型,取值:

  • PrePaid:预付费,包年包月。
  • PostPaid:按量付费。
ZoneId String cn-hangzhou-b

可用区ID。

AccessKeyId String LTAIgbTGpxxxxxx

阿里云颁发给用户的访问服务所用的密钥ID。

RegionId String cn-hangzhou

地域ID,可调用DescribeRegions接口进行查询。

Tag.N.Key String testdatabase

实例的标签键。N的取值范围:1~20。最多支持64个字符,不能以 aliyun、acs:、http:// 或者 https:// 开头。

说明 一旦传入该值,则不允许为空字符串。
Tag.N.Value String apitest

实例的标签值。N的取值范围:1~20。最多支持128个字符,不能以 aliyun、acs:、http:// 或者 https:// 开头。

说明 TagValue可以为空。

返回参数

名称 类型 示例值 描述
PageNumber Integer 1

页码。

TotalCount Integer 1

查询结果中实例的数量。

PageSize Integer 30

每页记录数。

RequestId String A10B8ECB-0BA0-4EC6-93A5-C65FDEDA07CB

请求ID。

DBInstances

实例信息列表。

  └ChargeType String PostPaid

实例付费类型。

  • PrePaid:预付费,包年包月。
  • PostPaid:按量付费。
  └CreationTime String 2018-09-25T06:33:07Z

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

  └DBInstanceClass String dds.mongo.mid

实例规格。

  └DBInstanceDescription String 测试数据库

实例的描述或备注信息。

  └DBInstanceId String dds-bpxxxxxxxx

实例ID。

  └DBInstanceStatus String Running

实例状态,详情请参见实例状态表

  └DBInstanceStorage Integer 20

实例存储空间。

  └DBInstanceType String sharding

实例的类型。

  • sharding:分片集群实例。
  • replicate:副本集实例。
  └DestroyTime String 2019-03-05T11:26:02Z

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

说明
  • 包年包月实例,到期7天后会被释放,数据也会被删除且无法恢复。
  • 按量付费实例,欠费超过24小时会被锁定,持续欠费7天会被释放,数据也被删除且无法恢复。
  └Engine String MongoDB

数据库引擎。

  └EngineVersion String 4.0

实例数据库版本。

  └ExpireTime String 2019-11-25T16:00Z

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

  └LastDowngradeTime String 2019-03-08

实例最后一次降配时间。

  └LockMode String Unlock

实例的锁定状态。

  • Unlock:正常。
  • ManualLock:手动触发锁定。
  • LockByExpiration:实例过期自动锁定。
  • LockByRestoration:实例回滚前自动锁定。
  • LockByDiskQuota:实例空间满自动锁定。
  • Released:实例已释放。此时实例无法进行解锁,只能使用备份数据重新创建新实例,重建时间较长,请耐心等待。
  └MongosList

Mongos节点信息列表。

说明 实例类型为分片集群实例时返回该参数。
    └NodeClass String dds.mongos.mid

Mongos节点规格。

    └NodeDescription String 测试mongos节点

Mongos节点描述。

    └NodeId String s-bpxxxxxxxx

Mongos节点ID。

  └NetworkType String VPC

实例网络类型。

  • Classic:经典网络。
  • VPC:专有网络。
  └RegionId String cn-hangzhou

实例所属地域ID。

  └ReplicationFactor String 3

实例中节点的个数。

说明 实例类型为副本集实例时返回该参数。
  └ResourceGroupId String rg-axxxxxxxx

资源组ID。

  └ShardList

Shard节点信息列表。

说明 实例类型为分片集群实例时返回该参数。
    └NodeClass String dds.shard.mid

Shard节点的实例规格。

    └NodeDescription String 测试shard节点

Shard节点描述。

    └NodeId String d-bpxxxxxxxx

Shard节点ID。

    └NodeStorage Integer 20

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

  └Tags

资源标签信息列表。

    └Key String test

资源的标签键。

    └Value String api

资源的标签值。

  └ZoneId String cn-hangzhou-b

实例所属可用区ID。

示例

请求示例


http(s)://mongodb.aliyuncs.com/?Action=DescribeDBInstances
&<公共请求参数>

正常返回示例

XML 格式

<DescribeDBInstancesResponse>
  <PageNumber>1</PageNumber>
  <TotalCount>1</TotalCount>
  <PageSize>30</PageSize>
  <RequestId>5E182ACD-6283-48BE-B2E6-0890BC123F8B</RequestId>
  <DBInstances>
    <DBInstance>
      <ChargeType>PostPaid</ChargeType>
      <LockMode>Unlock</LockMode>
      <DBInstanceClass>dds.mongo.logic</DBInstanceClass>
      <DBInstanceId>dds-bpxxxxxxxx</DBInstanceId>
      <ZoneId>cn-hangzhou-b</ZoneId>
      <MongosList>
        <MongosAttribute>
          <NodeId>s-bpxxxxxxxx</NodeId>
          <NodeClass>dds.mongos.mid</NodeClass>
        </MongosAttribute>
        <MongosAttribute>
          <NodeId>s-bpxxxxxxxx</NodeId>
          <NodeClass>dds.mongos.mid</NodeClass>
        </MongosAttribute>
      </MongosList>
      <Engine>MongoDB</Engine>
      <CreationTime>2019-03-07T06:06:00Z</CreationTime>
      <NetworkType>Classic</NetworkType>
      <ExpireTime>2999-09-08T16:00Z</ExpireTime>
      <RegionId>cn-hangzhou</RegionId>
      <DBInstanceType>sharding</DBInstanceType>
      <ShardList>
        <ShardAttribute>
          <NodeId>d-bpxxxxxxxx</NodeId>
          <NodeClass>dds.shard.standard</NodeClass>
          <NodeStorage>20</NodeStorage>
        </ShardAttribute>
        <ShardAttribute>
          <NodeId>d-bpxxxxxxxx</NodeId>
          <NodeClass>dds.shard.mid</NodeClass>
          <NodeStorage>10</NodeStorage>
        </ShardAttribute>
      </ShardList>
      <EngineVersion>3.4</EngineVersion>
      <DBInstanceStatus>Running</DBInstanceStatus>
    </DBInstance>
  </DBInstances>
</DescribeDBInstancesResponse>

JSON 格式

{
	"PageNumber":1,
	"TotalCount":1,
	"PageSize":30,
	"RequestId":"5E182ACD-6283-48BE-B2E6-0890BC123F8B",
	"DBInstances":{
		"DBInstance":[
			{
				"ChargeType":"PostPaid",
				"LockMode":"Unlock",
				"DBInstanceClass":"dds.mongo.logic",
				"DBInstanceId":"dds-bpxxxxxxxx",
				"ZoneId":"cn-hangzhou-b",
				"MongosList":{
					"MongosAttribute":[
						{
							"NodeId":"s-bpxxxxxxxx",
							"NodeClass":"dds.mongos.mid"
						},
						{
							"NodeId":"s-bpxxxxxxxx",
							"NodeClass":"dds.mongos.mid"
						}
					]
				},
				"Engine":"MongoDB",
				"CreationTime":"2019-03-07T06:06:00Z",
				"NetworkType":"Classic",
				"ExpireTime":"2999-09-08T16:00Z",
				"RegionId":"cn-hangzhou",
				"DBInstanceType":"sharding",
				"ShardList":{
					"ShardAttribute":[
						{
							"NodeId":"d-bpxxxxxxxx",
							"NodeClass":"dds.shard.standard",
							"NodeStorage":20
						},
						{
							"NodeId":"d-bpxxxxxxxx",
							"NodeClass":"dds.shard.mid",
							"NodeStorage":10
						}
					]
				},
				"EngineVersion":"3.4",
				"DBInstanceStatus":"Running"
			}
		]
	}
}

错误码

查看本产品错误码