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

1. 接口描述

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

修改站点信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyZone。
Version String 公共参数,本接口取值:2022-09-01。
Region String 公共参数,详见产品支持的 地域列表
ZoneId String 站点 ID。
Type String 站点接入方式,取值有:
  • full:NS 接入;
  • partial:CNAME 接入,如果站点当前是无域名接入,仅支持切换到CNAME接入。
  • 不填写保持原有配置。
    VanityNameServers VanityNameServers 自定义站点信息,以替代系统默认分配的名称服务器。不填写保持原有配置。当站点是无域名接入方式时不允许传此参数。
    AliasZoneName String 站点别名。数字、英文、-和_组合,限制20个字符。
    Area String 站点接入地域,取值有:
  • global:全球;
  • mainland:中国大陆;
  • overseas:境外区域。
  • 当站点是无域名接入方式时,不允许传此参数。
    ZoneName String 站点名称。仅当站点由无域名接入方式切换到CNAME接入方式的场景下有效。

    3. 输出参数

    参数名称 类型 描述
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 修改站点

    修改站点。

    输入示例

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ModifyZone
    <公共请求参数>
    
    {
        "VanityNameServers": {
            "Switch": "on",
            "Servers": [
                "ns1.example.com",
                "ns2.example.com"
            ]
        },
        "Type": "full",
        "ZoneId": "zone-27q0p0bali16",
        "AliasZoneName": "zone-example"
    }

    输出示例

    {
        "Response": {
            "RequestId": "4ac50b24-7dc2-47f4-92ce-9fd25d53gt2f"
        }
    }

    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 参数。
    FailedOperation 操作失败。
    InternalError.ConfigLocked 配置已被锁定,请解除配置锁定之后在重试。
    InvalidParameter.InvalidOriginIp 不支持填写内网IP/回环地址作为源站地址
    InvalidParameter.InvalidWebSocketTimeout 无效的WebSocket。
    InvalidParameter.LengthExceedsLimit 参数长度超过限制。
    InvalidParameter.ZoneNameIsRequired 无域名接入站点切换到CNAME接入类型时站点名称必传。
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.ZoneSameAsName 该同名站点标识已被占用,请重新输入。
    OperationDenied 操作被拒绝。
    OperationDenied.DisableZoneNotCompleted 站点停用未完毕,请稍后再试。
    OperationDenied.DomainInShareCnameGroup 有域名在共享cname组内,不可切换接入类型。
    OperationDenied.DomainNumberIsNotZero 站点下有域名时不允许修改服务区域。
    OperationDenied.ErrZoneIsAlreadyPaused 站点处于停用状态,请开启后重试。
    OperationDenied.MultipleCnameZone 已存在多个Cname接入站点,不允许切换至NS。
    OperationDenied.NSNotAllowTrafficStrategy NS接入模式不支持域名流量调度功能。
    OperationDenied.NoDomainAccessZoneOnlyAllowModifiedToCNAME 无域名接入站点仅可以切换到CNAME接入类型。
    OperationDenied.NoDomainAccessZoneOnlySupportModifyType 无域名接入站点不支持除切换为CNAME接入类型以外的任何修改动作。
    OperationDenied.PlanNotSupportModifyZoneArea 套餐不支持变更站点的服务区域。
    OperationDenied.ResourceLockedTemporary 当前有互相排斥的请求操作并行发起,请稍后重试。
    ResourceInUse.Cname 资源被本账号Cname接入占用。
    ResourceInUse.Dns Dns资源被占用。
    ResourceInUse.GenericHost 资源已被泛域名占用。
    ResourceInUse.NS 资源被本账号NS接入占用。
    ResourceInUse.Others 资源被其他用户接入。
    ResourceInUse.OthersAliasDomain 资源被其他账号别称域名占用。
    ResourceInUse.OthersCname 资源被其他账号Cname接入占用。
    ResourceInUse.OthersNS 资源被其他账号NS接入占用。
    ResourceInUse.SelfAndOthersCname 资源被本账号和其他账号同时Cname接入占用。
    ResourceNotFound 资源不存在。
    ResourceUnavailable 资源不可用。
    UnauthorizedOperation.CamUnauthorized Cam 未授权。
    UnauthorizedOperation.NoPermission 子账户没有操作权限,请添加权限后继续操作。