AddCdnDomain - 添加域名--内容分发网络-火山引擎

文档中心

立即注册

导航

AddCdnDomain - 添加域名

最近更新时间：2025.10.24 10:33:11首次发布时间：2022.02.15 21:27:24

在 CDN 中添加一个或者多个具有相同配置的域名，并指定这些配置。

使用限制

节流限制：您每秒最多可以发送 20 个请求。

在您调用该 API 时，CDN 会对该域名做一系列检查。如果域名未通过某项检查，您会收到相应的错误消息。参见域名检查。

说明

如果您要添加的域名是一个泛域名，请提交工单。

请求说明

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

请求参数

Query

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

Body

参数名称	数据类型	是否必选	参数说明	示例
Domain	String	是	表示待添加的域名列表，列表中最多可以包含 50 个域名。多个域名之间使用逗号（,）分隔。	`www.example.com`
Origin	Object[]	是	表示源站配置。关于该模块以及其他模块的配置说明，参见 UpdateCdnConfig。
ServiceType	String	是	表示业务类型。该参数有以下取值： `download`：表示文件下载。 `web`：表示网页。 `video`：表示音视频点播。	`web`
Project	String	否	表示这些域名所归属的项目。您可以在项目管理页面查看已有的项目以及项目下的资源。该参数的默认值是 `default`，表示名称是 default 的项目。	`default`
ResourceTags	Object[]	否	表示这些域名的标签。您最多可以设置 10 个标签。
ServiceRegion	String	否	表示加速区域。该参数有以下取值： `chinese_mainland`：表示中国内地。 `global`：表示全球。 `outside_chinese_mainland`：表示全球（不含中国内地）。该参数的默认值是 `chinese_mainland`。要指定另两个值，请提交工单。	`chinese_mainland`

返回参数

参数名称	数据类型	参数说明	示例
ResourceIds	String[]	表示创建的域名列表。	`["www.example.com","docs.example.com"]`

请求示例

POST https://cdn.volcengineapi.com/?Action=AddCdnDomain&Version=2021-03-01
{
    "Domain": "www.example.com,docs.example.com",
    "ServiceType": "web",
    "OriginProtocol": "http",
    "Origin": [
        {
            "OriginAction": {
                "OriginLines": [
                    {
                        "Address": "203.0.113.2",
                        "HttpPort": "80",
                        "HttpsPort": "443",
                        "InstanceType": "ip",
                        "OriginType": "primary",
                        "PrivateBucketAccess": false,
                        "Weight": "1"
                    }
                ]
            }
        }
    ],
    "ResourceTags": [
        {
            "key": "hello",
            "value": "world"
        }
    ],
    "SharedCname": {
        "Switch": true,
        "Cname": "test.cname.gslb.com"
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2025081906410106F4CE0C4C8141A3CBF2",
        "Action": "AddCdnDomain",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-1"
    },
    "Result": {
        "ResourceIds": [
            "www.example.com",
            "docs.example.com"
        ]
    }
}

错误码

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