すべてのプロダクト
Search

このプロダクト

    Virtual Private Cloud:DescribeVSwitches

    ドキュメントセンター

    Virtual Private Cloud:DescribeVSwitches

    最終更新日:Jul 22, 2026

    ネットワーク情報を照会します。内部ネットワークは vSwitch によって構成されます。

    今すぐお試しください

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

    list

    *VSwitch。

    acs:vpc:{#regionId}:{#accountId}:vswitch/*
    • vpc:VPC
    		 なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    VpcId

    string

    任意

    vSwitch が属する VPC の ID。

    説明

    RegionId または VpcId パラメーターのいずれか一方以上を指定してください。

    vpc-25cdvfeq58pl****
    VSwitchId

    string

    任意

    クエリ対象の vSwitch の ID。

    vsw-23dscddcffvf3****
    ZoneId

    string

    任意

    vSwitch が属するゾーンの ID。 DescribeZones 操作を呼び出してゾーン ID をクエリできます。

    cn-hangzhou-d。
    RegionId

    string

    任意

    vSwitch が属するリージョンの ID。 DescribeRegions 操作を呼び出してリージョン ID をクエリできます。

    説明

    RegionId または VpcId パラメーターのいずれか一方以上を指定してください。

    cn-hangzhou。
    VSwitchName

    string

    任意

    vSwitch の名前。

    名前は 1～128 文字で、http:// または https:// で始まることはできません。

    vSwitch。
    DryRun

    boolean

    任意

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

    • true: ドライランを実行します。システムは必須パラメーター、リクエスト構文、およびビジネス制限を確認します。ドライランに失敗した場合、対応するエラーが返されます。ドライランに成功した場合、エラーコード DryRunOperation が返されます。

    • false (デフォルト): ドライランを実行し、リクエストを送信します。ドライランに成功した場合、HTTP 2xx 状態コードが返され、操作が実行されます。

    true。
    IsDefault

    boolean

    任意

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

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

    • false: 指定されたリージョンのデフォルト vSwitch をクエリしません。

    このパラメーターを指定しない場合、システムは指定されたリージョン内のすべての vSwitch をクエリします。

    true。
    RouteTableId

    string

    任意

    ルートテーブルの ID。

    vtb-bp145q7glnuzdvzu2****
    ResourceGroupId

    string

    任意

    vSwitch が属するリソースグループの ID。

    rg-bp67acfmxazb4ph****
    PageNumber

    integer

    任意

    ページ番号。デフォルト値: 1。

    1
    PageSize

    integer

    任意

    ページング時の 1 ページあたりのエントリ数。最大値: 50。デフォルト値: 10。

    10
    VSwitchOwnerId

    integer

    任意

    リソース所有権の Alibaba Cloud アカウント ID。

    2546073170691****
    EnableIpv6

    boolean

    任意

    指定されたリージョンで IPv6 CIDR ブロックが有効になっている vSwitch をクエリするかどうかを指定します。有効な値:

    • true: 指定されたリージョンで IPv6 CIDR ブロックが有効になっている vSwitch をクエリします。

    • false: 指定されたリージョンで IPv6 CIDR ブロックが有効になっている vSwitch をクエリしません。

    このパラメーターを指定しない場合、システムは指定されたリージョン内のすべての vSwitch をクエリします。

    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。

    9A572171-4E27-40D1-BD36-D26C9E71E29E
    PageNumber

    integer

    ページ番号。

    1
    TotalCount

    integer

    返されるエントリの総数。

    1
    VSwitches

    object

    VSwitch

    array<object>

    vSwitch の詳細。

    array<object>

    vSwitch 構造体。

    VpcId

    string

    vSwitch が属する VPC の ID。

    vpc-257gcdcdq64****
    Status

    string

    vSwitch のステータス。有効な値:

    • Pending: 設定中。

    • Available: 利用可能。

    Available
    CreationTime

    string

    vSwitch が作成された時間。

    2022-01-18T12:43:57Z
    IsDefault

    boolean

    vSwitch がデフォルト vSwitch であるかどうかを示します。有効な値:

    • true: vSwitch はデフォルト vSwitch です。

    • false: vSwitch はデフォルト vSwitch ではありません。

    true
    AvailableIpAddressCount

    integer

    vSwitch で利用可能な IP アドレスの数。

    1
    NetworkAclId

    string

    ネットワーク ACL の ID。

    nacl-a2do9e413e0spzasx****
    OwnerId

    integer

    リソース所有権の Alibaba Cloud アカウント ID。

    25346073170691****
    VSwitchId

    string

    vSwitch の ID。

    vsw-25bcdxs7pv1****
    CidrBlock

    string

    vSwitch の IPv4 CIDR ブロック。

    172.16.0.0/24
    Description

    string

    vSwitch の説明。

    VSwitchDescription
    ResourceGroupId

    string

    vSwitch が属するリソースグループの ID。

    rg-acfmxazb4ph6aiy****
    ZoneId

    string

    vSwitch が属するゾーン。

    cn-hangzhou-d
    Ipv6CidrBlock

    string

    vSwitch の IPv6 CIDR ブロック。

    2408:4002:10c4:4e03::/64
    VSwitchName

    string

    vSwitch の名前。

    vSwitch
    ShareType

    string

    vSwitch の共有タイプ。

    • 値が空の場合、vSwitch はプライベート仮想スイッチです。

    • 値が Shared の場合、vSwitch は共有 vSwitch です。

    • 値が Sharing の場合、vSwitch は他のユーザーと共有されています。

    Shared
    EnabledIpv6

    boolean

    vSwitch で IPv6 CIDR ブロックが有効かどうかを示します。有効な値:

    • true: 有効。

    • false: 無効。

    true
    Tags

    object

    Tag

    array<object>

    vSwitch のタグ情報。

    object

    タグ情報構造体。

    Key

    string

    vSwitch のタグキー。

    department
    Value

    string

    vSwitch のタグ値。

    dev
    RouteTable

    object

    ルートテーブル情報。

    RouteTableId

    string

    vSwitch に関連付けられているルートテーブルの ID。

    vrt-bp145q7glnuzdv****
    RouteTableType

    string

    vSwitch に関連付けられているルートテーブルのタイプ。有効な値:

    • System: システムルートテーブル。

    • Custom: カスタムルートテーブル。

    System

    例

    成功レスポンス

    JSONJSON

    {
  "PageSize": 10,
  "RequestId": "9A572171-4E27-40D1-BD36-D26C9E71E29E",
  "PageNumber": 1,
  "TotalCount": 1,
  "VSwitches": {
    "VSwitch": [
      {
        "VpcId": "vpc-257gcdcdq64****",
        "Status": "Available",
        "CreationTime": "2022-01-18T12:43:57Z",
        "IsDefault": true,
        "AvailableIpAddressCount": 1,
        "NetworkAclId": "nacl-a2do9e413e0spzasx****",
        "OwnerId": 0,
        "VSwitchId": "vsw-25bcdxs7pv1****",
        "CidrBlock": "172.16.0.0/24",
        "Description": "VSwitchDescription",
        "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
        "ZoneId": "cn-hangzhou-d",
        "Ipv6CidrBlock": "2408:4002:10c4:4e03::/64",
        "VSwitchName": "vSwitch",
        "ShareType": "Shared",
        "EnabledIpv6": true,
        "Tags": {
          "Tag": [
            {
              "Key": "department",
              "Value": "dev"
            }
          ]
        },
        "RouteTable": {
          "RouteTableId": "vrt-bp145q7glnuzdv****",
          "RouteTableType": "System"
        }
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 Forbidden.VpcNotFound Specified VPC can not found. 指定された VPC は存在しません。
    400 InvalidTagKey The tag keys are not valid. タグインデックスが無効です。
    400 InvalidTagValue The tag values are not valid. タグ値が無効です。
    400 IellgalParameter.OwnerAccount The specified parameter OwnerAccount is not valid. 指定された OwnerAccount パラメーターが無効です。
    400 IllegalParam.OwnerId The specified parameter VSwitchOwnerId is not valid.
    400 InvalidVpcIdNumber.NotSupported The number of vpcIds exceeds the limit. VPC ID の数が上限を超えています。
    400 InvalidVSwitchIdNumber.NotSupported The number of vSwitchIds exceeds the limit.
    400 Throttling.DeepPageSkip Deep page skip throttled. Please reduce the page skip frequency or use sequential pagination. ディープページネーションのスキップ数が速度制限を引き起こしました。ディープページネーションのスキップ頻度を下げるか、順次ページネーションを使用してください。
    404 InvalidVSwitchId.NotFound VSwitch not exist.

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

    変更履歴

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