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

文档中心

立即注册

导航

veImageX

更新 UA 黑白名单配置

最近更新时间：2025.01.08 18:09:09首次发布时间：2022.11.30 19:02:43

本接口支持通过指定服务 ID、域名来配置 UA 访问限制。

注意事项

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

请求说明

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

请求参数

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

Query

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

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

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

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

ServiceId

String

是

qhc***uslz

服务 ID。

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

Body

参数	类型	是否必选	示例值	描述
domain	String	是	`123***.volcimagextest.com`	域名，您可以通过获取服务下全部域名获取服务下域名信息。
ua_auth	Object of UaAuth	是	`-`	UA 访问限制配置。

UaAuth

参数	类型	是否必选	示例值	描述
enable	Boolean	是	`true`	是否开启 UA 访问限制，取值如下所示： `true`：开启 `false`：未开启（默认）
rule_type	String	是	`deny`	黑白名单设置类型，取值如下所示： `deny`：黑名单 `allow`：白名单（默认）
user_agents	Array of String	是	`["road"]`	Agent 列表，最多可支持输入 1000 个，支持通配符 `*` 匹配任意字符串。输入多个时以 `\|` 分割，或者一行仅输入一个。注意若您需要对同类型名单内已设定的 Agent 列表进行增删处理，那么您可调用获取域名配置接口获取已配置的全部列表后，在此基础上添加或删除您期望变更的值，最后重新传入 `user_agents`。
allow_empty	Boolean	是	`true`	是否允许 UA 为空或者不包含 UA 字段的请求访问加速域名。取值如下所示： `true`：允许 `false`：不允许

返回参数

本接口暂无特定的返回参数。更多信息请见公共返回参数。

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateImageDomainUaAccess&Version=2018-08-01&ServiceId=qhc***uslz
{
    "domain": "123***.volcimagextest.com",
    "ua_auth": {
        "enable": true,
        "rule_type": "deny",
        "user_agents": [
            "road"
        ],
        "allow_empty": true
    }
}

返回示例

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

错误码

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