DescribeEnvironments

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

1. API Description

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

This API is used to query environment information in version management mode. The response includes the environment ID, type, and current effective version. 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: DescribeEnvironments.
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.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total environments.
EnvInfos	Array of EnvInfo	Environment 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 Release Environment List

Query information about the environment list with ZoneId set to zone-2k3lomh6sdcb.

Input Example

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

{
    "ZoneId": "zone-2k3lomh6sdcb"
}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "EnvInfos": [
            {
                "EnvId": "env-2kplomhisdcb",
                "EnvType": "production",
                "Status": "running",
                "Scope": [
                    "ALL"
                ],
                "CreateTime": "2023-09-21T00:00:00+00:00",
                "UpdateTime": "2023-09-22T00:00:00+00:00",
                "CurrentConfigGroupVersionInfos": [
                    {
                        "VersionId": "ver-2k3lomh6sdcb",
                        "VersionNumber": "1.0",
                        "GroupId": "cg-2k3lomh6sdcb",
                        "GroupType": "l7_acceleration",
                        "Description": "Used for production",
                        "Status": "active",
                        "CreateTime": "2023-09-22T00:00:00+00:00"
                    }
                ]
            }
        ],
        "RequestId": "9bd9c732-0f9a-4cd3-a3e8-1e9db5e53631"
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

tencent cloud

Recent Pages