ModifyAllowList - 修改白名单--消息队列 Kafka版-火山引擎

文档中心

立即注册

导航

ModifyAllowList - 修改白名单

最近更新时间：2024.10.17 14:06:27首次发布时间：2023.10.19 11:11:23

调用 ModifyAllowList 可以修改一个已经创建的白名单规则。

使用说明

创建白名单规则后，可以使用此接口对白名单名称、描述和规则进行修改。白名单规则的修改将会使用覆盖的方式执行，进行规则修改时需要包含所有的白名单规则。白名单规则的修改将会同步应用到所有已经绑定白名单的实例。

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ModifyAllowList	要执行的操作，取值：ModifyAllowList。
Version	String	是	2022-05-01	API的版本，取值：2022-05-01。
AllowListId	String	是	acl-fda2ed6365b94c***	待修改的白名单ID。
AllowListName	String	是	测试	修改后的白名单名称。长度为 1～128 个字符。只能包含中文、字母、数字、下划线和连字符（-）。不能以数字或连字符（-）开头。白名单名称在当前地域下唯一。
AllowListDesc	String	是	测试1	修改后的白名单描述。长度不超过200个字符。默认值为空，若修改时不设置，则描述会被设置为空字符串。
AllowList	String	否	127.0.0.1,192.168.0.1/24	修改后白名单 IP 地址或网段列表。若不设置，则不会对列表进行修改。
ApplyInstanceNum	Integer	否	2	此白名单已绑定的实例数量。若指定 AllowList 参数，则此字段必填，用于指定规则修改后预期将会影响到的实例个数。若预期影响个数与实际影响个数不符，则请求失败。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST /?Action=ModifyAllowList&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=********

{
    "AllowListId":"acl-fda2ed6365b94c909e44198fbbf48bcd",
    "AllowListName":"测试2",
    "AllowListDesc":"测试2",
    "AllowList":"127.0.0.1,192.168.0.1/24",
    "ApplyInstanceNum":2
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20231009164722454D149CF757A9BFA1DC",
        "Action": "ModifyAllowList",
        "Version": "2022-05-01",
        "Service": "Kafka",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

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

状态码	错误码	错误信息	说明
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.	内部错误，请稍后重试。