MongoDB インスタンスの照会 - MongoDB - Alibaba Cloud - ApsaraDB for MongoDB

ApsaraDB for MongoDB インスタンスのリストをクエリします。

操作説明

デフォルトでは、この操作はレプリカセットインスタンス (スタンドアロンインスタンスを含む) のリストを照会します。 DBInstanceType リクエストパラメーターを指定しない場合、デフォルト値は replicate です。シャードクラスターインスタンスのリストを照会するには、DBInstanceType を sharding に設定します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dds:DescribeDBInstances

get

* インスタンス

acs:dds:{#regionId}:{#accountId}:dbinstance/*

* インスタンス

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID です。DescribeRegions オペレーションを呼び出して、リージョン ID を照会できます。	cn-hangzhou
PageNumber	integer	任意	ページ番号です。値は 0 より大きく、整数データ型の最大値以下である必要があります。デフォルト値：1	1
PageSize	integer	任意	各ページに返すエントリの数です。有効な値： 30 (デフォルト) 50 100	30
DBInstanceId	string	任意	インスタンス ID です。	dds-bp199659b178****
ReplicationFactor	string	任意	レプリカセットインスタンスのノード数です。有効な値： 3 5 7	3
DBInstanceDescription	string	任意	インスタンス名です。名前は次の要件を満たす必要があります：中国語の文字または英字で始まる必要があります。数字、中国語の文字、英字、アンダースコア (_)、ハイフン (-) を含めることができます。長さは 2〜256 文字である必要があります。	Test database
ExpireTime	string	任意	インスタンスの有効期限です。時刻は yyyy-MM-ddTHH:mm:ssZ 形式です。時刻は UTC で表示されます。このパラメーターは、指定された時刻以前に有効期限が切れるインスタンスをフィルタリングするために使用されます。	2019-12-26T16:00:00Z
DBInstanceStatus	string	任意	インスタンスステータスです。詳細については、「インスタンスの状態」をご参照ください。	Running
DBInstanceType	string	任意	インスタンスアーキテクチャです。有効な値： sharding：シャードクラスターインスタンス。 replicate：レプリカセットまたはスタンドアロンインスタンス。これがデフォルト値です。	sharding
DBInstanceClass	string	任意	インスタンスタイプです。詳細については、「インスタンスタイプ」をご参照ください。	dds.mongo.mid
Engine	string	任意	データベースエンジンです。値を MongoDB に設定します。	MongoDB
EngineVersion	string	任意	データベースエンジンバージョンです。有効な値： 7.0 6.0 5.0 4.4 4.2 4.0 3.4	4.0
NetworkType	string	任意	インスタンスのネットワークタイプです。有効な値： Classic：クラシックネットワーク。 VPC：Virtual Private Cloud (VPC)。	VPC
VpcId	string	任意	VPC ID です。	vpc-bp1n3i15v90el48nx****
VSwitchId	string	任意	VPC の vSwitch ID です。	vsw-bp1vj604nj5a9zz74****
ChargeType	string	任意	インスタンスの課金方法です。有効な値： PrePaid：サブスクリプション。 PostPaid：従量課金。	PrePaid
ZoneId	string	任意	ゾーン ID です。DescribeRegions オペレーションを呼び出して、ゾーン ID を照会できます。	cn-hangzhou-b
Expired	string	任意	インスタンスの有効期限切れステータスです。有効な値： true：インスタンスは有効期限切れです。 false：インスタンスは有効期限切れではありません。	true
ConnectionDomain	string	任意	ノードのエンドポイントです。DescribeDBInstanceAttribute オペレーションを呼び出して、エンドポイントを照会できます。	dds-bp1ea17b41abecf43****.mongodb.rds.aliyuncs.com
ResourceGroupId	string	任意	リソースグループ ID です。	rg-acfmyiu4ekp****
Tag	array<object>	任意	インスタンスのタグです。
	object	任意
Key	string	任意	タグ N のキーです。N の値の範囲は1～20です。タグキーは `aliyun`、`acs:`、`http://`、または `https://` で始めることはできません。タグキーの長さは最大 64 文字です。タグキーを空の文字列にすることはできません。	testdatabase
Value	string	任意	タグ N の値です。N の値の範囲は1～20です。タグ値は `aliyun`、`acs:`、`http://`、または `https://` で始めることはできません。タグ値の長さは最大 128 文字です。タグ値は空の文字列にすることができます。	apitest
DBNodeType	string	任意	インスタンスをタイプでフィルタリングします。有効な値： customized：スタンドアロンインスタンスおよび DBFS インスタンス。 standard：標準インスタンス。レプリカセットおよびシャードクラスターインスタンスが含まれます。 default：すべてのインスタンス。	default

レスポンスフィールド

フィールド	型	説明	例
	object
TotalCount	integer	クエリ条件に一致するインスタンスの総数です。	5
RequestId	string	リクエスト ID です。	0E4FE33F-5510-5758-8FA7-A6672CDE****
PageSize	integer	ページごとに返されるエントリ数です。	30
PageNumber	integer	ページ番号です。	1
DBInstances	object
DBInstance	array<object>	インスタンスの詳細です。
	array<object>
CreationTime	string	インスタンスが作成された時刻です。時刻の形式は yyyy-MM-ddTHH:mm:ssZ です。時刻は UTC で表示されます。	2021-03-25T02:18:00Z
ChargeType	string	インスタンスの課金方法です。有効な値： PrePaid：サブスクリプション。 PostPaid：従量課金。	PrePaid
Tags	object
Tag	array<object>	リソースタグの詳細です。
	object	リソースタグの詳細です。
Key	string	タグキーです。	test
Value	string	タグ値です。	api
VpcAuthMode	string	VPC 経由でのパスワードなしのアクセスが有効になっているかどうかを示します。有効な値： Open：有効。 Close：無効。	Close
NetworkType	string	インスタンスのネットワークタイプです。有効な値： Classic：クラシックネットワーク。 VPC：VPC。	Classic
LockMode	string	インスタンスのロック状態です。有効な値： Unlock：インスタンスはロックされていません。 ManualLock：インスタンスは手動でロックされています。 LockByExpiration：インスタンスは有効期限切れにより自動的にロックされます。 LockByRestoration：インスタンスはロールバックの前に自動的にロックされます。 LockByDiskQuota：インスタンスはストレージ容量が一杯になったため自動的にロックされます。 Released：インスタンスがリリースされた状態です。この状態では、インスタンスのロックを解除することはできません。バックアップファイルからのみ新しいインスタンスを作成できます。復元プロセスには時間がかかる場合があります。	Unlock
EngineVersion	string	データベースエンジンバージョンです。有効な値： 7.0 6.0 5.0 4.4 4.2 4.0 3.4	4.2
MongosList	object
MongosAttribute	array<object>	Mongos ノードの詳細です。説明このパラメーターは、シャードクラスターインスタンスの場合にのみ返されます。
	object	Mongos ノードの詳細です。説明このパラメーターは、シャードクラスターインスタンスの場合にのみ返されます。
NodeClass	string	Mongos ノードのインスタンスタイプです。	dds.mongos.standard
NodeDescription	string	Mongos ノードの説明です。	テスト mongos ノード
NodeId	string	Mongos ノードの ID です。	s-bp10e3b0d02f****
DBInstanceDescription	string	インスタンスの説明です。	Test database
ExpireTime	string	インスタンスの有効期限が切れる時刻です。時刻の形式は yyyy-MM-ddTHH:mmZ です。時刻は UTC で表示されます。	2021-11-25T16:00Z
DBInstanceType	string	インスタンスアーキテクチャです。有効な値： sharding：シャードクラスターインスタンス。 replicate：レプリカセットまたはスタンドアロンインスタンス。	sharding
LastDowngradeTime	string	インスタンスが最後にダウングレードされた日付です。	2021-05-08
ShardList	object
ShardAttribute	array<object>	シャードノードの詳細です。説明このパラメーターは、シャードクラスターインスタンスの場合にのみ返されます。
	object	シャードノードの詳細です。説明このパラメーターは、シャードクラスターインスタンスの場合にのみ返されます。
NodeClass	string	シャードノードのインスタンスタイプです。	dds.shard.mid
NodeDescription	string	シャードノードの説明です。	テスト shard ノード
NodeStorage	integer	シャードノードのストレージ容量です。単位： GB。	10
NodeId	string	シャードノードの ID です。	d-bp1cac6f2083****
ReadonlyReplicas	integer	シャードノード内の読み取り専用ノードの数です。値は 0 ～ 5 の整数です。	2
DestroyTime	string	インスタンスのデータが破棄される時刻です。時刻の形式は yyyy-MM-ddTHH:mm:ssZ です。時刻は UTC で表示されます。説明サブスクリプションインスタンスの場合、コンピューティングリソースはインスタンスの有効期限が切れてから 16 日目にリリースされます。データはさらに 7 日間保持されます。23 日目にデータは削除され、回復できなくなります。従量課金インスタンスの場合、支払いが延滞してから 16 日目にコンピューティングリソースがリリースされます。データはさらに 7 日間保持されます。23 日目にデータは削除され、回復できなくなります。	2021-12-10T16:00:00Z
DBInstanceStatus	string	インスタンスステータスです。詳細については、「インスタンスステータス」をご参照ください。	Running
RegionId	string	インスタンスが配置されているリージョン ID です。	cn-hangzhou
DBInstanceStorage	integer	インスタンスのストレージ容量です。単位： GB。	20
ResourceGroupId	string	リソースグループ ID です。	rg-acfmyiu4ekp****
ZoneId	string	インスタンスが配置されているゾーン ID です。	cn-hangzhou-g
DBInstanceId	string	インスタンス ID です。	dds-bp18b0934e70****
DBInstanceClass	string	インスタンスタイプです。	dds.mongo.mid
Engine	string	データベースエンジンです。	MongoDB
ReplicationFactor	string	インスタンス内のノード数です。説明このパラメーターは、レプリカセットインスタンスの場合にのみ返されます。	3
KindCode	string	インスタンスのタイプです。有効な値： 0：物理サーバー。 1：ECS。 2：Docker。 18：新しいKubernetesベースのアーキテクチャのインスタンス。	1
CapacityUnit	string	インスタンスが消費する読み取り/書き込みスループットです。説明このパラメーターは、サーバーレスインスタンスの場合にのみ返されます。	100
StorageType	string	ストレージタイプです。有効な値： cloud_essd：ESSD クラウドディスク。 local_ssd：ローカル SSD。	local_ssd
BackupRetentionPolicy	integer	バックアップ保持ポリシーです。有効な値： 0：インスタンスがリリースされると、すべてのバックアップセットが直ちに削除されます。 1：インスタンスがリリースされると自動バックアップが実行され、このバックアップセットは長期間保持されます。 2：インスタンスがリリースされると自動バックアップが実行され、クラスターのすべてのバックアップセットが長期間保持されます。	1
ReleaseTime	string	インスタンスのリリース時刻です。時刻の形式は yyyy-MM-ddTHH:mmZ です。時刻は UTC で表示されます。	2024-06-17T07:01Z

例

成功レスポンス

JSONJSON

{
  "TotalCount": 5,
  "RequestId": "0E4FE33F-5510-5758-8FA7-A6672CDE****",
  "PageSize": 30,
  "PageNumber": 1,
  "DBInstances": {
    "DBInstance": [
      {
        "CreationTime": "2021-03-25T02:18:00Z",
        "ChargeType": "PrePaid",
        "Tags": {
          "Tag": [
            {
              "Key": "test",
              "Value": "api"
            }
          ]
        },
        "VpcAuthMode": "Close",
        "NetworkType": "Classic",
        "LockMode": "Unlock",
        "EngineVersion": "4.2",
        "MongosList": {
          "MongosAttribute": [
            {
              "NodeClass": "dds.mongos.standard",
              "NodeDescription": "テストMongosノード",
              "NodeId": "s-bp10e3b0d02f****"
            }
          ]
        },
        "DBInstanceDescription": "テストデータベース",
        "ExpireTime": "2021-11-25T16:00Z",
        "DBInstanceType": "sharding",
        "LastDowngradeTime": "2021-05-08",
        "ShardList": {
          "ShardAttribute": [
            {
              "NodeClass": "dds.shard.mid",
              "NodeDescription": "テストシャードノード",
              "NodeStorage": 10,
              "NodeId": "d-bp1cac6f2083****",
              "ReadonlyReplicas": 2
            }
          ]
        },
        "DestroyTime": "2021-12-10T16:00:00Z",
        "DBInstanceStatus": "Running",
        "RegionId": "cn-hangzhou",
        "DBInstanceStorage": 20,
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "ZoneId": "cn-hangzhou-g",
        "DBInstanceId": "dds-bp18b0934e70****",
        "DBInstanceClass": "dds.mongo.mid",
        "Engine": "MongoDB",
        "ReplicationFactor": "3",
        "KindCode": "1",
        "CapacityUnit": "100",
        "StorageType": "local_ssd",
        "BackupRetentionPolicy": 1,
        "ReleaseTime": "2024-06-17T07:01Z"
      }
    ]
  }
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。