DescribeDBInstances - - Alibaba Cloud ドキュメントセンター

この API は、MongoDB インスタンスのリストをクエリする場合に呼び出すことができます。

デバッグ

OpenAPI Explorer は API の使用を簡素化します。 OpenAPI Explorer を使用して、API の取得、API の呼び出し、SDK サンプルコードの動的生成などのデバッグ操作を実行できます。

リクエストパラメータ


パラメータ	データ型	必須	例	説明
Action	String	はい	DescribeDBInstances	実行する操作。値をDescribeDBInstances に設定します。
PageNumber	Integer	No	1	ページ番号。有効値：0 以外の正の整数。デフォルト値：1。
PageSize	Integer	いいえ	30	各ページの履歴件数。有効値：30、50、100。デフォルト値：30。
DBInstanceId	String	いいえ	dds-bpxxxxxxxx	インスタンス ID。
ReplicationFactor	String	いいえ	3	レプリカセットインスタンス内のノード数。有効値： 3、5、7。
DBInstanceDescription	String	いいえ	Test database	インスタンスの説明または備考。
DBInstanceStatus	String	いいえ	ACTIVATION	インスタンスのステータス情報。有効値の詳細は、インスタンスステータスをご参照ください。
DBInstanceType	String	いいえ	Replicate	インスタンスタイプ。有効値： sharding：シャードクラスターインスタンス。 replicate：レプリカセットまたはスタンドアロンインスタンス。デフォルト値です。
DBInstanceClass	String	いいえ	dds.mongo.mid	インスタンスタイプ。有効値の詳細は、インスタンスのタイプをご参照ください。
Engine	String	いいえ	MongoDB	データベースエンジン。有効値：MongoDB 。
EngineVersion	String	いいえ	4.0	インスタンスのデータベースバージョン。
NetworkType	String	いいえ	VPC	インスタンスのネットワークタイプ。有効値： Classic VPC
VpcId	String	いいえ	vpc-bpxxxxxxxx	VPC の ID。
VSwitchId	String	いいえ	vsw-bpxxxxxxxx	VPC の VSwitch ID。
ChargeType	String	いいえ	PrePaid	インスタンスの課金方法。有効値： PrePaid ：月単位または年単位のサブスクリプション。 PostPaid ：従量課金。
ZoneId	String	いいえ	cn-hangzhou-d	ゾーン ID。
AccessKeyId	String	いいえ	LTAIgbTGpxxxxxx	Alibaba Cloud から提供された AccessKey ID。
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://“ にすることはできません。注 Tag.N.Value は、空の文字列が使用可能です。

レスポンスパラメータ


パラメータ	タイプ	例	説明
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。
└DBInstanceClass	String	dds.mongo.mid	インスタンスのタイプ。
└DBInstanceDescription	String	Test database	インスタンスの説明または備考。
InstanceDBInstanceId	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。注サブスクリプションインスタンスは、有効期限の 15 日後に解放されます。解放されたインスタンスのデータは削除され、復元できません。未払いが 24 時間を超えると、従量課金インスタンスはロックされます。インスタンスは、未払いが 7 日間続くと解放されます。解放されたインスタンスのデータは削除され、復元できません。
└Engine	String	MongoDB	データベースエンジン。
└EngineVersion	String	4.0	データベースのバージョン。
└ExpireTime	String	2019-11-25T16:00Z	インスタンスの有効期限。
└LastDowngradeTime	String	2019-03-08	インスタンスが最後にダウングレードされた時刻。
└LockMode	String	Unlock	インスタンスのロックステータス。 Unlock ：インスタンスはロックされていません。 ManualLock：インスタンスは手動でロックされています。 LockByExpiration：有効期限が切れたため、インスタンスはロックされています。 LockByRestoration：インスタンスはロールバックの前にロックされています。 LockByDiskQuota：インスタンスは、容量がいっぱいのためロックされています。 Released ：インスタンスが解放されました。インスタンスが解放された状態の場合、ロックを解除できません。インスタンスを復元する場合は、バックアップデータのみを使用して新しいインスタンスを作成できます。バックアップデータからインスタンスを作成するには時間がかかります。
└MongosList			mongos のリスト。注インスタンスがシャードクラスターインスタンスである場合、このパラメーターが返されます。
└NodeClass	String	dds.mongos.mid	mongos の仕様。
└NodeDescription	String	Test 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			シャードのリスト。注インスタンスがシャードクラスターインスタンスである場合、このパラメーターが返されます。
└NodeClass	String	dds.shard.mid	シャードのインスタンスタイプ。
└NodeDescription	String	Test shard node	シャードの説明。
└NodeId	String	d-bpxxxxxxxx	シャードの ID。
└NodeStorage	Integer	20	シャードのストレージスペース。単位 : GB
└Tags			リソースタグ情報リスト。
└Key	String	test	リソースのタグキー。
└Value	String	api	リソースのタグ値。
└ZoneId	String	cn-hangzhou-d	インスタンスが属するゾーン ID。

例

リクエストの例


http(s)://mongodb.aliyuncs.com/? Action=DescribeDBInstances
&<Common request parameters>

通常のレスポンスの例

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

エラーコード

エラーコードの表示