文档首页/ 内容分发网络 CDN/ API参考/ API/ 域名操作/ 创建加速域名 - CreateDomain
更新时间:2026-11-06 GMT+08:00
分享

创建加速域名 - CreateDomain

功能介绍

将域名添加到CDN,并为域名配置源站。域名创建完成并配置解析后,客户端通过该域名访问源站资源时,CDN将源站资源缓存至节点,用户下次访问时,即可从最近的边缘节点获取资源,提升用户访问速度。

  • 创建加速域名前,需要先开通CDN服务。

  • 如果加速域名的服务范围包含中国大陆,加速域名需要已完成备案。

  • 单租户调用频率:20次/min。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    cdn:configuration:createDomains

    Write

    domain *

    -

    -

    -

    -

    g:EnterpriseProjectId

URI

POST /v1.0/cdn/domains

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户鉴权Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表2 请求Body参数

参数

是否必选

参数类型

描述

domain

是

DomainBody object

参数解释:

创建域名请求体,包含创建域名所需参数

约束限制:

不涉及

表3 DomainBody

参数

是否必选

参数类型

描述

domain_name

是

String

参数解释:

加速域名

说明:
添加泛域名后,该泛域名所有次级域名默认支持CDN加速

约束限制:

加速域名不允许重复添加

取值范围:

  • 域名长度不能超过200个字符

  • 支持大小写字母、数字、"-"、".",首尾字符不能是"-"或"."

  • 泛域名场景下支持"*",且"*必须为首字符

  • 域名单节点长度不超过63个字符,即:***.***.com中,***的字符数不超过63个字符

默认取值:

不涉及

business_type

是

String

参数解释:

域名业务类型

约束限制:

不涉及

取值范围:

  • web: 网页加速

  • download: 文件下载加速

  • video: 点播加速

  • wholeSite: 全站加速

默认取值:

不涉及

sources

是

Array of SourcesRequestBody objects

参数解释:

源站配置

约束限制:

不涉及

service_area

否

String

参数解释:

域名服务范围

约束限制:

服务范围为中国大陆或全球时,加速域名需要到工信部备案

取值范围:

  • mainland_china: 中国大陆

  • outside_mainland_china: 中国大陆境外

  • global: 全球

默认取值:

mainland_china: 中国大陆

enterprise_project_id

否

String

参数解释:

企业项目id。您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id

约束限制:

当用户开启企业项目功能时,该参数生效,表示查询资源所属项目,"all"表示所有项目

取值范围:

不涉及

默认取值:

不涉及

origin_protocol

否

String

参数解释:

指定CDN回源时的请求协议

约束限制:

不涉及

取值范围:

  • follow: 协议跟随

  • http: http协议

  • https: https协议

默认取值:

http: http协议

configs

否

CreateDomainConfigs object

参数解释:

创建域名时同步配置的配置项,创建域名后可通过"修改域名全量配置"接口再次调整

约束限制:

不涉及

表4 SourcesRequestBody

参数

是否必选

参数类型

描述

domain_id

否

String

参数解释:

加速域名ID,系统自动生成,创建域名时无需传入此参数

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

ip_or_domain

是

String

参数解释:

源站IP或者域名

约束限制:

不能配置内网IP

取值范围:

不涉及

默认取值:

不涉及

origin_type

是

String

参数解释:

源站类型

约束限制:

不涉及

取值范围:

  • ipaddr: 源站IP

  • domain: 源站域名

  • obs_bucket: OBS桶域名

默认取值:

不涉及

obs_bucket_type

否

String

参数解释:

OBS回源鉴权开关,适用于OBS桶源站场景,如果桶需要带鉴权访问,则需要打开OBS回源鉴权开关。如此,CDN节点回源时会携带鉴权信息,鉴权信息与OBS桶不匹配时,回源失败,避免非授权的请求盗刷流量

约束限制:

源站类型是“OBS桶域名”时需要传该参数

取值范围:

  • private: 开启回源鉴权开关

  • public: 关闭回源鉴权开关

默认取值:

public: 关闭回源鉴权开关

active_standby

是

Integer

参数解释:

设置主/备源站,主源站优先级高于备源站,CDN节点回源时优先回到主源站

说明:
  • 主源站优先级默认为70,备源站优先级默认为30。

约束限制:

不涉及

取值范围:

  • 1: 主源站

  • 0: 备源站

默认取值:

不涉及

priority

否

Integer

参数解释:

源站优先级,数值越大优先级越高,创建域名时可用于替代active_standby指定源站优先级

约束限制:

  • 与active_standby二者至少传一个,同时存在时以priority为准

  • 不同优先级数量不超过6个

