当前内容仅提供英语版本,中文版我们将尽快补充,感谢您的理解。

ModifyZoneCustomVariables

1. API Description

Domain name for API request: teo.intl.tencentcloudapi.com.

This API is used to manage site-level custom variables, supporting the creation, modification, and deletion of variable definitions and variable operations. The submitted list will override the corresponding existing configuration. To clear the configuration, pass in an empty list. Configuration items not passed in remain unchanged. The default values for variable definitions and variable operations are both empty.

For operations related to rule-level custom variables, call the CreateL7AccRules or ModifyL7AccRule API.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: ModifyZoneCustomVariables.
VersionYesStringCommon Params. The value used for this API: 2022-09-01.
RegionNoStringCommon Params. This parameter is not required.
ZoneIdYesString

Site ID.

CustomVariables.NNoArray of CustomVariable

List of site-level custom variables. CustomVariable.Name must use user.zone. as a prefix. Variables are initialized sequentially in array order. InitialValue can only reference variables before the current variable. It does not support referencing the current variable itself or variables after it.

CustomVariableOperations.NNoArray of CustomVariableOperation

Site-level custom variable calculation rules. The calculation supports references to defined site-level custom variables. This list currently only supports filling in one rule; additional entries are invalid.

3. Output Parameters

Parameter NameTypeDescription
RequestIdStringThe unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Configure Site-Level Custom Variables

Create a site-level custom variable user.zone.testa and configure its calculation rules.

Input Example

POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyZoneCustomVariables
<Common request parameters>

