DescribeIpControls - 查询IP访问控制列表

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

接口说明

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

调试

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

调试

授权信息

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

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

请求参数

名称类型必填描述示例值
IpControlIdstring

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

7ea91319a34d48a09b5c9c871d9768b1
IpControlNamestring

访问控制名称

访问控制test
IpControlTypestring

IP访问控制类型:

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

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

1
PageSizeinteger

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

10

返回参数

名称类型描述示例值
object
PageNumberinteger

返回指定的页码

1
RequestIdstring

请求ID

CEF72CEB-54B6-4AE8-B225-F876FF7BZ004
PageSizeinteger

返回指定的每页条数

10
TotalCountinteger

返回结果的总条数

1
IpControlInfosarray

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

object
IpControlIdstring

IP访问控制编号

7ea91319a34d48a09b5c9c871d9768b1
IpControlTypestring

IP访问控制类型

ALLOW
ModifiedTimestring

修改时间(UTC)

2018-01-17T06:00:38Z
IpControlNamestring

IP访问控制名称

testControl11
Descriptionstring

描述

description
CreateTimestring

创建时间(UTC)

2018-01-17T05:48:11Z
RegionIdstring

所在的region

cn-qingdao

示例

正常返回示例

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"
            }
        ]
    }
}

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>

错误码

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

阿里云首页 API 网关 相关技术圈