取值范围:

1-1000

默认取值:

不涉及

weight

否

Integer

参数解释:

权重,值越大回源到该源站的次数越多。多个优先级相同的源站,由权重决定回源到各个源站的比例

约束限制:

不涉及

取值范围:

1-100

默认取值:

50

host_name

否

String

参数解释:

回源HOST

约束限制:

不涉及

取值范围:

不涉及

默认取值:

加速域名

enable_obs_web_hosting

否

Integer

参数解释:

是否开启静态网站托管功能,如果您的源站是OBS桶域名且配置了静态网站托管,开启该功能后,客户端即可访问静态网站托管页面

说明:
开启该功能后将自动给桶源站地址加上website字段,如果地址中已有website字段,该参数不生效

约束限制:

  • 源站类型为obs_bucket时需要传该参数

  • 只有当源站OBS桶已经开启静态网站托管时,才可开启,否则将导致业务异常

取值范围:

  • 0: 关闭

  • 1: 开启

默认取值:

0: 关闭

http_port

否

Integer

参数解释:

HTTP端口

约束限制:

不涉及

取值范围:

1-65535

默认取值:

80

https_port

否

Integer

参数解释:

HTTPS端口

约束限制:

不涉及

取值范围:

1-65535

默认取值:

443

表5 CreateDomainConfigs

参数

是否必选

参数类型

描述

error_code_cache

否

Array of ErrorCodeCache objects

参数解释:

将源站返回的错误状态码缓存到CDN节点,用户再次请求时由CDN直接响应给用户错误码

约束限制:

不涉及

ip_filter

否

IpFilter object

参数解释:

IP黑白名单,对用户的请求IP地址进行过滤,从而限制访问来源

约束限制:

不涉及

flow_limit_strategy

否

Array of FlowLimitStrategy objects

参数解释:

设置用量封顶阈值,当实际用量大于阈值时停用域名,有效预防流量盗刷或恶意攻击带来的高额账单。

说明:
由于监控数据存在时延,域名将在用量达到阈值后的10分钟左右被停用

约束限制:

不涉及

bandwidth_alarm_strategy

否

BandwidthAlarmStrategy object

参数解释:

带宽告警策略,当带宽达到告警阈值时,发送告警通知

约束限制:

不涉及

表6 ErrorCodeCache

参数

是否必选

参数类型

描述

code

否

Integer

参数解释:

需要缓存的错误码

约束限制:

不涉及

取值范围:

  • 3xx: 301, 302

  • 4xx: 400, 401, 403, 404, 405, 407, 414, 416, 424, 451

  • 5xx: 500, 501, 502, 503, 504, 509, 514

默认取值:

不涉及

ttl

否

Integer

参数解释:

错误码缓存时间

约束限制:

不涉及

取值范围:

0-31536000,单位:秒

说明:
3XX状态码缓存时间范围为0-20s

默认取值:

不涉及

表7 IpFilter

参数

是否必选

参数类型

描述

type

是

String

参数解释:

IP黑白名单类型

约束限制:

不涉及

取值范围:

  • off: 关闭IP黑白名单

  • black: IP黑名单

  • white: IP白名单

默认取值:

不涉及

value

否

String

参数解释:

配置IP黑白名单

说明:
支持IPv6,支持配置IP地址和IP&掩码格式的网段

约束限制:

  • 当type=off时,非必传

  • 多条规则用“,”分隔

  • 最多支持配置500条规则

  • 多个完全重复的IP/IP段将合并为一条规则

  • 不支持带通配符的地址,如192.168.0.*

取值范围:

不涉及

默认取值:

不涉及

表8 FlowLimitStrategy

参数

是否必选

参数类型

描述

strategy_type

是

String

参数解释:

用量统计类型

约束限制:

不涉及

取值范围:

  • instant: 瞬时用量

  • hour: 累计用量(小时)

  • day: 累计用量(天)

默认取值:

不涉及

item_type

是

String

参数解释:

用量封顶类型

约束限制:

不涉及

取值范围:

  • bandwidth: 带宽封顶,单位: bit/s

  • traffic: 流量封顶,单位: byte

默认取值:

不涉及

limit_value

是

Long

参数解释:

用量封顶阈值,域名用量达到该阈值后,将会停用域名,单位由item_type参数决定(bandwidth对应bit/s,traffic对应byte)

约束限制:

不涉及

取值范围:

必须为正整数

默认取值:

不涉及

alarm_percent_threshold

否

Integer

参数解释:

用量告警阈值,单位为百分比(%),域名用量达到该百分比阈值后,将会发送告警

约束限制:

