1. 接口描述
接口请求域名: teo.tencentcloudapi.com 。
本接口用于管理站点级自定义变量,支持创建、修改和删除变量定义及变量运算。提交的列表将覆盖对应的现有配置;如需清空配置,请传入空列表。未传入的配置项保持不变。变量定义和变量运算的默认值均为空。
规则级自定义变量相关操作,请调用 CreateL7AccRules 或 ModifyL7AccRule 接口。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ModifyZoneCustomVariables。 |
| Version | 是 | String | 公共参数,本接口取值:2022-09-01。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| ZoneId | 是 | String | 站点 ID。 |
| CustomVariables.N | 否 | Array of CustomVariable | 站点级自定义变量列表。CustomVariable.Name 需要使用 user.zone. 作为前缀。变量按照数组顺序依次初始化,InitialValue 仅支持引用位于当前变量之前的变量,不支持引用当前变量自身或位于当前变量之后的变量。 |
| CustomVariableOperations.N | 否 | Array of CustomVariableOperation | 站点级自定义变量运算规则。运算中支持引用已定义的站点级自定义变量。此列表当前只支持填写一项规则,多填无效。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 配置站点级自定义变量
创建站点级自定义变量 user.zone.testa,并配置对应的变量运算规则。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyZoneCustomVariables
<公共请求参数>
{
"ZoneId": "zone-3n1uzjzxffby",
"CustomVariables": [
{
"Name": "user.zone.testa",
"InitialValue": "${http.request.headers[\"key\"]}",
"Description": ""
}
],
"CustomVariableOperations": [
{
"Branches": [
{
"Condition": "${eo.variable['user.zone.testa']} in ['aBc']",
"Actions": [
{
"Name": "Set",
"SetParameters": {
"Name": "user.zone.testa",
"Value": "${http.request.host}"
}
}
]
}
]
}
]
}
输出示例
{
"Response": {
"RequestId": "a33d2e57-25db-43de-add9-cf43748af91c"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.CertificateNotFound | 边缘HTTPS证书不存在。 |
| InternalError.ConfigLocked | 配置已被锁定,请解除配置锁定之后在重试。 |
| InternalError.RouteError | 后端服务路由地址错误。 |
| InternalError.SystemError | 内部错误-系统错误。 |
| InternalError.UnknowError | 未知错误。 |
| InvalidParameter.ActionInProgress | 操作频繁,请稍后重试。 |
| InvalidParameter.CacheKeyQueryStringRequiresFullUrlCacheOff | 无效的查询字符串。 |
| InvalidParameter.CacheKeyQueryStringTooManyValue | 查询字符串规则超过了限制。 |
| InvalidParameter.CertSystemError | 内部错误。 |
| InvalidParameter.ClientIpCountryConflictsWithIpv6 | IPv6 访问与客户端 IP 地理位置功能冲突。 |
| InvalidParameter.GrpcRequireHttp2 | 开启 Grpc 协议支持需要同时开启 HTTP/2 协议支持。 |
| InvalidParameter.InvalidAwsPrivateAccess | 无效的第三方对象存储。 |
| InvalidParameter.InvalidCacheConfigFollowOrigin | 无效的节点缓存,遵循源站行为。 |
| InvalidParameter.InvalidCacheKeyQueryStringValue | 无效的查询字符串。 |
| InvalidParameter.InvalidCacheOnlyOnSwitch | 无效的节点缓存。 |
| InvalidParameter.InvalidCacheTime | 无效的节点缓存时间。 |
| InvalidParameter.InvalidClientIpCountryHeaderName | 无效的客户端IP地理位置配置,HeaderName由1-100个字母或数字组成的,不能以"-"开头或结尾。 |
| InvalidParameter.InvalidClientIpHeaderName | 无效的客户端IP请求头。 |
| InvalidParameter.InvalidDynamicRoutine | 无效的智能加速。 |
| InvalidParameter.InvalidDynamicRoutineBilling | 套餐包不支持智能加速配置。 |
| InvalidParameter.InvalidForceRedirectType | 无效的强制HTTPS跳转。 |
| InvalidParameter.InvalidHttps | 无效的HTTPS。 |
| InvalidParameter.InvalidHttpsCertInfo | 无效的边缘HTTPS证书配置,证书内容无效。 |
| InvalidParameter.InvalidHttpsCipherSuiteAndTlsVersion | 加密套件与TLS版本不匹配。 |
| InvalidParameter.InvalidHttpsHstsMaxAge | 无效的HTTPS HSTS。 |
| InvalidParameter.InvalidHttpsTlsVersion | 无效的HTTPS TLS版本。 |
| InvalidParameter.InvalidIpv6Switch | 无效的Ipv6开关配置。 |
| InvalidParameter.InvalidMaxAgeTime | 无效的浏览器缓存。 |
| InvalidParameter.InvalidOrigin | 无效的源站。 |
| InvalidParameter.InvalidOriginType | 源站类型错误。 |
| InvalidParameter.InvalidParameter | 参数错误。 |
| InvalidParameter.InvalidPostMaxSizeBilling | 套餐包不支持最大上传大小。 |
| InvalidParameter.InvalidPostSizeValue | 无效的最大上传大小。 |
| InvalidParameter.InvalidRangeOriginPull | 无效的分片回源。 |
| InvalidParameter.InvalidRequestHeaderName | 无效的请求头header。 |
| InvalidParameter.InvalidResourceIdBilling | 无套餐包。 |
| InvalidParameter.InvalidStandardDebugClientIp | 无效的客户端ip或ip段。 |
| InvalidParameter.InvalidStandardDebugEmptyList | AllowClientIPList 参数必填,支持 IPv4 及 IPv6 网段。0.0.0.0/0 表示允许所有 IPv4 客户端进行调试,::/0 表示允许所有 IPv6 客户端进行调试。 |
| InvalidParameter.InvalidStandardDebugExpireTimeLimit | 有效期超过限制。 |
| InvalidParameter.InvalidWebSocketTimeout | 无效的WebSocket。 |
| InvalidParameter.MultiplyLayerNotSupportSmartRouting | 不支持智能路由 |
| InvalidParameter.OCDirectOriginRequiresSmartRouting | 域名处于直接回源架构,需要保持智能加速功能的开启。 |
| InvalidParameter.PostMaxSizeLimitExceeded | 最大上传大小超出限制 |
| InvalidParameter.SettingInvalidParam | 配置项参数错误。 |
| InvalidParameter.ShieldNotSupportZoneCachePrefresh | 当前站点不支持同时开启EdgeOne Shield和缓存预刷新。 |
| InvalidParameter.ShieldNotSupportZoneSmartRouting | 当前站点不支持同时开启EdgeOne Shield和智能加速。 |
| InvalidParameter.ZoneIsGrayPublishing | 站点升级中,暂不支持进行变更操作,请稍后再试。 |
| InvalidParameter.ZoneNotFound | 站点不存在。 |
| InvalidParameterValue.FormatMismatch | 格式不匹配。 |
| InvalidParameterValue.GeneralMismatch | 配置参数格式不匹配。 |
| InvalidParameterValue.IncludeInvalidValue | 包含无效的值。 |
| InvalidParameterValue.MissingNecessaryParam | 缺少必要配置参数。 |
| InvalidParameterValue.NotInEnumeration | 值不在要求的集合内。 |
| InvalidParameterValue.NotWithinRange | 值不在指定范围。 |
| InvalidParameterValue.RegExMismatch | 不符合指定的正则表达式。 |
| InvalidParameterValue.UnrecognizableValue | 配置项错误。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.AccelerateMainlandDisable | 功能内测中,请联系商务开启「中国大陆网络优化(国际加速)」功能。 |
| OperationDenied.AccelerateMainlandIpv6Conflict | 中国大陆加速与IPv6冲突,不能同时配置。 |
| OperationDenied.AccelerateMainlandMultiplyLayerConflict | 当前站点下存在域名功能与中国大陆网络优化冲突,不能同时配置。 |
| OperationDenied.ConfigLocked | 配置已被锁定,请解除配置锁定之后在重试。 |
| OperationDenied.DisableZoneNotCompleted | 站点停用未完毕,请稍后再试。 |
| OperationDenied.ErrZoneIsAlreadyPaused | 站点处于停用状态,请开启后重试。 |
| OperationDenied.NotAllowCloseAccelerateMainlandWhenDomainBoundExclusiveIP | 当前站点下存在域名关联了专属加速IP,如需关闭「中国大陆网络优化」请先解绑专属IP后重试。 |
| OperationDenied.SharedCNAMEUnsupportedAccelerateMainland | 绑定在共享 CNAME 中的域名不允许变更 中国大陆网络优化(国际加速)访问,如果您需要单独变更,请先将域名从共享 CNAME 中解绑。 |
| OperationDenied.SharedCNAMEUnsupportedIPv6 | 绑定在共享 CNAME 中的域名不允许变更 IPv6 访问,如果您需要单独变更,请先将域名从共享 CNAME 中解绑。 |
| ResourceInUse | 资源被占用。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.PostMaxSizeQuotaNotFound | 最大上传大小额度未配置 |
| ResourceUnavailable.CertNotFound | 证书不存在或未授权。 |
| UnauthorizedOperation.CamUnauthorized | Cam 未授权。 |
| UnauthorizedOperation.NoPermission | 子账户没有操作权限,请添加权限后继续操作。 |