DescribeAcls--负载均衡-火山引擎

文档中心

立即注册

导航

DescribeAcls

最近更新时间：2024.10.21 14:07:13首次发布时间：2021.08.31 10:37:28

调用 DescribeAcls 接口，查询满足指定条件的访问控制策略组。

调用说明

传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的策略组，若没有符合条件的策略组，则返回空值。
若请求参数非必选参数均未传入，则按照当前登录账号查询，返回当前账号下的所有策略组。

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeAcls	要执行的操作，取值为DescribeAcls。
Version	String	是	2020-04-01	API版本信息，当前版本为：2020-04-01。
AclName	String	否	myacl	访问控制策略组的名称。
AclIds.N	String	否	Aclds.1=acl-3cj44nv0jhhxc6c6rrtet**&AclIds.2=acl-2febxt4pu0zy85oxruw0t**	访问控制策略组的ID。参数 - N：表示访问控制策略组的序号，取值范围：1 ～ 100。多个访问控制策略组ID间使用“&”分隔。
ProjectName	String	否	default	访问控制策略组所属项目的名称。
TagFilters.N.Key	String	否	TagFilters.1.Key=k1&TagFilters.2.Key=k2&TagFilters.3.Key=k3	标签的标签键。参数 - N：表示标签键的序号，取值范围：1～10。多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与（AND）”，即查询同时添加多个标签键的访问控制策略组。不允许重复。
TagFilters.N.Values.N	String	否	TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.3.Values.1=v1	标签的标签值。第一个N：表示标签键的序号，取值范围：1～10。第二个N：表示标签值的序号，取值范围：1～3。同一标签键多个标签值之间的关系为逻辑“或(OR)”，即查询同一标签键下添加其中一个标签值的访问控制策略组。多个标签值之间用&分隔。说明若传入该参数，则必须先传入`TagFilters.N.Key`。传入空字符串时，表示查询标签值为空的访问控制策略组。
PageNumber	Integer	否	1	列表的页码，默认值为1。
PageSize	Integer	否	10	分页查询时每页的行数，取值范围为1 ～ 100，默认为10。

返回参数

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

Acls

名称	类型	示例值	描述
AclId	String	acl-3cj44nv0jhhxc6c6rrtet****	访问控制策略组的ID。
AclName	String	myacl	访问控制策略组的名称。
Description	String	This is an acl.	访问控制策略组的描述。
AclEntryCount	Integer	10	访问控制策略组包含的IP条目数量。
Listeners	List of String	["lsn-3tihaugk2y3vj0wt**","lsn-2fe6fszjgeznk5oxruv0u**"]	访问控制策略组关联的监听器ID。
ServiceManaged	Boolean	false	是否为托管资源。 true：托管资源。 false：非托管资源。
Status	String	Active	访问控制策略组的状态。 Creating：创建中 Active：正常可用 Configuring：配置中 Deleting：删除中
ProjectName	String	default	访问控制策略组所属项目的名称。
Tags	Array of Struct	-	标签的详细信息。具体请参见“ Tags”。
CreateTime	String	2021-08-11T16:37:37Z	访问控制策略组的创建时间。
UpdateTime	String	2021-08-11T16:37:37Z	访问控制策略组的最近操作时间。

名称	类型	示例值	描述
Key	String	k1	标签键。
Value	String	v1	标签值。

请求示例

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