不涉及

取值范围:

10-90

默认取值:

不涉及

ban_time

否

Long

参数解释:

域名封禁周期

约束限制:

ban_time设置为0时,表示不自动解封,需要客户手动解封域名

取值范围:

  • 0: 不自动解封

  • 60: 60分钟,即1个小时

  • 720: 720分钟,即12个小时

  • 1440: 1440分钟,即24个小时

  • 4320: 4320分钟,即3天

默认取值:

0

表9 BandwidthAlarmStrategy

参数

是否必选

参数类型

描述

status

否

String

参数解释:

带宽告警开关

约束限制:

不涉及

取值范围:

  • on: 开启

  • off: 关闭

默认取值:

off: 关闭

value

否

Long

参数解释:

带宽告警阈值,单位:bit/s

约束限制:

  • status为on时必填

取值范围:

1000000-10000000000000

默认取值:

不涉及

响应参数

状态码:200

表10 响应Body参数

参数

参数类型

描述

domain

CreateDomainResponseBodyContent object

创建域名返回信息。

表11 CreateDomainResponseBodyContent

参数

参数类型

描述

id

String

参数解释:

加速域名ID。

取值范围:

不涉及

domain_name

String

参数解释:

加速域名。

取值范围:

不涉及

business_type

String

域名业务类型:

  • web:网站加速;

  • download:文件下载加速;

  • video:点播加速;

  • wholeSite:全站加速。

service_area

String

域名服务范围,若为mainland_china,则表示服务范围为中国大陆;若为outside_mainland_china,则表示服务范围为中国大陆境外;若为global,则表示服务范围为全球。

user_domain_id

String

参数解释:

域名所属用户的domain_id。

取值范围:

不涉及

domain_status

String

加速域名状态。取值意义:

  • online表示“已开启”

  • offline表示“已停用”

  • configuring表示“配置中”

  • configure_failed表示“配置失败”

  • checking表示“审核中”

  • check_failed表示“审核未通过”

  • deleting表示“删除中”。

cname

String

参数解释:

加速域名对应的CNAME。

取值范围:

不涉及

sources

Array of Sources objects

源站信息。

domain_origin_host

DomainOriginHost object

域名回源HOST配置。

https_status

Integer

是否开启HTTPS加速。取值意义:

  • 0:未开启

  • 1:开启

create_time

Long

参数解释:

域名创建时间,相对于UTC 1970-01-01到当前时间相隔的毫秒数。

取值范围:

不涉及

modify_time

Long

参数解释:

域名修改时间,相对于UTC 1970-01-01到当前时间相隔的毫秒数。

取值范围:

不涉及

disabled

Integer

封禁状态(0代表未禁用;1代表禁用)。

locked

Integer

锁定状态(0代表未锁定;1代表锁定)。

range_status

String

range状态。取值意义:

  • on:开启

  • off:关闭

follow_status

String

follow302状态。取值意义:

  • on:开启

  • off:关闭

origin_status

String

参数解释:

是否暂停源站回源

取值范围:

  • on: 开启

  • off: 关闭

auto_refresh_preheat

Integer

自动刷新预热(0代表关闭;1代表打开)。

表12 Sources

参数

参数类型

描述

domain_id

String

参数解释:

加速域名id。

取值范围:

不涉及

ip_or_domain

String

参数解释:

源站IP(非内网IP)或者域名。

取值范围:

不涉及

origin_type

String

源站类型取值:ipaddr:源站IP、 domain:源站域名、obs_bucket:OBS桶域名。

obs_bucket_type

String

OBS桶类型。

  • private: 私有桶(除桶ACL授权外的其他用户无桶的访问权限)。

  • public: 公有桶(任何用户都可以对桶内对象进行读操作)。

active_standby

Integer

主备状态,1代表主源站,0代表备源站。

enable_obs_web_hosting

Integer

参数解释:

是否开启静态网站托管功能,如果您的源站是OBS桶域名且配置了静态网站托管,开启该功能后,客户端即可访问静态网站托管页面

说明:
开启该功能后将自动给桶源站地址加上website字段,如果地址中已有website字段,该参数不生效

取值范围:

  • 0: 关闭

  • 1: 开启

表13 DomainOriginHost

参数

参数类型

描述

domain_id

String

参数解释:

域名ID。

取值范围:

不涉及

origin_host_type

String

回源host的类型,accelerate:选择加速域名作为回源host域名, customize:使用自定义的域名作为回源host域名。

customize_domain

String

参数解释:

回源host域名。返回加速域名主源站设置的HOST域名,如果加速域名有多个主源站且对应多个回源HOST,则返回源站配置中的第一个主源站对应的HOST域名。

