DescribeAllowListDetail - 查询单个访问白名单详情--消息队列 RocketMQ版-火山引擎

文档中心

立即注册

导航

DescribeAllowListDetail - 查询单个访问白名单详情

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

调用 DescribeAllowListDetail 查询指定白名单的详细信息。

注意事项

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeAllowListDetail	要执行的操作，取值：DescribeAllowListDetail。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
AllowListId	String	是	acl-90c721ca3f1648e7b9803xxxxxxx	待查询的白名单 ID。

返回参数

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

参数	类型	示例值	描述
AllowListId	String	acl-90c721ca3f1648e7b9803xxxxxxx	白名单 ID。
AllowListName	String	testlist	白名单名称。
AllowListDesc	String	forTest	白名单描述。
AllowListType	String	IPv4	白名单类型。默认为 IPv4，表示允许 AllowList 中的 IPv4 地址访问。
AllowList	String	["1270.0.0.1"]	IP 地址列表。
AssociatedInstances	Array of Object	[{ "InstanceId": "rocketmq-cnoexxxxx","InstanceName": "test","VPC": "vpc-3ret6bva9k54wxxxxx"}]	白名单绑定的实例信息列表。返回 null 表示未绑定任何实例。

请求示例

POST https://rocketmq.volcengineapi.com/?Action=DescribeAllowListDetail&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=********

{
    "AllowListId": "acl-90c721ca3f1648e7b9803xxxxxxx"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20231214112043C5C50079C40F4F69F190",
        "Action": "DescribeAllowListDetail",
        "Version": "2023-01-01",
        "Service": "RocketMQ",
        "Region": "cn-beijing"
    },
    "Result": {
        "AllowList": "1.1.1.1,0.0.0.0/0",
        "AllowListDesc": "bangding",
        "AllowListId": "acl-90c721ca3f1648e7b9803xxxxxxx",
        "AllowListName": "makan-test22222",
        "AllowListType": "IPv4",
        "AssociatedInstances": null
    }
}

错误码

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