DescribeVSwitchAttributes - Virtual Private Cloud - Alibaba Cloud ドキュメントセンター

指定された 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:DescribeVSwitchAttributes

get

*VSwitch。

acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
VSwitchId	string	必須	照会する vSwitch の ID。	vsw-25naue4g****
RegionId	string	任意	ルートテーブルが属する VPC のリージョン ID。 DescribeRegions 操作を呼び出してリージョン ID を照会できます。	cn-hangzhou
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効な値: true: vSwitch の構成を照会せずにドライランを実行します。システムは必須パラメーター、リクエストフォーマット、およびサービス制限をチェックします。チェックが失敗した場合、対応するエラーが返されます。チェックが成功した場合、エラーコード DryRunOperation が返されます。 false (デフォルト): ドライランを実行し、リクエストを送信します。リクエストがチェックに合格すると、HTTP 2xx 状態コードが返され、vSwitch の構成が照会されます。	false

レスポンスフィールド

フィールド	型	説明	例
	object	vSwitch の詳細。
VpcId	string	vSwitch が属する VPC の ID。	vpc-257gq642n****
Status	string	vSwitch のステータス。有効な値: Pending: 設定中。 Available: アクティブな。	Pending
CreationTime	string	vSwitch が作成された時間。	2021-08-22T10:40:25Z
IsDefault	boolean	vSwitch がデフォルト vSwitch であるかどうかを示します。有効な値: true: vSwitch はデフォルト vSwitch です。 false: vSwitch はデフォルト vSwitch ではありません。	false
AvailableIpAddressCount	integer	利用可能な IP アドレス数。	12
NetworkAclId	string	ネットワーク ACL ルール。	1
OwnerId	integer	リソース所有権の Alibaba Cloud アカウント ID。重要この値は Long 型です。特定のプログラミング言語では精度の損失が発生する可能性があります。この値は注意して使用してください。	28768383240243****
VSwitchId	string	vSwitch の ID。	vsw-25b7pv15t****
RequestId	string	リクエスト ID。	7B48B4B9-1EAD-469F-B488-594DAB4B6A1A
CidrBlock	string	vSwitch のプライベートネットワークのアドレス範囲。	192.168.0.1/24
Description	string	vSwitch の説明。	abc
ResourceGroupId	string	リソースグループ ID。	rg-acfmxazb4ph****
ZoneId	string	vSwitch が属するゾーンの ID。	cn-beijing-a
Ipv6CidrBlock	string	vSwitch の IPv6 CIDR ブロック。	2408:XXXX:3c5:44e::/64
VSwitchName	string	vSwitch の名前。	test
ShareType	string	vSwitch の共有タイプ。値が空の場合、vSwitch はプライベート仮想スイッチです。値が Shared の場合、vSwitch は共有 vSwitch です。値が Sharing の場合、vSwitch は他のアカウントと共有されています。	Shared
EnabledIpv6	boolean	vSwitch の IPv6 CIDR ブロックが有効かどうかを示します。有効な値: true: 有効。 false: 無効。	true
RouteTable	object	vSwitch のルートテーブル情報。
RouteTableId	string	vSwitch に関連付けられているルートテーブルの ID。	vtb-bp145q7glnuzdv****
RouteTableType	string	ルートテーブルのタイプ。有効な値: System: システムルートテーブル。 Custom: カスタムルートテーブル。	System
Tags	object
Tag	array<object>	タグリスト。
	object	タグリスト。
Key	string	タグキー。	FinanceDept
Value	string	タグ値。	FinanceJoshua

例

成功レスポンス

JSONJSON

{
  "VpcId": "vpc-257gq642n****",
  "Status": "Pending",
  "CreationTime": "2021-08-22T10:40:25Z",
  "IsDefault": false,
  "AvailableIpAddressCount": 12,
  "NetworkAclId": "1",
  "OwnerId": 0,
  "VSwitchId": "vsw-25b7pv15t****",
  "RequestId": "7B48B4B9-1EAD-469F-B488-594DAB4B6A1A",
  "CidrBlock": "192.168.0.1/24",
  "Description": "abc",
  "ResourceGroupId": "rg-acfmxazb4ph****",
  "ZoneId": "cn-beijing-a",
  "Ipv6CidrBlock": "2408:XXXX:3c5:44e::/64",
  "VSwitchName": "test",
  "ShareType": "Shared",
  "EnabledIpv6": true,
  "RouteTable": {
    "RouteTableId": "vtb-bp145q7glnuzdv****",
    "RouteTableType": "System"
  },
  "Tags": {
    "Tag": [
      {
        "Key": "FinanceDept",
        "Value": "FinanceJoshua"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidVSwitchId.NotFound	Specified VSwitch can not found.

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

変更履歴

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