You need to enable JavaScript to run this app.
导航

DescribeAcls

最近更新时间2024.04.03 10:22:59

首次发布时间2021.08.31 10:37:28

调用 DescribeAcls 接口查询访问控制策略组列表。

使用说明

a.N.b类型的参数中,“N”表示根据标签查询资源时标签信息的序号,需按照数字顺序从1开始填写,取值范围为1~50。多个标签之间使用&分隔。

调试

请求参数

名称类型是否必填示例值
描述
ActionStringDescribeAcls要执行的操作,取值为DescribeAcls。
VersionString2020-04-01API版本信息,当前版本为:2020-04-01。
PageNumberInteger1列表的页码,默认值为1。
PageSizeInteger10分页查询时每页的行数,取值范围为1 ~ 100,默认为10。
AclNameStringmyacl访问控制策略组的名称。

AclIds.N

String

Aclds.1=acl-3cj44nv0jhhxc6c6rrtet****&AclIds.2=acl-2febxt4pu0zy85oxruw0t****

访问控制策略组的ID 列表。您可以调用本接口获取访问控制策略组ID。

  • 参数 - N:表示访问控制策略组的序号。取值范围为1 ~ 100,表示指定ID时最多可查询100个。
  • 多个访问控制策略组ID间使用“&”分隔。

ProjectName

String

default

访问控制策略组所属项目的名称。

  • 该参数不传入或传入为空时,表示查询所有的访问控制策略组。
  • 该参数传入不为空时,表示查询属于指定项目的访问控制策略组。

TagFilters.N.Key

String

TagFilters.1.Key=k1&TagFilters.2.Key=k2

根据标签查询资源时指定的标签键。

  • 参数 - N:表示标签键的序号,单次调用数量上限10个。
  • 多个标签键之间使用&分隔。
  • 指定多个标签键时,表示查询同时包含所有指定标签键的资源。

TagFilters.N.Values.M

String

TagFilters.1.Value.1=v1&TagFilters.1.Value.2=v2&TagFilters.2.Value.1=v3

资源标签的标签值。每个标签键最多可指定3个标签值。

  • 未传入该参数时,表示查询指定标签键下所有标签值对应的标签所关联的CLB实例。
  • 该参数取值为空时,表示查询指定标签键下标签值为空的标签所关联的CLB实例。
  • 同一个标签键指定多个标签值时,表示查询各个标签值对应标签所关联CLB实例的集合。

如果传入该参数,则必须先传入TagFilters.N.Key

返回参数

字段类型示例值
描述
RequestIdString20210811152539010225146063030****请求ID。
PageSizeInteger20当前分页的行数。
PageNumberInteger1当前页码。
TotalCountInteger50符合条件的访问控制策略组总数。
AclsArray of Struct-符合条件的访问控制策略组的详细信息。具体请参见下表“ Acls ”。

Acls

字段类型示例值
描述
AclIdStringacl-3cj44nv0jhhxc6c6rrtet****访问控制策略组的ID。
AclNameStringmyacl访问控制策略组的名称。

Status

String

Active

访问控制策略组的状态。

  • Creating:创建中
  • Active:正常可用
  • Configuring:配置中
  • Deleting:删除中
CreateTimeString2021-08-11T16:37:37Z访问控制策略组的创建时间。
UpdateTimeString2021-08-11T16:37:37Z访问控制策略组的最近操作时间。
AclEntryCountInteger10访问控制策略组包含的IP条目数量。
ListenersList of String["lsn-3tihaugk2y3vj0wt****","lsn-2fe6fszjgeznk5oxruv0u****"]访问控制策略组关联的监听器ID。
DescriptionStringThis is an acl.访问控制策略组的描述。
ProjectNameStringdefault访问控制策略组所属项目的名称。

ServiceManaged

Boolean

false

是否为托管资源。

  • true:托管资源。
  • false:非托管资源。
TagsArray of Struct-标签的详细信息。具体请参见“ Tags”。

Tags

名称类型示例值描述
KeyStringk1标签键。
ValueStringv1标签值。

请求示例

GET /?&Action=DescribeAcls&Version=2020-04-01&AclIds.1=acl-3cj44nv0jhhxc6c6rrtet**** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: clb

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20210811152539010225146063030****",
        "Action": "DescribeAcls",
        "Version": "2020-04-01",
        "Service": "clb",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "20210811152539010225146063030****",
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 1,
        "Acls": [
            {
                "CreateTime": "2021-08-11T16:37:37Z",
                "UpdateTime": "2021-08-11T16:37:37Z",
                "AclId": "acl-3cj44nv0jhhxc6c6rrtet****",
                "AclName": "myacl",
                "Status": "Active",
                "AclEntryCount": 0,
                "Description": "",
                "Listeners": [], 
                "ProjectName": "default",
                "ServiceManaged": false,
                "Tags": [
                    {
                        "Key": "k1",
                        "Value": "v1"
                    }
                ]
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HttpCode错误码错误信息描述
400InvalidPaging.MalformedThe specified PageNumber or PageSize is malformed.指定的分页参数格式不合法。
400LimitExceeded.AclIdYou've reached the limit on the number of AclId that you can operate.已达到单次可操作 ACL 的资源数量上限。
400InvalidIncorrectOrder.MalformedThe specified index order is malformed.指定的索引顺序参数格式不合法。
400InvalidTagKey.MalformedThe specified TagKey is malformed.指定的 TagKey 参数格式不合法。
400InvalidTagValue.MalformedThe specified TagValue is malformed.指定的 TagValue 参数格式不合法。
400LimitExceeded.TagFilterKeyYou've reached the limit on the number of tag keys that you can filter.已达到单次可指定过滤标签键数量的上限。
400LimitExceeded.TagFilterValuesYou've reached the limit on the number of tag values that you can filter.已达到单次可指定过滤标签键值数量的上限。