Query access control lists with DescribeIpControls - API Gateway - Alibaba Cloud - API Gateway

Operation description

This operation is intended for API providers.
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.

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

apigateway:DescribeIpControls

get

*IpControl

acs:apigateway:{#regionId}:{#accountId}:ipcontrol/*

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.	访问控制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 elements

Element	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
IpControlInfo	array<object>	The information about the ACL. The information is an array that consists of IpControlInfo data. The information does not include specific policies.
	object
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

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.