DescribeVSwitches - Elastic Compute Service - Alibaba Cloud ドキュメントセンター

DescribeVSwitches

説明

この API は廃止されました。一時的にアクセス可能ですが、更新やバグ修正対応は一切行われません。代わりに Vpc(2016-04-28) - DescribeVSwitches への移行を推奨します。より強化された機能に加え、サポートも引き続きご利用いただけます。

今すぐお試しください

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

get

*All Resource

*

vpc:VPC

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
VpcId	string	任意	VPC の ID。
VSwitchId	string	任意	vSwitch の ID。
ZoneId	string	任意	ゾーンの ID。
RegionId	string	任意	vSwitch が属するリージョンの ID。最新のリージョン一覧を照会するには、DescribeRegions API を呼び出します。
IsDefault	boolean	任意	vSwitch がゾーンのデフォルト vSwitch かどうかを指定します。有効な値： `true` `false`
PageNumber	integer	任意	返すページ番号。デフォルト値：1。
PageSize	integer	任意	各ページで返すエントリ数。有効な値：1～50。デフォルト値：10。

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスデータです。
PageSize	integer	ページサイズです。
RequestId	string	リクエスト ID です。
PageNumber	integer	ページ番号です。
TotalCount	integer	総数です。
VSwitches	object	VSwitch のコレクションです。
VSwitch	array<object>	VSwitch の詳細の配列です。
	object	1 つの VSwitch の詳細です。
CreationTime	string	VSwitch が作成された日時です。時刻は `YYYY-MM-DDThh:mm:ssZ` の ISO 8601 フォーマットで表示されます。
Status	string	VSwitch のステータスです。有効な値： Pending Available
VpcId	string	VSwitch が属する VPC の ID です。
IsDefault	boolean	VSwitch がゾーンのデフォルト VSwitch かどうかを示します。有効な値： true false
VSwitchId	string	VSwitch の ID です。
CidrBlock	string	VSwitch の IPv4 CIDR ブロックです。
Description	string	VSwitch の説明です。
AvailableIpAddressCount	integer	VSwitch で利用可能な IP アドレス数です。
ResourceGroupId	string	VSwitch が属するリソースグループの ID です。
ZoneId	string	VSwitch が属するゾーンの ID です。
VSwitchName	string	VSwitch の名前です。

例

成功レスポンス

JSONJSON

{
  "PageSize": 0,
  "RequestId": "",
  "PageNumber": 0,
  "TotalCount": 0,
  "VSwitches": {
    "VSwitch": [
      {
        "CreationTime": "",
        "Status": "",
        "VpcId": "",
        "IsDefault": false,
        "VSwitchId": "",
        "CidrBlock": "",
        "Description": "",
        "AvailableIpAddressCount": 0,
        "ResourceGroupId": "",
        "ZoneId": "",
        "VSwitchName": ""
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	Forbidden.VpcNotFound	Specified VPC can not found.
400	IellgalParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.
400	OperationFailed.Endpoint	The specified RegionId is unavailable for this endpoint.
400	Mismatch.InstanceIdAndRegionId	The instanceId and regionId are mismatched.
404	InvalidVSwitchId.NotFound	VSwitch not exist.
404	InvalidVpcIdNumber.NotSupported	The number of vpcIds exceeds the limit.
404	InvalidVSwitchIdNumber.NotSupported	The number of vSwitchIds exceeds the limit.

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

変更履歴

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