All Products
Search
Document Center

API Gateway:RemoveIpControlApis

Last Updated:May 25, 2023

Unbinds an API from an access control list (ACL).

Operation Description

The ID of the API group containing the API to be managed.

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:RemoveIpControlApisWrite
  • ApiGateway
    acs:apigateway:*:{#accountId}:*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
IpControlIdstringYes

The ID of the API to be managed.

  • If this parameter is not specified, all APIs of the API group are unbound in the specified environment by default.
  • The IDs of the APIs that you want to query. Separate multiple IDs with commas (,). A maximum of 100 IDs can be entered.
dd05f1c54d6749eda95f9fa6d491449a
GroupIdstringYes

The name of the runtime environment. Valid values:

  • RELEASE
  • TEST
0009db9c828549768a200320714b8930
ApiIdsstringNo

The ID of the request.

123
StageNamestringYes
  • This API is intended for API providers.
  • The unbinding takes effect immediately. After the API is unbound from the ACL, the corresponding environment does not have any IP address access control in place for the API.
TEST

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

Unbinds an API from an access control list (ACL).

CEF72CEB-54B6-4AE8-B225-F876FF7BZ004

Examples

Sample success responses

JSONformat

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

XMLformat

<RemoveIpControlApisResponse>
    <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>
</RemoveIpControlApisResponse>

Error codes

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