DescribeVpcs - Virtual Private Cloud - Alibaba Cloud ドキュメントセンター

作成済みの VPC を照会します。

操作説明

DescribeVpcs 操作は、頻繁なディープページングまたはページスキップ中に Throttling.DeepPageSkip エラーコードを返す場合があります。クエリの周波数を下げるか、順次ページングを使用してください。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

vpc:DescribeVpcs

list

VPC。

acs:vpc:{#regionId}:{#accountId}:vpc/*

VPC。

acs:vpc:{#regionId}:{#accountId}:vpc/{#VPCId}

vpc:tag

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
VpcId	string	任意	VPC の ID。	vpc-bp1b1xjllp3ve5yze****
RegionId	string	必須	VPC のリージョン ID。	cn-hangzhou
VpcName	string	任意	VPC の名前。	Vpc-1
IsDefault	boolean	任意	指定されたリージョンのデフォルト VPC をクエリするかどうかを指定します。有効な値:	false
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効な値:	false
ResourceGroupId	string	任意	VPC が属するリソースグループの ID。	rg-acfmxvfvazb4p****
PageNumber	integer	任意	ページ番号。デフォルト値: 1。	1
PageSize	integer	任意	ページングクエリにおける 1 ページあたりのエントリ数。最大値: 50。デフォルト値: 10。	10
VpcOwnerId	integer	任意	VPC を所有する Alibaba Cloud アカウントの ID。	253460731706911258
DhcpOptionsSetId	string	任意	DHCP オプションセットの ID。	dopt-o6w0df4epg9zo8isy****
EnableIpv6	boolean	任意	指定されたリージョンで IPv6 CIDR ブロックが有効になっている VPC をクエリするかどうかを指定します。デフォルト値は空で、IPv6 の有効化に基づいてフィルタリングが行われないことを意味します。有効な値:	false
Tag	array<object>	任意	リソースのタグ。
	object	任意	タグ。
Key	string	任意	リソースのタグキー。最大 20 個のタグキーを指定できます。タグキーを空文字列にすることはできません。	FinanceDept
Value	string	任意	リソースのタグ値。最大 20 個のタグ値を指定できます。タグ値は空文字列にできます。	FinanceJoshua

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
PageSize	integer	ページングクエリにおける 1 ページあたりのエントリ数。	10
RequestId	string	リクエスト ID。	C6532AA8-D0F7-497F-A8EE-094126D441F5
PageNumber	integer	ページ番号。	1
TotalCount	integer	返されるエントリの総数。	2
Vpcs	object
Vpc	array<object>	VPC の詳細。
	array<object>	VPC の詳細。
CreationTime	string	VPC が作成された時間。	2021-04-18T15:02:37Z
Status	string	VPC のステータス。有効な値:	Available
VpcId	string	VPC の ID。	vpc-bp1qpo0kug3a20qqe****
IsDefault	boolean	VPC がリージョン内のデフォルト VPC であるかどうかを示します。有効な値:	false
OwnerId	integer	VPC を所有する Alibaba Cloud アカウントの ID。	253460731706911258
RegionId	string	VPC のリージョン ID。	cn-hangzhou
VpcName	string	VPC の名前。	vpc1
VRouterId	string	VPC 内の vRouter の ID。	vrt-bp1jcg5cmxjbl9xgc****
DhcpOptionsSetStatus	string	DHCP オプションセットのステータス。有効な値:	Available
CidrBlock	string	VPC の IPv4 CIDR ブロック。	192.168.0.0/16
Description	string	VPC の説明。	This is my VPC
ResourceGroupId	string	VPC が属するリソースグループの ID。	rg-acfmxazb4ph****
DhcpOptionsSetId	string	DHCP オプションセットの ID。	dopt-o6w0df4epg9zo8isy****
Ipv6CidrBlock	string	VPC の IPv6 CIDR ブロック。	2408:XXXX:0:a600::/56
CenStatus	string	Cloud Enterprise Network (CEN) インスタンスに接続されている VPC のステータス。VPC が CEN インスタンスに接続されている場合にのみ Attached が返されます。	Attached
Tags	object
Tag	array<object>	VPC のタグ情報。
	object	VPC のタグ情報。
Key	string	VPC のタグキー。	FinanceDept
Value	string	VPC のタグ値。	FinanceJoshua
Ipv6CidrBlocks	object
Ipv6CidrBlock	array<object>	VPC の IPv6 CIDR ブロック情報。
	object	VPC の IPv6 CIDR ブロック情報。
Ipv6Isp	string	VPC の IPv6 CIDR ブロックのタイプ。有効な値:	BGP
Ipv6CidrBlock	string	VPC の IPv6 CIDR ブロック。	2408:XXXX:0:a600::/56
VSwitchIds	object
VSwitchId	array	クエリされた VPC 内の vSwitch のリスト。
	string	クエリされた VPC 内の vSwitch のリスト。	vsw-bp1nhbnpv2blyz8dl****
SecondaryCidrBlocks	object
SecondaryCidrBlock	array	セカンダリ CIDR ブロック情報。
	string	VPC のセカンダリ CIDR ブロック。	192.168.20.0/24
UserCidrs	object
UserCidr	array	ユーザー側 CIDR ブロックのリスト。
	string	ユーザー側 CIDR ブロックのリスト。	10.0.0.0/8
NatGatewayIds	object
NatGatewayIds	array	NAT Gateway の ID。
	string	NAT Gateway の ID。	nat-245xxxftwt45bg****
RouterTableIds	object
RouterTableIds	array	ルートテーブル情報。
	string	ルートテーブル ID。	vtb-bp1krxxzp0c29fmon****
EnabledIpv6	boolean	IPv6 が有効かどうかを示します。有効な値:	false
DnsHostnameStatus	string	DNS ホスト名が有効かどうかを示します。	DISABLED

例

成功レスポンス

JSONJSON

{
  "PageSize": 10,
  "RequestId": "C6532AA8-D0F7-497F-A8EE-094126D441F5",
  "PageNumber": 1,
  "TotalCount": 2,
  "Vpcs": {
    "Vpc": [
      {
        "CreationTime": "2021-04-18T15:02:37Z",
        "Status": "Available",
        "VpcId": "vpc-bp1qpo0kug3a20qqe****",
        "IsDefault": false,
        "OwnerId": 253460731706911260,
        "RegionId": "cn-hangzhou",
        "VpcName": "vpc1",
        "VRouterId": "vrt-bp1jcg5cmxjbl9xgc****",
        "DhcpOptionsSetStatus": "Available",
        "CidrBlock": "192.168.0.0/16",
        "Description": "This is my VPC",
        "ResourceGroupId": "rg-acfmxazb4ph****",
        "DhcpOptionsSetId": "dopt-o6w0df4epg9zo8isy****",
        "Ipv6CidrBlock": "2408:XXXX:0:a600::/56",
        "CenStatus": "Attached",
        "Tags": {
          "Tag": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        },
        "Ipv6CidrBlocks": {
          "Ipv6CidrBlock": [
            {
              "Ipv6Isp": "BGP",
              "Ipv6CidrBlock": "2408:XXXX:0:a600::/56"
            }
          ]
        },
        "VSwitchIds": {
          "VSwitchId": [
            "vsw-bp1nhbnpv2blyz8dl****"
          ]
        },
        "SecondaryCidrBlocks": {
          "SecondaryCidrBlock": [
            "192.168.20.0/24"
          ]
        },
        "UserCidrs": {
          "UserCidr": [
            "10.0.0.0/8"
          ]
        },
        "NatGatewayIds": {
          "NatGatewayIds": [
            "nat-245xxxftwt45bg****"
          ]
        },
        "RouterTableIds": {
          "RouterTableIds": [
            "vtb-bp1krxxzp0c29fmon****"
          ]
        },
        "EnabledIpv6": false,
        "DnsHostnameStatus": "DISABLED"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidVpcIdNumber.NotSupported	The number of vpcIds exceeds the limit.	VPC ID の数が上限を超えています。
400	InvalidAliuid	User Id is not valid.
400	InvalidResourceGroupId	The specified ResourceGroupId does not exist.	リソースグループ ID が存在しません。
400	InvalidTagKey	The tag keys are not valid.	タグインデックスが無効です。
400	InvalidTagValue	The tag values are not valid.	タグ値が無効です。
400	InvalidResourceGroupId.NotFound	The Specified ResourceGroupId not exists.
400	OperationUnsupported.ResourceGroupId	%s
400	IellgalParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.	指定された OwnerAccount パラメーターが無効です。
400	IllegalParam.OwnerId	The specified parameter VpcOwnerId is not valid.
400	InvalidAccount.NotFound	The account is invalid.	無効な呼び出しアカウントが使用されたため、操作は失敗した状態です。
400	Throttling.DeepPageSkip	Deep page skip throttled. Please reduce the page skip frequency or use sequential pagination.	ディープページネーションのページスキップのレート制限がトリガーされました。ディープページネーションのページスキップの頻度を下げるか、順次ページネーションを使用してください。
400	Duplicated.TagKey	The specified parameter TagKey is duplicated.	指定された TagKey パラメーターが重複しています。
500	InternalError	The request processing has failed due to some unknown error.

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

変更履歴

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