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

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

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeIpControls

操作接口名,系统规定参数,取值:DescribeIpControls

IpControlId String 7ea91319a34d48a09b5c9c871d9768b1

IP访问控制的ID,代表了唯一的IP控制策略

IpControlName String 访问控制test

访问控制名称

IpControlType String ALLOW

IP访问控制类型:

  • ALLOW:IP访问控制为白名单类型
  • REFUSE:IP访问控制为黑名单类型
PageNumber Integer 1

指定要查询的页码,默认是1,起始是1

PageSize Integer 10

指定分页查询时每页行数,最大值100,默认值为10

返回数据

名称 类型 示例值 描述
IpControlInfos Array

由IpControlInfo组成的数组格式,返回的是IP访问控制的信息项(不包含具体的策略)。

IpControlInfo

由IpControlInfo组成的数组格式,返回的是IP访问控制的信息项(不包含具体的策略)。

CreateTime String 2018-01-17T05:48:11Z

创建时间(UTC)

Description String description

描述

IpControlId String 7ea91319a34d48a09b5c9c871d9768b1

IP访问控制编号

IpControlName String testControl11

IP访问控制名称

IpControlType String ALLOW

IP访问控制类型

ModifiedTime String 2018-01-17T06:00:38Z

修改时间(UTC)

RegionId String cn-qingdao

所在的region

PageNumber Integer 1

返回指定的页码

PageSize Integer 10

返回指定的每页条数

RequestId String CEF72CEB-54B6-4AE8-B225-F876FF7BZ004

请求ID

TotalCount Integer 1

返回结果的总条数

示例

请求示例


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

正常返回示例

XML 格式

<DescribeIpControlsResponse>
      <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>
</DescribeIpControlsResponse>

JSON 格式

{
	"IpControlInfos":{
		"IpControlInfo":[
			{
				"Description":"description",
				"IpControlName":"testControl11",
				"IpControlId":"7ea91319a34d48a09b5c9c871d9768b1",
				"IpControlType":"ALLOW",
				"CreateTime":"2018-01-17T05:48:11Z",
				"RegionId":"cn-qingdao",
				"ModifiedTime":"2018-01-17T06:00:38Z"
			}
		]
	},
	"PageNumber":1,
	"TotalCount":1,
	"PageSize":10,
	"RequestId":"75BC8C98-85F3-4468-A8CB-146AC5830900"
}

错误码

访问错误中心查看更多错误码。