Creates an access control list (ACL) in a region.
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.
Debugging
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:CreateIpControl | Write |
|
| 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 |
Description | string | No | The description. The description can be up to 200 characters in length. | test |
IpControlPolicys | object [] | No | The information about the policies. The information is an array of ipcontrolpolicys data. | |
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.
| 11111 |
CidrIp | string | No | The IP address or CIDR block involved in a policy.
| 114.1.1.0/24 |
Response parameters
Examples
Sample success responses
JSON
format
{
"IpControlId": "7ea91319a34d48a09b5c9c871d9768b1",
"RequestId": "CE5722A6-AE78-4741-A9B0-6C817D360510"
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|