本接口支持通过指定服务 ID、域名来配置 UA 访问限制。
说明
veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址。
以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共参数。
参数 | 类型 | 是否必选 | 描述 |
---|---|---|---|
Action | String | 是 | 接口名称。 |
Version | String | 是 | 接口版本。veImageX 当前 API 的版本为 2018-08-01 。 |
ServiceId | String | 是 | 服务 ID。 |
参数 | 类型 | 是否必选 | 描述 |
---|---|---|---|
domain | String | 是 | 域名,您可以通过获取服务下全部域名获取服务下域名信息。 |
ua_auth | Object of ua_auth | 是 | UA 访问限制配置 |
参数 | 类型 | 是否必选 | 描述 |
---|---|---|---|
enabled | bool | 是 | 是否开启 UA 访问限制,取值如下所示:
|
rule_type | String | 是 | 黑白名单设置类型,取值如下所示:
|
user_agents | Array of String | 是 | Agent 列表,最多可支持输入100个,支持通配符 注意 若您需要对同类型名单内已设定的 Agent 列表进行增删处理,那么您可调用 获取域名配置 接口获取已配置的全部列表后,在此基础上添加或删除您期望变更的值,最后重新传入 |
allow_empty | bool | 是 | 表示是否允许 UA 为空或者不包含 UA 字段的请求访问加速域名。取值如下所示:
|
正确更新返回 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": "参数异常" } } }