すべてのプロダクト
Search

このプロダクト

    Virtual Private Cloud:DescribeVpcs

    ドキュメントセンター

    Virtual Private Cloud:DescribeVpcs

    最終更新日:Jun 19, 2026

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    vpc:DescribeVpcs

    list

    VPC

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

    VPC

    acs:vpc:{#regionId}:{#accountId}:vpc/{#VPCId}
    • vpc:tag
    		 なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    VpcId

    string

    任意

    VPC の ID。

    最大 20 個の VPC ID を指定できます。複数の ID はカンマ (,) で区切ります。

    vpc-bp1b1xjllp3ve5yze****
    RegionId

    string

    必須

    VPC のリージョン ID。

    DescribeRegions 操作を呼び出して、リージョン ID をクエリできます。

    cn-hangzhou
    VpcName

    string

    任意

    VPC の名前。

    Vpc-1
    IsDefault

    boolean

    任意

    指定されたリージョンのデフォルト VPC をクエリするかどうかを指定します。有効な値:

    • true (デフォルト): 指定されたリージョンのデフォルト VPC をクエリします。

    • false: デフォルト VPC をクエリしません。

    false
    DryRun

    boolean

    任意

    ドライランを実行するかどうかを指定します。有効な値:

    • true: ドライランを実行します。システムは、無効な AccessKey ペア、未承認の RAM ユーザー、欠落しているパラメーター値など、リクエストの潜在的な問題をチェックします。チェックが失敗した場合、対応するエラーが返されます。チェックが成功した場合、DryRunOperation エラーコードが返されます。

    • false (デフォルト): 通常のリクエストを送信します。チェックが成功した場合、HTTP 2xx 状態コードが返され、リソースが照会されます。

    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: IPv6 は有効になっていません。

    • true: IPv6 は有効になっています。

    false
    Tag

    array<object>

    任意

    リソースのタグ。

    object

    任意

    タグ。

    Key

    string

    任意

    リソースのタグキー。最大 20 個のタグキーを指定できます。タグキーは空文字列にできません。

    タグキーは最大 128 文字です。aliyun または acs: で始めることはできず、http:// または https:// を含めることはできません。

    FinanceDept
    Value

    string

    任意

    リソースのタグ値。最大 20 個のタグ値を指定できます。タグ値は空文字列にできます。

    タグ値は最大 128 文字です。aliyun または acs: で始めることはできず、http:// または https:// を含めることはできません。

    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 のステータスです。有効値：

    • Pending

    • Available

    Available
    VpcId

    string

    VPC ID です。

    vpc-bp1qpo0kug3a20qqe****
    IsDefault

    boolean

    VPC がそのリージョンのデフォルト VPC であるかどうかを示します。有効値：

    • true

    • false

    false
    OwnerId

    integer

    VPC が属する Alibaba Cloud アカウントの ID です。

    253460731706911258
    RegionId

    string

    VPC が属するリージョンの ID です。

    cn-hangzhou
    VpcName

    string

    VPC の名前です。

    vpc1
    VRouterId

    string

    vRouter の ID です。

    vrt-bp1jcg5cmxjbl9xgc****
    DhcpOptionsSetStatus

    string

    DHCP オプションセットのステータスです。有効値：

    • Available

    • InUse

    • Deleted

    • Pending

    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

    VPC がアタッチされている Cloud Enterprise Network (CEN) インスタンスのステータスです。

    有効値：

    • Attached：VPC は CEN インスタンスにアタッチされています。

    • Detached：VPC は CEN インスタンスにアタッチされていません。

    Attached
    Tags

    object

    Tag

    array<object>

    VPC のタグ情報です。

    object

    Key

    string

    タグ N のキーです。

    FinanceDept
    Value

    string

    タグ N の値です。

    FinanceJoshua
    Ipv6CidrBlocks

    object

    Ipv6CidrBlock

    array<object>

    VPC の IPv6 CIDR ブロックです。

    object

    Ipv6Isp

    string

    IPv6 CIDR ブロックのタイプです。有効値：

    • BGP

    • ChinaMobile

    • ChinaUnicom

    • ChinaTelecom 注意

    説明

    Alibaba Cloud アカウントでシングル ISP 帯域幅のアクティベートが許可されている場合、このパラメーターを ChinaTelecom、ChinaUnicom、または ChinaMobile に設定できます。

    BGP
    Ipv6CidrBlock

    string

    VPC の IPv6 CIDR ブロックです。

    2408:XXXX:0:a600::/56
    VSwitchIds

    object

    VSwitchId

    array

    VPC 内の vSwitch です。

    VPC 内の vSwitch は最大 300 個までクエリできます。最新の vSwitch 情報が返されます。VPC 内のすべての vSwitch 情報をクエリする場合は、 DescribeVSwitches 操作を呼び出してください。

    string

    VPC 内の vSwitch です。

    VPC 内の vSwitch は最大 300 個までクエリできます。最新の vSwitch 情報が返されます。VPC 内のすべての vSwitch 情報をクエリする場合は、 DescribeVSwitches 操作を呼び出してください。

    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 ゲートウェイの ID です。

    string

    インターネット NAT ゲートウェイの ID です。

    nat-245xxxftwt45bg****
    RouterTableIds

    object

    RouterTableIds

    array

    ルートテーブルの情報です。

    string

    ルートテーブルの ID です。

    vtb-bp1krxxzp0c29fmon****
    EnabledIpv6

    boolean

    IPv6 が有効化されているかどうかを示します。

    有効値：

    • false：false

    • true：true

    false
    DnsHostnameStatus

    string

    Domain Name System (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.
    400 InvalidAliuid User Id is not valid.
    400 InvalidResourceGroupId The specified ResourceGroupId does not exist.
    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.
    400 IllegalParam.OwnerId The specified parameter VpcOwnerId is not valid.
    400 InvalidAccount.NotFound The account is invalid.
    500 InternalError The request processing has failed due to some unknown error.

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

    変更履歴

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