更新 IP 黑白名单配置--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

更新 IP 黑白名单配置

最近更新时间：2024.07.10 11:12:54首次发布时间：2022.11.09 10:16:21

本接口支持修改指定服务 ID 下域名的 IP 黑白名单配置。

使用说明

通过设置用户请求的 IP 黑白名单，拦截不符合规则的请求，实现对访客身份的识别和过滤。

设置 IP 黑名单，则黑名单外的 IP 被允许访问；
设置 IP 白名单，则白名单内的 IP 被允许访问。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
超时时间：约为 10 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

请求方式：POST
请求地址：https://imagex.volcengineapi.com/?Action=UpdateImageDomainIPAuth&Version=2018-08-01

请求参数

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

Query

参数类型是否必选示例值描述

Action String 是 UpdateImageDomainIPAuth 接口名称。当前 API 的名称为 UpdateImageDomainIPAuth。

Version String 是 2018-08-01 接口版本。当前 API 的版本为 2018-08-01。

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateImageDomainIPAuth`	接口名称。当前 API 的名称为 `UpdateImageDomainIPAuth`。
Version	String	是	`2018-08-01`	接口版本。当前 API 的版本为 `2018-08-01`。
ServiceId	String	是	`098**ud9`	服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

ServiceId

String

是

098**ud9

服务 ID。

您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。
您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

Body

参数	类型	是否必选	示例值	描述
domain	String	是	`example.imagex.com`	待修改配置的域名，您可以通过获取服务下全部域名获取服务下域名信息。
ip_auth	Object of IpAuth	是	`-`	黑白名单配置

IpAuth

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
enabled	Boolean	是	`true`	是否开启黑白名单配置，取值如下所示： `true`：开启黑白名单配置 `false`：关闭黑白名单配置
is_white_mode	Boolean	是	`true`	是否是 IP 白名单，取值如下所示： `true`：配置白名单 `false`：配置黑名单
values	Array of String	是	`["192.0.2.0","192.0.2.0/24"]`	黑白名单 IP 地址，您可以指定一个或者多个 IP 地址（如 192.0.2.0）和 IP 地址网段（192.0.2.0/24）。IP 地址和网段可以是 IPv4 或 IPv6 格式，可混合填写，最多可输入 100 个地址。注意若您需要对同类型名单内已设定的 `values` 地址进行增删处理，那么您可调用获取域名配置接口获取已配置的全部地址列表后，在此基础上添加或删除您期望变更的地址，最后重新传入 `values`。

enabled

Boolean

是

true

是否开启黑白名单配置，取值如下所示：

true：开启黑白名单配置
false：关闭黑白名单配置

is_white_mode

Boolean

是

true

是否是 IP 白名单，取值如下所示：

true：配置白名单
false：配置黑名单

values

Array of String

是

["192.0.2.0","192.0.2.0/24"]

黑白名单 IP 地址，您可以指定一个或者多个 IP 地址（如 192.0.2.0）和 IP 地址网段（192.0.2.0/24）。IP 地址和网段可以是 IPv4 或 IPv6 格式，可混合填写，最多可输入 100 个地址。

注意

若您需要对同类型名单内已设定的 values 地址进行增删处理，那么您可调用获取域名配置接口获取已配置的全部地址列表后，在此基础上添加或删除您期望变更的地址，最后重新传入 values。

返回参数

本接口调用成功后返回 OK。更多信息请见公共返回参数。

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateImageDomainIPAuth&Version=2018-08-01&ServiceId=098**ud9
{
    "domain": "example.imagex.com",
    "ip_auth": {
        "enabled": true,
        "is_white_mode": true,
        "values": [
            "192.0.2.0",
            "192.0.2.0/24"
        ]
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateImageDomainIPAuth",
        "Version": "2018-08-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": "ok"
}

错误码

本接口无特有的错误码。更多信息请见公共错误码以及 veImageX 错误码。