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

ApsaraDB for MongoDB インスタンスに関する情報を照会します。

今すぐお試しください

この 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:DescribeDBInstanceAttribute

get

*dbinstance

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Engine	string	任意	データベースエンジン。有効値：MongoDB。	MongoDB
DBInstanceId	string	必須	インスタンス ID。	dds-bp11483712c1****
ResourceGroupId	string	任意	リソースグループの ID。詳細については、「リソースグループの基本情報の表示」をご参照ください。説明このパラメーターは、Alibaba Cloud China Website (www.aliyun.com) のみでサポートされています。	rg-acfmyiu4ekp****
IsDelete	boolean	任意	インスタンスが削除されたかどうかを示します。有効値： false：インスタンスは正常に実行中です。実行中のインスタンスの情報を照会します。 true：インスタンスは削除されています。削除済みインスタンスの情報を照会します。	false

レスポンスフィールド

フィールド	型	説明	例
	object	インスタンスの詳細情報。
RequestId	string	リクエストの ID。	A935A8EE-A6CC-53DE-98BA-20ABAA7E632B
DBInstances	object
DBInstance	array<object>	インスタンスの詳細情報。
	array<object>	インスタンスの詳細情報。
CreationTime	string	インスタンスの作成時刻。形式は yyyy-MM-ddTHH:mm:ssZ（協定世界時 (UTC)）です。	2022-01-02T07:43:59Z
ReplicaSets	object
ReplicaSet	array<object>	レプリカセットインスタンスの情報。説明このパラメーターは、インスタンスタイプがレプリカセットの場合にのみ返されます。
	object	レプリカセットインスタンスの情報。説明このパラメーターは、インスタンスタイプがレプリカセットの場合にのみ返されます。
VSwitchId	string	vSwitch の ID。説明このパラメーターは、インスタンスのネットワークタイプが VPC の場合にのみ返されます。	vpc-bp1jk5vwkcri27qme****
ConnectionPort	string	ノードの接続ポート。	3717
ReplicaSetRole	string	ノードのロール。有効値： Primary：プライマリノード。 Secondary：セカンダリノード。	Primary
ConnectionDomain	string	ノードのエンドポイント。	dds-bp11483712c1****.mongodb.rds.aliyuncs.com
VPCCloudInstanceId	string	レプリカセットノードの VPC インスタンス ID。説明このパラメーターは、インスタンスのネットワークタイプが VPC の場合にのみ返されます。	dds-bp11483712c1****
NetworkType	string	ネットワークタイプ。有効値： Classic：クラシックネットワーク。 VPC：VPC (Virtual Private Cloud)。	VPC
VPCId	string	VPC の ID。説明このパラメーターは、インスタンスのネットワークタイプが VPC の場合にのみ返されます。	vpc-bp1jk5vwkcri27qme****
ReplacateId	string	Redis グローバル分散キャッシュインスタンスの論理 ID。説明 MongoDB では、このタイプのインスタンスの新規購入はサポートされていません。このパラメーターは、レガシ Redis グローバル分散キャッシュインスタンスにのみ適用されます。	bls-m****
Tags	object
Tag	array<object>	インスタンスのタグリスト。
	object	インスタンスのタグリスト。
