全部产品
云市场

创建IP访问控制(CreateIpControl)

更新时间:2018-02-23 19:34:44

描述

在某个地域下新增IP访问控制,用于允许(或拒绝)某些IP访问API。

  • 此功能面向API提供者
  • IP访问控制创建后未绑定API前是无意义的,绑定API后,对绑定的API即时生效
  • 具体的IP策略可以在创建IP控制时添加,也可以通过AddIpControlPolicyItem接口添加
  • 当IP访问控制下策略为空时,该策略无效

请求参数

名称 类型 是否必须 描述
Action String 操作接口名,系统规定参数,取值:CreateIpControl
IpControlName String IP访问控制名称。支持大小写英文字母、中文、数字、下划线(_)、长度为[4,50]个字符, 且不能以下划线开头。
IpControlType String IP访问控制类型:
  • ALLOW:IP访问控制为白名单类型
  • REFUSE:IP访问控制为黑名单类型
Description String 描述,不超过200个字符
IpControlPolicys.N.CidrIp String 具体策略的IP或者IP段
  • 当要在创建访问控制时指定策略,该值不能为空;
  • 每条策略的IP或者IP段,多个请用英文分号(;)分割,最多添加10个;
  • IpControlPolicys.N 中N的取值范围:[1,100]
IpControlPolicys.N.AppId String 策略限制的AppId,只有控制类型为白名单(即 IpControlType为ALLOW)时,才可同时增加AppId的限制。
  • 一次只能增加一个;
  • 为空表示没有AppId的限制;
  • 当该值不为空,表示在有IP限制的同时,还限制访问的AppId;
  • 当该值不为空,如果API的安全认证为“无认证”,将限制所有的API调用,请注意;
  • 当黑名单(IpControlType为REFUSE)时,该值不为空,API网关会自动忽略该值,只设置IP的限制;
  • IpControlPolicys.N 中N的取值范围:[1,100];

返回参数

名称 类型 描述
RequestId String 本次请求编号
IpControlId String 访问控制的ID

示例

请求示例

  1. https://apigateway.cn-qingdao.aliyuncs.com/?Action=CreateIpControl
  2. &IpControlName=controlNameTest
  3. &IpControlType=ALLOW
  4. &Description=test
  5. &IpControlPolicys.1.CidrIp=114.1.1.0/24
  6. &IpControlPolicys.1.AppId=11111
  7. &<公共请求参数>

返回示例

XML格式

  1. <CreateSignatureResponse>
  2. <RequestId>CE5722A6-AE78-4741-A9B0-6C817D360510</RequestId>
  3. <IpControlId>7ea91319a34d48a09b5c9c871d9768b1</IpControlId>
  4. </CreateSignatureResponse>

JSON格式

  1. {
  2. "RequestId":"CE5722A6-AE78-4741-A9B0-6C817D360510",
  3. "IpControlId":"7ea91319a34d48a09b5c9c871d9768b1"
  4. }