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

文档中心

立即注册

导航

DescribeAclAttributes

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

调用 DescribeAclAttributes 接口，查看指定访问策略控制组的详情。

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeAclAttributes	要执行的操作，取值为DescribeAclAttributes
Version	String	是	2020-04-01	API版本信息，当前版本为：2020-04-01。
AclId	String	是	acl-3cj44nv0jhhxc6c6rrtet****	访问控制策略组ID。您可以调用DescribeAcls接口，查询访问控制策略组ID。

返回参数

名称	类型	示例值	描述
RequestId	String	20210811152539010225146063030****	请求ID。
AclId	String	acl-3cj44nv0jhhxc6c6rrtet****	访问控制策略组的ID。
AclName	String	myacl	访问控制策略组的名称。
Description	String	test	访问控制策略组的描述。
AclEntries	Array of Struct	-	访问控制策略组中IP条目的详细信息。具体请参见“ AclEntry ”。
Listeners	Array of Struct	-	访问控制策略组关联的监听器的详细信息。具体请参见“ Listener ”。
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	访问控制策略组的最近操作时间。

AclEntry

名称	类型	示例值	描述
Entry	String	192.XX.XX.7/16	IP条目的地址段。
Description	String	entry1	IP条目的描述。

Listener

名称	类型	示例值	描述
ListenerId	String	lsn-2fek3rgsxhrsw5oxruwec****	监听器的ID。
ListenerName	String	mylistener	监听器的名称。
Protocol	String	TCP	监听器的协议。 TCP UDP HTTP HTTPS
Port	Integer	88	监听器的端口。
AclType	String	white	监听器对本访问控制策略组的控制方式。 white ：白名单。监听器监听CLB的流量时，CLB仅转发其白名单关联访问控制策略组中IP地址的请求。 black：黑名单。监听器监听CLB的流量时，对于白名单关联访问控制策略组中IP地址的请求，CLB拒绝转发。

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

请求示例

GET /?Action=DescribeAclAttributes&Version=2020-04-01&AclId=acl-3cj44nv0jhhxc6c6rrtet**** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: clb

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20210811152539010225146063030****",
        "Action": "DescribeAclAttributes",
        "Version": "2020-04-01",
        "Service": "clb",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "20210811152539010225146063030****",
        "CreateTime": "2021-08-11T16:37:37Z",
        "UpdateTime": "2021-08-11T16:37:37Z",
        "AclId": "acl-3cj44nv0jhhxc6c6rrtet****",
        "AclName": "myacl",
        "Status": "Active",
        "Description": "test",
        "ProjectName": "default",
        "AclEntries": [
            {
                "Entry": "192.XX.XX.1/32",
                "Description": ""
            },
            {
                "Entry": "192.XX.XX.1/32",
                "Description": ""
            }
        ],
        "Listeners": [
            {
                "AclType": "black",
                "ListenerId": "lsn-2fek3rgsxhrsw5oxruwec****",
                "ListenerName": "mylistener",
                "Protocol": "HTTP",
                "Port": 22
            }
        ],
        "ServiceManaged": false,
        "Tags": [
            {
                "Key": "k1",
                "Value": "v1"
            }
        ]
    }
}

错误码

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

HttpCode	错误码	错误信息	描述
404	InvalidAcl.NotFound	The specified ACL does not exist.	指定的 ACL 不存在。