查询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": 0
},
"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-08-15 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2021-11-15 | 新增 OpenAPI | 查看变更详情 |