All Products
Search
Document Center

API Gateway:DescribeIpControlPolicyItems

Last Updated:Mar 01, 2024

Queries the rule entries of an IP address-based traffic control policy.

Operation description

  • This operation is intended for API providers.
  • You can filter the query results by policy ID.

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:DescribeIpControlPolicyItemsRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
IpControlIdstringNo

The ID of the ACL. The ID is unique.

7ea91319a34d48a09b5c9c871d9768b1
PolicyItemIdstringNo

The ID of the policy.

P151617000829241
PageNumberintegerNo

The number of the page to return. Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Maximum value: 100. Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object
PageNumberinteger

The page number of the returned page.

1
RequestIdstring

The ID of the request.

CEF72CEB-54B6-4AE8-B225-F876FF7BZ004
PageSizeinteger

The number of entries returned per page.

10
TotalCountinteger

The total number of returned entries.

2
IpControlPolicyItemsobject []

The information about policies. The information is an array of IpControlPolicyItem data.

ModifiedTimestring

The time when the policy was modified. The time is displayed in UTC.

2018-01-17T06:25:13Z
PolicyItemIdstring

The ID of the policy.

P151617000829241
CidrIpstring

The IP addresses or CIDR blocks.

113.125.XX.XX;101.11.XX.XX
CreateTimestring

The time when the policy was created. The time is displayed in UTC.

2018-01-17T06:20:08Z
AppIdstring

The ID of the application.

11112

Examples

Sample success responses

JSONformat

{
  "PageNumber": 1,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004",
  "PageSize": 10,
  "TotalCount": 2,
  "IpControlPolicyItems": {
    "IpControlPolicyItem": [
      {
        "ModifiedTime": "2018-01-17T06:25:13Z",
        "PolicyItemId": "P151617000829241",
        "CidrIp": "113.125.XX.XX;101.11.XX.XX",
        "CreateTime": "2018-01-17T06:20:08Z",
        "AppId": "11112"
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history