查詢VPC邊界防火墻(防護云企業網內的網絡實例和指定VPC之間的互訪流量)的信息。
接口說明
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
yundun-cloudfirewall:DescribeVpcFirewallCenList | get | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Lang | string | 否 | 接收消息的語言類型。取值:
| zh |
RegionNo | string | 否 | VPC 所在的地域 ID。 說明
關于云防火墻支持地域的詳細信息,請參見支持的地域。
| cn-hangzhou |
NetworkInstanceId | string | 否 | 網絡實例 ID。 | vpc-8vbwbo90rq0anm6t**** |
FirewallSwitchStatus | string | 否 | VPC 邊界防火墻的狀態。取值:
說明
不設置該參數表示查詢所有狀態的 VPC 邊界防火墻。
| opened |
VpcFirewallId | string | 否 | VPC 邊界防火墻的實例 ID。 | vfw-m5e7dbc4y**** |
VpcFirewallName | string | 否 | VPC 邊界防火墻的實例名稱。 | 測試環境防火墻 |
CenId | string | 否 | 云企業網實例 ID。 | cen-x5jayxou71ad73**** |
CurrentPage | string | 否 | 分頁查詢時,設置當前頁面的頁碼。 默認值為 1,表示返回第 1 頁數據。 | 1 |
PageSize | string | 否 | 分頁查詢時,設置每頁包含 VPC 邊界防火墻的數量。 默認值為 10,表示每頁包含 10 條結果。最大值為 50。 | 10 |
RouteMode | string | 否 | 路由模式。取值:
說明
不設置該參數表示查詢所有路由模式的 VPC 邊界防火墻。
| auto |
MemberUid | string | 否 | 當前阿里云賬號的成員賬號(其他阿里云賬號)UID。 | 258039427902**** |
TransitRouterType | string | 否 | 轉發實例路由器類型。可選值:
| Basic |
返回參數
示例
正常返回示例
JSON
格式
{
"TotalCount": 10,
"RequestId": "850A84D6-0DE4-4797-A1E8-00090125k8g2",
"VpcFirewalls": [
{
"ConnectType": "cen",
"VpcFirewallId": "vfw-m5e7dbc4y****",
"RegionStatus": "enable",
"CenId": "cen-x5jayxou71ad73****",
"VpcFirewallName": "測試防火墻",
"ResultCode": "Unauthorized",
"CenName": "測試云企業網",
"FirewallSwitchStatus": "opened",
"LocalVpc": {
"VpcId": "vpc-8vbwbo90rq0anm6t****",
"TransitRouterType": "Basic",
"NetworkInstanceId": "vpc-2zefk9fbn8j7v585g****",
"RouteMode": "auto",
"RegionNo": "cn-hangzhou",
"AuthorizationStatus": "authorized",
"ManualVSwitchId": "vsw-zeq4o875u****",
"OwnerId": 0,
"NetworkInstanceType": "VPC",
"VpcName": "測試用實例",
"SupportManualMode": "0",
"NetworkInstanceName": "測試業務VPC",
"VpcCidrTableList": [
{
"RouteTableId": "vtb-1234",
"RouteEntryList": [
{
"NextHopInstanceId": "vrt-m5eb5me6c3l5sezae****",
"DestinationCidr": "192.168.XX.XX/24"
}
]
}
],
"DefendCidrList": [
"10.0.XX.XX/24"
]
},
"IpsConfig": {
"BasicRules": 1,
"EnableAllPatch": 1,
"RunMode": 0,
"RuleClass": 1
},
"MemberUid": "258039427902****",
"PrecheckStatus": "failed"
}
]
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | ErrorAliUid | The aliuid is invalid. | 無效的用戶id |
400 | ErrorDBSelectError | A database select error occurred. | 內部錯誤:數據庫查詢錯誤 |
400 | ErrorPageNo | Either page number or page size is invalid. | 無效的page number 或者 page size |
400 | ErrorUserNotFound | User not found | 用戶不存在. |
400 | ErrorFirewallStatus | firewall status error. | 防火墻狀態錯誤,請稍后再試。 |
400 | ErrorOwnerId | owner id invalid. | 所屬賬號錯誤,請重新輸入。 |
400 | ErrorInvalidMemberUid | Member uid is invalid | 成員賬號錯誤. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-10-08 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-08-15 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2021-11-15 | 新增 OpenAPI | 查看變更詳情 |