DescribeVpcsForMongoDB で MongoDB インスタンスの VPC を一覧表示 - MongoDB - Alibaba Cloud - ApsaraDB for MongoDB

VPC のページネーションリストを取得します。

今すぐお試しください

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

list

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID。	cn-hangzhou
ZoneId	string	任意	ゾーン ID。	cn-hangzhou-h
PageNumber	integer	任意	ページ番号。値は 0 より大きく、Integer データの型の最大値以下である必要があります。デフォルト値: 1。	1
PageSize	integer	任意	1 ページあたりのレコード数。値は 0 より大きく、Integer データの型の最大値以下である必要があります。デフォルト値: 50。	10
ResourceGroupId	string	任意	リソースグループの ID。	rg-acfmyiu4ekp****

レスポンスフィールド

フィールド	型	説明	例
	object
TotalCount	integer	レコードの総数。	4
Vpcs	array<object>	VPC のリスト。
	array<object>
Status	string	VPC のステータス。Available は、VPC が利用可能であることを示します。	Available
VpcName	string	VPC の名前。	vpc-name
VpcId	string	VPC の ID。	vpc-2zep2pepkthg5ueal****
IsDefault	boolean	VPC がデフォルト VPC であるかどうかを示します。有効な値: true: はい。 false: いいえ。列挙値: true : true。 false : false。	true
CidrBlock	string	VPC の CIDR ブロック。	10...**/24
RegionNo	string	リージョン ID。	cn-hangzhou
GmtCreate	string	このパラメーターは非推奨であり、値は返されません。	null
AliUid	string	このパラメーターは非推奨であり、値は返されません。	null
VSwitchs	array<object>	vSwitch のリスト。
	object
Status	string	vSwitch のステータス。Available は、vSwitch が利用可能であることを示します。	Available
VSwitchId	string	vSwitch の ID。	vsw-bp*******************
IsDefault	boolean	vSwitch がデフォルト vSwitch であるかどうかを示します。有効な値: true: vSwitch はデフォルト vSwitch です。 false: vSwitch はデフォルト vSwitch ではありません。列挙値: true : true。 false : false。	true
CidrBlock	string	vSwitch の CIDR ブロック。	10...**/28
GmtCreate	string	このパラメーターは非推奨であり、値は返されません。	null
GmtModified	string	このパラメーターは非推奨であり、値は返されません。	null
IzNo	string	vSwitch が属するゾーン。	cn-hangzhou-i
VSwitchName	string	vSwitch の名前。	vsw-name
GmtModified	string	このパラメーターは非推奨であり、値は返されません。	null
Bid	string	このパラメーターは非推奨であり、値は返されません。	null
RequestId	string	リクエストの ID。	53924AF0-1628-5AA2-9C95-D4**********
PageSize	integer	1 ページあたりのレコード数。	10
PageNumber	integer	ページ番号。	1

例

成功レスポンス

JSONJSON

{
  "TotalCount": 4,
  "Vpcs": [
    {
      "Status": "Available",
      "VpcName": "vpc-name",
      "VpcId": "vpc-2zep2pepkthg5ueal****",
      "IsDefault": true,
      "CidrBlock": "10.**.**.**/24",
      "RegionNo": "cn-hangzhou",
      "GmtCreate": "null",
      "AliUid": "null",
      "VSwitchs": [
        {
          "Status": "Available",
          "VSwitchId": "vsw-bp*******************",
          "IsDefault": true,
          "CidrBlock": "10.**.**.**/28",
          "GmtCreate": "null",
          "GmtModified": "null",
          "IzNo": "cn-hangzhou-i",
          "VSwitchName": "vsw-name"
        }
      ],
      "GmtModified": "null",
      "Bid": "null"
    }
  ],
  "RequestId": "53924AF0-1628-5AA2-9C95-D4**********",
  "PageSize": 10,
  "PageNumber": 1
}

エラーコード

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

変更履歴

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