全部产品
Search
文档中心

智能接入网关:AddACLRule - 添加访问控制规则

更新时间:Mar 29, 2024

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

调试

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

授权信息

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

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

请求参数

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

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

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

cn-shanghai
AclIdstring

访问控制实例 ID。

acl-xhwhyuo43l0n*****
Descriptionstring

访问控制规则描述信息。

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

desctest
Directionstring

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

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

源网段。

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

192.168.20.0/24
DestCidrstring

目的网段。

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

192.168.10.0/24
IpProtocolstring

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

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

tcp
SourcePortRangestring

源端口范围。

取值范围:-11~65535

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

1/200
DestPortRangestring

目的端口范围。

取值范围:-11~65535

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

1/200
Policystring

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

  • accept:允许。

  • drop:拒绝。

accept
Priorityinteger

访问控制规则优先级。

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

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

12
Typestring

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

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

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

LAN
Namestring

访问控制规则名称。

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

doctest
DpiSignatureIdsarray

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

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

string

应用 ID。

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

1
DpiGroupIdsarray

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

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

string

应用组 ID。

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

20

返回参数

名称类型描述示例值
object
Policystring

访问控制规则授权策略。

  • accept:允许。

  • drop:拒绝。

drop
Descriptionstring

访问控制规则描述信息。

test
RequestIdstring

请求 ID。

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

源端口范围。

1/65535
SourceCidrstring

源网段。

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

192.168.20.0/24
Priorityinteger

访问控制规则优先级。

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

1
AclIdstring

访问控制实例 ID。

acl-xhwhyuo43l0*******
AcrIdstring

访问控制规则 ID。

acr-c1hkd054qywi******
DestPortRangestring

目的端口范围。

1/65535
Directionstring

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

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

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

20
Namestring

访问控制规则名称。

doctest
Typestring

访问控制规则类型。

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

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

LAN
GmtCreatelong

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

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

1553766882689
DestCidrstring

目的网段。

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

192.168.10.0/24
DpiSignatureIdsarray
string

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

1
IpProtocolstring

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

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错误码错误信息描述
400ACL.NoSupportWanTypeAn SAG 1000 device does not support a WAN ACL.sag-1000类型盒子不支持公网ACL。
400ACL.InvalidTypeThe specified ACL type is invalid.非法的ACL类型。
403ForbiddenUser not authorized to operate on the specified resource.用户没有操作此资源的权限。
403MissingParameterThe input parameter is missing, please check your input.输入参数缺失,请检查您的输入。
403InvalidDescriptionDescription not valid.详情描述超过长度限制。
403InvalidParameterThe specified parameter is invalid.非法参数。
403FeatureNotSupportThe current edition of the smart access gateway does not support this feature.智能接入网关当前版本不支持该功能特性。
403FeatureNotSupportForActiveSmartAGThe current edition of the active smart access gateway does not support this feature.主智能接入网关的当前版本不支持该功能特性。
403FeatureNotSupportForStandBySmartAGThe current edition of the standby smart access gateway does not support this feature.备智能接入网关的当前版本不支持该功能特性。
403NotSupportedProtocolThe specified protocol of the ACL rule is not supported.您输入的ACL规则的协议类型是不支持的。
403InvalidId.ACLThe specified ACL ID is invalid.无效的ACL组ID。
403InvalidPortRangeThe specified port range is invalid.您输入的端口范围不合法。
403AcrPerAclAmountLimitThe maximum number of rules in an ACL is exceeded. You can open a ticket to increase the quota.您创建的ACL规则超出了单个ACL组下规则数量限额,您可以通过工单申请提升限额。
403InternalErrorAn internal server error occurred.内部服务错误。

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

变更历史

变更时间变更内容概要操作
暂无变更历史