Call AddIpControlPolicyItem to Add ACL Entries via API - API Gateway

Operation description

When you call this operation, note that:

This operation is intended for API providers.
An added policy immediately takes effect on all APIs that are bound to the access control list (ACL).
A maximum of 100 policies can be added to an ACL.

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:AddIpControlPolicyItem

create

*IpControl

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

None

Request parameters

Parameter	Type	Required	Description	Example
IpControlId	string	Yes	The ID of the ACL. The ID is unique.	7ea91319a34d48a09b5c9c871d9768b1
AppId	string	No	The restriction policy on app IDs for a specific policy. You can restrict app IDs only for whitelists. The IpControlType values of whitelists are ALLOW. You can add only one app ID restriction policy at a time. If this parameter is empty, no restriction is imposed on the app IDs. If this parameter is not empty, there is restriction not only on IP addresses, but also on apps. Please note that if this parameter is not empty and the security authentication method of the API is No Authentication, all API calls are restricted. If this parameter is not empty for a blacklist, API Gateway automatically skips this parameter and sets only restriction on IP addresses. The IpControlType value of a blacklist is REFUSE.	1111111
CidrIp	string	Yes	The IP addresses or CIDR blocks involved in the policy. Separate multiple IP addresses or CIDR blocks with semicolons (;). You can specify a maximum of 10 IP addresses or CIDR blocks.	113.125.1.101;101.11.1.1

Response elements

Element	Type	Description	Example
	object
PolicyItemId	string	The ID of the policy. The ID is unique.	P151617000829241
RequestId	string	The ID of the request.	CEF72CEB-54B6-4AE8-B225-F876FF7BZ004

Examples

Success response

JSON format

{
  "PolicyItemId": "P151617000829241",
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.