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

文档中心

立即注册

导航

添加域名

最近更新时间：2024.11.18 19:55:14首次发布时间：2022.02.15 21:27:24

在内容分发网络中添加您的域名。在添加域名时，您可以设置域名的配置。

使用限制

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

您添加的域名必须满足以下要求：

如果您指定的加速区域包含中国内地，该域名必须已在工信部备案。您可以在域名信息备案管理系统页面查询您的域名是否已备案。
如果该域名已在其他火山引擎账号下，您无法添加该域名。
如果该域名已在您的账号下，您无法再次添加该域名。
该域名不能是二级域名。例如，您添加的域名不能是 example.com。

说明

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

请求说明

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

请求参数

说明

在您调用该 API 时，您必须在 Body 中指定 Origin 模块。在 Body 中，您也可以指定其他可选的域名配置模块。这些可选模块在 UpdateCdnConfig 文档中说明。

Query

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

Body

参数名称	数据类型	是否必选	参数说明	示例
Domain	String	是	表示您需要添加的一个域名。主账号下最多能添加 200 个加速域名。如果您需要添加的域名数量超过 200 个，请提交工单。您可以添加中文域名。在指定中文名时，您必须将域名中的汉字转化为 punycode 码后再输入。您添加的域名必须满足以下额外要求：域名长度不超过 100 个字符。域名不能包含大写字母。域名不包含这些后缀：`zjgslb.com`，`yangyi19.com`，`volcgslb.com`，`veew-alb-cn1.com`，`bplgslb.com`，`bplslb.com`，`ttgslb.com`。	`www.example.com`
ServiceType	String	否	表示该域名的业务类型。该参数有以下取值： `download`：表示文件下载。 `web`：表示网页。 `video`：表示音视频点播。	`web`
ServiceRegion	String	否	表示加速区域。该参数有以下取值： `chinese_mainland`：表示中国内地。 `global`：表示全球。 `outside_chinese_mainland`：表示全球（不含中国内地）。 `global` 和 `outside_chinese_mainland` 是白名单功能。如果您需要指定这两个参数值，请提交工单。该参数的默认值是 `chinese_mainland`。	`outside_chinese_mainland`
Project	String	否	表示该域名所归属的项目。您可以在项目管理页面查看已有的项目以及项目下的资源。该参数的默认值是 `default`，表示名称是 default 的项目。	`default`
ResourceTags	Object[]	否	表示您对该域名设置的标签。您最多可以设置 10 个标签。
SharedCname	Object	否	表示共享 CNAME 的配置。如果您需要使用此功能，请提交工单。

返回参数

由于该 API 没有响应参数，响应正文只有包含请求元数据的 ResponseMetadata 结构体，没有 Result 结构体。

请求示例

POST https://cdn.volcengineapi.com/?Action=AddCdnDomain&Version=2021-03-01
{
  "Domain": "www.example.com",
  "ServiceType": "web",
  "OriginProtocol": "http",
  // 由于 Origin 结构体是 AddCdnDomain 的必填项，该结构体在本示例中列出。关于该模块中参数的描述，参见 UpdateCdnConfig。
  "Origin": [
    {
      "OriginAction": {
        "OriginLines": [
          {
            "Address": "1.1.1.1",
            "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"
  }
  //关于其他域名配置的示例，参见 UpdateCdnConfig 文档中相应配置的请求示例。
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2021121621104801021219403908010CBC",
    "Action": "AddCdnDomain",
    "Version": "2021-03-01",
    "Service": "CDN",
    "Region": "cn-north-1"
  }
}

错误码

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