All Products
Search
Document Center

API Gateway:ModifyIpControlPolicyItem

Last Updated:Mar 01, 2024

Modifies a policy in an access control list (ACL).

Operation description

  • This operation is intended for API providers.
  • The modification immediately takes effect on all the APIs that are bound to the policy.
  • This operation causes a full modification of the content of a policy.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
apigateway:ModifyIpControlPolicyItemWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
IpControlIdstringYes

The ID of the ACL. The ID is unique.

7ea91319a34d48a09b5c9c871d9768b1
PolicyItemIdstringYes

The ID of the policy.

P151617000829241
AppIdstringNo

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.
123
CidrIpstringYes

The IP address or CIDR block that is defined in a policy. Separate multiple IP addresses or CIDR blocks with semicolons (;). You can add a maximum of 10 IP addresses or CIDR blocks.

113.125.1.101;101.11.1.1

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

CEF72CEB-54B6-4AE8-B225-F876FF7BZ004

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history