インスタンス概要の照会 - MongoDB

1 つ以上の ApsaraDB for MongoDB インスタンスの概要を照会します。

操作説明

インスタンス ID を指定しない場合、この操作は Alibaba Cloud アカウントの指定されたリージョン内のすべてのインスタンスの概要を返します。
この操作の結果はページ分割されません。

今すぐお試しください

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

list

*Instance

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストを照会します。	cn-hangzhou
InstanceIds	string	任意	概要を照会するインスタンスの ID。説明このパラメーターを指定しない場合、Alibaba Cloud アカウント内のすべてのインスタンスの概要が返されます。複数のインスタンス ID を指定できます。 ID はコンマ (,) で区切ります。	dds-bp12c5b040dc****
InstanceStatus	string	任意	インスタンスのステータス。詳細については、「インスタンスの状態」をご参照ください。	Running
ChargeType	string	任意	インスタンスの課金方法。有効な値: PrePaid: サブスクリプション PostPaid: 従量課金	PostPaid
NetworkType	string	任意	インスタンスのネットワークタイプ。有効な値: Classic: クラシックネットワーク VPC: VPC	Classic
EngineVersion	string	任意	インスタンスのデータベースエンジンバージョン。有効な値: 5.0、4.4、4.2、4.0、および 3.4。	4.0
InstanceClass	string	任意	インスタンスタイプ。さまざまなインスタンスアーキテクチャで使用可能なインスタンスタイプの詳細については、次をご参照ください。スタンドアロンインスタンスタイプレプリカセットインスタンスタイプシャードクラスターインスタンスタイプ	dds.mongo.2xlarge
VpcId	string	任意	VPC の ID。	vpc-bp1nme44gek34slfc****
VSwitchId	string	任意	vSwitch の ID。	vsw-bp1e7clcw529l773d****
InstanceType	string	任意	インスタンスアーキテクチャ。有効な値: sharding: シャードクラスターインスタンス replicate: レプリカセットまたはスタンドアロンインスタンス説明必要に応じてこのパラメーターを設定します。たとえば、シャードクラスターインスタンスの概要を照会するには、このパラメーターを sharding に設定します。このパラメーターを指定しない場合、すべてのインスタンスの概要が返されます。	replicate
ZoneId	string	任意	ゾーンの ID。	cn-hangzhou-b
ResourceGroupId	string	任意	リソースグループの ID。リソースグループの詳細については、「リソースグループの基本情報を表示する」をご参照ください。	rg-acfmyiu4ekp****
ShowTags	boolean	任意	インスタンスのタグを返すかどうかを指定します。デフォルト値は false です。	false

レスポンスフィールド

フィールド	型	説明	例
	object	インスタンスの概要情報。
TotalCount	string	返されたインスタンスの数。	1
RequestId	string	リクエスト ID。	52820D2B-B2DD-59F0-BDF2-83EC19C6F1CA
DBInstances	array<object>	インスタンスの詳細のリスト。
	array<object>	インスタンスの詳細のリスト。
CreationTime	string	インスタンスが作成された時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式です。時刻は UTC です。	2022-01-05T03:18:53Z
ExpireTime	string	サブスクリプションインスタンスの有効期限が切れる時刻。時刻は yyyy-MM-ddTHH:mmZ 形式です。時刻は UTC です。	2022-02-05T16:00Z
Tags	array<object>	インスタンスのタグ。
	object	インスタンスのタグ。
