批量修改加速域名配置--内容分发网络-火山引擎

文档中心

立即注册

导航

批量修改加速域名配置

最近更新时间：2024.10.09 20:34:08首次发布时间：2024.10.09 20:34:08

批量更新多个加速域名的配置。

说明

您无法更新 Status 是 offline 的域名。要获取一个域名的状态，请调用 DescribeCdnConfig。
如果待更新的域名都启用了 HTTPS，则您无法批量修改这些域名所关联的证书。
在待更新的域名中，如果有些域名启用了 HTTPS，有些没有启用，则您无法批量修改这些域名的 HTTPS 相关配置。

在该 API 的请求正文中，您可以指定的与域名配置相关的参数在 UpdateCdnConfig 中描述。

使用限制

节流限制：您每秒最多可以提交 20 个 API 请求。

请求说明

请求方式：POST
请求地址：https://cdn.volcengineapi.com/?Action=BatchUpdateCdnConfig&Version=2021-03-01

请求参数

Query

参数名称	数据类型	是否必选	参数说明
Action	String	是	接口名称。当前 API 的名称为 `BatchUpdateCdnConfig`。
Version	String	是	接口版本。当前 API 的版本为 `2021-03-01`。

Body

参数名称	数据类型	是否必选	参数说明	示例
Domains	String[]	是	表示一个域名列表，最多可以包含 50 个域名。 CDN 会为列表中的所有域名更新指定的配置。	`["abc.example.com","zzz.example.com"]`
Aggregate	Boolean	否	表示 CDN 是否按域名展示配置更新的结果以及当 CDN 无法更新 `Domains` 列表中某个域名的配置时，CDN 处理失败的方式。该参数有以下取值： `true`：表示 CDN 不按域名展示配置更新的结果。一个域名的配置更新失败会导致列表中所有域名的配置更新失败。更新失败时，响应正文会包含 `Error` 结构体。该结构体中包含的是 `Domain` 列表中第一个配置更新失败的域名的错误信息。参见示例 1。 `false`：表示 CDN 按域名展示配置更新的结果。一个域名的配置更新失败不会影响其他域名的配置更新。响应正文会包含 `DeployResult` 结构体。该结构体中包含的是 `Domain` 列表中各域名的配置更新结果。参见示例 2。该参数的默认值是 `true`。	`true`

返回参数

参数名称	数据类型	参数说明	示例
DeployResult	Object[]	表示 `Domains` 列表中各域名的配置更新结果。该参数仅当 `Aggregate` 是 `false` 时才会出现。

请求示例 1

POST https://cdn.volcengineapi.com/?Action=BatchUpdateCdnConfig&Version=2021-03-01
{
    "Domains": [
        "www.example.com",
        "img.example.com",
        "videos.example.com"
    ],
    "OriginProtocol": "http",
    "HTTPS": {
        "Switch": true,
        "OCSP": true
    },
    "Aggregate": true
}

返回示例 1

{
    "ResponseMetadata": {
        "RequestId": "202410091237542EE1A0C61B73114E0B08",
        "Action": "BatchUpdateCdnConfig",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-01",
        "Error": {
            "Code": "InvalidParameter.Domain.Locked",
            "Message": "域名处于代运维状态，无法自助修改配置。"
        }
    }
}

请求示例 2

POST https://cdn.volcengineapi.com/?Action=BatchUpdateCdnConfig&Version=2021-03-01
{
    "Domains": [
        "www.example.com",
        "img.example.com",
        "videos.example.com"
    ],
    "OriginProtocol": "http",
    "HTTPS": {
        "Switch": true,
        "OCSP": true
    },
    "Aggregate": false
}

返回示例 2

{
    "ResponseMetadata": {
        "RequestId": "20241009141640E5DE873D9A01D9F72861",
        "Action": "BatchUpdateCdnConfig",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-01"
    },
    "Result": {
        "DeployResult": [
            {
                "Domain": "www.example.com",
                "Status": "success"
            },
            {
                "Domain": "img.example.com",
                "ErrorMsg": "域名处于代运维状态，无法自助修改配置。",
                "Status": "fail"
            },
            {
                "Domain": "videos.example.com",
                "ErrorMsg": "传入的HTTPS.CertInfo字段不允许为空。",
                "Status": "fail"
            }
        ]
    }
}

错误码

如果响应正文的 ResponseMetadata 字段中包含 Error 字段，则表示 API 请求失败。更多关于错误码的信息，参见错误码。