API Gateway:CreateIpControl - API Gateway

Operation description

This operation is intended for API providers.
An ACL must be bound to an API to take effect. After an ACL is bound to an API, the ACL takes effect on the API immediately.
You can add policies to an ACL when you create the ACL.
If an ACL does not have any policy, the ACL is ineffective.

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

create

*IpControl

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

None

Request parameters

Parameter	Type	Required	Description	Example
IpControlName	string	Yes	The name of the ACL. The name must be 4 to 50 characters in length, and can contain letters, digits, and underscores (_). The name cannot start with an underscore (_).``	controlNameTest
IpControlType	string	Yes	The type of the ACL. Valid values: ALLOW: an IP address whitelist REFUSE: an IP address blacklist	ALLOW
Description	string	No	The description. The description can be up to 200 characters in length.	test
IpControlPolicys	array<object>	No	The information about the policies. The information is an array of ipcontrolpolicys data.
	object	No
AppId	string	No	The ID of the application that is restricted by the policy. You can configure the AppId parameter only when the value of the IpControlType parameter is ALLOW. You can add only one application ID at a time. If this parameter is empty, no applications are restricted. If this parameter is not empty, not only IP addresses but also applications are restricted. If this parameter is not empty and no security authentication method is specified for the API, all API calls are restricted. If the value of the IpControlType parameter is REFUSE and the AppId parameter is not empty, API Gateway automatically ignores the AppId parameter and restricts only the IP addresses. Valid values of N in IpControlPolicys.N: `[1,100]`.	11111
CidrIp	string	No	The IP address or CIDR block involved in a policy. If you want to specify a policy when you create an ACL, this parameter is required. The IP address or CIDR block that is defined in each policy. Separate multiple IP addresses or CIDR blocks with semicolons (;). You can add a maximum of 10 IP addresses or CIDR blocks. Valid values of N in IpControlPolicys.N: `[1,100]`.	114.1.1.0/24

Response elements

Element	Type	Description	Example
	object
IpControlId	string	The ID of the ACL.	7ea91319a34d48a09b5c9c871d9768b1
RequestId	string	The ID of the request.	CE5722A6-AE78-4741-A9B0-6C817D360510

Examples

Success response

JSON format

{
  "IpControlId": "7ea91319a34d48a09b5c9c871d9768b1",
  "RequestId": "CE5722A6-AE78-4741-A9B0-6C817D360510"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.