DescribeComputeEnvs

Last updated: 2019-07-08 20:38:14

1. API Description

API request domain name: batch.tencentcloudapi.com.

This API is used to view compute environment list

Default API request frequency limit: 2 times/second.

2. Input Parameters

The following list of request parameters lists only the API request parameters and some common parameters. For the complete list of common parameters, see Common Request Parameters.

Parameter name Required Type Description
Action Yes String Common parameter; the value for this API: DescribeComputeEnvs
Version Yes String Common parameter; the value for this API: 2017-03-12
Region Yes String Common parameters; for details, see the Region List supported by the product.
EnvIds.N No Array of String Compute environment ID
Filters.N No Array of Filter Filter
Offset No Integer Offset
Limit No Integer Number of returns

3. Output Parameters

Parameter name Type Description
ComputeEnvSet Array of ComputeEnvView Compute environment list
TotalCount Integer Number of compute environments
RequestId String The unique request ID which is returned for each request. The RequestId for the current request needs to be provided when troubleshooting.

4. Examples

Example 1. Viewing Compute Environment List

Input

https://batch.tencentcloudapi.com/?Action=DescribeComputeEnvs
&EnvIds.0=env-lcx7qbbr
&EnvIds.1=env-lcpcej85
&<Common request parameter>

Output

{
  "Response": {
    "ComputeEnvSet": [
      {
        "ComputeNodeMetrics": {
          "AbnormalCount": 1,
          "CreatedCount": 0,
          "CreatingCount": 0,
          "CreationFailedCount": 0,
          "DeletingCount": 0,
          "RunningCount": 1,
          "SubmittedCount": 0
        },
        "CreateTime": "2018-03-08T11:48:43Z",
        "DesiredComputeNodeCount": 2,
        "EnvId": "env-lcpcej85",
        "EnvName": "test compute env",
        "EnvType": "MANAGED",
        "Placement": {
          "Zone": "ap-guangzhou-2"
        }
      },
      {
        "ComputeNodeMetrics": {
          "AbnormalCount": 0,
          "CreatedCount": 0,
          "CreatingCount": 0,
          "CreationFailedCount": 0,
          "DeletingCount": 0,
          "RunningCount": 1,
          "SubmittedCount": 0
        },
        "CreateTime": "2018-03-08T11:48:42Z",
        "DesiredComputeNodeCount": 1,
        "EnvId": "env-lcx7qbbr",
        "EnvName": "test compute env",
        "EnvType": "MANAGED",
        "Placement": {
          "Zone": "ap-guangzhou-2"
        }
      }
    ],
    "RequestId": "5d5bc973-d924-4c95-90b5-1ace7b5e41b9",
    "TotalCount": 2
  }
}

5. Developer Resources

It is recommended to use API 3.0 Explorer. This tool provides various capabilities such as online debugging, signature verification, SDK code generation and quick API retrieval that significantly reduce the difficulty of using cloud APIs.

Cloud API 3.0 comes with a set of complementary development tools that make it easier to call the API.

6. Error Codes

Only the error codes related to this API are listed below. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error
InvalidParameter.EnvIdMalformed Invalid compute environment ID format.
InvalidParameterValue Invalid parameter value.
InvalidZone.MismatchRegion The specified zone does not exist.
UnknownParameter Unknown parameter error