文档

CreateIpControl - 新增IP访问控制

更新时间:

在某个地域下新增IP访问控制。

接口说明

调用本接口之前,您需要了解:

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

调试

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

授权信息

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

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

请求参数

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

IP 访问控制名称。支持大小写英文字母、中文、数字、下划线(_)、长度为[4,50]个字符, 且不能以下划线开头。

controlNameTest
IpControlTypestring

IP 访问控制类型:

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

描述,不超过 200 个字符

test
IpControlPolicysobject []

由 ipcontrolpolicys 组成的数组格式,返回策略的信息项

AppIdstring

策略限制的 AppId,只有控制类型为白名单(即 IpControlType 为 ALLOW)时,才可同时增加 AppId 的限制。

  • 一次只能增加一个;
  • 为空表示没有 AppId 的限制;
  • 当该值不为空,表示在有 IP 限制的同时,还限制访问的 AppId;
  • 当该值不为空,如果 API 的安全认证为“无认证”,将限制所有的 API 调用,请注意;
  • 当黑名单(IpControlType 为 REFUSE)时,该值不为空,API 网关会自动忽略该值,只设置 IP 的限制;
  • IpControlPolicys.N 中 N 的取值范围:[1,100]
11111
CidrIpstring

具体策略的 IP 或者 IP 段

  • 当要在创建访问控制时指定策略,该值不能为空;
  • 每条策略的 IP 或者 IP 段,多个请用英文分号(;)分割,最多添加 10 个;
  • IpControlPolicys.N 中 N 的取值范围:[1,100]
114.1.1.0/24

返回参数

名称类型描述示例值
object
IpControlIdstring

访问控制的 ID

7ea91319a34d48a09b5c9c871d9768b1
RequestIdstring

请求 ID

CE5722A6-AE78-4741-A9B0-6C817D360510

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (0)
文档反馈