DescribeVSwitches で vSwitch を查询 - ENS - Alibaba Cloud - ENS - Alibaba Cloud ドキュメントセンター

VSwitch に関する情報を取得するには、DescribeVSwitches オペレーションを呼び出します。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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ens:DescribeVSwitches

リスト

* すべてのリソース

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
EnsRegionId	文字列	任意	ENS ノードの ID。	cn-xian-unicom
VSwitchId	文字列	任意	VSwitch の ID。	vsw-5m9xhlq8oh***
VSwitchName	文字列	任意	VSwitch の名前。	testVSwitchName
NetworkId	文字列	任意	VSwitch が属する VPC の ID。	vpc-25cdvfeq58pl****
PageNumber	整数	任意	ページ番号。デフォルト値： 1。	1
PageSize	整数	任意	ページあたりのエントリ数。最大値： 50。デフォルト値： 10。	10
▶ EnsRegionIds	配列	任意	ENS ノードの ID。1～100個の ID を指定できます。
EnsRegionId	文字列	任意	ENS ノードの ID。	cn-chengdu-telecom-4
▶ VSwitchIds	配列	任意	VSwitch の ID。1～100個の ID を指定できます。
VSwitchId	文字列	任意	VSwitch の ID。	vsw-5****tzrpf

レスポンスフィールド

フィールド	型	説明	例
	オブジェクト
RequestId	文字列	リクエスト ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageSize	整数	1 ページあたりのエントリ数。	2
PageNumber	整数	ページ番号。	1
TotalCount	整数	エントリの総数。	3
VSwitches	オブジェクト	VSwitch のコレクション。
VSwitch	配列<オブジェクト>	VSwitch オブジェクトの配列。
	オブジェクト	VSwitch オブジェクト。
EnsRegionId	文字列	ENS ノードの ID。	cn-xian-unicom
Status	文字列	VSwitch のステータス。有効な値： `Pending`：ペンディング。 `Available`：アベイラブル。	Pending
FreeIpCount	整数	利用可能な IP アドレス数。	1024
VSwitchId	文字列	VSwitch の ID。	vsw-5m9xhlq8oh***
CidrBlock	文字列	VSwitch の IPv4 CIDR ブロック。	10.21.224.0/22
Description	文字列	VSwitch の説明。	VSwitchDescription
NetworkId	文字列	ネットワークの ID。	vpc-25cdvfeq58pl****
CreatedTime	文字列	VSwitch が作成された時刻。時刻は UTC で表示され、`yyyy-MM-ddTHH:mm:ssZ` フォーマットです。	2020-06-16T06:33:15Z
VSwitchName	文字列	VSwitch の名前。	testVSwitchName
Tags	オブジェクト	VSwitch のタグ。
Tag	配列<オブジェクト>	タグの配列。
	オブジェクト	タグ。
Value	文字列	タグ値。	TestValue
Key	文字列	タグキー。	TestKey
TagValue `非推奨`	文字列	タグ値。	TestValue
TagKey `非推奨`	文字列	タグキー。	TestKey
Ipv6CidrBlock	文字列	VSwitch の IPv6 CIDR ブロック。	2408:XXXX:0:a600::/110

例

成功レスポンス

JSON JSON

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageSize": 2,
  "PageNumber": 1,
  "TotalCount": 3,
  "VSwitches": {
    "VSwitch": [
      {
        "EnsRegionId": "cn-xian-unicom",
        "Status": "Pending",
        "FreeIpCount": 1024,
        "VSwitchId": "vsw-5m9xhlq8oh***",
        "CidrBlock": "10.21.224.0/22",
        "Description": "VSwitchDescription",
        "NetworkId": "vpc-25cdvfeq58pl****",
        "CreatedTime": "2020-06-16T06:33:15Z",
        "VSwitchName": "testVSwitchName",
        "Tags": {
          "Tag": [
            {
              "TagKey": "TestKey",
              "TagValue": "TestValue"
            }
          ]
        },
        "Ipv6CidrBlock": "2408:XXXX:0:a600::/110"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	NoPermission	Permission denied.	アクセス許可がありません。
400	CallInterface	Call Interface Happen Error.	インターフェイスの呼び出し中にエラーが発生しました。
400	ens.interface.error	Failed to call API.	API の呼び出しに失敗しました。
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.	指定されたフィールド %s は無効です。もう一度ご確認ください。

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

変更履歴

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