DescribeIpControlPolicyItems

0.0.201

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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

Operation	Access level	Resource type	Condition key	Associated operation
apigateway:DescribeIpControlPolicyItems	get	*IpControl `acs:apigateway:{#regionId}:{#accountId}:ipcontrol/{#IpControlId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example

Parameter	Type	Required	Description	Example
IpControlId	string	No	The ID of the ACL. The ID is unique.	7ea91319a34d48a09b5c9c871d9768b1
PolicyItemId	string	No	The ID of the policy.	P151617000829241
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Maximum value: 100. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example

Parameter	Type	Description	Example
	object
PageNumber	integer	The page number of the returned page.	1
RequestId	string	The ID of the request.	CEF72CEB-54B6-4AE8-B225-F876FF7BZ004
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of returned entries.	2
IpControlPolicyItems	array<object>	The information about policies. The information is an array of IpControlPolicyItem data.
IpControlPolicyItem	object
ModifiedTime	string	The time when the policy was modified. The time is displayed in UTC.	2018-01-17T06:25:13Z
PolicyItemId	string	The ID of the policy.	P151617000829241
CidrIp	string	The IP addresses or CIDR blocks.	113.125.XX.XX;101.11.XX.XX
CreateTime	string	The time when the policy was created. The time is displayed in UTC.	2018-01-17T06:20:08Z
AppId	string	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"
      }
    ]
  }
}