文档中心

更新镜像回源配置

最近更新时间：2024.01.31 14:59:42

首次发布时间：2021.02.23 10:42:26

根据服务 ID 以及输入的待更新的镜像回源配置详情，更新该服务的镜像回源配置。

说明

本接口全量更新配置，如果某个配置项为空，比如 Host 为空，接口会将对应的配置设为空。

请求说明

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

说明

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

参数	类型	是否必填	描述
Schema	String	是	下载图片的协议，取值为：http、https。
Host	String	是	镜像回源域名。
Hosts	JSON Map	否	带权重回源域名。key 为 String 类型，代表镜像回源域名；value 为 Integer 类型，代表域名权重。
Source	String	是	镜像源 URI，其中图片名用 %s 占位符替代，比如/obj/%s。
Headers	JSON Map	是	镜像回源下载原图时，携带的 HTTP 头部，键值都为 String 类型。

返回参数

无

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateImageMirrorConf&Version=2018-08-01&ServiceId=WMKp6UXedj
{
	"Schema": "http",
	"Host": "xxx",
	"Source": "/obj/%s"
}

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2019091720065701022506808073E8D1BC",
        "Action": "UpdateImageMirrorConf",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
    
    }
}

异常返回示例

{
    "ResponseMetadata":{
        "RequestId": "201806041104200100100232280022D30",
        "Action": "UpdateImageMirrorConf",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
        // 如下Error结构在API调用失败时返回
        "Error": {
            "Code": "RetrieveServiceFailure",
            "Message": "Service not found."
        }
    }
}

错误码

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