文档

DescribeACLs - 查询访问控制信息

更新时间:

调用DescribeACLs查询指定地域下访问控制实例信息。

调试

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

授权信息

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

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

请求参数

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

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

cn-shanghai
AclIdsstring

访问控制实例 ID。

  • 若同时查询多个访问控制实例,多个实例 ID 请以半角逗号(,)隔开。
  • 若不填写该项,则表示查询当前地域下所有访问控制实例的信息。
acl-xhwhyuo43l*******
Namestring

访问控制实例名称。

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

test
PageSizeinteger

分页查询时每页的条目数。最大值为 50,默认值为 10

10
PageNumberinteger

查询页码,默认值为 1

1
AclTypestring

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

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

返回参数

名称类型描述示例值
object

查询结果。

TotalCountinteger

总条目数。

1
PageSizeinteger

分页查询时每页的条目数。

10
RequestIdstring

请求 ID。

660F303F-C88E-4026-BC6A-FC24B78FD7EA
PageNumberinteger

查询页码。

1
Aclsobject []

访问控制实例信息列表。

SagCountstring

访问控制实例绑定的智能接入网关实例数量。

0
AclIdstring

访问控制实例 ID。

acl-xhwhyuo43l*******
Namestring

访问控制实例名称。

test
ResourceGroupIdstring

访问控制实例所属资源组 ID。

rg-acfm2iu4fnc****
AclTypestring

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

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

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "660F303F-C88E-4026-BC6A-FC24B78FD7EA",
  "PageNumber": 1,
  "Acls": {
    "Acl": [
      {
        "SagCount": "0",
        "AclId": "acl-xhwhyuo43l*******",
        "Name": "test",
        "ResourceGroupId": "rg-acfm2iu4fnc****",
        "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.非法参数。
403InternalErrorAn internal server error occurred.内部服务错误。

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

变更历史

变更时间变更内容概要操作
2022-09-06OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
入参OpenAPI 入参发生变更
    新增入参:AclType
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