全部产品
Search

搜索本产品

    智能接入网关：DescribeACLAttribute - 批量查询访问控制信息

    文档中心

    智能接入网关：DescribeACLAttribute - 批量查询访问控制信息

    更新时间：Mar 29, 2024

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

    调试

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

    授权信息

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

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

    请求参数

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

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

    		cn-hangzhou
    AclIdstring是

    访问控制实例 ID。

    		acl-ohlexqptfhyaq****
    PageSizeinteger否

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

    取值范围：1~50。

    默认值：10。

    		10
    PageNumberinteger否

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

    		1
    Directionstring否

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

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

    订单 ID。

    		1255444444
    Namestring否

    访问控制实例名称。

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

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

    返回参数

    名称类型描述示例值
    object
    TotalCountinteger

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

    		3
    PageSizeinteger

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

    		10
    RequestIdstring

    请求 ID。

    		8F62CE77-FBA2-4F8D-AED9-0A02814EDA69
    PageNumberinteger

    分页查询时的页码。

    		1
    Acrsobject []

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

    Directionstring

    访问控制规则应用方向。

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

    访问控制规则类型：

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

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

    		WAN
    DpiSignatureIdsarray
    string

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

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

    		1
    IpProtocolstring

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

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

    		UDP
    Priorityinteger

    访问控制规则优先级。

    取值范围：1~100。

    		70
    AclIdstring

    访问控制实例 ID。

    		acl-7louazbja80bmg****
    Policystring

    访问控制规则授权策略：

    • accept：允许。

    • drop：拒绝。

    		drop
    Descriptionstring

    访问控制规则描述信息。

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

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

    		访问规则
    GmtCreatelong

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

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

    		1580821597000
    DestCidrstring

    目的网段。

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

    		0.0.0.0/0
    DestPortRangestring

    目的端口范围。

    取值范围：-1或 1~65535。

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

    		10000/20000
    Namestring

    访问控制实例名称。

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

    		doctest
    AcrIdstring

    访问控制规则 ID。

    		acr-gxzxj5w9qqdf1c****
    SourceCidrstring

    源网段。

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

    		0.0.0.0/0
    SourcePortRangestring

    源端口范围。

    取值范围：-1或 1~65535。

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

    		30000/40000
    DpiGroupIdsarray
    string

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

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

    		20
    AclTypestring

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

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

    示例

    正常返回示例

    JSON格式

    {
  "TotalCount": 3,
  "PageSize": 10,
  "RequestId": "8F62CE77-FBA2-4F8D-AED9-0A02814EDA69",
  "PageNumber": 1,
  "Acrs": {
    "Acr": [
      {
        "Direction": "out",
        "Type": "WAN",
        "DpiSignatureIds": {
          "DpiSignatureId": [
            "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": {
          "DpiGroupId": [
            "20"
          ]
        },
        "AclType": "acl-hardware"
      }
    ]
  }
}

    错误码

    HTTP status code错误码错误信息描述
    403ForbiddenUser not authorized to operate on the specified resource.用户没有操作此资源的权限。
    403MissingParameterThe input parameter is missing, please check your input.输入参数缺失，请检查您的输入。
    403InvalidParameterThe specified parameter is invalid.非法参数。
    403InvalidId.ACLThe specified ACL ID is invalid.无效的ACL组ID。
    403InternalErrorAn internal server error occurred.内部服务错误。

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

    变更历史

    变更时间变更内容概要操作
    2022-09-06OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更。
      删除错误码：403
    出参OpenAPI 返回结构发生变更。