You need to enable JavaScript to run this app.
导航
消息队列 Kafka版
  • 文档首页
    • /
  • 消息队列 Kafka版

ModifyAllowList

最近更新时间：2023.10.19 11:11:23

首次发布时间：2023.10.19 11:11:23

我的收藏

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

使用说明

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

请求参数

参数

参数类型

是否必选

示例值

说明

AllowListId

String

是

acl-fda2ed6365b94c909e44198fbbf4****

待修改的白名单 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-fda2ed6365b94c909e44198fbbf4****",
    "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
}