AddACLRule - 添加访问控制规则

调用AddACLRule添加访问控制规则。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

smartag:AddACLRule

create

*Acl

acs:smartag:{#regionId}:{#accountId}:acl/{#AclId}

请求参数

名称

类型

必填

描述

示例值

RegionId

string

访问控制实例所属地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-shanghai

AclId

string

访问控制实例 ID。

acl-xhwhyuo43l0n*****

Description

string

访问控制规则描述信息。

描述长度为1~512个字符。

desctest

Direction

string

访问控制规则应用方向。取值:

  • in:入方向,指从外部访问智能接入网关实例所在的本地分支的流量。

  • out:出方向,指从智能接入网关实例所在的本地分支访问外部的流量。

in

SourceCidr

string

源网段。

源网段格式为 CIDR 格式。例如:192.168.1.0/24。

192.168.20.0/24

DestCidr

string

目的网段。

目的网段格式为 CIDR 格式。例如:192.168.10.0/24。

192.168.10.0/24

IpProtocol

string

访问控制规则应用的协议。

访问控制功能支持的协议类型,请以控制台为准。协议格式不区分大小写。

tcp

SourcePortRange

string

源端口范围。

取值范围:-11~65535

源端口范围格式例如:1/200、80/80,其中-1/-1 代表不限制端口。

1/200

DestPortRange

string

目的端口范围。

取值范围:-11~65535

目的端口范围格式例如:1/200、80/80,其中-1/-1 代表不限制端口。

1/200

Policy

string

访问控制规则授权策略。取值:

  • accept:允许。

  • drop:拒绝。

accept

Priority

integer

访问控制规则优先级。

数值越小,优先级越高。同优先级时,首先下发到智能接入网关设备的规则优先生效。

取值范围:1~100。默认值:1

12

Type

string

访问控制规则类型。取值:

  • LAN:(默认值)私网,表示针对私网地址的流量设置访问控制规则。

  • WAN:公网,表示针对公网地址的流量设置访问控制规则。

LAN

Name

string

访问控制规则名称。

长度为 2~100 个字符,以大小写字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。

doctest

DpiSignatureIds

array

当前访问控制规则匹配的应用 ID 列表。

您可以通过 ListDpiSignatures 查询应用 ID 及其对应的应用信息。N 的最大值为 10

1

string

应用 ID。

系统支持一次最多输入 100 个应用 ID。

1

DpiGroupIds

array

当前访问控制规则匹配的应用组 ID 列表。

您可以通过 ListDpiGroups 查询应用组 ID 及其包含的应用信息。N 的最大值为 10

20

string

应用组 ID。

系统支持一次最多输入 100 个应用组 ID。

20

返回参数

名称

类型

描述

示例值

object

Policy

string

访问控制规则授权策略。

  • accept:允许。

  • drop:拒绝。

drop

Description

string

访问控制规则描述信息。

test

RequestId

string

请求 ID。

880F84CB-9B54-4413-A8A3-8832C82D1BC4

SourcePortRange

string

源端口范围。

1/65535

SourceCidr

string

源网段。

源网段格式为 CIDR 格式。例如:192.168.1.0/24。

192.168.20.0/24

Priority

integer

访问控制规则优先级。

数值越小,优先级越高。同优先级时,首先下发到智能接入网关设备的规则优先生效。

1

AclId

string

访问控制实例 ID。

acl-xhwhyuo43l0*******

AcrId

string

访问控制规则 ID。

acr-c1hkd054qywi******

DestPortRange

string

目的端口范围。

1/65535

Direction

string

访问控制规则应用方向。取值:

  • in:入方向,指从外部访问智能接入网关实例所在的本地分支的流量。

  • out:出方向,指从智能接入网关实例所在的本地分支访问外部的流量。

out

DpiGroupIds

object

DpiGroupId

array

string

当前访问控制规则匹配的应用组 ID 列表。

20

Name

string

访问控制规则名称。

doctest

Type

string

访问控制规则类型。

  • LAN:私网,表示针对私网地址的流量设置访问控制规则。

  • WAN:公网,表示针对公网地址的流量设置访问控制规则。

LAN

GmtCreate

integer

创建访问控制规则时的时间戳。

时间戳格式为 Long 型,优先级相同时,时间戳小的访问控制规则优先生效。

1553766882689

DestCidr

string

目的网段。

目的网段格式为 CIDR 格式。例如:192.168.10.0/24。

192.168.10.0/24

DpiSignatureIds

object

DpiSignatureId

array

string

当前访问控制规则匹配的应用 ID 列表。

1

IpProtocol

string

访问控制规则应用的协议。

TCP

示例

正常返回示例

JSON格式

{
  "Policy": "drop",
  "Description": "test",
  "RequestId": "880F84CB-9B54-4413-A8A3-8832C82D1BC4",
  "SourcePortRange": "1/65535",
  "SourceCidr": "192.168.20.0/24",
  "Priority": 1,
  "AclId": "acl-xhwhyuo43l0*******",
  "AcrId": "acr-c1hkd054qywi******",
  "DestPortRange": "1/65535",
  "Direction": "out",
  "DpiGroupIds": {
    "DpiGroupId": [
      "20"
    ]
  },
  "Name": "doctest",
  "Type": "LAN",
  "GmtCreate": 1553766882689,
  "DestCidr": "192.168.10.0/24",
  "DpiSignatureIds": {
    "DpiSignatureId": [
      "1"
    ]
  },
  "IpProtocol": "TCP"
}

错误码

HTTP status code

错误码

错误信息

描述

400 ACL.NoSupportWanType An SAG 1000 device does not support a WAN ACL. sag-1000类型盒子不支持公网ACL。
400 ACL.InvalidType The specified ACL type is invalid. 非法的ACL类型。
403 Forbidden User not authorized to operate on the specified resource. 用户没有操作此资源的权限。
403 MissingParameter The input parameter is missing, please check your input. 输入参数缺失,请检查您的输入。
403 InvalidDescription Description not valid. 详情描述超过长度限制。
403 InvalidParameter The specified parameter is invalid. 非法参数。
403 FeatureNotSupport The current edition of the smart access gateway does not support this feature. 智能接入网关当前版本不支持该功能特性。
403 FeatureNotSupportForActiveSmartAG The current edition of the active smart access gateway does not support this feature. 主智能接入网关的当前版本不支持该功能特性。
403 FeatureNotSupportForStandBySmartAG The current edition of the standby smart access gateway does not support this feature. 备智能接入网关的当前版本不支持该功能特性。
403 NotSupportedProtocol The specified protocol of the ACL rule is not supported. 您输入的ACL规则的协议类型是不支持的。
403 InvalidId.ACL The specified ACL ID is invalid. 无效的ACLID。
403 InvalidPortRange The specified port range is invalid. 您输入的端口范围不合法。
403 AcrPerAclAmountLimit The maximum number of rules in an ACL is exceeded. You can open a ticket to increase the quota. 您创建的ACL规则超出了单个ACL组下规则数量限额,您可以通过工单申请提升限额。
403 InternalError An internal server error occurred. 内部服务错误。

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

变更历史

更多信息,参考变更详情