DescribeAcls--应用型负载均衡-火山引擎

文档中心

立即注册

导航

DescribeAcls

最近更新时间：2025.04.17 11:56:34首次发布时间：2022.05.20 22:35:54

请求说明

API 名称：DescribeAcls。
API 域名：open.volcengineapi.com。
API 描述：查询访问控制策略组列表。调用一次接口最多可查询100个访问控制策略组。

使用限制

节流限制：每秒最多提交 200 个 API 请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

URI 参数

在使用该部分 API 提交请求时必须包含以下 URI 参数。

除了 URI 参数，该 API 请求还需要包含签名参数。关于更多签名参数的信息，参见公共请求参数。

名称	类型	是否必选	格式	说明
Action	string	是	[a-zA-Z]+	API 名称，如 DescribeAcls 。
Version	string	是	YYYY-MM-DD	API 版本信息。该参数的取值是 2020-04-01 。
X-Expires	int	否	900	表示签名的有效时间，单位是秒，默认值是900。

请求参数

在使用该 API 提交请求时，请求参数中可以包含的参数如下。

参数	类型	是否必选	参数说明	示例值
PageNumber	Integer	否	列表的页码，默认值为1。	1
PageSize	Integer	否	分页查询时每页的行数，取值：1 ~ 100，默认为10。	10
AclName	String	否	访问控制策略组的名称。	myacl
AclIds.N	List of String	否	访问控制策略组的ID 列表。	Aclds.1=acl-xxxxx& AclIds.2=acl-yyyyy
ProjectName	String	否	访问控制策略组所属项目名称。	default
TagFilters	Array	否	访问控制策略组绑定的标签，具体参见下表 TagFilters。	-

TagFilters

参数	类型	是否必选	参数说明	示例值
TagFilters.N.Key	String	否	访问控制策略组标签的标签键。指定多个标签键时，表示查询同时包含所有指定标签键的访问控制策略组。	TagFilters.1.Key=k1&TagFilters.2.Key=k2
TagFilters.N.Values.N	String	否	访问控制策略组标签的标签值。如果传入该参数，则必须先传入TagFilters.N.Key。具体规则如下：每个标签键最多可指定3个标签值。同一个标签键指定多个标签值时，表示查询各个标签值对应标签所关联访问控制策略组的集合。未传入该参数时，表示查询指定标签键下所有标签值对应的标签所关联的访问控制策略组。该参数取值为空时，表示查询指定标签键下标签值为空的标签所关联的访问控制策略组。	TagFilters.1.Value.1=v1&TagFilters.1.Value.2=v2&TagFilters.2.Value.1=v3

参数

类型

是否必选

参数说明

示例值

TagFilters.N.Key

String

否

访问控制策略组标签的标签键。指定多个标签键时，表示查询同时包含所有指定标签键的访问控制策略组。

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

TagFilters.N.Values.N

String

否

访问控制策略组标签的标签值。如果传入该参数，则必须先传入TagFilters.N.Key。具体规则如下：

每个标签键最多可指定3个标签值。
同一个标签键指定多个标签值时，表示查询各个标签值对应标签所关联访问控制策略组的集合。
未传入该参数时，表示查询指定标签键下所有标签值对应的标签所关联的访问控制策略组。
该参数取值为空时，表示查询指定标签键下标签值为空的标签所关联的访问控制策略组。

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

返回参数

参数	类型	参数说明	示例值
RequestId	String	请求ID。	20210811152539010225146063030****
PageSize	Integer	当前分页的行数。	20
PageNumber	Integer	当前页码。	1
TotalCount	Integer	符合条件的访问控制策略组总数。	50
Acls	Array	符合条件的访问控制策略组的详细信息，具体参见下表 Acls。	-

Acls

参数	类型	参数说明	示例值
AclId	String	访问控制策略组的ID。	acl-3cj44nv0jhhxc6c6rrtet****
AclName	String	访问控制策略组的名称。	myacl
CreateTime	String	访问控制策略组的创建时间。	2021-08-11T16:37:37Z
UpdateTime	String	访问控制策略组的最近操作时间。	2021-08-11T16:37:37Z
AclEntryCount	Integer	访问控制策略组包含的IP条目数量。	10
Listeners	List	访问控制策略组关联的监听器ID。	[ lsn-3tihaugk2y3vj0wt** , lsn-2fe6fszjgeznk5oxruv0u** ]
Description	String	访问控制策略组的描述。	测试
ProjectName	String	访问控制策略组所属项目名称。	default
Tags	Array	访问控制策略组绑定的标签，具体参见下表 Tags。	-

Tags

参数	类型	参数说明	示例值
Key	String	用户标签的标签键。	key
Value	String	用户标签的标签键。	value

示例

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202108161840280****52431470309D1E3",
        "Action": "DescribeAcls",
        "Version": "2020-04-01",
        "Service": "alb",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "2021081618402801****2431470309D1E3",
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 1,
        "Acls": [
            {
                "CreateTime": "2021-08-16T11:22:00Z",
                "UpdateTime": "2021-08-16T11:22:00Z",
                "AclId": "acl-3cipi****qps6c6rrsbfr0eb",
                "AclName": "acl-3cipi****jqps6c6rrsbfr0eb",
                "AclEntryCount": 0,
                "Listeners": []
            }
        ]
    }
}

错误码

如果响应正文包含 Error 字段，则表示 API 请求失败。此处仅展示当前 API 的错误码，更多错误码请参见公共错误码。

HTTP Code	错误码	错误信息	错误描述
400	InvalidPaging.Malformed	The specified PageNumber or PageSize is malformed.	指定的分页参数格式不合法。
400	LimitExceed.Acl	You've reached the limit on the number of ACLs that you can operate at a time.	已达到单次可操作的 ACL 的数量上限。
400	LimitExceed.TagFilters.Values	You've reached the limit on the number of tag filter values that you can operate at a time.	已达到单次可操作的标签值的数量上限。
400	InvalidTagFilters.Key.Malformed	The specified TagFilters.Key is malformed.	指定的 TagFilters.Key 参数格式不合法。
400	InvalidTagFilters.Value.Malformed	The specified TagFilters.Value is malformed.	指定的 TagFilters.Value 参数格式不合法。
400	InvalidTagFilters.Key.Duplicated	The specified TagFilters.Key is duplicated.	指定的 TagFilters.Key 重复。