获取所有访问控制策略的信息。
接口说明
本接口一般用于分页查询访问控制策略的信息。
QPS 限制
本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
yundun-cloudfirewall:DescribeControlPolicy |
get |
*ControlPolicyOrder
*ControlPolicy
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
Lang |
string |
否 |
接收消息的语言类型。取值:
|
zh |
Lang |
string |
否 |
接收消息的语言类型。取值:
|
zh |
Direction |
string |
否 |
访问控制策略控制的流量方向。取值:
|
in |
CurrentPage |
string |
是 |
分页查询时,显示的当前页的页码。 默认值为 1。 |
1 |
PageSize |
string |
是 |
分页查询时,显示的每页数据的最大条数。 |
10 |
Source |
string |
否 |
访问控制策略中的访问源地址。支持使用模糊查询的方式进行查询。SourceType(源类型)不同,访问源地址的取值也不同。
说明
不设置该参数表示查询所有类型的访问源。 |
192.0.XX.XX |
Destination |
string |
否 |
访问控制策略中的目的地址。支持模糊查询。DestinationType(目的类型)不同,目的地址的取值也不同。
说明
不设置该参数表示查询所有类型的目的地址。 |
192.0.XX.XX |
Description |
string |
否 |
访问控制策略的描述信息。支持模糊查询。 说明
不设置该参数表示查询所有策略的描述信息。 |
test |
Proto |
string |
否 |
访问控制策略中访问流量的协议类型。取值:
说明
不设置该参数表示查询所有协议类型。 |
TCP |
AclAction |
string |
否 |
访问控制策略中设置的流量通过云防火墙的方式(动作)。取值:
说明
不设置该参数表示查询所有的动作类型。 |
accept |
Release |
string |
否 |
访问控制策略的启用状态。取值:
|
true |
AclUuid |
string |
否 |
访问控制策略的唯一标识 ID。 |
00281255-d220-4db1-8f4f-c4df221a**** |
IpVersion |
string |
否 |
支持的 IP 地址版本。取值:
|
6 |
RepeatType |
string |
否 |
访问控制策略的策略有效期的重复类型。取值:
|
Permanent |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
|||
PageNo |
string |
分页查询时,显示的当前页的页码。 |
1 |
PageSize |
string |
分页查询时,显示的每页数据的最大条数。 |
10 |
RequestId |
string |
结果的请求 ID。 |
CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2**** |
TotalCount |
string |
访问控制策略的总数量。 |
100 |
Policys |
array<object> |
访问控制策略的信息。 |
|
object |
无 |
||
Direction |
string |
访问控制策略的流量方向。取值:
|
in |
Order |
integer |
访问控制策略生效的优先级。 优先级数字从 1 开始顺序递增,优先级数字越小,优先级越高。 |
1 |
SourceType |
string |
访问控制策略中的源地址类型。取值:
|
net |
ApplicationName |
string |
访问控制策略支持的应用类型,推荐使用 ApplicationNameList。取值:
|
HTTP |
HitTimes |
integer |
访问控制策略的命中次数。 |
100 |
Description |
string |
访问控制策略的描述信息。 |
test |
SourceGroupType |
string |
访问控制策略中的源地址簿类型。取值:
|
ip |
DnsResultTime |
integer |
DNS 解析的时间戳。使用秒级时间戳格式表示。 |
1579261141 |
DnsResult
deprecated
|
string |
DNS 解析结果。 |
192.0.XX.XX,192.0.XX.XX |
Proto |
string |
访问控制策略中流量访问的安全协议类型。取值:
|
TCP |
DestinationGroupType |
string |
访问控制策略中的目的地址簿类型。取值:
|
ip |
Destination |
string |
访问控制策略中的目的地址。DestinationType(目的类型)不同,目的地址的取值也不同。取值:
|
192.0.XX.XX/24 |
HitLastTime |
integer |
最新命中时间戳。使用秒级时间戳格式表示。 |
1579261141 |
DestPortGroup |
string |
访问控制策略中流量访问的目的端口地址簿名称。 |
my_port_group |
AclUuid |
string |
访问控制策略的唯一标识 ID。 |
00281255-d220-4db1-8f4f-c4df221a**** |
DestPortType |
string |
访问控制策略中流量访问的目的端口类型。取值:
|
port |
Source |
string |
访问控制策略中的访问源地址。取值:
|
192.0.XX.XX/24 |
DestinationType |
string |
访问控制策略中的目的地址类型。取值:
|
net |
DestPort |
string |
访问控制策略中访问流量的目的端口。 |
80 |
IpVersion |
integer |
支持的 IP 地址版本。取值:
|
6 |
AclAction |
string |
访问控制策略中设置的流量通过云防火墙的方式(动作)。取值:
|
accept |
Release |
string |
访问控制策略的启用状态。策略创建后默认启用该策略。取值:
|
true |
ApplicationId |
string |
访问控制策略中设置访问流量的应用 ID。 |
10*** |
DestinationGroupCidrs |
array |
访问控制策略中的目的地址簿中的网段列表。 |
|
string |
访问控制策略中的目的地址簿中的网段。 |
192.0.XX.XX/24 |
|
DestPortGroupPorts |
array |
目的端口地址簿中包含的端口列表。 |
|
string |
目的端口地址簿中包含的端口。 |
80/80 |
|
SourceGroupCidrs |
array |
访问控制策略中的源地址簿中的网段列表。 |
|
string |
访问控制策略中的源地址簿中的网段。 |
192.0.XX.XX/24 |
|
ApplicationNameList |
array |
应用名称列表。 |
|
string |
访问控制策略支持的应用类型列表。取值:
|
HTTP |
|
SpreadCnt |
integer |
占用访问控制策略的规格数,即每条策略占用规格数的累加值。 单条策略占用的规格数 = 源地址个数(IP 地址段个数或区域个数)* 目的地址个数(IP 地址段个数或区域个数或域名个数)* 端口段个数 * 应用数。 |
10000 |
CreateTime |
integer |
创建策略的时间。 |
1761062400 |
ModifyTime |
integer |
修改策略的时间。 |
1761062400 |
RepeatType |
string |
访问控制策略的策略有效期的重复类型。取值:
|
Permanent |
RepeatDays |
array |
访问控制策略的策略有效期的重复日期集合。
说明
RepeatType 设置为 Weekly 时,RepeatDays 不允许重复。
说明
RepeatType 设置为 Monthly 时,RepeatDays 不允许重复。 |
|
integer |
访问控制策略的策略有效期的重复日期。 说明
RepeatType 设置为 Weekly 时,取值范围:0~6,每周开始于周日。 RepeatType 设置为 Monthly 时,取值范围:1~31。 |
1 |
|
RepeatStartTime |
string |
访问控制策略的策略有效期的重复开始时间。例如:08:00,必须为整点或半点时间,且小于重复结束时间至少半小时。 说明
当 RepeatType 为 Permanent、None 时,RepeatStartTime 为空。当 RepeatType 为 Daily、Weekly、Monthly 时,RepeatStartTime 必须有值,您需要设置重复开始时间。 |
08:00 |
RepeatEndTime |
string |
访问控制策略的策略有效期的重复结束时间。例如:23:30,必须为整点或半点时间,且大于重复开始时间至少半小时。 说明
当 RepeatType 为 Permanent、None 时,RepeatEndTime 为空。当 RepeatType 为 Daily、Weekly、Monthly 时,RepeatEndTime 必须有值,您需要设置重复结束时间。 |
23:30 |
StartTime |
integer |
访问控制策略的策略有效期的开始时间。使用秒级时间戳格式表示。必须为整点或半点时间,且小于结束时间至少半小时。 说明
当 RepeatType 为 Permanent 时,StartTime 为空。当 RepeatType 为 None、Daily、Weekly、Monthly 时,StartTime 必须有值,您需要设置开始时间。 |
1694761200 |
EndTime |
integer |
访问控制策略的策略有效期的结束时间。使用秒级时间戳格式表示。必须为整点或半点时间,且大于开始时间至少半小时。 说明
当 RepeatType 为 Permanent 时,EndTime 为空。当 RepeatType 为 None、Daily、Weekly、Monthly 时,EndTime 必须有值,您需要设置结束时间。 |
1694764800 |
DomainResolveType |
string |
访问控制策略的域名解析方式。取值:
|
FQDN |
示例
正常返回示例
JSON
格式
{
"PageNo": "1",
"PageSize": "10",
"RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2****",
"TotalCount": "100",
"Policys": [
{
"Direction": "in",
"Order": 1,
"SourceType": "net",
"ApplicationName": "HTTP",
"HitTimes": 100,
"Description": "test",
"SourceGroupType": "ip",
"DnsResultTime": 1579261141,
"DnsResult": "192.0.XX.XX,192.0.XX.XX",
"Proto": "TCP",
"DestinationGroupType": "ip",
"Destination": "192.0.XX.XX/24",
"HitLastTime": 1579261141,
"DestPortGroup": "my_port_group",
"AclUuid": "00281255-d220-4db1-8f4f-c4df221a****",
"DestPortType": "port",
"Source": "192.0.XX.XX/24",
"DestinationType": "net",
"DestPort": "80",
"IpVersion": 6,
"AclAction": "accept",
"Release": "true",
"ApplicationId": "10***",
"DestinationGroupCidrs": [
"192.0.XX.XX/24"
],
"DestPortGroupPorts": [
"80/80"
],
"SourceGroupCidrs": [
"192.0.XX.XX/24"
],
"ApplicationNameList": [
"HTTP"
],
"SpreadCnt": 10000,
"CreateTime": 1761062400,
"ModifyTime": 1761062400,
"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 | ErrorParameterIpVersion | The IP version is invalid. | IP版本参数错误 |
400 | ErrorParametersDirection | The direction is invalid. | 无效的方向 |
400 | ErrorDBSelect | An error occurred while querying database. | 内部错误:数据库查询错误 |
400 | ErrorUnmarshalJSON | An error occurred while parsing JSON. | 内部错误:JSON解码错误 |
400 | ErrorUUIDNew | The UUID is invalid. | 内部错误:UUID错误 |
400 | ErrorParametersAppId | The AppId parameter is incorrect. | AppId不正确 |
400 | ErrorParametersSource | The source is invalid. | 无效的来源 |
400 | ErrorDomainResolve | An error occurred while resolving the domain. | 域名解析错误 |
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编码错误 |
400 | ErrorParametersAclUuid | Specified parameter AclUuid is not valid. | 指定的ACL uuid不合法。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。