Key	string	インスタンスのタグキー。	test
Value	string	インスタンスのタグ値。	api
VpcAuthMode	string	内部ネットワークでのパスワードなしのアクセスモード。有効値： Open：内部ネットワークでのパスワードなしのアクセスが有効化されています。 Close：内部ネットワークでのパスワードなしのアクセスが無効化されています。インスタンスへのアクセスにはパスワードが必要です。 NotSupport：この機能はサポートされていません。	Open
NetworkType	string	インスタンスのネットワークタイプ。有効値： Classic：クラシックネットワーク。 VPC：VPC (Virtual Private Cloud)。	VPC
LockMode	string	インスタンスのロックステータス。有効値： Unlock：インスタンスは正常でロックされていません。 ManualLock：インスタンスは手動でロックされています。 LockByExpiration：有効期限後にインスタンスが自動的にロックされます。 LockByRestoration：ロールバック前にインスタンスが自動的にロックされます。 LockByDiskQuota：ストレージ容量がいっぱいになるとインスタンスが自動的にロックされます。	Unlock
EngineVersion	string	データベースのメジャーバージョン。	4.4
MaxIOPS	integer	インスタンスの最大 IOPS。	1000
MaxMBPS	integer	インスタンスの最大ディスクスループット。単位：MB/s。	350
VPCCloudInstanceIds	string	VPC インスタンスの ID。説明このパラメーターは、インスタンスのネットワークタイプが VPC の場合にのみ返されます。重要このパラメーターは非推奨です。	dds-bp11483712c1****
MongosList	object
MongosAttribute	array<object>	Mongos ノード情報のリスト。説明このパラメーターは、インスタンスタイプがシャードクラスターの場合にのみ返されます。
	object	Mongos ノード情報のリスト。説明このパラメーターは、インスタンスタイプがシャードクラスターの場合にのみ返されます。
VpcCloudInstanceId	string	Mongos ノードの VPC インスタンス ID。	s-bp1d8c262a158****
LockMode	string	インスタンスのロックステータス。有効値： Unlock：正常。 ManualLock：手動でロック済み。 LockByExpiration：有効期限後に自動ロック。 LockByRestoration：ロールバック前に自動ロック。 LockByDiskQuota：ストレージ容量がいっぱいになると自動ロック。	Unlock
MaxIOPS	integer	Mongos ノードの最大 IOPS。	800
VSwitchId	string	vSwitch の ID。説明このパラメーターは、インスタンスのネットワークタイプが VPC の場合にのみ返されます。	vsw-bp1vj604nj5a9zz74****
NodeClass	string	Mongos ノードの仕様。	dds.mongos.mid
MaxConnections	integer	Mongos ノードの最大接続数。	1000
Port	integer	Mongos ノードの接続ポート。	3717
VPCId	string	VPC の ID。説明このパラメーターは、インスタンスのネットワークタイプが VPC の場合にのみ返されます。	vpc-bp1n3i15v90el48nx****
ConnectSting	string	Mongos ノードのエンドポイント。警告このパラメーターは近日中に非推奨となります。代わりに ConnectString パラメーターをご使用ください。	s-bp1d8c262a15****.mongodb.rds.aliyuncs.com
NodeDescription	string	Mongos ノードの名前。	mongos1
NodeId	string	Mongos ノードの ID。	s-bp1d8c262a15****
Status	string	Mongos ノードのステータス。詳細については、「インスタンスステータス表」をご参照ください。	Running
CurrentKernelVersion	string	MongoDB ノードの現在のマイナーカーネルバージョン。	mongodb_20220518_4.0.21
ConnectString	string	Mongos ノードのエンドポイント。	s-bp1d8c262a15****.mongodb.rds.aliyuncs.com
ProtocolType	string	インスタンスへのアクセスに使用されるプロトコルタイプ。有効値： mongodb：MongoDB プロトコル。 dynamodb：DynamoDB プロトコル。説明このパラメーターは、インスタンスタイプがシャードクラスターの場合にのみ返されます。	mongodb
DBInstanceDescription	string	インスタンスの名前。	Test database
CurrentKernelVersion	string	データベースの現在のマイナーバージョン。	5.0.5-20220721143518_0
DBInstanceReleaseProtection	boolean	インスタンスのリリース保護が有効かどうかを示します。有効値： true：有効。 false：無効。	false
ExpireTime	string	サブスクリプションインスタンスの有効期限。形式は yyyy-MM-ddTHH:mmZ（協定世界時 (UTC)）です。説明このパラメーターは、課金方法がサブスクリプションの場合にのみ返されます。	2022-02-05T16:00Z
MaintainStartTime	string	インスタンスのメンテナンスウィンドウの開始時刻。形式は HH:mmZ（協定世界時 (UTC)）です。	18:00Z
DBInstanceType	string	インスタンスタイプ。有効値： replicate：レプリカセットインスタンス。 sharding：シャードクラスターインスタンス。	replicate
LastDowngradeTime	string	インスタンスの仕様を最後にスペックダウンした時刻。	2022-01-08
ShardList	object
ShardAttribute	array<object>	シャードノード情報のリスト。説明このパラメーターは、インスタンスタイプがシャードクラスターの場合にのみ返されます。
	object	シャードノード情報のリスト。説明このパラメーターは、インスタンスタイプがシャードクラスターの場合にのみ返されます。
LockMode	string	クラスターのロックモード。有効値： Unlock：正常。 ManualLock：手動でロック済み。 LockByExpiration：有効期限後に自動ロック。 LockByRestoration：ロールバック前に自動ロック。 LockByDiskQuota：ストレージ容量がいっぱいになると自動ロック。	Unlock
MaxIOPS	integer	シャードノードの最大 IOPS。	8000
ConnectString	string	シャードノードのエンドポイント。	d-bp1af0680a9c6d3**.mongodb.rds.aliyuncs.com:**
NodeClass	string	シャードノードの仕様。	dds.shard.mid
MaxConnections	integer	シャードノードの最大接続数。	8000
Port	integer	シャードノードのポート。	3717
NodeDescription	string	シャードノードの名前。	testshard
NodeId	string	シャードノードの ID。	d-bp16e09d9c5d****
NodeStorage	integer	シャードノードのストレージ容量。単位：GB。	10
ReadonlyReplicas	integer	シャードノード内の読み取り専用ノードの数。有効値：0 ～ 5。	0
Status	string	シャードノードのステータス。詳細については、「インスタンスステータス表」をご参照ください。	Running
MaxDiskMbps	string	シャードノードの最大ディスクスループット。	350
CurrentKernelVersion	string	MongoDB ノードの現在のマイナーカーネルバージョン。	mongodb_20220518_4.0.21
ReplicaSetName	string	シャードノードの名前。	mgset-xxxx
MaintainEndTime	string	インスタンスのメンテナンスウィンドウの終了時刻。形式は HH:mmZ（協定世界時 (UTC)）です。	03:00Z
DBInstanceStatus	string	インスタンスのステータス。詳細については、「インスタンスステータス表」をご参照ください。	Running
VPCId	string	VPC の ID。説明このパラメーターは、インスタンスのネットワークタイプが VPC の場合にのみ返されます。	vpc-bp1n3i15v90el48nx****
RegionId	string	インスタンスのリージョン ID。	cn-hangzhou
DBInstanceStorage	integer	インスタンスのストレージ容量。	10
ReplicaSetName	string	レプリカセットインスタンスの名前。説明このパラメーターは、インスタンスタイプがレプリカセットの場合にのみ返されます。	mgset-10ace****
VSwitchId	string	vSwitch の ID。説明このパラメーターは、インスタンスのネットワークタイプが VPC の場合にのみ返されます。	vsw-bp1oo2a7isyrb8igf****
StorageEngine	string	インスタンスのストレージエンジンタイプ。	WiredTiger
ConfigserverList	object
ConfigserverAttribute	array<object>	ConfigServer ノード情報のリスト。説明このパラメーターは、インスタンスタイプがシャードクラスターの場合にのみ返されます。
	object	ConfigServer ノード情報のリスト。説明このパラメーターは、インスタンスタイプがシャードクラスターの場合にのみ返されます。
