文档中心

更新地域访问限制配置

最近更新时间：2024.01.31 15:08:07

首次发布时间：2022.11.30 19:02:43

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

请求说明

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

说明

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

请求参数

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

Query

参数类型是否必选描述

Action String 是接口名称。

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

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

ServiceId

String

是

服务 ID。

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

Body

参数	类型	是否必选	描述
domain	String	是	域名，您可以通过获取服务下全部域名获取服务下域名信息。
area_access	Object of area_access	是	区域访问限制配置

area_access

参数	类型	是否必选	描述
enabled	bool	是	是否开启区域限制，取值如下所示： true：开启 false：未开启
rule_type	String	是	黑白名单设置类型，取值如下所示： deny：黑名单 allow：白名单
areas	Array of String	是	地区列表。取值请见国家名称对照表表格中国家简写该列内容。

参数

类型

是否必选

描述

enabled

bool

是

是否开启区域限制，取值如下所示：

true：开启
false：未开启

rule_type

String

是

黑白名单设置类型，取值如下所示：

deny：黑名单
allow：白名单

areas

Array of String

是

地区列表。取值请见国家名称对照表表格中国家简写该列内容。

返回参数

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

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateImageDomainAreaAccess&Version=2018-08-01 
{
    "domain": "because",
    "area_access": {
        "enabled": false,
        "rule_type": "lashings",
        "areas": [
            "sign"
        ]
    }
}

正常返回示例

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

异常返回示例

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

错误码

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