全部产品
云市场

查询IP访问控制列表 (DescribeIpControls)

更新时间:2018-02-23 20:18:27

描述

分页查询用户自定义的IP访问控制列表

  • 此功能面向API提供者
  • 用于查询某Region下的IP访问控制列表,Region为系统参数
  • 可根据控制ID,名称,类型等过滤。
  • 该接口不含具体的策略,如果需要查询详细策略,请用查询IP访问控制策略列表接口

请求参数

名称 类型 是否必须 描述
Action String 操作接口名,系统规定参数,取值:DescribeIpControls
IpControlId String IP访问控制的ID,代表了唯一的IP控制策略
IpControlName String 访问控制名称
IpControlType String IP访问控制类型:
  • ALLOW:IP访问控制为白名单类型
  • REFUSE:IP访问控制为黑名单类型
PageNumber Integer 指定要查询的页码,默认是1,起始是1
PageSize Integer 指定分页查询时每页行数,最大值100,默认值为10

返回参数

名称 类型 描述
RequestId String 本次请求编号
TotalCount Integer 返回结果的总条数
PageSize Integer 返回指定的每页条数
PageNumber Integer 返回指定的页码
IpControlInfos IpControlInfo IpControlInfo组成的数组格式,返回的是IP访问控制的信息项(不包含具体的策略)。

示例

请求示例

  1. https://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeIpControls
  2. &IpControlId=7ea91319a34d48a09b5c9c871d9768b1
  3. &<公共请求参数>

返回示例

XML格式

  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格式

  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. }