Overview
Menu

DeployConfigGroupVersion

1. API Description

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

This API is used to release versions in version management mode. Users can deploy the version to either the testing environment or the production environment by specifying the EnvId parameter. The version management feature is currently undergoing beta testing and is accessible only to users on the whitelist.

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: DeployConfigGroupVersion.
VersionYesStringCommon Params. The value used for this API: 2022-09-01.
RegionNoStringCommon Params. This parameter is not required.
ZoneIdYesStringZone ID.
EnvIdYesStringEnvironment ID. Please specify the environment ID to which the version should be released.
ConfigGroupVersionInfos.NYesArray of ConfigGroupVersionInfoVersion information required for release. Multiple versions of different configuration groups can be modified simultaneously, while each group allows modifying only one version at a time.
DescriptionYesStringChange description. It is used to describe the content and reasons for this change. A maximum of 100 characters are supported.

3. Output Parameters

Parameter NameTypeDescription
RecordIdStringRelease record ID.
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 Create a Version Deployment Task

Release a specific version with ZoneId set to zone-32qwgrnvbisw, VersionId to ver-2ogs1as803hm, and EnvId to env-28jw51ksm9bw.

Input Example

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

{
    "ZoneId": "zone-32qwgrnvbisw",
    "EnvId": "env-28jw51ksm9bw",
    "ConfigGroupVersionInfos": [
        {
            "VersionId": "ver-2ogs1as803hm"
        }
    ],
    "Description": "Add IPv6 and AccelerationMainland configuration"
}

Output Example

{
    "Response": {
        "RequestId": "5e0a2b4e-df6d-4d2a-as19-1706cbf8a902",
        "RecordId": "dr-2nvadq3sa41u"
    }
}

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
FailedOperation.ConfigConditionSyntaxErrorSyntax error in the condition expression of the configuration file.
FailedOperation.ConfigConditionUnknownTargetUnrecognized condition matching type.
FailedOperation.ConfigConditionValueEmptyErrorThe value field of the condition expression cannot be empty in the configuration file.
FailedOperation.ConfigFieldTypeErrorThe configuration file contains fields with inconsistent data types.
FailedOperation.ConfigFormatErrorSyntax error in the configuration file.
FailedOperation.ConfigMalformedContentIncorrect format of the configuration file. Parsing failed.
FailedOperation.ConfigParamValidateErrorsParameter verification error in the configuration file.
FailedOperation.ConfigUnknownFieldThe specified field in the configuration file is not recognized, indicating a possible spelling error or incorrect placement within the file structure.
FailedOperation.ConfigUnsupportedFormatVersionThe current configuration file version is not supported.
InvalidParameter.ZoneNotFoundThe site does not exist.
OperationDenied.ConfigLockedThe configuration is locked. Please unlock and try again.
OperationDenied.DomainStatusUnstableSome domain names on the site are currently experiencing instability. The stable states for domain names are "online" and "offline".
OperationDenied.EnvNotReadyThe site environment is not ready.
OperationDenied.NotInVersionControlWhiteListThe current user is not included in the whitelist for version management.
OperationDenied.VersionControlLockedThe operation is not allowed because the version management mode is applied.
OperationDenied.WorkModeNotInVersionControlThe specified site working mode is not applicable to the version management mode.
ResourceNotFoundThe resource doesn’t exist.
ResourceNotFound.VersionNotFoundThe configuration group version does not exist. Please check and try again.