You need to enable JavaScript to run this app.
导航
DescribeAclAttributes
最近更新时间:2024.02.29 14:48:17首次发布时间:2022.05.20 22:35:58

API 说明

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

使用限制

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

快速调试

URI 参数

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

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

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

请求正文

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

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

响应正文

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

AclEntries

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

Listeners

参数类型参数说明示例值
AclType
String

监听器对本访问控制策略组的控制方式。

  • white:白名单方式。表示监听器仅转发来自所选访问控制策略组中设置的IP地址或地址段的请求。 如果所选策略组中没有添加任何IP,则监听器不会转发任何请求。
  • black:黑名单方式。表示仅拒绝来自所选访问控制策略组中设置的IP地址或地址段的请求。 如果所选策略组中没有添加任何IP,则监听器会转发全部请求。
white
ListenerIdString监听器的ID。lsn-2fek3rgsxhrsw5oxruwec****
ListenerNameString监听器的名称。mylistener
ProtocolString监听器的协议。HTTP
PortInteger监听器的端口。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 不存在。