DescribeIpControls - API Gateway - Alibaba Cloud Documentation Center

Queries custom access control lists (ACLs) on separate pages.

Operation description

This operation is intended for API providers.
This operation is used to query the ACLs in a region. Region is a system parameter.
You can filter the query results by ACL ID, name, or type.
This operation cannot be used to query specific policies. If you want to query specific policies, call the DescribeIpControlPolicyItems operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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 Resources is 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
apigateway:DescribeIpControls	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
IpControlId	string	No	The ID of the ACL. The ID is unique.	7ea91319a34d48a09b5c9c871d9768b1
IpControlName	string	No	The name of the ACL.	ACL test
IpControlType	string	No	The type of the ACL. Valid values: ALLOW: a whitelist REFUSE: a blacklist	ALLOW
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Maximum value: 100. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object
PageNumber	integer	The page number of the returned page.	1
RequestId	string	The ID of the request.	CEF72CEB-54B6-4AE8-B225-F876FF7BZ004
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of returned entries.	1
IpControlInfos	object []	The information about the ACL. The information is an array that consists of IpControlInfo data. The information does not include specific policies.
IpControlId	string	The ID of the ACL.	7ea91319a34d48a09b5c9c871d9768b1
IpControlType	string	The type of the ACL.	ALLOW
ModifiedTime	string	The time when the ACL was modified. The time is displayed in UTC.	2018-01-17T06:00:38Z
IpControlName	string	The name of the ACL.	testControl11
Description	string	The description of the ACL.	description
CreateTime	string	The time when the ACL was created. The time is displayed in UTC.	2018-01-17T05:48:11Z
RegionId	string	The ID of the region in which the ACL is deployed.	cn-qingdao

Examples

Sample success responses

JSONformat

{
  "PageNumber": 1,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004",
  "PageSize": 10,
  "TotalCount": 1,
  "IpControlInfos": {
    "IpControlInfo": [
      {
        "IpControlId": "7ea91319a34d48a09b5c9c871d9768b1",
        "IpControlType": "ALLOW",
        "ModifiedTime": "2018-01-17T06:00:38Z",
        "IpControlName": "testControl11",
        "Description": "description",
        "CreateTime": "2018-01-17T05:48:11Z",
        "RegionId": "cn-qingdao"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history