查詢 VPC 防火牆 vSwitch 列表 - Cloud Firewall - 阿里雲 - Cloud Firewall

查詢 VPC 防火牆手動模式交換器清單。

介面說明

取得防火牆手動交換器清單。【必填參數】OwnerId（所屬使用者 ID，Long 類型）為空時返回 ErrorOwnerId；regionNo（地域）為空時返回 ErrorRegionNoError；vpcId 為空時返回 ErrorVpcIdError。【前置條件】可先呼叫 DescribeVpcFirewallList 取得：VpcFirewallId、OwnerId（取自回應的 LocalVpc.OwnerId 或 PeerVpc.OwnerId）、VpcId（取自 LocalVpc.VpcId 或 PeerVpc.VpcId）。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-cloudfirewall:DescribeVpcFirewallManualVSwitchList

get

*全部資源。

*

無

請求參數

名稱	類型	必填	描述	樣本值
Lang	string	否	請求和接收訊息的語言類型。枚舉值： 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>	交換器清單。
	object	交換器清單。
Status	string	狀態。	Available
VpcId	string	VPC 執行個體 ID。	vpc-uf62kq7c364sil2z2****
VSwitchId	string	交換器 ID。	vsw-bp10d0kcp907721z****
CidrBlock	string	IPv4 網段。	10.0.31.0/24
AvailableIpAddressCount	integer	交換器中可用的 IP 位址數量。	10
RegionNo	string	執行個體所在的地域 ID。	cn-beijing
ZoneId	string	可用區 ID。	cn-hangzhou-a
AliUid	integer	阿里雲帳號的 UID。說明雲端防火牆成員帳號的主帳號。	122167357026****
RouteTableId	string	關聯路由表 ID。	vtb-2zet3gyk01o07so****
OwnerId	integer	所屬使用者 ID。	137578716100****
VSwitchName	string	交換器的名稱。	vsw-test

樣本

正常返回樣本

JSON格式

{
  "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 status code	錯誤碼	錯誤資訊
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

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。