Key	string	タグキー。キーは `aliyun`、`acs:`、`http://`、または `https://` で始めることはできません。キーの長さは最大 64 文字です。キーを空の文字列にすることはできません。	testdatabase
Value	string	タグの値。値は `aliyun`、`acs`:、`http://`、または `https://` で始めることはできません。値の長さは最大 128 文字です。値は空の文字列にすることができます。	apitest
LastDowngradeTime	string	インスタンスが最後にスペックダウンされた時刻。	2021-05-08
ShardList	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
DBInstanceType	string	インスタンスアーキテクチャ。有効な値: sharding: シャードクラスターインスタンス replicate: レプリカセットまたはスタンドアロンインスタンス	replicate
DestroyTime	string	インスタンスのデータが破棄された時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式です。時刻は UTC です。	2021-12-10T16:00:00Z
ChargeType	string	インスタンスの課金方法。有効な値: PrePaid: サブスクリプション PostPaid: 従量課金	PrePaid
CapacityUnit	string	インスタンスの読み取り/書き込みスループット。説明このパラメーターは、サーバーレスインスタンスに対してのみ返されます。サーバーレスインスタンスは、中国サイト (aliyun.com) でのみ利用可能です。	100
VpcAuthMode	string	VPC 経由のパスワードなしのアクセスが有効になっているかどうかを示します。有効な値: Open: 有効 Close: 無効	Open
DBInstanceStatus	string	インスタンスのステータス。詳細については、「インスタンスの状態」をご参照ください。	Running
NetworkType	string	インスタンスのネットワークタイプ。有効な値: Classic: クラシックネットワーク VPC: VPC	VPC
LockMode	string	インスタンスのロックモード。 Unlock: インスタンスはロックされていません。 ManualLock: インスタンスは手動でロックされます。 LockByExpiration: インスタンスは有効期限が切れると自動的にロックされます。 LockByRestoration: インスタンスはロールバックの前に自動的にロックされます。 LockByDiskQuota: インスタンスはストレージ容量がなくなると自動的にロックされます。 Released: インスタンスはリリースされます。リリースされたインスタンスのロックを解除することはできません。インスタンスのデータを新しいインスタンスに復元することしかできません。復元には時間がかかる場合があります。	Unlock
EngineVersion	string	インスタンスのデータベースエンジンバージョン。	4.2
MongosList	array<object>	Mongos ノードの詳細。説明このパラメーターは、シャードクラスターインスタンスに対してのみ返されます。
	object	Mongos ノードの詳細。説明このパラメーターは、シャードクラスターインスタンスに対してのみ返されます。
NodeClass	string	Mongos ノードのインスタンスタイプ。	dds.mongos.standard
NodeDescription	string	Mongos ノードの説明。	测试mongos节点
NodeId	string	Mongos ノードの ID。	s-bp10e3b0d02f****
RegionId	string	インスタンスのリージョン ID。	cn-hangzhou
DBInstanceStorage	integer	インスタンスのストレージ容量 (GB)。	20
ResourceGroupId	string	インスタンスが属するリソースグループの ID。	rg-acfm22cdcgc****
ZoneId	string	インスタンスのゾーン。	cn-hangzhou-i
DBInstanceId	string	インスタンス ID。	dds-bp12c5b040dc****
DBInstanceClass	string	インスタンスタイプ。さまざまなインスタンスアーキテクチャで使用可能なインスタンスタイプの詳細については、次をご参照ください。スタンドアロンインスタンスタイプレプリカセットインスタンスタイプシャードクラスターインスタンスタイプ	dds.mongo.mid
Engine	string	データベースエンジン。値は MongoDB です。	MongoDB
ReplicationFactor	string	インスタンス内のノードの数。説明このパラメーターは、レプリカセットインスタンスに対してのみ返されます。	3
DBInstanceDescription	string	インスタンスの説明。	Test database
KindCode	string	インスタンスのエディション。有効な値: 0: 物理サーバ 1: ECS 2: DOCKER 18: 新しい Kubernetes ベースのアーキテクチャ上のインスタンス	0

例

成功レスポンス

JSONJSON

{
  "TotalCount": "1",
  "RequestId": "52820D2B-B2DD-59F0-BDF2-83EC19C6F1CA",
  "DBInstances": [
    {
      "CreationTime": "2022-01-05T03:18:53Z",
      "ExpireTime": "2022-02-05T16:00Z",
      "Tags": [
        {
          "Key": "testdatabase",
          "Value": "apitest"
        }
      ],
      "LastDowngradeTime": "2021-05-08",
      "ShardList": [
        {
          "NodeClass": "dds.shard.mid",
          "NodeDescription": "测试shard节点",
          "NodeStorage": 10,
          "NodeId": "d-bp1cac6f2083****",
          "ReadonlyReplicas": 2
        }
      ],
      "DBInstanceType": "replicate",
      "DestroyTime": "2021-12-10T16:00:00Z",
      "ChargeType": "PrePaid",
      "CapacityUnit": "100",
      "VpcAuthMode": "Open",
      "DBInstanceStatus": "Running",
      "NetworkType": "VPC",
      "LockMode": "Unlock",
      "EngineVersion": "4.2",
      "MongosList": [
        {
          "NodeClass": "dds.mongos.standard",
          "NodeDescription": "测试mongos节点",
          "NodeId": "s-bp10e3b0d02f****"
        }
      ],
      "RegionId": "cn-hangzhou",
      "DBInstanceStorage": 20,
      "ResourceGroupId": "rg-acfm22cdcgc****",
      "ZoneId": "cn-hangzhou-i",
      "DBInstanceId": "dds-bp12c5b040dc****",
      "DBInstanceClass": "dds.mongo.mid",
      "Engine": "MongoDB",
      "ReplicationFactor": "3",
      "DBInstanceDescription": "Test database",
      "KindCode": "0"
    }
  ]
}

エラーコード

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

変更履歴

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