Description
Query the custom IP access control list in multiple pages.
- This function is intended for API providers.
- It is used to query the IP access control list for a region. Region is a system parameter.
- You can specify an access control ID, name, or type to filter the displayed information.
- This interface does not show specific policies. To view specific policies, use the View the IP access control policies interface.
Request parameters
Parameter | Type | Required | Description |
---|---|---|---|
Action | String | Yes | Operation interface name, a required parameter, value: DescribeIpControls |
IpControlId | String | No | IP access control ID, which identifies a unique IP access control policy |
IpControlName | String | No | Access control name |
IpControlType | String | No | IP access control type:
|
PageNumber | Integer | No | Page number specified for query; default value: 1; start number: 1 |
PageSize | Integer | No | Number of lines per page; maximum value: 100; default value: 10 |
Response parameters
Parameter | Type | Description |
---|---|---|
RequestId | String | ID of the current request |
TotalCount | Integer | Total number of returned results |
PageSize | Integer | Number of results returned per page |
PageNumber | Integer | Page number for returned results |
IpControlInfos | IpControlInfo | IpControlInfo array, containing the IP access control information items (not including the specific policies) |
Example
Sample request
https://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeIpControls
&IpControlId=7ea91319a34d48a09b5c9c871d9768b1
&<Public Request Parameters>
Sample response
XML
format
<CreateSignatureResponse>
<RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>
<TotalCount>1</TotalCount>
<PageSize>10</PageSize>
<PageNumber>1</PageNumber>
<IpControlInfos>
<IpControlInfo>
<RegionId>cn-qingdao</RegionId>
<IpControlId>7ea91319a34d48a09b5c9c871d9768b1</IpControlId>
<IpControlName>testControl11</IpControlName>
<IpControlType>ALLOW</IpControlType>
<Description>description</Description>
<CreateTime>2018-01-17T05:48:11Z</CreateTime>
<ModifiedTime>2018-01-17T06:00:38Z</ModifiedTime>
</IpControlInfo>
</IpControlInfos>
</CreateSignatureResponse>
JSON
format
{
"TotalCount":1,
"PageSize":10,
"PageNumber":1,
"RequestId":"75BC8C98-85F3-4468-A8CB-146AC5830900",
"IpControlInfos":
{
"IpControlInfo":
[
{
"IpControlName":"testControl11",
"ModifiedTime":"2018-01-17T06:00:38Z",
"IpControlType":"ALLOW",
"RegionId":"cn-qingdao",
"IpControlId":"7ea91319a34d48a09b5c9c871d9768b1",
"Description":"description",
"CreateTime":"2018-01-17T05:48:11Z"
}
]
}
}