All Products
Document Center

Query the IP access control list (DescribeIpControls)

Last Updated: Feb 25, 2018


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:
  • ALLOW: whitelist
  • REFUSE: blacklist
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)


Sample request

  2. &IpControlId=7ea91319a34d48a09b5c9c871d9768b1
  3. &<Public Request Parameters>

Sample response

XML format

  1. <CreateSignatureResponse>
  2. <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>
  3. <TotalCount>1</TotalCount>
  4. <PageSize>10</PageSize>
  5. <PageNumber>1</PageNumber>
  6. <IpControlInfos>
  7. <IpControlInfo>
  8. <RegionId>cn-qingdao</RegionId>
  9. <IpControlId>7ea91319a34d48a09b5c9c871d9768b1</IpControlId>
  10. <IpControlName>testControl11</IpControlName>
  11. <IpControlType>ALLOW</IpControlType>
  12. <Description>description</Description>
  13. <CreateTime>2018-01-17T05:48:11Z</CreateTime>
  14. <ModifiedTime>2018-01-17T06:00:38Z</ModifiedTime>
  15. </IpControlInfo>
  16. </IpControlInfos>
  17. </CreateSignatureResponse>

JSON format

  1. {
  2. "TotalCount":1,
  3. "PageSize":10,
  4. "PageNumber":1,
  5. "RequestId":"75BC8C98-85F3-4468-A8CB-146AC5830900",
  6. "IpControlInfos":
  7. {
  8. "IpControlInfo":
  9. [
  10. {
  11. "IpControlName":"testControl11",
  12. "ModifiedTime":"2018-01-17T06:00:38Z",
  13. "IpControlType":"ALLOW",
  14. "RegionId":"cn-qingdao",
  15. "IpControlId":"7ea91319a34d48a09b5c9c871d9768b1",
  16. "Description":"description",
  17. "CreateTime":"2018-01-17T05:48:11Z"
  18. }
  19. ]
  20. }
  21. }