1. 接口描述
接口请求域名: teo.tencentcloudapi.com 。
在版本管理模式下,用于版本发布,可通过 EnvId 将版本发布至测试环境或生产环境。版本管理功能内测中,当前仅白名单开放。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DeployConfigGroupVersion。 |
Version | 是 | String | 公共参数,本接口取值:2022-09-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
ZoneId | 是 | String | 站点 ID。 |
EnvId | 是 | String | 环境 ID。请填写版本需要发布到的环境 ID。 |
ConfigGroupVersionInfos.N | 是 | Array of ConfigGroupVersionInfo | 需要发布的版本信息。可以同时变更多个不同配置组的版本,每个配置组一次仅支持变更一个版本。 |
Description | 是 | String | 变更说明。用于描述此次变更的内容、原因,最大支持 100 个字符。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RecordId | String | 发布记录 ID。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建版本部署任务
将站点 ID 为 zone-32qwgrnvbisw 下版本 ID 为 ver-2ogs1as803hm 的版本发布到环境 ID 为 env-28jw51ksm9bw 的环境中。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDeployVersionTask
<公共请求参数>
{
"ZoneId": "zone-32qwgrnvbisw",
"EnvId": "env-28jw51ksm9bw",
"ConfigGroupVersionInfos": [
{
"VersionId": "ver-2ogs1as803hm"
}
],
"Description": "Add IPv6 and AccelerationMainland configuration"
}
输出示例
{
"Response": {
"RequestId": "5e0a2b4e-df6d-4d2a-as19-1706cbf8a902",
"RecordId": "dr-2nvadq3sa41u"
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.ConfigConditionSyntaxError | 配置文件Condition表达式语法错误。 |
FailedOperation.ConfigConditionUnknownTarget | 无法识别的Condition匹配类型。 |
FailedOperation.ConfigConditionValueEmptyError | 配置文件Condition表达式值的项不能为空。 |
FailedOperation.ConfigFieldTypeError | 配置文件存在类型不匹配的字段。 |
FailedOperation.ConfigFormatError | 配置文件存在语法错误。 |
FailedOperation.ConfigMalformedContent | 配置文件内容格式错误,无法解析。 |
FailedOperation.ConfigParamValidateErrors | 配置文件参数校验错误。 |
FailedOperation.ConfigUnknownField | 配置文件无法识别的字段:存在拼写错误,或者该字段所在的层级出错。 |
FailedOperation.ConfigUnsupportedFormatVersion | 当前不支持该配置文件版本。 |
InvalidParameter.ZoneNotFound | 站点不存在。 |
OperationDenied.ConfigLocked | 配置已被锁定,请解除配置锁定之后在重试。 |
OperationDenied.DomainStatusUnstable | 站点内有域名处于非稳态,稳态包括:“在线” 和 “离线” 两个状态。 |
OperationDenied.EnvNotReady | 站点环境未准备好。 |
OperationDenied.NotInVersionControlWhiteList | 用户不在版本管理的白名单内。 |
OperationDenied.VersionControlLocked | 当前处于版本管理模式下,该操作不允许。 |
OperationDenied.WorkModeNotInVersionControl | 站点工作模式不属于版本管理模式。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.VersionNotFound | 配置组版本不存在,请检查后重试。 |