首页 API 网关 开发指南 API参考指南 API目录 访问控制插件(经典网络实例) DescribeIpControlPolicyItems - 查询IP访问控制策略列表

DescribeIpControlPolicyItems - 查询IP访问控制策略列表

分页查询某IP访问控制下的策略列表。

接口说明

  • 此功能面向API提供者
  • 可支持策略ID过滤

调试

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

调试

授权信息

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

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

请求参数

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

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

7ea91319a34d48a09b5c9c871d9768b1
PolicyItemIdstring

策略ID

P151617000829241
PageNumberinteger

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

1
PageSizeinteger

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

10

返回参数

名称类型描述示例值
object
PageNumberinteger

返回指定的页码

1
RequestIdstring

请求ID

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

返回指定的每页条数

10
TotalCountinteger

返回结果的总条数

2
IpControlPolicyItemsarray

由 IpControlPolicyItem组成的数组格式,返回的是某IP访问控制下的策略信息。

object
ModifiedTimestring

修改时间(UTC)

2018-01-17T06:25:13Z
PolicyItemIdstring

某项策略的ID

P151617000829241
CidrIpstring

IP或者IP段组成的字符串

113.125.XX.XX;101.11.XX.XX
CreateTimestring

创建时间(UTC)

2018-01-17T06:20:08Z
AppIdstring

应用ID

11112

示例

正常返回示例

JSON格式

{
    "TotalCount":2,
    "PageSize":10,
    "PageNumber":1,
    "RequestId":"754693C2-E0ED-4A7F-A72A-792241167B3C",
    "IpControlPolicyItems":
    {
        "IpControlPolicyItem":
        [
            {
                "PolicyItemId":"P151617000829241",
                "CreateTime":"2018-01-17T06:20:08Z",
                "ModifiedTime":"2018-01-17T06:25:13Z",
                "CidrIp":"113.125.1.101;101.11.1.1",
                "AppId":"11112"
            },
            {
                "PolicyItemId":"P151616809156728",
                "CreateTime":"2018-01-17T05:48:11Z",
                "ModifiedTime":"2018-01-17T05:48:11Z",
                "CidrIp":"102.0.0.0\/8"
            }
        ]
    }
}

XML格式

<DescribeIpControlPolicyItemsResponse>
    <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>
    <TotalCount>2</TotalCount>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <IpControlPolicyItems>
        <IpControlPolicyItem>
            <PolicyItemId>P151617000829241</PolicyItemId>
            <CreateTime>2018-01-17T06:20:08Z</CreateTime>
            <ModifiedTime>2018-01-17T06:25:13Z</ModifiedTime>
            <CidrIp>113.125.1.101;101.11.1.1</CidrIp>
            <AppId>11112</AppId>
        </IpControlPolicyItem>
        <IpControlPolicyItem>
            <PolicyItemId>P151616809156728</PolicyItemId>
            <CreateTime>2018-01-17T05:48:11Z</CreateTime>
            <ModifiedTime>2018-01-17T05:48:11Z</ModifiedTime>
            <CidrIp>102.0.0.0/8</CidrIp>
        </IpControlPolicyItem>
    </IpControlPolicyItems>
</DescribeIpControlPolicyItemsResponse>

错误码

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

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