有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

接口请求域名: teo.tencentcloudapi.com 。

EdgeOne 为您提供 CNAME、NS 和无域名接入三种接入方式,您需要先通过此接口完成站点创建。CNAME 和 NS 接入站点的场景可参考 从零开始快速接入 EdgeOne; 无域名接入的场景可参考 快速启用四层代理服务

建议您在账号下已存在套餐时调用本接口创建站点,请在入参时传入 PlanId ,直接将站点绑定至该套餐;不传入 PlanId 时,创建出来的站点会处于未激活状态,无法正常服务,您需要通过 BindZoneToPlan 完成套餐绑定之后,站点才可正常提供服务 。若您当前没有可绑定的套餐时,请前往控制台购买套餐完成站点创建。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateZone。
Version String 公共参数,本接口取值:2022-09-01。
Region String 公共参数,详见产品支持的 地域列表
Type String 站点接入类型。该参数取值如下,不填写时默认为 partial:
  • partial:CNAME 接入;
  • full:NS 接入;
  • noDomainAccess:无域名接入。
  • ZoneName String 站点名称。CNAME/NS 接入的时,请传入二级域名(example.com)作为站点名称;无域名接入时,该值请保留为空。
    Area String Type 取值为 partial/full 时,七层域名的加速区域。以下为该参数取值,不填写时该值默认为 overseas。Type 取值为 noDomainAccess 时该值请保留为空:
  • global: 全球可用区;
  • mainland: 中国大陆可用区;
  • overseas: 全球可用区(不含中国大陆)。
  • PlanId String 待绑定的目标套餐 ID。当您账号下已存在套餐时,可以填写此参数,直接将站点绑定至该套餐。若您当前没有可绑定的套餐时,请前往控制台购买套餐完成站点创建。
    AliasZoneName String 同名站点标识。限制输入数字、英文、- 和 _ 组合,长度 20 个字符以内。详情参考 同名站点标识,无此使用场景时,该字段保留为空即可。
    Tags.N Array of Tag 标签。该参数用于对站点进行分权限管控、分账。需要先前往 标签控制台 创建对应的标签才可以在此处传入对应的标签键和标签值。

    3. 输出参数

    参数名称 类型 描述
    ZoneId String 站点 ID。
    OwnershipVerification OwnershipVerification 站点归属权验证信息。站点完成创建后,您还需要完成归属权校验,站点才能正常服务。

    Type = partial 时,您需要参考 站点/域名归属权验证 前往您的域名解析服务商添加 TXT 记录或者前往根域名服务器添加文件,再调用接口 VerifyOwnership 完成验证;

    Type = full 时,您需要参考 修改 DNS 服务器 切换 DNS 服务器即可,可通过接口 VerifyOwnership 查询 DNS 是否切换成功;

    Type = noDomainAccess 时,该值为空,不需要进行任何操作。
    注意:此字段可能返回 null,表示取不到有效值。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 创建 NS 接入类型的站点

    创建NS接入模式站点 example.com,服务区域为中国大陆可用区,绑定套餐 edgeone-37q0w6qali10。接口将返回 DNS 服务器信息,您需要前往域名注册商处修改,可参考 修改 DNS 服务器

    输入示例

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateZone
    <公共请求参数>
    
    {
        "Type": "full",
        "ZoneName": "example.com",
        "Area": "mainland",
        "PlanId": "edgeone-37q0w6qali10"
    }

    输出示例

    {
        "Response": {
            "ZoneId": "zone-27q0p0bali16",
            "OwnershipVerification": {
                "DnsVerification": null,
                "FileVerification": null,
                "NsVerification": {
                    "NameServers": [
                        "ns1.teodns.com",
                        "ns2.teodns.com"
                    ]
                }
            },
            "RequestId": "9kl50bew-89ga-44f4-91ce-78125d53vd2a"
        }
    }

    示例2 创建无域名接入模式站点

    创建无域名接入模式站点,绑定套餐 edgeone-37q0w6qali10。接口将返回站点 ID。有关无域名接入模式的相关信息,可参考 快速启用四层代理服务

    输入示例

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateZone
    <公共请求参数>
    
    {
        "Type": "noDomainAccess",
        "PlanId": "edgeone-37q0w6qali10"
    }

    输出示例

    {
        "Response": {
            "ZoneId": "zone-27q0p0bali16",
            "RequestId": "9kl50bew-89ga-44f4-91ce-78125d53vd2a"
        }
    }

    示例3 创建 CNAME 接入类型的站点

    创建 CNAME 接入类型的站点 example.com,服务区域为全球可用区,绑定套餐 edgeone-37q0w6qali10。接口将返回站点 ID 和站点归属权验证信息。您可以对站点进行归属权验证,可参考 站点/域名归属权验证

    输入示例

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateZone
    <公共请求参数>
    
    {
        "Type": "partial",
        "ZoneName": "example.com",
        "Area": "global",
        "PlanId": "edgeone-37q0w6qali10"
    }

    输出示例

    {
        "Response": {
            "ZoneId": "zone-27q0p0bali16",
            "OwnershipVerification": {
                "DnsVerification": {
                    "Subdomain": "edgeonereclaim",
                    "RecordType": "TXT",
                    "RecordValue": "reclaim-a24aba2420cf4ce8b7bff7c8be6d337f"
                },
                "FileVerification": {
                    "Path": "/.well-known/teo-verification/vd4ewuqa9n.txt",
                    "Content": "88v24mnnljwbhaohrpfx80f63duhdnjx"
                },
                "NsVerification": null
            },
            "RequestId": "9kl50bew-89ga-44f4-91ce-78125d53vd2a"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    DryRunOperation DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。
    InvalidParameter.InvalidOriginIp 不支持填写内网IP/回环地址作为源站地址
    InvalidParameter.LengthExceedsLimit 参数长度超过限制。
    InvalidParameter.PlanNotFound 套餐不存在。
    InvalidParameter.ZoneHasBeenBound 站点已被绑定。
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.AccessBlacklist 该站点域名已被禁用。
    InvalidParameterValue.InvalidTagValue 标签值存在不合法字符。
    InvalidParameterValue.TopLevelDomainNotSupport 暂不支持当前域名后缀接入,如您需要使用请联系我们。
    InvalidParameterValue.ZoneNameInvalid 站点名称格式不正确,请输入正确的域名格式。
    InvalidParameterValue.ZoneNameNotSupportPunyCode 暂不支持 punycode 接入。
    InvalidParameterValue.ZoneNameNotSupportSubDomain 站点不支持以子域名接入,请以二级域名作为站点接入。
    InvalidParameterValue.ZoneSameAsName 该同名站点标识已被占用,请重新输入。
    LimitExceeded.ZoneBindPlan 套餐可绑定的站点数量超过配额。
    OperationDenied 操作被拒绝。
    OperationDenied.DomainIsBlocked 域名被封禁,暂时无法操作。
    OperationDenied.RecordIsForbidden DNS 记录不允许添加。
    ResourceInUse 资源被占用。
    ResourceInUse.AliasDomain 资源被本账号别称域名占用。
    ResourceInUse.Cname 资源被本账号Cname接入占用。
    ResourceInUse.Dns Dns资源被占用。
    ResourceInUse.GenericHost 资源已被泛域名占用。
    ResourceInUse.Host 资源被本账号的子域名占用。
    ResourceInUse.NS 资源被本账号NS接入占用。
    ResourceInUse.Others 资源被其他用户接入。
    ResourceInUse.OthersAliasDomain 资源被其他账号别称域名占用。
    ResourceInUse.OthersCname 资源被其他账号Cname接入占用。
    ResourceInUse.OthersHost 资源被其他账号的子域名占用。
    ResourceInUse.OthersNS 资源被其他账号NS接入占用。
    ResourceInUse.SelfAndOthersCname 资源被本账号和其他账号同时Cname接入占用。
    ResourceNotFound 资源不存在。
    UnauthorizedOperation.CamUnauthorized Cam 未授权。
    UnauthorizedOperation.NoPermission 子账户没有操作权限,请添加权限后继续操作。
    UnauthorizedOperation.Unknown 后端服务器发生未知错误。