文档

AddEntriesToAcl - 在访问控制策略组中添加IP条目

更新时间:

为访问控制策略组添加IP条目,并通过设置白名单或黑名单来允许或者限制监听对这些IP条目访问请求的转发,可实现客户端请求的精确控制。您可以通过调用AddEntriesToAcl接口在访问控制策略组中添加IP条目。

接口说明

  • AddEntriesToAcl 接口属于异步接口,即系统会先返回一个请求 ID,但 IP 条目并未添加完成,系统后台的添加任务仍在进行。您可以调用 GetAclListAcls 查询访问控制策略组的状态:
    • 当访问控制策略组处于 configuring 状态时,表示 IP 条目正在添加中,在该状态下,您只能执行查询操作,不能执行其他操作。
    • 当访问控制策略组处于 active 状态时,表示 IP 条目添加完成。
  • AddEntriesToAcl 接口不支持在同一个全球加速实例内并发为访问控制策略组添加 IP 条目。

调试

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

授权信息

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

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

请求参数

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

全球加速实例所属的地域 ID,仅取值:cn-hangzhou

cn-hangzhou
AclIdstring

访问控制策略组 ID。

nacl-hp34s2h0xx1ht4nwo****
AclEntriesobject []

需要添加的访问控制策略组条目,即 IP 地址条目或 IP 地址段条目。

一次最多支持添加 50 个条目。

Entrystring

需要添加的访问控制策略组条目,即 IP 地址条目(192.168.XX.XX)或 IP 地址段条目(10.0.XX.XX/24)。 一次最多支持添加 50 个条目。

说明 该参数必填。
10.0.XX.XX/24
EntryDescriptionstring

访问控制策略组条目备注内容。

一次最多支持添加 50 个条目备注。

长度限制为 1~256 个字符,允许包含字母、数字、短划线(-)、正斜线(/)、半角句号(.)和下划线(_),支持中文字符。

test-entry
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
5A2CFF0E-5718-45B5-9D4D-70B3FF3898
DryRunboolean

是否只预检此次请求。取值:

  • true:发送检查请求,不会在访问控制策略组中添加 IP 条目。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回 HTTP 2xx 状态码并直接进行操作。
false

返回参数

名称类型描述示例值
object

返回信息列表。

RequestIdstring

请求 ID。

365F4154-92F6-4AE4-92F8-7FF34B540710
AclIdstring

访问控制策略组 ID。

nacl-hp34s2h0xx1ht4nwo****

示例

正常返回示例

JSON格式

{
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "AclId": "nacl-hp34s2h0xx1ht4nwo****"
}

错误码

HTTP status code错误码错误信息描述
400NotExist.Aclacl %s is not exist访问控制列表 %s 不存在
400StateError.Aclacl state %s is illegal访问控制列表 %s 状态非法。
400IsExist.AclEntriesIsExistacl entries %s is exist访问控制条目%s已存在。
400QuotaExceeded.AclEntriesThe number of acl entries exceeds the limit访问控制列表条目数量超过了配额限制。
400Repeat.AclEntriesacl entries repeat访问控制列表条目重复。

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

变更历史

变更时间变更内容概要操作
2021-04-27新增 OpenAPI看变更集
  • 本页导读 (1)
文档反馈