すべてのプロダクト
Search
ドキュメントセンター

:vSwitchに関する詳細なクエリ

最終更新日:Mar 07, 2025

DescribeVSwitch操作を呼び出して、仮想プライベートクラウド (VPC) に属するvSwitchの詳細を照会できます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

項目 データ型 必須/任意 例: 説明 
操作 String 必須 DescribeVSwitches

実行する操作です。 値をDescribeVSwitchに設定します。

RegionId String 任意 cn-hangzhou

vSwitchが属するリージョンのID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

VpcId String 任意 vpc-bp1opxu1zkhn **********

vSwitchが属するVPCのID。

説明 このパラメーターまたはDedicatedHostGroupIdパラメーターを指定する必要があります。
ZoneId String 任意 cn-hangzhou-i

vSwitchが属するゾーンのID。 DescribeAvailableZones操作を呼び出して、ゾーンのIDを照会できます。 このパラメーターを指定すると、このパラメーターの値に基づいてクエリ結果がフィルターされ、指定されたゾーンにデプロイされているvSwitchに関する詳細のみが返されます。

DedicatedHostGroupId String 任意 dhg-7a9 ********

専用クラスターのID。 DescribeDedicatedHostGroups操作を呼び出して、専用クラスターのIDを照会できます。 このパラメーターを指定すると、専用クラスターが属するVPC内のすべてのvSwitchに関する詳細が返されます。

説明 このパラメーターまたはVpcIdパラメーターを指定する必要があります。
PageNumber Integer いいえ 1

返されるページ数。 既定値:1

PageSize Integer いいえ 30

各ページで返されるエントリ数。 設定可能な値は、1 から 50 です 。 デフォルト値: 30

ResourceGroupId String 任意 rg-bp67acfmxazb4p****

リソースグループの ID です。

レスポンスパラメーター

項目 データ型 例: 説明 
RequestId String 8A68AEA1-AFBD-53F8-9BBB-06555EAE5C0E

リクエストの ID です。

TotalCount Integer 2

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

PageNumber Integer 1

返されたページ数。

PageSize Integer 30

返された各ページのエントリ数を示します。 このパラメーターの値は、リクエストパラメーターのPageSizeパラメーターの値と同じです。

VSwitchs VSwitchの配列

vSwitchの詳細。

CidrBlock String 172.16.0.0/24

vSwitchのCIDRブロック。

説明  String VSwitchDescription

vSwitchの説明。

IsDefault ブール 真実

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

  • true: vSwitchはデフォルトのvSwitchです。
  • false: vSwitchはデフォルトのvSwitchではありません。
IzNo String cn-hangzhou

vSwitchが属するゾーンのID。

Status String Available

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

  • Pending: vSwitchは設定中です。
  • 使用可能: vSwitchは使用可能です。
VSwitchId String vsw-bp1pnaz94xc **********

vSwitchのID

VSwitchName String test

vSwitchの名前。

リクエストの例

http(s):// rds.aliyuncs.com/?Action=DescribeVSwitches
&ResourceOwnerId=0
&RegionId=cn-hangzhou
&VpcId=vpc-bp1opxu1zkhn **********
&ZoneId=cn-hangzhou-h
&PageNumber=1
&PageSize=30
&共通リクエストパラメータ

正常に処理された場合のレスポンス例

XML 形式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeVSwitchesResponse>
    <VSwitchs>
        <IsDefault> false </ IsDefault>
        <Status>Active</Status>
        <IzNo>cn-hangzhou-h</IzNo>
        <説明/>
        <VSwitchId>vsw-bp1pnaz94xc **********</VSwitchId>
        <CidrBlock>192.168.0.1/24</CidrBlock>
        <VSwitchName> テスト </VSwitchName>
    </VSwitchs>
    <VSwitchs>
        <IsDefault>true</IsDefault>
        <Status>Active</Status>
        <IzNo>cn-hangzhou-h</IzNo>
        <説明> システムが作成したデフォルトの仮想スイッチ。</Description>
        <VSwitchId>vsw-bp10aqj6o4l **********</VSwitchId>
        <CidrBlock>172.16.0.1/20</CidrBlock>
        <VSwitchName/>
    </VSwitchs>
    <TotalCount> 2 </ TotalCount>
    <RequestId>A5362A78-1B78-53D7-AFBA-E375D9C26F2F</RequestId>
    <PageSize>30</PageSize>
    <PageNumber>1</PageNumber>
</DescribeVSwitchesResponse>

JSON 形式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "VSwitchs" : [ {
    "IsDefault" : false、
    "ステータス" : "利用可能" 、
    "IzNo" : "cn-hangzhou-h" 、
    "Description" : "" 、
    "VSwitchId" : "vsw-bp1pnaz94xc **********" 、
    "CidrBlock" : "192.168.0.1/24" 、
    "VSwitchName" : "test"
  }, {
    "IsDefault" : true、
    "ステータス" : "利用可能" 、
    "IzNo" : "cn-hangzhou-h" 、
    "Description" : "システムが作成したデフォルトの仮想スイッチ" 、
    "VSwitchId" : "vsw-bp10aqj6o4l **********" 、
    "CidrBlock" : "172.16.0.1/20" 、
    "VSwitchName" : "
  } ],
  "TotalCount" : 2,
  "RequestId" : "A5362A78-1B78-53D7-AFBA-E375D9C26F2F" 、
  "PageSize" : 30、
  "PageNumber" : 1
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明 
400 InvalidVSwitchId.NotFound Specified virtual switch is not found in specified VPC. VPCで使用可能なvSwitchがない場合に返されるエラーメッセージ。
400 IncorrectttVpcId 指定されたパラメーターVPCIdは無効です。 VpcIdパラメーターの値が無効な場合に返されるエラーメッセージ。 VpcIdパラメーターに有効な値を指定します。
400 InvalidIzNo.NotSupported 指定されたVPCゾーンはサポートされていません。 ゾーンが指定されたVPCでサポートされていない場合に返されるエラーメッセージ。 有効なゾーンIDを指定して、もう一度お試しください。

エラーコードリストについては、「API エラーセンター」をご参照ください。