CreateAccelerator

1. 接口描述

调用本接口用于创建加速器。

准备工作

查询可用源站区域：调用DescribeOriginRegions。
查询可用加速区域：调用DescribeAccelerateRegions。
创建证书：若需加速 https，则需提前调用CreateCertificate 上传证书和密钥。

注意事项

若 domain 参数为空，则加速器为 IP 加速，仅支持配置 L4 加速规则。
domain 全局唯一，不允许加速器配置相同 domain。
domain 不允许和 origin 相同，否则会形成回环，使加速无法使用。
创建Standard类型加速，则accelerateRegions配置Anycast, 此区域不可与其他加速区域同时存在。
本接口为异步接口，接口返回成功后，此时创建加速器操作并未立即完成。在此期间加速器的状态将会处于Deploying，加速器状态可以通过调用DescribeAccelerators 接口查询，如果加速器状态(acceleratorStatus)由Deploying(部署中)变为Accelerating(加速中），则代表加速成功，AccelerateFailure代表加速失败，可调用 redeploy 接口重试部署。

2. 请求参数

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

参数名称

必选

类型

描述

acceleratorName

否

String

加速器名称

不得超过 64 个字符

chargeType

否

String

计费类型

如果不传，则使用账号默认计费类型

resourceGroupId

否

String

资源组的 ID。

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

certificateId

否

String

证书 Id 该参数可以通过调用DescribeCertificates的返回值中的 certificateId 字段来获取。

domain

否

Domain

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

若不填，则表示 IP 加速，IP 加速不允许配置 7 层加速

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

origin

是

Origin

源站信息

accelerateRegions

是

Array of AccelerateRegion

加速区域信息

l4Listeners

否

Array of AccelerationRuleL4Listener

L4 加速规则

不允许 L4,L7 全为空

l7Listeners

否

Array of AccelerationRuleL7Listener

L7 加速规则

不允许 L4,L7 全为空

protocolOpts

否

AccelerationRuleProtocolOpts

加速器加速规则协议可选配置

healthCheck

否

HealthCheck

健康检查配置

3. 响应结果

参数名称

类型

描述

requestId

String

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

acceleratorId

String

加速器 Id

4. 代码示例

创建加速器

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

Request:
{
    "acceleratorName": "xx.xx.com_Singapore",
    "chargeType": "ByTrafficPackage",
    "resourceGroupId":"xxx-xx",
    "certificateId": "f0864***66c6fa",
    "domain": {
        "domain": "xx.xx.com",
        "relateDomains": "xx.xx.cn"
    },
    "origin": {
        "originRegionId": "SG",
        "origin": "10.10.10.10",
        "backupOrigin": ""
    },
    "accelerateRegions": [
        {
            "accelerateRegionId": "FR",
        }
    ],
    "l4Listeners": [
        {
            "portRange": "53/54",
            "protocol": "udp"
        }
    ],
    "l7Listeners": [
        {
            "port": 443,
            "backPort": 443,
            "backProtocol": "https",
            "protocol": "https"
        }
    ],
    "protocolOpts": {
        "toa": false,
        "toaValue": 253,
        "websocket": false,
        "proxyProtocol": false,
        "gzip": false,
        "sniCheck": false,
        "httpRedirect": false
    },
    "healthCheck": {
        "enable": true,
        "alarm": true,
        "port": 80
    }
}


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

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用 Zenlayer 的产品和服务。

6. 错误码

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

HTTP 状态码

错误码

说明

400

IP_ACCELERATOR_NOT_SUPPORT_L7

IP 加速器不支持 7 层加速

400

NOT_SUPPORT_RELATE_DOMAINS

IP 加速不支持关联域名

400

RELATE_DOMAINS_EXCEED_LIMIT

关联域名配置超出限制

400

RELATE_DOMAINS_CONFLICT_WITH_DOMAIN

关联域名和域名冲突

400

PORT_NOT_AVAILABLE

端口不可用，请检查端口范围

400

PORT_CONFLICT

端口冲突

400

PORT_FORBIDDEN

加速端口被禁止

400

PORT_EXCEEDED_LIMIT

端口数超出限制

400

HTTPS_NEED_CRT

https 需要配置证书

400

PROXYPROTOCOL_NOT_ALLOW_CONFIGURED_WITH_TOA

ProxyProtocol 和 Toa 不允许同时被配置

400

ORIGIN_FORBIDDEN

源站被禁止

400

ORIGIN_NOT_AVAILABLE

源站不可用

400

IP_CNAME_EXIST_SAME_TIME

源站不能同时存在 IP 和 cname

400

MULTIPLE_CNAMES_EXIST

源站不能存在多个 cname

400

CNAME_ORIGIN_NOT_SUPPORT_BACKUP_ORIGIN

主源站为 CNAME 类型时不支持配置备源站

400

CERT_NOT_MATCH_DOMAIN_OR_EXPIRED

证书过期或与域名不匹配

500

FIND_RESOUCE_GROUP_ERROR

查询用户资源组失败

400

ACCELERATE_REGION_ONLY

此区域仅提供于加速区域使用

400

ANYCAST_ONLY

此区域仅提供于 Anycast 使用

400

DOMAIN_SAME_AS_ORIGIN

domain 不允许和源站相同

400

ACCELERATOR_DOMAIN_EXIST

domain 已经存在

400

NO_FIT_LINE

没有线路提供给加速区域

404

INVALID_REGION_NOT_FOUND

未找到指定区域

400

ANYCAST_NOT_ALLOW_WITH_NORMAL_REGION

Anycast 加速不允许和普通加速区域同时使用

400

CUSTOMER_ACCOUNT_NOT_AVAILABLE

客户账号不可用

400

TRAFFIC_PACKAGE_NOT_EXIST

全球加速包不存在

400

TRAFFIC_PACKAGE_EXPIRED

全球加速包已经过期，请续费

400

LINE_NOT_ENOUGH

账户线路资源已到限制数量

400

NO_ENOUGH_BANDWIDTH

用户没有足够的带宽

400

ONLY_ONE_CN2_SELECTED

只有一个 CN2 加速区域能被选择

500

ADD_RESOURCE_GROUP_ERROR

添加资源组失败

500

FOUND_AVAILABLE_REGION_ERROR

查询可用区域失败

404

INVALID_CERTIFICATE_NOT_FOUND

未找到指定的证书

400

IP_ACCELERATOR_NOT_SUPPORT_GZIP

IP 加速不支持配置 gzip

400

IP_ACCELERATOR_NOT_SUPPORT_WEBSOCKET

IP 加速不支持配置 websocket

400

IP_ACCELERATOR_NOT_SUPPORT_SNI_CHECK

IP 加速不支持配置 sni 检查

400

IP_ACCELERATOR_NOT_SUPPORT_HTTP_REDIRECT

IP 加速不支持配置 http redirect

400

HTTP_REDIRECT_MUST_CONFIGURED_REQUIRED_PORTS

http redirect 必须配置 80/http 和 443/https 加速端口

最后更新于3天前