描述
分页查询用户自定义的IP访问控制列表
- 此功能面向API提供者
- 用于查询某Region下的IP访问控制列表,Region为系统参数
- 可根据控制ID,名称,类型等过滤。
- 该接口不含具体的策略,如果需要查询详细策略,请用查询IP访问控制策略列表接口
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 操作接口名,系统规定参数,取值:DescribeIpControls |
IpControlId | String | 否 | IP访问控制的ID,代表了唯一的IP控制策略 |
IpControlName | String | 否 | 访问控制名称 |
IpControlType | String | 否 | IP访问控制类型:
|
PageNumber | Integer | 否 | 指定要查询的页码,默认是1,起始是1 |
PageSize | Integer | 否 | 指定分页查询时每页行数,最大值100,默认值为10 |
返回参数
名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 本次请求编号 |
TotalCount | Integer | 返回结果的总条数 |
PageSize | Integer | 返回指定的每页条数 |
PageNumber | Integer | 返回指定的页码 |
IpControlInfos | IpControlInfo | 由IpControlInfo组成的数组格式,返回的是IP访问控制的信息项(不包含具体的策略)。 |
示例
请求示例
https://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeIpControls
&IpControlId=7ea91319a34d48a09b5c9c871d9768b1
&<公共请求参数>
返回示例
XML
格式
<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
格式
{
"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"
}
]
}
}