调用DescribeACLAttribute查询指定访问控制实例信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeACLAttribute

系统规定参数。取值:DescribeACLAttribute

RegionId String cn-hangzhou

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

AclId String acl-ohlexqptfhyaq****

访问控制实例ID。

PageSize Integer 10

分页查询时每页展示的访问控制规则条目数。

取值范围:1~50

默认值:10

PageNumber Integer 1

分页查询时的页码。默认值:1

Direction String out

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

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

订单ID。

Name String doctest

访问控制实例名称。

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

说明 该参数支持模糊搜索。

返回数据

名称 类型 示例值 描述
TotalCount Integer 3

当前访问控制实例包含的总的访问控制规则条目数。

PageSize Integer 10

分页查询时每页展示的访问控制规则条目数。

RequestId String 8F62CE77-FBA2-4F8D-AED9-0A02814EDA69

请求ID。

PageNumber Integer 1

分页查询时的页码。

Acrs Array of Acr

当前访问控制实例包含的访问控制规则信息。

Acr
Direction String out

访问控制规则应用方向。

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

访问控制规则类型:

  • LAN:私网,表示针对私网地址的流量设置访问控制规则。
  • WAN:公网,表示针对公网地址的流量设置访问控制规则。
DpiSignatureIds Array of String 1

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

您可以通过ListDpiSignatures查询应用ID及其对应的应用信息。

IpProtocol String UDP

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

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

Priority Integer 70

访问控制规则优先级。

取值范围:1~100

AclId String acl-7louazbja80bmg****

访问控制实例ID。

Policy String drop

访问控制规则授权策略:

  • accept:允许。
  • drop:拒绝。
Description String 访问规则

访问控制规则描述信息。

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

此字段默认不会返回。可通过ModifyACLRule接口设置,设置后查询会正常返回。

GmtCreate Long 1580821597000

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

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

DestCidr String 0.0.0.0/0

目的网段。

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

DestPortRange String 10000/20000

目的端口范围。

取值范围:-11~65535

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

Name String doctest

访问控制实例名称。

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

AcrId String acr-gxzxj5w9qqdf1c****

访问控制规则ID。

SourceCidr String 0.0.0.0/0

源网段。

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

SourcePortRange String 30000/40000

源端口范围。

取值范围:-11~65535

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

DpiGroupIds Array of String 20

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

您可以通过ListDpiGroups查询应用组ID及其包含的应用信息。

AclType String acl-hardware

访问控制实例支持绑定的智能接入网关实例类型。取值:

  • acl-hardware:智能接入网关硬件实例。
  • acl-software:智能接入网关App实例。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeACLAttribute
&RegionId=cn-hangzhou
&AclId=acl-ohlexqptfhyaq****
&PageSize=10
&PageNumber=1
&Direction=out
&Order=1255444444
&Name=doctest
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeACLAttributeResponse>
    <TotalCount>3</TotalCount>
    <PageSize>10</PageSize>
    <RequestId>8F62CE77-FBA2-4F8D-AED9-0A02814EDA69</RequestId>
    <PageNumber>1</PageNumber>
    <Acrs>
        <Direction>out</Direction>
        <Type>WAN</Type>
        <DpiSignatureIds>1</DpiSignatureIds>
        <IpProtocol>UDP</IpProtocol>
        <Priority>70</Priority>
        <AclId>acl-7louazbja80bmg****</AclId>
        <Policy>drop</Policy>
        <Description>访问规则</Description>
        <GmtCreate>1580821597000</GmtCreate>
        <DestCidr>0.0.0.0/0</DestCidr>
        <DestPortRange>10000/20000</DestPortRange>
        <Name>doctest</Name>
        <AcrId>acr-gxzxj5w9qqdf1c****</AcrId>
        <SourceCidr>0.0.0.0/0</SourceCidr>
        <SourcePortRange>30000/40000</SourcePortRange>
        <DpiGroupIds>20</DpiGroupIds>
        <AclType>acl-hardware</AclType>
    </Acrs>
</DescribeACLAttributeResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 3,
  "PageSize" : 10,
  "RequestId" : "8F62CE77-FBA2-4F8D-AED9-0A02814EDA69",
  "PageNumber" : 1,
  "Acrs" : [ {
    "Direction" : "out",
    "Type" : "WAN",
    "DpiSignatureIds" : [ "1" ],
    "IpProtocol" : "UDP",
    "Priority" : 70,
    "AclId" : "acl-7louazbja80bmg****",
    "Policy" : "drop",
    "Description" : "访问规则",
    "GmtCreate" : 1580821597000,
    "DestCidr" : "0.0.0.0/0",
    "DestPortRange" : "10000/20000",
    "Name" : "doctest",
    "AcrId" : "acr-gxzxj5w9qqdf1c****",
    "SourceCidr" : "0.0.0.0/0",
    "SourcePortRange" : "30000/40000",
    "DpiGroupIds" : [ "20" ],
    "AclType" : "acl-hardware"
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
403 Forbidden User not authorized to operate on the specified resource. 用户没有操作此资源的权限。
403 MissingParameter The input parameter is missing, please check your input. 输入参数缺失,请检查您的输入。
403 InvalidParameter The specified parameter is invalid. 非法参数。
403 InvalidId.ACL The specified ACL ID is invalid. 无效的ACL组ID。
403 InternalError An internal server error occurred. 内部服务错误。

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