You need to enable JavaScript to run this app.
导航
更新 UA 黑白名单配置
最近更新时间:2024.09.30 14:07:50首次发布时间:2022.11.30 19:02:43

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

请求说明

  • 接口名称:UpdateImageDomainUaAccess
  • 请求方式:POST
  • 接口地址示例:https://imagex.volcengineapi.com/?Action=UpdateImageDomainUaAccess&Version=2018-08-01
  • 请求频率限制:10 次/秒
  • 超时时间:15 秒

说明

veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址

请求参数

以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共参数

Query

参数类型是否必选描述
ActionString接口名称。
VersionString接口版本。veImageX 当前 API 的版本为 2018-08-01

ServiceId

String

服务 ID。

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

Body

参数类型是否必选描述
domainString域名,您可以通过获取服务下全部域名获取服务下域名信息。
ua_authObject of ua_authUA 访问限制配置

ua_auth

参数类型是否必选描述

enabled

bool

是否开启 UA 访问限制,取值如下所示:

  • true:开启
  • false:未开启(默认)

rule_type

String

黑白名单设置类型,取值如下所示:

  • deny:黑名单
  • allow:白名单(默认)

user_agents

Array of String

Agent 列表,最多可支持输入100个,支持通配符*匹配任意字符串。输入多个时以|分割,或者一行仅输入一个。

注意

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

allow_empty

bool

表示是否允许 UA 为空或者不包含 UA 字段的请求访问加速域名。取值如下所示:

  • true:允许
  • false:不允许

返回示例

正确更新返回 ok,否则错误在 Err 中返回。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateImageDomainUaAccess&Version=2018-08-01 
{
    "domain": "point",
    "ua_auth": {
        "enabled": true,
        "rule_type": "folding",
        "user_agents": [
            "road"
        ],
		    "allow_empty": true
    }
}

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30"
        "Action": "UpdateImageDomainUaAccess",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
    },
    "Result": "ok"
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "UpdateImageDomainUaAccess",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
            "Code": "200000",
            "Message": "参数异常"
        }
    }
}

错误码

访问公共错误码域名相关错误码获取详细信息。