查询指定的VPC边界防火墙的所有访问控制策略信息。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
yundun-cloudfirewall:DescribeVpcFirewallControlPolicy | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Lang | string | 否 | 请求和接收消息的语言类型。 取值:
| zh |
VpcFirewallId | string | 是 | VPC 边界防火墙的实例 ID。取值:
说明
您可以调用 DescribeVpcFirewallAclGroupList 接口获取该 ID。
| vfw-a42bbb7b887148c9**** |
CurrentPage | string | 是 | 分页查询时,设置当前页的页码。 | 1 |
PageSize | string | 是 | 分页查询时,设置每页包含 VPC 边界防火墙的访问控制策略数量。 可设置值最大为 50。 | 10 |
Source | string | 否 | VPC 边界防火墙访问控制策略中的访问源地址。支持使用模糊查询。 说明
Source 可以是单个 CIDR 地址或地址簿名称。
| 192.0.XX.XX/24 |
Destination | string | 否 | VPC 边界防火墙访问控制策略中的目的地址。支持模糊查询。 说明
Destination 可以是单个 CIDR 地址或域名,也可以是地址薄名称。
| 192.0.XX.XX/24 |
Description | string | 否 | VPC 边界防火墙访问控制策略的描述信息。支持模糊查询。 | test |
Proto | string | 否 | VPC 边界防火墙访问控制策略中访问流量的协议类型。取值:
说明
不设置该参数表示查询所有协议类型。
| TCP |
AclAction | string | 否 | VPC 边界防火墙访问控制策略中设置的访问流量通过云防火墙的方式(动作)。取值:
说明
不设置该参数表示查询所有动作。
| accept |
MemberUid | string | 否 | 当前阿里云账号的成员账号 UID。 | 258039427902**** |
AclUuid | string | 否 | VPC 边界防火墙访问控制策略的唯一标识 ID。 | 4037fbf7-3e39-4634-92a4-d0155247**** |
Release | string | 否 | 访问控制策略的启用状态。取值:
| true |
RepeatType | string | 否 | 访问控制策略的策略有效期的重复类型。取值:
| Permanent |
返回参数
示例
正常返回示例
JSON
格式
{
"TotalCount": "20",
"RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D",
"Policys": [
{
"Destination": "192.0.XX.XX/24",
"Order": 1,
"DestPortGroup": "my_port_group",
"SourceType": "net",
"ApplicationName": "HTTP",
"AclUuid": "4037fbf7-3e39-4634-92a4-d0155247****",
"DestPortType": "port",
"Source": "192.0.XX.XX/24",
"DestinationType": "net",
"HitTimes": 100,
"DestPort": "80",
"Description": "test",
"AclAction": "accept",
"ApplicationId": "10**",
"Proto": "TCP",
"DestinationGroupCidrs": [
"[\"192.0.XX.XX/24\", \"192.0.XX.XX/32\"]"
],
"DestPortGroupPorts": [
"[80,443]"
],
"SourceGroupCidrs": [
"[\"192.0.XX.XX/24\", \"198.51.XX.XX/32\"]"
],
"MemberUid": "258039427902****",
"Release": "true",
"SourceGroupType": "ip",
"DestinationGroupType": "ip",
"HitLastTime": 1579261141,
"ModifyTime": 1761062400,
"SpreadCnt": 0,
"CreateTime": 1761062400,
"ApplicationNameList": [
"[\n \"HTTPS\", \n \"SMTPS\", \n \"SSL\"\n]"
],
"RepeatType": "Permanent",
"RepeatDays": [
1
],
"RepeatStartTime": "08:00",
"RepeatEndTime": "23:30",
"StartTime": 1694761200,
"EndTime": 1694764800,
"DomainResolveType": "FQDN"
}
]
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | ErrorParametersUid | The aliUid parameter is invalid. | aliUid 不合法 |
400 | ErrorParametersPageSizeOrNo | Either pageSize or pageNo is invalid. | 无效的pageSize或者pageNo |
400 | ErrorDBSelect | An error occurred while querying database. | 内部错误:数据库查询错误 |
400 | ErrorUUIDNew | The UUID is invalid. | 内部错误:UUID错误 |
400 | ErrorParametersAppId | The appId is invalid. | 无效的AppId |
400 | ErrorParameterIpVersion | The IP version is invalid. | IP版本参数错误 |
400 | ErrorParametersDirection | The direction is invalid. | 无效的方向 |
400 | ErrorParametersSource | The source is invalid. | 无效的来源 |
400 | ErrorDomainResolve | A domain resolution error occurred. | 域名解析错误 |
400 | ErrorParametersDestination | The Destination parameter is invalid. | Destination参数非法 |
400 | ErrorParametersProto | The protocol is invalid. | 无效的协议 |
400 | ErrorParametersDestPort | The dst_port is invalid. | 无效的目的端口 |
400 | ErrorParametersAction | The action is invalid. | 无效的动作 |
400 | ErrorParameters | Parameters error. | 参数错误。 |
400 | ErrorMarshalJSON | An error occurred while encoding JSON. | 内部错误:JSON编码错误 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-09-06 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-08-08 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-10-12 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-09-14 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-09-11 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |