边缘安全加速平台 EO
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 边缘安全加速平台 EO > API 文档 > 加速域名管理相关接口 > 批量修改加速域名状态

批量修改加速域名状态

最近更新时间：2024-04-19 15:23:54

我的收藏

本页目录：

1. 接口描述

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

批量修改加速域名状态

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：ModifyAccelerationDomainStatuses。
Version 是 String 公共参数，本接口取值：2022-09-01。
Region 否 String 公共参数，此参数为可选参数。
ZoneId 是 String 加速域名所属站点ID。
DomainNames.N 是 Array of String 要执行状态变更的加速域名列表。
Status 是 String 加速域名状态，取值有：
  • online：启用；
  • offline：停用。
    		•
    Force 否 Boolean 是否强制停用。当域名存在关联资源（如马甲域名、流量调度功能）时，是否强制停用该域名，取值有：
  • true：停用该域名及所有关联资源；
  • false：当该加速域名存在关联资源时，不允许停用。
    • 不填写，默认值为：false。

    3. 输出参数

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

    4. 示例

    示例1 批量修改加速域名状态

    停用指定名称的加速域名。

    输入示例

    POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAccelerationDomainStatuses
<公共请求参数>

{
    "DomainNames": [
        "example.com"
    ],
    "ZoneId": "zone-225qgrnvbi9w",
    "Status": "offline",
    "Force": "false"
}

    输出示例

    {
    "Response": {
        "RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707"
    }
}

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation 操作失败。
    InternalError.SystemError 内部错误-系统错误。
    InvalidParameter.ErrInvalidActionParamValue 非法操作-非法参数-无效参数值。
    InvalidParameter.InvalidErrorPage 无效的自定义错误页面。
    InvalidParameter.InvalidServerName 无效的回源Host。
    InvalidParameter.ZoneIsGrayPublishing 站点升级中，暂不支持进行变更操作，请稍后再试。
    InvalidParameterValue.DomainNotMatchZone 入参中的域名与站点参数不匹配，请更正后重试。
    OperationDenied 操作被拒绝。
    OperationDenied.ConfigLocked 配置已被锁定，请解除配置锁定之后在重试。
    OperationDenied.ErrZoneIsAlreadyPaused 站点处于停用状态，请开启后重试。
    OperationDenied.ResourceLockedTemporary 当前有互相排斥的请求操作并行发起，请稍后重试。
    OperationDenied.VersionControlIsGraying 存在使用中的测试版本，请将测试版本发布现网或者回滚测试版本再重试。
    OperationDenied.VersionControlLocked 当前处于版本管理模式下，该操作不允许。
    ResourceInUse 资源被占用。
    ResourceUnavailable.DomainNotFound 请求的加速域名不存在，请更正后重试。
    UnauthorizedOperation.CamUnauthorized Cam 未授权。
    UnauthorizedOperation.Unknown 后端服务器发生未知错误。
    中国站