1. 接口描述
接口请求域名: teo.tencentcloudapi.com 。
本接口用于修改站点下各配置模块的工作模式。站点各配置模块可按照配置组维度开启「版本管理模式」或「即时生效模式」,详情请参考 版本管理。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ModifyZoneWorkMode。 |
| Version | 是 | String | 公共参数,本接口取值:2022-09-01。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| ZoneId | 是 | String | 站点 ID。 |
| WorkModeInfos.N | 否 | Array of ConfigGroupWorkModeInfo | 版本管理配置组工作模式。站点各配置模块可按照配置组维度开启「版本管理模式」或「即时生效模式」,详情请参考 版本管理。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改站点配置组的工作模式
修改站点七层加速配置组、边缘函数配置组工作模式为版本管理。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyZoneWorkMode
<公共请求参数>
{
"ZoneId": "zone-27********v1",
"WorkModeInfos": [
{
"ConfigGroupType": "l7_acceleration",
"WorkMode": "version_control"
},
{
"ConfigGroupType": "edge_functions",
"WorkMode": "version_control"
}
]
}
输出示例
{
"Response": {
"RequestId": "a06f52e7-2aab-4510-b2c2-1065bfb4414c"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.WorkModeIsSame | 站点工作模式未发生变更 |
| InvalidParameter.ZoneNotFound | 站点不存在。 |
| InvalidParameterValue.OwnershipVerificationNotPassed | 归属权校验未通过,请先完成站点归属权校验。 |
| OperationDenied.AliasDomainNotSupport | 该操作不支持别称域名。 |
| OperationDenied.ConfigLocked | 配置已被锁定,请解除配置锁定之后在重试。 |
| OperationDenied.DomainStatusUnstable | 站点内有域名处于非稳态,稳态包括:“在线” 和 “离线” 两个状态。 |
| OperationDenied.ErrZoneIsAlreadyPaused | 站点处于停用状态,请开启后重试。 |
| OperationDenied.NotInVersionControlWhiteList | 用户不在版本管理的白名单内。 |
| OperationDenied.OwnershipVerificationNotPassed | 归属权校验未通过,请先完成站点归属权校验。 |
| OperationDenied.PlanTypeIsWrong | 站点的配置的企业套餐不支持版本控制功能 |
| OperationDenied.VersionControlLocked | 当前处于版本管理模式下,该操作不允许。 |
| OperationDenied.VersionControlNeedNSSwitched | NS模式的站点,开关版本管理之前请先切换 NS。 |
| ResourceNotFound.ZoneNotFound | 站点不存在。 |
| ResourceUnavailable.ZoneNotFound | 站点不存在或不属于该账号。 |