{
    "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}"
                            }
                        }
                    ]
                }
            ]
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "a33d2e57-25db-43de-add9-cf43748af91c"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error CodeDescription
FailedOperationOperation failed.
FailedOperation.CertificateNotFoundThe edge HTTPS certificate does not exist.
InternalError.ConfigLockedThe configuration is locked. Please unlock and try again.
InternalError.RouteErrorThe backend routing address is incorrect.
InternalError.SystemErrorInternal system error.
InternalError.UnknowErrorUnknown error.
InvalidParameter.ActionInProgressToo many attempts. Please try again later.
InvalidParameter.CacheKeyQueryStringRequiresFullUrlCacheOffInvalid query string.
InvalidParameter.CacheKeyQueryStringTooManyValueThe query string has too many values.
InvalidParameter.CertSystemErrorInternal error.
InvalidParameter.ClientIpCountryConflictsWithIpv6IPv6 access conflicts with client IP geographical location.
InvalidParameter.GrpcRequireHttp2To enable gRPC support, HTTP/2 support must be enabled as well.
InvalidParameter.InvalidAwsPrivateAccessInvalid third-party object storage.
InvalidParameter.InvalidCacheConfigFollowOriginInvalid node cache. The origin behavior is followed.
InvalidParameter.InvalidCacheKeyQueryStringValueInvalid query string.
InvalidParameter.InvalidCacheOnlyOnSwitchInvalid node cache.
InvalidParameter.InvalidCacheTimeInvalid node cache validity.
InvalidParameter.InvalidClientIpCountryHeaderNameInvalid client IP location configuration. HeaderName consists of 1-100 alphanumeric characters and cannot start or end with hyphens (-).
InvalidParameter.InvalidClientIpHeaderNameInvalid client IP request header.
InvalidParameter.InvalidDynamicRoutineInvalid smart acceleration.
InvalidParameter.InvalidDynamicRoutineBillingThe package does not support Smart Acceleration.
InvalidParameter.InvalidForceRedirectTypeInvalid enforced HTTPS redirect.
InvalidParameter.InvalidHttpsInvalid parameter "https".
InvalidParameter.InvalidHttpsCertInfoInvalid edge HTTPS certificate configuration. The certificate content is invalid.
InvalidParameter.InvalidHttpsCipherSuiteAndTlsVersionThe cipher suite does not match the TLS version.
InvalidParameter.InvalidHttpsHstsMaxAgeInvalid HTTPS HSTS.
InvalidParameter.InvalidHttpsTlsVersionInvalid HTTPS TLS version.
InvalidParameter.InvalidIpv6SwitchInvalid IPv6 settings.
InvalidParameter.InvalidMaxAgeTimeInvalid browser cache.
InvalidParameter.InvalidOriginInvalid origin server.
InvalidParameter.InvalidOriginTypeIncorrect origin server type.
InvalidParameter.InvalidParameterInvalid parameter.
InvalidParameter.InvalidPostMaxSizeBillingThe speciThe plan does not support limiting the max upload size.
InvalidParameter.InvalidPostSizeValueInvalid POST request size.
InvalidParameter.InvalidRangeOriginPullInvalid Range GETs.
InvalidParameter.InvalidRequestHeaderNameInvalid request header.
InvalidParameter.InvalidResourceIdBillingYou have not purchased a plan yet.
InvalidParameter.InvalidStandardDebugClientIpInvalid client IP or CIDR block.
InvalidParameter.InvalidStandardDebugEmptyListThe AllowClientIPList parameter is mandatory. The IPv4 and IPv6 network segments are supported. 0.0.0.0/0 indicates that all IPv4 clients can be debugged, and ::/0 indicates that all IPv6 clients can be debugged.
InvalidParameter.InvalidStandardDebugExpireTimeLimitThe expiration time is exceeded.
InvalidParameter.InvalidWebSocketTimeoutInvalid WebSocket.
InvalidParameter.MultiplyLayerNotSupportSmartRoutingSmart routing is not supported.
InvalidParameter.OCDirectOriginRequiresSmartRoutingThe domain name is configured to forward requests to the origin directly. iSmart Acceleration must be enabled.
InvalidParameter.PostMaxSizeLimitExceededMaximum upload size exceeded.
InvalidParameter.SettingInvalidParamConfiguration parameter error.
InvalidParameter.ShieldNotSupportZoneCachePrefreshThe current site does not support enabling EdgeOne Shield and cache pre-refresh simultaneously.
InvalidParameter.ShieldNotSupportZoneSmartRoutingThe current site does not support enabling EdgeOne Shield and smart acceleration simultaneously.
InvalidParameter.ZoneIsGrayPublishingThe site is being upgraded. Changing is not supported. Please try again later.
InvalidParameter.ZoneNotFoundThe site does not exist.
InvalidParameterValue.FormatMismatchFormat mismatch.
InvalidParameterValue.GeneralMismatchConfiguration parameter format mismatch.
InvalidParameterValue.IncludeInvalidValueContains invalid value.
InvalidParameterValue.MissingNecessaryParamMissing required configuration parameters.
InvalidParameterValue.NotInEnumerationThe value is not within the required collection.
InvalidParameterValue.NotWithinRangeThe value is not within the specified range.
InvalidParameterValue.RegExMismatchDoes not match the specified regular expression.
InvalidParameterValue.UnrecognizableValueConfiguration item error.
OperationDeniedOperation denied.
OperationDenied.AccelerateMainlandDisableCross-MLC-border acceleration is in beta. To join the beta, submit a ticket.
OperationDenied.AccelerateMainlandIpv6ConflictCross-MLC-border acceleration and IPv6 cannot be configured at the same time.
OperationDenied.AccelerateMainlandMultiplyLayerConflictThe existing domain feature under the current site conflicts with the Chinese mainland network optimization, and cannot be configured at the same time.
OperationDenied.ConfigLockedThe configuration is locked. Please unlock and try again.
OperationDenied.DisableZoneNotCompletedThe EdgeOne service of the site is being disabled. Please try again later.
OperationDenied.ErrZoneIsAlreadyPausedThe EdgeOne service of the site is disabled. Please enable it and try again.
OperationDenied.NotAllowCloseAccelerateMainlandWhenDomainBoundExclusiveIPThe current site has a domain name associated with an exclusive accelerated IP. To disable "network optimization in the Chinese mainland", unbind the exclusive IP first and try again after.
OperationDenied.SharedCNAMEUnsupportedAccelerateMainlandThe domain name is bound with a shared CNAME and cannot be changed to "Cross-MLC-border acceleration". Please unbind the domain name from the shared CNAME first.
OperationDenied.SharedCNAMEUnsupportedIPv6The domain name is bound with a shared CNAME and cannot be changed to "IPv6 access". Please unbind the domain name from the shared CNAME first.
ResourceInUseThe resource is occupied.
ResourceNotFoundThe resource doesn’t exist.
ResourceNotFound.PostMaxSizeQuotaNotFoundMaximum upload size is not configured.
ResourceUnavailable.CertNotFoundThe certificate does not exist or is not authorized.
UnauthorizedOperation.CamUnauthorizedCAM is not authorized.
UnauthorizedOperation.NoPermissionThe sub-account is not authorized for the operation. Please get permissions first.