MaxIOPS	integer	ConfigServer ノードの最大 IOPS。	1000
LockMode	string	インスタンスのロックステータス。有効値： Unlock：正常。 ManualLock：手動でロック済み。 LockByExpiration：有効期限後に自動ロック。 LockByRestoration：ロールバック前に自動ロック。 LockByDiskQuota：ストレージ容量がいっぱいになると自動ロック。	Unlock
ConnectString	string	ConfigServer ノードのエンドポイント。	dds-bp18b0934e7053e4-cs****.mongodb.rds.aliyuncs.com
NodeClass	string	ConfigServer ノードの仕様。	dds.cs.mid
MaxConnections	integer	ConfigServer ノードの最大接続数。	1000
Port	integer	ConfigServer ノードのポート。	3717
NodeDescription	string	ConfigServer ノードの名前。	testConfigserver
NodeId	string	ConfigServer ノードの ID。	dds-bp11483712c1****-cs
NodeStorage	integer	ConfigServer ノードのストレージ容量。単位：GB。	20
Status	string	ConfigServer ノードのステータス。詳細については、「インスタンスステータス表」をご参照ください。	Running
CurrentKernelVersion	string	MongoDB ノードの現在のマイナーカーネルバージョン。	mongodb_20220518_4.0.21
ResourceGroupId	string	インスタンスが属するリソースグループの ID。説明このパラメーターは、Alibaba Cloud China Website (www.aliyun.com) のみで返されます。	rg-acfmyiu4ekp****
ZoneId	string	インスタンスのゾーン ID。	cn-hangzhou-b
MaxConnections	integer	インスタンスの最大接続数。	500
DBInstanceId	string	インスタンス ID。	dds-bp11483712c1****
DBInstanceClass	string	インスタンスタイプ。	dds.mongo.mid
Engine	string	データベースエンジン。	MongoDB
ReadonlyReplicas	string	インスタンスの読み取り専用ノード数。	1
ReplicationFactor	string	インスタンス内のノード数。説明このパラメーターは、インスタンスタイプがレプリカセットの場合にのみ返されます。	3
KindCode	string	インスタンスタイプ。有効値： 0：ローカルディスクインスタンス。 3：スタンドアロンインスタンス。 18：クラウドディスクインスタンス。	18
CapacityUnit	string	インスタンスが消費する読み取り/書き込みスループット。	100
ChargeType	string	インスタンスの課金方法。有効値： PrePaid：サブスクリプション。 PostPaid：従量課金。	PostPaid
StorageType	string	ストレージクラス。有効値： cloud_essd1：ESSD PL1 クラウドディスク。 cloud_essd2：ESSD PL2 クラウドディスク。 cloud_essd3：ESSD PL3 クラウドディスク。 local_ssd：SSD ローカルディスク。 cloud_essd_dbfs_s：DBFS 共有ストレージクラウドディスク。	cloud_essd1
DestroyTime	string	インスタンスデータが削除される時刻。形式は yyyy-MM-ddTHH:mm:ssZ（協定世界時 (UTC)）です。	2021-12-10T16:00:00Z
DBInstanceOrderStatus	string	インスタンスに対して生成された注文のステータス。有効値： all_completed：すべての注文が処理中または完了しています。 order_unpaid：未払いの注文があります。 order_wait_for_produce：処理待ちの注文があります。説明注文処理フローには、注文の発注、支払い、製造指示、製造、製造完了が含まれます。注文ステータスが長時間 order_wait_for_produce のままである場合、注文発行プロセスに問題が発生しています。システムは自動的にリトライします。インスタンスステータスは、注文製造中または製造後（例えば、仕様変更時や実行中など）にのみ変更されます。	all_completed
Encrypted	boolean	ディスク暗号化が有効かどうかを示します。	true
EncryptionKey	string	ディスク暗号化に使用される KMS キー。	07609cc3-3109-408f-a35e-c548e776da0b
SyncPercent	string	データ同期の進捗率（パーセント）。インスタンスの仕様変更中は、データ同期などの操作が実行されます。このフィールドを使用して同期の進捗状況をモニターできます。	0.8
UseClusterBackup	boolean	クラスターバックアップモードが有効かどうかを示します。有効値： true：クラスターバックアップモードが有効化されています。 false：クラスターバックアップモードが無効化されています。	true
BurstingEnabled	boolean	バースト性能が有効かどうかを示します。	true
ProvisionedIops	integer	プロビジョニングされたパフォーマンス。	1960
DisasterRecoveryInfo	string	Redis グローバル分散キャッシュのソースインスタンスと宛先インスタンスに関する情報。	{"relations":[{"destInsName":"dds-bp11483712c1**","destRegionId":"cn-hangzhou","srcInsName":"dds-7xv054b9c43c**","srcRegionId":"cn-guangzhou"}]}
SearchNodeClass	string	仕様変更時の Search ノードの仕様。	mdb.shard.2x.xlarge.d
SearchNodeStorage	integer	仕様変更時の Search ノードの容量。	20
SearchNodeCount	integer	仕様変更時の Search ノード数。	2
ColdDataEnabled	boolean
ShardSearchNodes	object
ShardSearchNodes	array<object>
	object
