更新默认域名配置--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

更新默认域名配置

最近更新时间：2024.08.05 18:26:07首次发布时间：2021.02.23 10:42:26

本接口通过指定默认默认域名来更改默认域名信息。

说明

该接口属于历史版本 API，建议您使用新版 SetDefaultDomain 接口。

请求说明

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

说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	描述
domain	String	是	域名，您可以通过获取服务下全部域名获取服务下域名信息。

返回参数

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

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=SetDefaultDomain&Version=2018-08-01 
{
    "domain": "test.imagex.com"
}

正常返回示例

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

异常返回示例

{
    "ResponseMetadata":{
        "RequestId": "201806041104200100100232280022D30",
        "Action": "SetDefaultDomain",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
            "Code": "UpdateDomainFailure",
            "Message": "Service not found."
        }
    }
}

错误码

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