Retrieve access control policies using DescribeControlPolicy - Cloud Firewall - Alibaba Cloud - Cloud Firewall

Retrieves information about all access control policies.

Operation description

This operation is typically used for paging query of access control policy information.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-cloudfirewall:DescribeControlPolicy

get

*ControlPolicyOrder

acs:cloudfirewall::{#accountId}:controlpolicy/{#AclUuid}/controlpolicyorder/{#Direction}

*ControlPolicy

acs:cloudfirewall::{#accountId}:controlpolicy/{#AclUuid}

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language type for receiving messages. Valid values:	zh
Direction	string	No	The traffic direction controlled by the access control policy. Valid values: in (inbound) or out (outbound). You must specify at least one of Direction and AclUuid. If AclUuid is not specified, you must specify a non-empty Direction. Otherwise, the ErrorParametersDirection error is returned. Valid values: in : Inbound, which indicates traffic from external sources to internal resources. out : Outbound, which indicates traffic from internal resources to external destinations.	in
CurrentPage	string	Yes	The page number of the current page displayed in a paging query.	1
PageSize	string	Yes	The maximum number of entries per page displayed in a paging query.	10
Source	string	No	The source address in the access control policy. Fuzzy queries are supported. The value varies depending on the SourceType (source type).	192.0.XX.XX
Destination	string	No	The destination address in the access control policy. Fuzzy queries are supported. The value varies depending on the DestinationType (destination type).	192.0.XX.XX
Description	string	No	The description of the access control policy. Fuzzy queries are supported.	Allow access to office network segment
Proto	string	No	The protocol type of the traffic in the access control policy. Valid values:	TCP
AclAction	string	No	The action that Cloud Firewall performs on the traffic in the access control policy. Valid values:	accept
Release	string	No	The enabled status of the access control policy. Valid values:	true
AclUuid	string	No	The unique ID of the access control policy. You must specify at least one of AclUuid and Direction. If AclUuid is specified, you can query the policy by its ID.	00281255-d220-4db1-8f4f-c4df221a****
IpVersion	string	No	The supported IP address version. Valid values: Valid values: 4 : IPv4 6 : IPv6	6
RepeatType	string	No	The recurrence type of the policy validity period for the access control policy. Valid values: Valid values: Daily : every day. Monthly : every month. Permanent : always. Weekly : every week. None : a specified one-time period.	Permanent

Response elements

Element	Type	Description	Example
	object
PageNo	string	The page number of the current page displayed in a paging query.	1
PageSize	string	The maximum number of entries per page displayed in a paging query.	10
RequestId	string	The request ID.	CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2****
TotalCount	string	The total number of the access control policies.	100
Policys	array<object>	The information about the access control policies.
	object	The details of the access control policy.
Direction	string	The traffic direction of the access control policy. Valid values:	in
Order	integer	The priority of the access control policy.	1
SourceType	string	The type of the source address in the access control policy. Valid values:	net
ApplicationName	string	The application type supported by the access control policy. We recommend that you use ApplicationNameList. Valid values:	HTTP
HitTimes	integer	The number of hits for the access control policy.	100
Description	string	The description of the access control policy.	Allow access to office network segment
SourceGroupType	string	The type of the source address book in the access control policy. Valid values:	ip
DnsResultTime	integer	The timestamp of the DNS resolution. The value is a UNIX timestamp in seconds.	1579261141
DnsResult `deprecated`	string	The DNS resolution result.	192.0.XX.XX,192.0.XX.XX
Proto	string	The security protocol type of the traffic in the access control policy. Valid values:	TCP
DestinationGroupType	string	The type of the destination address book in the access control policy. Valid values:	ip
Destination	string	The destination address in the access control policy. The value varies depending on the DestinationType (destination type). Valid values:	192.0.XX.XX/24
HitLastTime	integer	The most recent time of hits. The value is in the format of a UNIX timestamp in seconds.	1579261141
DestPortGroup	string	The name of the destination port address book in the access control policy.	my_port_group
AclUuid	string	The unique ID of the access control policy.	00281255-d220-4db1-8f4f-c4df221a****
DestPortType	string	The type of the destination port in the access control policy. Valid values:	port
Source	string	The source address in the access control policy. Valid values:	192.0.XX.XX/24
DestinationType	string	The type of the destination address in the access control policy. Valid values:	net
DestPort	string	The destination port of the traffic in the access control policy.	80
IpVersion	integer	The supported IP address version. Valid values:	6
AclAction	string	The action that Cloud Firewall performs on the traffic in the access control policy. Valid values:	accept
Release	string	The enabled status of the access control policy. The policy is enabled by default after creation. Valid values:	true
ApplicationId	string	The application ID of the traffic in the access control policy.	10***
DestinationGroupCidrs	array	The list of CIDR blocks in the destination address book of the access control policy.
	string	The CIDR block in the destination address book of the access control policy.	192.0.XX.XX/24
DestPortGroupPorts	array	The list of ports in the destination port address book.
	string	The port in the destination port address book.	80/80
SourceGroupCidrs	array	The list of CIDR blocks in the source address book of the access control policy.
	string	The CIDR block in the source address book of the access control policy.	192.0.XX.XX/24
ApplicationNameList	array	The list of application names.
	string	The list of application types supported by the access control policy. Valid values:	HTTP
SpreadCnt	integer	The number of quota units consumed by the access control policy, which is the cumulative number of quota units consumed by each policy.	10000
CreateTime	integer	The time when the policy was created. The value is a UNIX timestamp in seconds, which is the number of seconds that have elapsed since January 1, 1970 (UTC).	1761062400
ModifyTime	integer	The time when the policy was last modified. The value is a UNIX timestamp in seconds, which is the number of seconds that have elapsed since January 1, 1970 (UTC).	1761062400
RepeatType	string	The recurrence type of the policy validity period for the access control policy. Valid values: Valid values: Daily : every day. Monthly : every month. Permanent : always. Weekly : every week. None : a specified one-time period.	Permanent
RepeatDays	array	The collection of recurrence days for the policy validity period of the access control policy.
	integer	The recurrence day for the policy validity period of the access control policy.	1
RepeatStartTime	string	The recurrence start time of the policy validity period for the access control policy. Example: 08:00. The value must be on the hour or half hour and must be at least 30 minutes earlier than the recurrence end time.	08:00
RepeatEndTime	string	The recurrence end time of the policy validity period for the access control policy. Example: 23:30. The value must be on the hour or half hour and must be at least 30 minutes later than the recurrence start time.	23:30
StartTime	integer	The start time of the policy validity period for the access control policy. The value is a UNIX timestamp in seconds. The value must be on the hour or half hour and must be at least 30 minutes earlier than the end time.	1694761200
EndTime	integer	The end time of the policy validity period for the access control policy. The value is a UNIX timestamp in seconds. The value must be on the hour or half hour and must be at least 30 minutes later than the start time.	1694764800
DomainResolveType	string	The domain name resolution method of the access control policy. Valid values:	FQDN

Examples

Success response

JSON format

{
  "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"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorParametersUid	The aliUid parameter is invalid.	The aliUid parameter is invalid.
400	ErrorParametersPageSizeOrNo	Either pageSize or pageNo is invalid.	Either pageSize or pageNo is invalid.
400	ErrorParameterIpVersion	The IP version is invalid.	The IP version is invalid.
400	ErrorParametersDirection	The direction is invalid.	The direction is invalid.
400	ErrorDBSelect	An error occurred while querying database.	An error occurred while querying database.
400	ErrorUnmarshalJSON	An error occurred while parsing JSON.	An error occurred while decoding JSON.
400	ErrorUUIDNew	The UUID is invalid.	The UUID is invalid.
400	ErrorParametersAppId	The AppId parameter is incorrect.	The AppId parameter is invalid.
400	ErrorParametersSource	The source is invalid.	The source is invalid.
400	ErrorDomainResolve	An error occurred while resolving the domain.	An error occurred while resolving the domain.
400	ErrorParametersDestination	The Destination parameter is invalid.	The Destination parameter is invalid.
400	ErrorParametersProto	The protocol is invalid.	The protocol is invalid.
400	ErrorParametersDestPort	The dst_port is invalid.	The dst_port is invalid.
400	ErrorParametersAction	The action is invalid.	The action is invalid.
400	ErrorParameters	Parameters error.	Parameter error.
400	ErrorMarshalJSON	An error occurred while encoding JSON.	An error occurred while encoding JSON.
400	ErrorParametersAclUuid	Specified parameter AclUuid is not valid.	Specified parameter AclUuid is not valid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.