DescribeConfigGroupVersions

最后更新时间：2024-10-11 15:51:58

1. API Description

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

This API is used to query the version list for the specified configuration group 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 Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: DescribeConfigGroupVersions.
Version	Yes	String	Common Params. The value used for this API: 2022-09-01.
Region	No	String	Common Params. This parameter is not required.
ZoneId	Yes	String	Zone ID.
GroupId	Yes	String	Configuraration group ID.
Filters.N	No	Array of AdvancedFilter	Filtering condition. The maximum value of Filters.Values is 20. If this parameter is not specified, all version information for the selected configuration group is returned. Detailed filtering conditions: version-id: Filter by version ID.
Offset	No	Integer	Paging query offset. The default value is 0.
Limit	No	Integer	Limited entries in paging queries. The default value is 20 and the maximum value is 100.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total versions.
ConfigGroupVersionInfos	Array of ConfigGroupVersionInfo	Version information list.
RequestId	String	The 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 List

Query version details with ZoneId set to zone-2kpsqmtisdcb, GroupId to cg-27fil26zq2s1, and VersionId to ver-2kuq2mhis9c0.

Input Example

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

{
    "ZoneId": "zone-2kpsqmtisdcb",
    "GroupId": "cg-27fil26zq2s1",
    "Filters": [
        {
            "Name": "version-id",
            "Values": [
                "ver-2kuq2mhis9c0"
            ]
        }
    ]
}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "ConfigGroupVersionInfos": [
            {
                "VersionId": "ver-2kuq2mhis9c0",
                "Description": "test",
                "VersionNumber": "1.0",
                "GroupId": "cg-27fil26zq2s1",
                "GroupType": "l7_acceleration",
                "Status": "RELEASED",
                "CreateTime": "2020-09-22T00:00:00+00:00"
            }
        ],
        "RequestId": "9bd9c732-8f9a-4cd3-a3e8-1c9db5e53631"
    }
}

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

Tencent Cloud CLI 3.0

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 Code	Description
ResourceNotFound	The resource doesn’t exist.

tencent cloud

Recent Pages