DescribeAllowLists - 查询访问白名单列表--消息队列 RocketMQ版-火山引擎

文档中心

立即注册

导航

DescribeAllowLists - 查询访问白名单列表

最近更新时间：2024.11.18 10:27:32首次发布时间：2023.12.14 21:43:10

调用 DescribeAllowLists 查询白名单列表。

使用说明

请求频率：该接口请求频率限制为 100 次/秒；单用户请求频率限制为 20 次/秒。

调试

API Explorer

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

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeAllowLists	要执行的操作，取值：DescribeAllowLists。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
RegionID	String	是	cn-beijing	当前地域 RegionID。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
AllowLists	Array of Object	[{"AllowListDesc": "test", "AllowListIPNum": 2,"AllowListId": "acl-90c721ca3f1648e7b980xxxxxx","AllowListName": "test", "AllowListType": "IPv4", "AssociatedInstanceNum": 1 }]	白名单列表。

请求示例

POST https://rocketmq.volcengineapi.com/?Action=DescribeAllowLists&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: rocketmq.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/rocketmq/request, SignedHeaders=x-date, Signature=********

{
    "RegionID": "cn-beijing"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20231214115358F0ADC469D4812A61F7F9",
        "Action": "DescribeAllowLists",
        "Version": "2023-01-01",
        "Service": "RocketMQ",
        "Region": "cn-test-region"
    },
    "Result": {
        "AllowLists": [
            {
                "AllowListDesc": "test",
                "AllowListIPNum": 2,
                "AllowListId": "acl-90c721ca3f1648e7b980xxxxxx",
                "AllowListName": "test",
                "AllowListType": "IPv4",
                "AssociatedInstanceNum": 1
            },
        ]
    }
}

错误码

公共错误码请参见公共错误码文档。