CreateDomain

1. 接口描述

调用本接口用于创建加速域名。

准备工作

查询加速域名的业务类型：调用DescribeBusinessTypes。
查询加速域名的加速区域：调用DescribeAccelerationRegions。

注意事项

domain全局唯一，不允许创建相同的domain。
domainName不允许和origin相同，否则会形成回环，使加速无法使用。
本接口为异步接口，接口返回成功后，此时创建加速域名操作并未立即完成。在此期间加速域名的状态将会处于Deploying，加速域名状态可以通过调用DescribeCdnDomains 接口查询，如果加速域名状态(domainStatus)由Deploying(部署中)变为Deployed(部署成功），则代表部署成功，Failed代表配置失败。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称

必选

类型

描述

domainName

是

String

加速域名

域名全局唯一，不允许重复。

domain不允许和源站地址相同，会导致回环

businessTypeId

是

String

业务类型ID

resourceGroupId

否

String

资源组的ID。

如果不传，则使用默认资源组

accelerationRegionId

是

String

加速区域ID

origin

是

Origin

源站信息

3. 响应结果

参数名称

类型

描述

requestId

String

唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 requestId。

domainId

String

加速域名Id

4. 代码示例

创建加速域名

POST / HTTP/1.1
Host: console.zenlayer.com/api/v2/cdn
Content-Type: application/json
X-ZC-Action: CreateDomain
<Common Request Params>

Request:
{
    "domainName": "cdntest.zenlayer.com",
    "businessTypeId": "xxx-xx",
    "accelerationRegionId": "xxx-xx",
    "resourceGroupId":"xxx-xx",
    "origin": {
        "masterSource": "1.1.1.1",
        "slaverSource": "2.2.2.2",
        "originPort": "80",
        "originPortHttps": "443"
    }
}


Response:
{
    "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
    "response": {
        "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
        "domainId": "domainIdxxxxx",
    }
}

5. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码

HTTP状态码

错误码

说明

404

INVALID_ACCELERATION_REGION_NOT_FOUND

未找到指定的加速区域

404

INVALID_BUSINESS_TYPE_NOT_FOUND

未找到指定的加速类型

404

INVALID_RESOURCE_GROUP_NOT_FOUND

未找到指定的资源组

400

INVALID_ORIGIN_MASTER_SOURCE

主源格式不正确

400

INVALID_ORIGIN_SLAVER_SOURCE

备源格式不正确

400

INVALID_ORIGIN_SOURCE_SAME_AS_DOMAIN

源站不能与加速域名相同

最后更新于6个月前