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

文档中心

立即注册

导航

DescribeAllowLists - 查询白名单列表

最近更新时间：2024.09.26 15:55:19首次发布时间：2023.10.19 11:11:24

调用 DescribeAllowLists 可以查询白名单列表。

使用说明

可以使用此接口查看所有的白名单列表。

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeAllowLists	要执行的操作，取值：DescribeAllowLists。
Version	String	是	2022-05-01	API的版本，取值：2022-05-01。
RegionId	String	是	cn-beijing	地域 ID。表示查询指定地域下的白名单列表。
InstanceId	String	否	kafka-cnitzqgnk***	Kafka 实例 ID。若指定此参数，表示查询所有绑定此实例 ID 的白名单列表。否则，将返回所有的白名单列表。

返回参数

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

参数	类型	示例值	描述
AllowLists	Array of Object	--	白名单列表信息。

请求示例

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

{
    "RegionId": "cn-beijing",
    "InstanceId": "kafka-cnitzqg**"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20231009164722454D149CF757A9BFA1DC",
        "Action": "DescribeAllowLists",
        "Version": "2022-05-01",
        "Service": "Kafka",
        "Region": "cn-beijing"
    },
    "Result": {
        "AllowLists": [
            {
                "AllowListDesc": "测试",
                "AllowListIPNum": 1,
                "AllowListId": "acl-fc849fa39a114c9**",
                "AllowListName": "测试",
                "AssociatedInstanceNum": 2,
            }
        ]
    }
}

错误码

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

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter is not valid.	参数值无效。
403	OperationDenied.InvalidInstanceStatus	The operation is not valid for the current status of the instance.	当前实例状态不允许执行该操作。
404	InvalidInstanceId.NotFound	The specified Instance ID does not exist.	实例不存在。
500	InternalError	The request failed due to some unknown error, exception or failure.	内部错误，请稍后重试。