全部产品
Search
文档中心

全球加速:AssociateAclsWithListener - 关联ACL到监听

更新时间:Mar 29, 2024

调用AssociateAclsWithListener接口将访问控制策略组(ACL)关联到监听。

接口说明

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

调试

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

授权信息

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

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

请求参数

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

全球加速所在的地域 ID,仅取值cn-hangzhou

cn-hangzhou
AclIdsarray

访问控制策略组 ID,最多支持关联 2 个访问控制策略组 ID。

string

访问控制策略组 ID,最多支持关联 2 个访问控制策略组 ID。

nacl-hp34s2h0xx1ht4nwo****
ListenerIdstring

监听 ID。

仅智能路由类型监听支持使用访问控制功能。

lsr-bp1bpn0kn908w4nbw****
AclTypestring

访问控制类型。取值:

  • white:仅转发来自所选访问控制策略组中设置的 IP 地址或地址段的请求,白名单适用于只允许特定 IP 访问的场景。设置白名单存在一定业务风险。一旦设置白名单,就只有白名单中的 IP 可以访问全球加速监听。如果开启了白名单访问,但访问策略组中没有添加任何 IP,则全球加速监听会转发全部请求。
  • black:来自所选访问控制策略组中设置的 IP 地址或地址段的所有请求都不会转发,黑名单适用于只限制某些特定 IP 访问的场景。如果开启了黑名单访问,但访问策略组中没有添加任何 IP,则全球加速监听会转发全部请求。
white
ClientTokenstring

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

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

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
02fb3da4****
DryRunboolean

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

  • true:发送检查请求,不会关联资源。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回 HTTP 2xx 状态码并直接进行操作。
false

返回参数

名称类型描述示例值
object

返回信息列表。

RequestIdstring

请求 ID。

64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF
AclIdsarray

访问控制策略组 ID。

string

访问控制策略组 ID。

nacl-hp34s2h0xx1ht4nwo****
ListenerIdstring

监听 ID。

lsr-bp1bpn0kn908w4nbw****

示例

正常返回示例

JSON格式

{
  "RequestId": "64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF",
  "AclIds": [
    "nacl-hp34s2h0xx1ht4nwo****"
  ],
  "ListenerId": "lsr-bp1bpn0kn908w4nbw****"
}

错误码

HTTP status code错误码错误信息描述
400NotExist.Listenerlistener %s is not exist监听%s不存在。
400NotActive.Listenerlistener %s is not active监听%s不可用。
400NotExist.Acceleratoraccelerator %s is not exist加速实例%s不存在。
400StateError.Acceleratoraccelerator state %s is illegal加速实例状态%s非法
400NotExist.Aclacl %s is not exist访问控制列表 %s 不存在
400StateError.Aclacl state %s is illegal访问控制列表 %s 状态非法。

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

变更历史

变更时间变更内容概要操作
2021-04-27新增 OpenAPI看变更集