調用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"
			}
		]
	}
}

錯誤碼

查看本產品錯誤碼