调用DescribeIpControls查询IP访问控制列表_API 网关(API Gateway)-阿里云帮助中心

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

接口说明

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
apigateway:DescribeIpControls	get	IpControl acs:apigateway:{#regionId}:{#accountId}:ipcontrol/*	无	无

请求参数

名称	类型	必填	描述	示例值
IpControlId	string	否	IP 访问控制的 ID，代表了唯一的 IP 控制策略	7ea91319a34d48a09b5c9c871d9768b1
IpControlName	string	否	访问控制名称	访问控制test
IpControlType	string	否	IP 访问控制类型： ALLOW：IP 访问控制为白名单类型 REFUSE：IP 访问控制为黑名单类型	ALLOW
PageNumber	integer	否	指定要查询的页码，默认是 1，起始是 1	1
PageSize	integer	否	指定分页查询时每页行数，最大值 100，默认值为 10	10

返回参数

名称	类型	描述	示例值
	object
PageNumber	integer	返回指定的页码	1
RequestId	string	请求 ID	CEF72CEB-54B6-4AE8-B225-F876FF7BZ004
PageSize	integer	返回指定的每页条数	10
TotalCount	integer	返回结果的总条数	1
IpControlInfos	array<object>	由 IpControlInfo 组成的数组格式，返回的是 IP 访问控制的信息项（不包含具体的策略）。
IpControlInfo	object
IpControlId	string	IP 访问控制编号	7ea91319a34d48a09b5c9c871d9768b1
IpControlType	string	IP 访问控制类型	ALLOW
ModifiedTime	string	修改时间（UTC）	2018-01-17T06:00:38Z
IpControlName	string	IP 访问控制名称	testControl11
Description	string	描述	description
CreateTime	string	创建时间（UTC）	2018-01-17T05:48:11Z
RegionId	string	所在的 region	cn-qingdao

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004",
  "PageSize": 10,
  "TotalCount": 1,
  "IpControlInfos": {
    "IpControlInfo": [
      {
        "IpControlId": "7ea91319a34d48a09b5c9c871d9768b1",
        "IpControlType": "ALLOW",
        "ModifiedTime": "2018-01-17T06:00:38Z",
        "IpControlName": "testControl11",
        "Description": "description",
        "CreateTime": "2018-01-17T05:48:11Z",
        "RegionId": "cn-qingdao"
      }
    ]
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史