DescribeVSwitchAttributes で VSwitch 属性をクエリ - ENS - Alibaba Cloud - ENS

DescribeVSwitchAttributes 操作を呼び出して、指定された 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:DescribeVSwitchAttributes

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
VSwitchId	string	必須	vSwitch の ID。	vsw-5****

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	リクエストの ID。	C0003****2A8
EnsRegionId	string	ENS エッジゾーンの ID。	cn-xian-unicom
NetworkId	string	ネットワークの ID。	n-257gqcdfvx6n****
VSwitchName	string	vSwitch の名前。	Test-switch
CidrBlock	string	ネットワークの IPv4 CIDR ブロック。	10.0.0.0/24
Status	string	vSwitch のステータス。有効な値： Pending：vSwitch は設定中です。 Available：vSwitch はアクティブです。 Releasing：vSwitch はリリース中です。	Available
Description	string	vSwitch の説明。	This is my vswitch.
CreatedTime	string	vSwitch が作成された時間。この値は協定世界時 (UTC) を使用し、yyyy-MM-ddTHH:mm:ssZ 形式に従います。	2019-06-01T00:00:00Z
InstanceIds	object
InstanceId	array	インスタンス ID のリスト。
	string	インスタンスの ID。	i-5****4evfn
NetworkInterfaceIds	object
NetworkInterfaceId	array	弾性ネットワークインターフェース ID のリスト。
	string	弾性ネットワークインターフェースの ID。	eni-5****yfjm
LoadBalancerIds	object
LoadBalancerId	array	SLB インスタンス ID のリスト。
	string	SLB インスタンスの ID。	lb-5****
NatGatewayIds	object
NatGatewayId	array	NAT Gateway ID のリスト。
	string	NAT Gateway の ID。	nat-5****
HaVipIds	object
HaVipId	array	高可用性 (HA) VIP インスタンス ID のリスト。
	string	HA VIP インスタンスの ID。	havip-5****
VSwitchId	string	vSwitch の ID。	vsw-5****
AvailableIpAddressCount	integer	vSwitch で利用可能な IP アドレスの数。	253
Ipv6CidrBlock	string		2408:XXXX:0:a600::/110

例

成功レスポンス

JSONJSON

{
  "RequestId": "C0003****2A8",
  "EnsRegionId": "cn-xian-unicom",
  "NetworkId": "n-257gqcdfvx6n****",
  "VSwitchName": "Test-switch",
  "CidrBlock": "10.0.0.0/24",
  "Status": "Available",
  "Description": "This is my vswitch.",
  "CreatedTime": "2019-06-01T00:00:00Z",
  "InstanceIds": {
    "InstanceId": [
      "i-5****4evfn"
    ]
  },
  "NetworkInterfaceIds": {
    "NetworkInterfaceId": [
      "eni-5****yfjm"
    ]
  },
  "LoadBalancerIds": {
    "LoadBalancerId": [
      "lb-5****"
    ]
  },
  "NatGatewayIds": {
    "NatGatewayId": [
      "nat-5****"
    ]
  },
  "HaVipIds": {
    "HaVipId": [
      "havip-5****"
    ]
  },
  "VSwitchId": "vsw-5****",
  "AvailableIpAddressCount": 253,
  "Ipv6CidrBlock": "2408:XXXX:0:a600::/110"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	ens.interface.error	Failed to call API.
400	InvalidVSwitchId.NotFound	Specified virtual switch does not exist.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

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

変更履歴

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