tencent cloud

All product documents
APIs
DocumentationAPIsTencent Cloud Elastic MicroserviceEnvironment APIsDescribeEnvironments
DescribeEnvironments
Last updated: 2023-12-04 16:38:18
DescribeEnvironments
Last updated: 2023-12-04 16:38:18

1. API Description

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

This API is used to obtain the list of environments.

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: 2021-07-01.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
Limit No Integer Pagination limit
Offset No Integer Page offset
SourceChannel No Integer Source
Filters.N No Array of QueryFilter Filters for query
SortInfo No SortType Sorting field
EnvironmentId No String Environment ID

3. Output Parameters

Parameter Name Type Description
Result NamespacePage Returned result
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Obtaining the list of environments

This example shows you how to obtain the list of environments.

Input Example

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

{}

Output Example

{
    "Response": {
        "Result": {
            "Current": 0,
            "Records": [
                {
                    "SubAccountUin": "xx",
                    "Channel": "xx",
                    "Status": 0,
                    "EnvironmentName": "xx",
                    "HasAuthority": true,
                    "ModifyDate": "xx",
                    "Description": "xx",
                    "Tags": [
                        {
                            "TagKey": "xx",
                            "TagValue": "xx"
                        }
                    ],
                    "RegionId": "xx",
                    "ClusterId": "xx",
                    "RunInstancesNum": 0,
                    "Vpc": "xx",
                    "SubnetId": "xx",
                    "CreateDate": "xx",
                    "Locked": 0,
                    "Region": "xx",
                    "EnableTswTraceService": true,
                    "Modifier": "xx",
                    "EnvironmentId": "xx",
                    "Creator": "xx",
                    "EnvType": "xx",
                    "Uin": "xx",
                    "AppId": "xx",
                    "ClusterStatus": "xx",
                    "ApplicationNum": 0
                }
            ],
            "Total": 0,
            "Pages": 0,
            "Size": 0
        },
        "RequestId": "xx"
    }
}

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 Code Description
InternalError.ActionReadTimeout Request timed out
InternalError.DefaultInternalError The server is busy. Retry later.
InvalidParameterValue.InvalidTenantInfo Unable to identify the tenant information
ResourceNotFound.MicroserviceOffline The target microservice is offline.
ResourceNotFound.NamespaceNotFound The environment does not exist.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support