API を使用した VPC ファイアウォール vSwitch リストの取得 - Cloud Firewall - Alibaba Cloud - Cloud Firewall

VPC ファイアウォールのマニュアルモードで vSwitch リストを照会します。

操作説明

ファイアウォールのマニュアルモードで vSwitch リストを照会します。必須パラメーター: OwnerId (オーナーユーザー ID、Long 型) が空の場合、ErrorOwnerId が返されます。regionNo (リージョン) が空の場合、ErrorRegionNoError が返されます。vpcId が空の場合、ErrorVpcIdError が返されます。開始する前に: DescribeVpcFirewallList を呼び出して、VpcFirewallId、OwnerId (応答の LocalVpc.OwnerId または PeerVpc.OwnerId)、および VpcId (応答の LocalVpc.VpcId または PeerVpc.VpcId) を取得してください。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

yundun-cloudfirewall:DescribeVpcFirewallManualVSwitchList

get

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Lang	string	任意	リクエストおよび応答の言語。有効な値: zh: 中国語 en: 英語列挙値: en : 英語。 zh : 中国語。	zh
Lang	string	任意	リージョン ID。列挙値: en : 英語 zh : 中国語	cn-qingdao
RegionNo	string	必須	VPC に接続されたインスタンスの ID。	vpc-m5ewlqkuf7orclr1****
VpcId	string	必須	メンバーアカウントの UID。	18820897691****
MemberUid	string	任意	メンバーアカウントの UID。	18820897691****

レスポンスフィールド

フィールド	型	説明	例
	object
TotalCount	integer	返されるエントリの総数。	3
RequestId	string	リクエスト ID。	6EED3674-74E7-54DC-8FD4-6A374133****
VSwitchList	array<object>	vSwitch のリスト。
	object	vSwitch のリスト。
Status	string	ステータス。	Available
VpcId	string	VPC に接続されたインスタンスの ID。	vpc-uf62kq7c364sil2z2****
VSwitchId	string	vSwitch の ID。	vsw-bp10d0kcp907721z****
CidrBlock	string	IPv4 CIDR ブロック。	10.0.31.0/24
AvailableIpAddressCount	integer	vSwitch で利用可能な IP アドレスの数。	10
RegionNo	string	インスタンスのリージョン ID。	cn-beijing
ZoneId	string	ゾーンの ID。	cn-hangzhou-a
AliUid	integer	Alibaba Cloud アカウントの UID。説明 Cloud Firewall メンバーアカウントのプライマリアカウント。	122167357026****
RouteTableId	string	プレフィックスリストをルートテーブルに関連付けるための ID。	vtb-2zet3gyk01o07so****
OwnerId	integer	オーナーユーザー ID。	137578716100****
VSwitchName	string	vSwitch の名前。	vsw-test

例

成功レスポンス

JSONJSON

{
  "TotalCount": 3,
  "RequestId": "6EED3674-74E7-54DC-8FD4-6A374133****",
  "VSwitchList": [
    {
      "Status": "Available",
      "VpcId": "vpc-uf62kq7c364sil2z2****",
      "VSwitchId": "vsw-bp10d0kcp907721z****",
      "CidrBlock": "10.0.31.0/24",
      "AvailableIpAddressCount": 10,
      "RegionNo": "cn-beijing",
      "ZoneId": "cn-hangzhou-a",
      "AliUid": 0,
      "RouteTableId": "vtb-2zet3gyk01o07so****",
      "OwnerId": 0,
      "VSwitchName": "vsw-test"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	ErrorAliUid	Aliuid invalid.
400	ErrorInvalidMemberUid	Member uid is invalid
400	ErrorOwnerId	owner id invalid.
400	ErrorRegionNoError	Region invalid.
400	ErrorVpcIdError	Vpc ID invalid.
400	ErrorDBSelectError	A database select error occurred.
400	ErrorUserCredentials	User credentials failed.
400	ErrorVpcOpenApi	vpc open api failed
400	ErrorVswitchNotFound	vswitch not found

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

変更履歴

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