文档

AddIpControlPolicyItem - 增加IP访问控制策略

更新时间:

向某个已存在的IP访问控制增加一条策略。

接口说明

调用该接口时请注意:

  • 此功能面向 API 提供者。
  • 增加该策略后,所有绑定该访问控制的 API,即时生效。
  • 一个 IP 访问控制下最多添加 100 条策略。

调试

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

授权信息

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

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

请求参数

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

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

7ea91319a34d48a09b5c9c871d9768b1
AppIdstring

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

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

具体策略的 IP 或者 IP 段,多个请用英文分号(;)分割,最多添加 10 个。

113.125.1.101;101.11.1.1

返回参数

名称类型描述示例值
object
PolicyItemIdstring

该策略的唯一 ID

P151617000829241
RequestIdstring

请求 ID

CEF72CEB-54B6-4AE8-B225-F876FF7BZ004

示例

正常返回示例

JSON格式

{
  "PolicyItemId": "P151617000829241",
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004"
}

JSON格式

{
  "PolicyItemId": "P151617000829241",
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004"
}

错误码

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

变更历史

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