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

文档中心

立即注册

导航

DescribeAclAttributes

最近更新时间：2024.06.28 16:26:01首次发布时间：2022.05.20 22:35:58

请求说明

API 名称：DescribeAclAttributes。
API 域名：open.volcengineapi.com。
API 描述：查询指定访问控制策略组的详细信息。

使用限制

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

调试

API Explorer

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

去调试

URI 参数

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

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

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

请求参数

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

参数	类型	是否必选	参数说明	示例值
AclId	String	是	访问控制策略组ID。	acl-3cj44nv0jhhxc6c6rrtet****

返回参数

参数	类型	参数说明	示例值
RequestId	String	请求ID。	20210811152539010225146063030****
AclId	String	访问控制策略组的ID。	acl-3cj44nv0jhhxc6c6rrtet****
AclName	String	访问控制策略组的名称。	myacl
CreateTime	String	访问控制策略组的创建时间。	2021-08-11T16:37:37Z
UpdateTime	String	访问控制策略组的最近操作时间。	2021-08-11T16:37:37Z
AclEntries	Array	访问控制策略组中IP条目的详细信息。具体参见 AclEntries 。	-
Listeners	Array	访问控制策略组关联的监听器详细信息。具体参见 Listeners 。	-
Description	String	访问控制策略组的描述。	测试
ProjectName	String	访问控制所属项目名称。	default

AclEntries

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

Listeners

参数	类型	参数说明	示例值
AclType	String	监听器对本访问控制策略组的控制方式。 white：白名单方式。表示监听器仅转发来自所选访问控制策略组中设置的IP地址或地址段的请求。如果所选策略组中没有添加任何IP，则监听器不会转发任何请求。 black：黑名单方式。表示仅拒绝来自所选访问控制策略组中设置的IP地址或地址段的请求。如果所选策略组中没有添加任何IP，则监听器会转发全部请求。	white
ListenerId	String	监听器的ID。	lsn-2fek3rgsxhrsw5oxruwec****
ListenerName	String	监听器的名称。	mylistener
Protocol	String	监听器的协议。	HTTP
Port	Integer	监听器的端口。	88

示例

请求示例

GET /?Action=DescribeAclAttributes&AclId=acl-33txelibucdfk57uhwmviq46o&Version=2020-04-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: alb

返回示例

{
    "ResponseMetadata":{
        "RequestId": "d9e8b282-d9a0-4d58-84f7-91f482960b6b",
        "Action": "DescribeAclAttributes",
        "Version": "2020-04-01",
        "Service": "alb",
        "Region": "cn-beijing"
    },
    "Result":{
        "RequestId": "d9e8b282-d9a0-4d58-84f7-91f482960b6b",
        "CreateTime": "2022-02-22T08:34:34Z",
        "UpdateTime": "2022-02-23T06:21:31Z",
        "AclId": "acl-33txelibucdfk57uhwmviq46o",
        "AclName": "yxl-test",
        "Description": "yxl-test",
        "AclEntries":[
            {
                "Entry":"1.0.0.0/8",
                "Description":"acl-rule-1"
            },
            {
                "Entry":"12.1.0.0/16",
                "Description":"acl-rule-2"
            }
        ],
        "Listeners": null
    }
}

错误码

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

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