NodeId	string
SearchNodeId	string
SearchNodeClass	string
SearchNodeStorage	string
SearchNodeCount	string
AIGatewayEnabled	boolean

例

成功レスポンス

JSONJSON

{
  "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****",
              "LockMode": "Unlock",
              "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",
              "CurrentKernelVersion": "mongodb_20220518_4.0.21",
              "ConnectString": "s-bp1d8c262a15****.mongodb.rds.aliyuncs.com"
            }
          ]
        },
        "ProtocolType": "mongodb",
        "DBInstanceDescription": "Test database",
        "CurrentKernelVersion": "5.0.5-20220721143518_0",
        "DBInstanceReleaseProtection": false,
        "ExpireTime": "2022-02-05T16:00Z",
        "MaintainStartTime": "18:00Z",
        "DBInstanceType": "replicate",
        "LastDowngradeTime": "2022-01-08",
        "ShardList": {
          "ShardAttribute": [
            {
              "LockMode": "Unlock",
              "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",
              "CurrentKernelVersion": "mongodb_20220518_4.0.21",
              "ReplicaSetName": "mgset-xxxx"
            }
          ]
        },
        "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,
              "LockMode": "Unlock",
              "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",
              "CurrentKernelVersion": "mongodb_20220518_4.0.21"
            }
          ]
        },
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "ZoneId": "cn-hangzhou-b",
        "MaxConnections": 500,
        "DBInstanceId": "dds-bp11483712c1****",
        "DBInstanceClass": "dds.mongo.mid",
        "Engine": "MongoDB",
        "ReadonlyReplicas": "1",
        "ReplicationFactor": "3",
        "KindCode": "18",
        "CapacityUnit": "100",
        "ChargeType": "PostPaid",
        "StorageType": "cloud_essd1",
        "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,
        "DisasterRecoveryInfo": "{\"relations\":[{\"destInsName\":\"dds-bp11483712c1****\",\"destRegionId\":\"cn-hangzhou\",\"srcInsName\":\"dds-7xv054b9c43c****\",\"srcRegionId\":\"cn-guangzhou\"}]}",
        "SearchNodeClass": "mdb.shard.2x.xlarge.d",
        "SearchNodeStorage": 20,
        "SearchNodeCount": 2,
        "ColdDataEnabled": false,
        "ShardSearchNodes": {
          "ShardSearchNodes": [
            {
              "NodeId": "",
              "SearchNodeId": "",
              "SearchNodeClass": "",
              "SearchNodeStorage": "",
              "SearchNodeCount": ""
            }
          ]
        },
        "AIGatewayEnabled": false
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	VpcCloudInstanceIdNumError	Get vpcCloudInstanceId number error.

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

変更履歴

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