You need to enable JavaScript to run this app.
导航
CreateAllowList - 新建白名单
最近更新时间:2024.09.26 15:55:18首次发布时间:2023.10.19 11:11:23

调用 CreateAllowList 接口可以创建一个新的 IP 白名单规则。

使用说明

创建白名单并绑定白名单和 Kafka 实例后,白名单中配置的 IP 地址或地址段才能访问该实例。每个火山引擎账号在每个地域下最多创建 100 个白名单。

调试

请求参数

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

参数
类型
是否必填
示例值
描述
Action
String

CreateAllowList

要执行的操作,取值:CreateAllowList。

Version
String

2022-05-01

API的版本,取值:2022-05-01。

AllowListName
String

测试

白名单规则名称。

  • 长度为 1~128 个字符。
  • 只能包含中文、字母、数字、下划线和连字符(-)。
  • 不能以数字或连字符(-)开头。
  • 白名单名称在当前地域下唯一。
AllowListDesc
String

测试白名单

白名单描述。长度不超过200个字符。

AllowList
String

127.0.0.1,192.168.0.1/24

白名单规则列表。

  • 支持指定为 IP 地址或者 IP 网段。
  • 多个 IP 地址或网段之间使用英文逗号(,)分隔。
  • 每个白名单最多可配置 300 个 IP 地址或网段。

返回参数

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

参数
类型
示例值
描述
AllowListId
String

acl-fda2ed6365b9**

创建的白名单ID。

请求示例

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

{
    "AllowList":"127.0.0.1,192.168.0.1/24",
    "AllowListName":"测试",
    "AllowListDesc":"测试白名单"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023100916165107E94074D816B8C1E88A",
        "Action": "CreateAllowList",
        "Version": "2022-05-01",
        "Service": "Kafka",
        "Region": "cn-beijing"
    },
    "Result": {
        "AllowListId": "acl-fda2ed6365b94c909e44198fbbf48bcd"
    }
}

错误码

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

状态码
错误码
错误信息
说明
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.

内部错误,请稍后重试。