Queries the details about all access control policies.
Operation description
You can call the DescribeControlPolicy operation to query the details about access control policies by page.
Limits
You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| yundun-cloudfirewall:DescribeControlPolicy | Read |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Lang | string | No | The language of the content within the response. Valid values:
| zh |
| Direction | string | Yes | The direction of the traffic to which the access control policy applies. Valid values:
| in |
| CurrentPage | string | Yes | The number of the page to return. Default value: 1. | 1 |
| PageSize | string | Yes | The number of entries to return on each page. | 10 |
| Source | string | No | The source address in the access control policy. Fuzzy match is supported. The value of this parameter depends on the value of the SourceType parameter.
Note
If you do not specify this parameter, access control policies of all source address types are queried.
| 192.0.XX.XX |
| Destination | string | No | The destination address in the access control policy. Fuzzy match is supported. The value of this parameter depends on the value of the DestinationType parameter.
Note
If you do not specify this parameter, access control policies of all destination address types are queried.
| 192.0.XX.XX |
| Description | string | No | The description of the access control policy. Fuzzy match is supported. Note
If you do not specify this parameter, access control policies that have descriptions are queried.
| test |
| Proto | string | No | The type of the protocol in the access control policy. Valid values:
Note
If you do not specify this parameter, access control policies of all protocol types are queried.
| TCP |
| AclAction | string | No | The action that Cloud Firewall performs on the traffic. Valid values:
Note
If you do not specify this parameter, access control policies of all action types are queried.
| accept |
| Release | string | No | Specifies whether the access control policy is enabled. By default, an access control policy is enabled after it is created. Valid values:
| true |
| AclUuid | string | No | The unique ID of the access control policy. | 00281255-d220-4db1-8f4f-c4df221a**** |
| IpVersion | string | No | The IP version of the address in the access control policy. Valid values:
| 6 |
| RepeatType | string | No | The recurrence type for the access control policy to take effect. Valid values:
| Permanent |
Response parameters
Examples
Sample success responses
JSONformat
{
"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": [
"443/443"
],
"SourceGroupCidrs": [
"192.0.XX.XX/24"
],
"ApplicationNameList": [
"HTTPS"
],
"SpreadCnt": 0,
"CreateTime": 1761062400,
"ModifyTime": 1761062400,
"RepeatType": "Permanent",
"RepeatDays": [
1
],
"RepeatStartTime": "08:00",
"RepeatEndTime": "23:30",
"StartTime": 1694761200,
"EndTime": 1694764800
}
]
}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. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2023-10-12 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | see changesets | ||||||||||
|