CreateIpControl-阿里云帮助中心

Operation description

Before you call this operation, note the following items:

This feature is intended for API providers.
An IP access control policy is meaningless until it is bound to an API. After it is bound to an API, it takes effect immediately.
You can add specific IP policies when you create the IP access control policy.
If no policies are configured under the IP access control policy, the policy is invalid.

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 IP access control policy. The name must be 4 to 50 characters in length and can contain uppercase and lowercase letters, Chinese characters, digits, and underscores (_). It cannot start with an underscore.	controlNameTest
IpControlType	string	Yes	The type of the IP access control policy. Valid values: ALLOW: The IP access control policy is a whitelist. REFUSE: The IP access control policy is a blacklist.	ALLOW
Description	string	No	The description of the IP access control policy. The description can be up to 200 characters in length.	test
IpControlPolicys	array<object>	No	The array of IP control policies, which contains the information items of the policies.
	object	No
AppId	string	No	The AppId restricted by the policy. You can add an AppId restriction only when the control type is whitelist (IpControlType is ALLOW). You can add only one AppId at a time. If this parameter is empty, no AppId restriction is applied. If this parameter is not empty, the AppId is restricted in addition to the IP address restriction. If this parameter is not empty and the security authentication of the API is set to No Authentication, all API calls are restricted. Take note of this. If the control type is blacklist (IpControlType is REFUSE) and this parameter is not empty, API Gateway automatically ignores this value and applies only the IP address restriction. Valid values of N in IpControlPolicys.N: 1 to 100.	11111
CidrIp	string	No	The IP address or CIDR block of the specific policy. To specify a policy when you create the access control policy, this parameter is required. For each policy, you can specify multiple IP addresses or CIDR blocks. Separate multiple values with semicolons (;). You can add up to 10 values. Valid values for N in IpControlPolicys.N: 1 to 100.	114.1.1.0/24

Response elements

Element	Type	Description	Example
	object
IpControlId	string	The ID of the IP access control policy.	7ea91319a34d48a09b5c9c871d9768b1
RequestId	string	The request ID.	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.