取值范围:

不涉及

请求示例

POST https://cdn.myhuaweicloud.com/v1.0/cdn/domains

{
  "domain" : {
    "domain_name" : "example1.example2.example3.com",
    "business_type" : "web",
    "sources" : [ {
      "ip_or_domain" : "0.0.0.0",
      "origin_type" : "ipaddr",
      "active_standby" : 1
    } ],
    "service_area" : "mainland_china",
    "enterprise_project_id" : "0"
  }
}

响应示例

状态码:200

{
  "domain" : {
    "sources" : [ {
      "domain_id" : "ff80*************************07b",
      "ip_or_domain" : "0.0.0.0",
      "origin_type" : "ipaddr",
      "active_standby" : 1
    } ],
    "id" : "ff80*************************07b",
    "user_domain_id" : "38***********************5024dcb",
    "domain_name" : "example11.example2.example3.com",
    "business_type" : "web",
    "service_area" : "mainland_china",
    "cname" : "example1.example2.example3.com.c.example4.com",
    "domain_status" : "configuring",
    "https_status" : 0,
    "create_time" : 1513152634467,
    "modify_time" : 1513152634467,
    "domain_origin_host" : {
      "domain_id" : "ff80*************************07b",
      "origin_host_type" : "customize",
      "customize_domain" : "example5.example6.com"
    },
    "disabled" : 0,
    "locked" : 0,
    "range_status" : "off",
    "follow_status" : "off",
    "origin_status" : "on",
    "auto_refresh_preheat" : 0
  }
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.cdn.v2.region.CdnRegion;
import com.huaweicloud.sdk.cdn.v2.*;
import com.huaweicloud.sdk.cdn.v2.model.*;

import java.util.List;
import java.util.ArrayList;

public class CreateDomainSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        CdnClient client = CdnClient.newBuilder()
                .withCredential(auth)
                .withRegion(CdnRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateDomainRequest request = new CreateDomainRequest();
        CreateDomainRequestBody body = new CreateDomainRequestBody();
        List<SourcesRequestBody> listDomainSources = new ArrayList<>();
        listDomainSources.add(
            new SourcesRequestBody()
                .withIpOrDomain("0.0.0.0")
                .withOriginType(SourcesRequestBody.OriginTypeEnum.fromValue("ipaddr"))
                .withActiveStandby(1)
        );
        DomainBody domainbody = new DomainBody();
        domainbody.withDomainName("example1.example2.example3.com")
            .withBusinessType(DomainBody.BusinessTypeEnum.fromValue("web"))
            .withSources(listDomainSources)
            .withServiceArea(DomainBody.ServiceAreaEnum.fromValue("mainland_china"))
            .withEnterpriseProjectId("0");
        body.withDomain(domainbody);
        request.withBody(body);
        try {
            CreateDomainResponse response = client.createDomain(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdkcdn.v2.region.cdn_region import CdnRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcdn.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = GlobalCredentials(ak, sk)

    client = CdnClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CdnRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateDomainRequest()
        listSourcesDomain = [
            SourcesRequestBody(
                ip_or_domain="0.0.0.0",
                origin_type="ipaddr",
                active_standby=1
            )
        ]
        domainbody = DomainBody(
            domain_name="example1.example2.example3.com",
            business_type="web",
            sources=listSourcesDomain,
            service_area="mainland_china",
            enterprise_project_id="0"
        )
        request.body = CreateDomainRequestBody(
            domain=domainbody
        )
        response = client.create_domain(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    cdn "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth, err := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := cdn.CdnClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := cdn.NewCdnClient(hcClient)

    request := &model.CreateDomainRequest{}
	var listSourcesDomain = []model.SourcesRequestBody{
        {
            IpOrDomain: "0.0.0.0",
            OriginType: model.GetSourcesRequestBodyOriginTypeEnum().IPADDR,
            ActiveStandby: int32(1),
        },
    }
	serviceAreaDomain:= model.GetDomainBodyServiceAreaEnum().MAINLAND_CHINA
	enterpriseProjectIdDomain:= "0"
	domainbody := &model.DomainBody{
		DomainName: "example1.example2.example3.com",
		BusinessType: model.GetDomainBodyBusinessTypeEnum().WEB,
		Sources: listSourcesDomain,
		ServiceArea: &serviceAreaDomain,
		EnterpriseProjectId: &enterpriseProjectIdDomain,
	}
	request.Body = &model.CreateDomainRequestBody{
		Domain: domainbody,
	}
	response, err := client.CreateDomain(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

错误码

请参见错误码。

相关文档