Overview
Menu

DescribeDeployHistory

1. API Description

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

This API is used to query the release history of versions in the production or test environment in version management mode. 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: DescribeDeployHistory.
VersionYesStringCommon Params. The value used for this API: 2022-09-01.
RegionNoStringCommon Params. This parameter is not required.
ZoneIdYesStringZone ID.
EnvIdYesStringEnvironment ID.
Filters.NNoArray of AdvancedFilterFiltering condition. The maximum value of Filters.Values is 20. Detailed filtering conditions:
  • record-id: Filter by release record ID.
  • 3. Output Parameters

    Parameter NameTypeDescription
    TotalCountIntegerTotal release records.
    RecordsArray of DeployRecordRelease record details.
    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 Query Version Release History

    Query the version release history with ZoneId set to zone-3swlomhssdcb and EnvId set to env-2kpeomhisdwb.

    Input Example

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeCustomErrorPages
    <Common request parameters>
    
    {
        "ZoneId": "zone-3swlomhssdcb",
        "EnvId": "env-2kpeomhisdwb"
    }
    

    Output Example

    {
        "Response": {
            "TotalCount": 1,
            "Records": [
                {
                    "ConfigGroupVersionInfos": [
                        {
                            "VersionId": "ver-2kplomhiqdcb",
                            "VersionNumber": "1.0",
                            "GroupId": "cg-2kplomhisdcb",
                            "GroupType": "l7_acceleration",
                            "Description": "Test version",
                            "Status": "active",
                            "CreateTime": "2020-09-22T00:00:00+00:00"
                        }
                    ],
                    "RecordId": "dr-2nvehs3fa40u",
                    "DeployTime": "2023-09-22T00:00:00+00:00",
                    "Status": "success",
                    "Message": "Released successfully."
                }
            ],
            "RequestId": "9bd9c732-8f9a-4cd3-a3e0-1c2db5e53631"
        }
    }
    

    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
    ResourceNotFoundThe resource doesn’t exist.