1. 接口描述
接口请求域名: teo.tencentcloudapi.com 。
在版本管理模式下,用于创建指定配置组的新版本。版本管理功能内测中,当前仅白名单开放。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateConfigGroupVersion。 |
Version | 是 | String | 公共参数,本接口取值:2022-09-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
ZoneId | 是 | String | 站点 ID。 |
GroupId | 是 | String | 待新建版本的配置组 ID。 |
Content | 是 | String | 待导入的配置内容。要求采用 JSON 格式,按照 UTF-8 方式进行编码。配置文件内容可参考下方示例。 |
Description | 否 | String | 版本描述,可输入最大长度为 50 个字符,可以通过本字段填写该版本的使用场景等。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
VersionId | String | 版本 ID。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 为指定配置组创建新版本
在站点 ID 为 zone-m2kplohsdc4b 的站点下配置组 ID 为 cg-2p9unsmt54uw 的配置组下创建一个新版本。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateConfigGroupVersion
<公共请求参数>
{
"ZoneId": "zone-m2kplohsdc4b",
"GroupId": "cg-2p9unsmt54uw",
"Description": "created for openday",
"Content": "{\n \"FormatVersion\": \"1.0\",\n \"ZoneConfig\": {\n \"SmartRouting\": {\n \"Switch\": \"off\"\n },\n \"Cache\": {\n \"CustomTime\": {\n \"Switch\": \"on\",\n \"CacheTime\": 604800\n }\n },\n \"MaxAge\": {\n \"FollowOrigin\": \"on\",\n \"CacheTime\": 600\n },\n \"CacheKey\": {\n \"FullURLCache\": \"off\",\n \"QueryString\": {\n \"Switch\": \"on\",\n \"Action\": \"includeCustom\",\n \"Values\": [\n \"key1\",\n \"key2\"\n ]\n },\n \"IgnoreCase\": \"on\"\n },\n \"CachePrefresh\": {\n \"Switch\": \"off\",\n \"CacheTimePercent\": 90\n },\n \"OfflineCache\": {\n \"Switch\": \"on\"\n },\n \"Compression\": {\n \"Switch\": \"on\",\n \"Algorithms\": [\n \"brotli\",\n \"gzip\"\n ]\n },\n \"ImageOptimize\": {\n \"Switch\": \"off\"\n },\n \"ForceRedirectHTTPS\": {\n \"Switch\": \"on\",\n \"RedirectStatusCode\": 302\n },\n \"HSTS\": {\n \"Switch\": \"on\",\n \"IncludeSubDomains\": \"on\",\n \"Timeout\": 16070400,\n \"Preload\": \"on\"\n },\n \"TLSConfig\": {\n \"CipherSuite\": \"loose-v2023\",\n \"Version\": [\n \"TLSv1\",\n \"TLSv1.1\",\n \"TLSv1.2\",\n \"TLSv1.3\"\n ]\n },\n \"OCSPStapling\": {\n \"Switch\": \"off\"\n },\n \"HTTP2\": {\n \"Switch\": \"on\"\n },\n \"QUIC\": {\n \"Switch\": \"off\"\n },\n \"UpstreamHTTP2\": {\n \"Switch\": \"off\"\n },\n \"IPv6\": {\n \"Switch\": \"off\"\n },\n \"WebSocket\": {\n \"Switch\": \"on\",\n \"Timeout\": 30\n },\n \"PostMaxSize\": {\n \"Switch\": \"on\",\n \"MaxSize\": 838860800\n },\n \"ClientIPHeader\": {\n \"Switch\": \"off\",\n \"HeaderName\": \"\"\n },\n \"ClientIPCountry\": {\n \"Switch\": \"on\",\n \"HeaderName\": \"EO-Client-IPCountry\"\n },\n \"gRPC\": {\n \"Switch\": \"off\"\n },\n \"AccelerateMainland\": {\n \"Switch\": \"off\"\n },\n \"StandardDebug\": {\n \"Switch\": \"on\",\n \"AllowClientIPList\": [\n \"1.2.3.4\"\n ],\n \"Expires\": \"2023-11-04T04:46:28Z\"\n }\n },\n \"Rules\": [\n {\n \"RuleName\": \"未命名规则\",\n \"Branches\": [\n {\n \"Condition\": \"${http.request.host} matches '.*'\",\n \"Actions\": [\n {\n \"Name\": \"UpstreamURLRewrite\",\n \"Parameters\": {\n \"Type\": \"Path\",\n \"Action\": \"rmvPrefix\",\n \"Value\": \"/prefix\"\n }\n }\n ],\n \"SubRules\": [\n {\n \"Branches\": [\n {\n \"Condition\": \"${http.request.file_extension} in ['.jpg']\",\n \"Actions\": [\n {\n \"Name\": \"PostMaxSize\",\n \"Parameters\": {\n \"Switch\": \"on\",\n \"MaxSize\": 524288000\n }\n }\n ]\n }\n ]\n },\n {\n \"Branches\": [\n {\n \"Condition\": \"${http.request.file_extension} in ['.png']\",\n \"Actions\": [\n {\n \"Name\": \"PostMaxSize\",\n \"Parameters\": {\n \"Switch\": \"on\",\n \"MaxSize\": 209715200\n }\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n}"
}
输出示例
{
"Response": {
"VersionId": "ver-5ksglmhghsu3",
"RequestId": "5e0a2b4e-dw6d-4dsa-ac39-1706cbf8a703"
}
}
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 | 操作失败。 |
FailedOperation.ConfigConditionSyntaxError | 配置文件Condition表达式语法错误。 |
FailedOperation.ConfigConditionUnknownTarget | 无法识别的Condition匹配类型。 |
FailedOperation.ConfigConditionValueEmptyError | 配置文件Condition表达式值的项不能为空。 |
FailedOperation.ConfigFieldTypeError | 配置文件存在类型不匹配的字段。 |
FailedOperation.ConfigFormatError | 配置文件存在语法错误。 |
FailedOperation.ConfigMalformedContent | 配置文件内容格式错误,无法解析。 |
FailedOperation.ConfigParamValidateErrors | 配置文件参数校验错误。 |
FailedOperation.ConfigUnknownField | 配置文件无法识别的字段:存在拼写错误,或者该字段所在的层级出错。 |
FailedOperation.ConfigUnsupportedFormatVersion | 当前不支持该配置文件版本。 |
FailedOperation.MissingConfigChunk | content缺少必带的配置块。 |
FailedOperation.UnknownConfigGroupType | 未知的配置组类型。 |
InvalidParameter | 参数错误。 |
InvalidParameter.DuplicateRule | 重复规则。 |
InvalidParameter.ErrInvalidConditionValueBadValue | 非法条件-非法参数值-无效的参数值。 |
InvalidParameter.InvalidCacheKeyQueryStringAction | 无效的查询字符串。 |
InvalidParameter.InvalidConditions | 不合法的条件。 |
InvalidParameter.InvalidDynamicRoutine | 无效的智能加速。 |
InvalidParameter.InvalidIpv6Switch | 无效的Ipv6开关配置。 |
InvalidParameter.InvalidMaxAgeFollowOrigin | 无效的浏览器缓存。 |
InvalidParameter.InvalidStandardDebug | edgeone的debug配置无效。 |
InvalidParameter.PostMaxSizeLimitExceeded | 最大上传大小超出限制 |
InvalidParameter.StatusCodeCacheInvalidStatusCode | 状态码缓存的状态码无效。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded.RuleLimitExceeded | 规则数量达到限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.AccelerateMainlandIpv6Conflict | 中国大陆加速与IPv6冲突,不能同时配置。 |
OperationDenied.ConfigLocked | 配置已被锁定,请解除配置锁定之后在重试。 |
OperationDenied.ErrZoneIsAlreadyPaused | 站点处于停用状态,请开启后重试。 |
OperationDenied.NotInVersionControlWhiteList | 用户不在版本管理的白名单内。 |
OperationDenied.OwnershipVerificationNotPassed | 归属权校验未通过,请先完成站点归属权校验。 |
OperationDenied.VersionControlLocked | 当前处于版本管理模式下,该操作不允许。 |
OperationDenied.WorkModeNotInVersionControl | 站点工作模式不属于版本管理模式。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable.FunctionNotFound | 函数不存在或不属于该账号。 |