Last updated: 2021-01-28 19:55:30

1. API Description

Domain name for API request:

This API is used to view the list of compute environments.

A maximum of 2 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 parameter. The value used for this API: DescribeComputeEnvs.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
EnvIds.N No Array of String Compute environment ID
Filters.N No Array of Filter Filter.
  • zone - String - Optional - Filter by availability zone.
  • env-id - String - Optional - Filter by compute environment ID.
  • env-name - String - Optional - Filter by compute environment name.
  • resource-type - String - Optional - Filter by compute resource type, which can be CVM or CPM (BM).
  • tag-key - String - Optional - Filter by tag key.

  • tag-value - String - Optional - Filter by tag value.
  • tag:tag-key - String - Optional - Filter by tag key-value pair. The tag-key should be replaced by a specified tag key.

  • It cannot be specified together with the EnvIds parameter.
    Offset No Integer Offset
    Limit No Integer Number of returned results

    3. Output Parameters

    Parameter Name Type Description
    ComputeEnvSet Array of ComputeEnvView List of compute environments
    TotalCount Integer Number of compute environments
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Viewing the list of compute environment

    Input Example
    &<Common request parameters>

    Output Example

      "Response": {
        "TotalCount": 1,
        "ComputeEnvSet": [
            "EnvId": "env-lcx7qbbr",
            "ComputeNodeMetrics": {
              "CreatedCount": 0,
              "DeletingCount": 0,
              "CreationFailedCount": 0,
              "SubmittedCount": 0,
              "CreatingCount": 0,
              "AbnormalCount": 1,
              "RunningCount": 0
            "Tags": [
                "Key": "batch-test-tag-env-key",
                "Value": "batch-test-tag-env-value"
            "ResourceType": "CVM",
            "EnvType": "MANAGED",
            "AttachedComputeNodeCount": 0,
            "DesiredComputeNodeCount": 1,
            "EnvName": "test-compute-env",
            "Placement": {
              "Zone": "ap-guangzhou-4"
            "NextAction": "",
            "CreateTime": "2020-09-22T06:51:42Z"
        "RequestId": "bedb1750-a09f-4c4d-9f25-6afccda50dea"

    5. Developer Resources


    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 Internal error.
    InvalidFilter The specified filter is not supported.
    InvalidParameter.EnvIdMalformed Invalid compute environment ID format.
    InvalidParameter.InvalidParameterCombination Invalid parameter combination.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.ResourceType The specified ResourceType is invalid.
    InvalidZone.MismatchRegion The specified zone does not exist.
    UnknownParameter Unknown parameter.