使用CreateIpControl新增IP访问控制-API 网关-阿里云-API 网关(API Gateway)-阿里云帮助中心

接口说明

调用本接口之前，您需要了解：

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

操作

访问级别

资源类型

条件关键字

关联操作

apigateway:CreateIpControl

create

*IpControl

acs:apigateway:{#regionId}:{#accountId}:ipcontrol/*

无

名称	类型	必填	描述	示例值
IpControlName	string	是	IP 访问控制名称。支持大小写英文字母、中文、数字、下划线（_）、长度为`[4,50]`个字符, 且不能以下划线开头。	controlNameTest
IpControlType	string	是	IP 访问控制类型： ALLOW：IP 访问控制为白名单类型 REFUSE：IP 访问控制为黑名单类型	ALLOW
Description	string	否	描述，不超过 200 个字符	test
IpControlPolicys	array<object>	否	由 ipcontrolpolicys 组成的数组格式，返回策略的信息项
	object	否
AppId	string	否	策略限制的 AppId，只有控制类型为白名单（即 IpControlType 为 ALLOW）时，才可同时增加 AppId 的限制。一次只能增加一个；为空表示没有 AppId 的限制；当该值不为空，表示在有 IP 限制的同时，还限制访问的 AppId；当该值不为空，如果 API 的安全认证为“无认证”，将限制所有的 API 调用，请注意；当黑名单（IpControlType 为 REFUSE）时，该值不为空，API 网关会自动忽略该值，只设置 IP 的限制； IpControlPolicys.N 中 N 的取值范围：`[1,100]`；	11111
CidrIp	string	否	具体策略的 IP 或者 IP 段当要在创建访问控制时指定策略，该值不能为空；每条策略的 IP 或者 IP 段，多个请用英文分号（;）分割，最多添加 10 个； IpControlPolicys.N 中 N 的取值范围：`[1,100]`	114.1.1.0/24

正常返回示例

JSON格式

{
  "IpControlId": "7ea91319a34d48a09b5c9c871d9768b1",
  "RequestId": "CE5722A6-AE78-4741-A9B0-6C817D360510"
}

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

更多信息，参考变更详情。