调用 CreateAllowList 接口可以创建一个新的 IP 白名单规则。
创建白名单并绑定白名单和 Kafka 实例后,白名单中配置的 IP 地址或地址段才能访问该实例。每个火山引擎账号在每个地域下最多创建 100 个白名单。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateAllowList | 要执行的操作,取值:CreateAllowList。 |
Version | String | 是 | 2022-05-01 | API的版本,取值:2022-05-01。 |
AllowListName | String | 是 | 测试 | 白名单规则名称。
|
AllowListDesc | String | 否 | 测试白名单 | 白名单描述。长度不超过200个字符。 |
AllowList | String | 是 | 127.0.0.1,192.168.0.1/24 | 白名单规则列表。
|
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
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 | 参数值无效。 |
403 | OperationDenied.InvalidInstanceStatus | 当前实例状态不允许执行该操作。 |
404 | InvalidInstanceId.NotFound | 实例不存在。 |
500 | InternalError | 内部错误,请稍后重试。 |