DescribeComputeEnv

Last updated: 2020-06-24 11:39:10

1. API Description

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

This API is used to query compute environment details.

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: DescribeComputeEnv.
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.
EnvId Yes String Compute environment ID

3. Output Parameters

Parameter Name Type Description
EnvId String Compute environment ID
EnvName String Compute environment name
Placement Placement Location information
CreateTime String Compute environment creation time
ComputeNodeSet Array of ComputeNode List of compute nodes
ComputeNodeMetrics ComputeNodeMetrics Compute node statistical metrics
DesiredComputeNodeCount Integer Number of desired compute nodes
EnvType String Compute environment type
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Viewing compute environment details

Input Example

https://batch.tencentcloudapi.com/?Action=DescribeComputeEnv
&EnvId=env-lcpcej85
&<common request parameters>

Output Example

{
  "Response": {
    "EnvId": "env-lcpcej85",
    "ComputeNodeMetrics": {
      "CreatedCount": 0,
      "DeletingCount": 0,
      "CreationFailedCount": 0,
      "SubmittedCount": 0,
      "CreatingCount": 0,
      "AbnormalCount": 1,
      "RunningCount": 1
    },
    "ResourceType": "CVM",
    "EnvType": "MANAGED",
    "CreateTime": "2018-03-08T11:48:43Z",
    "EnvName": "test compute env",
    "Placement": {
      "Zone": "ap-guangzhou-2"
    },
    "ComputeNodeSet": [
      {
        "ComputeNodeId": "node-noa8vefu",
        "ComputeNodeState": "ABNORMAL",
        "Mem": 2,
        "ResourceCreatedTime": "2018-03-08T11:49:17Z",
        "ResourceType": "CVM",
        "ResourceOrigin": "BATCH_CREATED",
        "ComputeNodeInstanceId": "ins-0kj3gz6s",
        "AgentVersion": "1.1.9",
        "TaskInstanceNumAvailable": 1,
        "Cpu": 1
      },
      {
        "ComputeNodeId": "node-9yzd5jei",
        "ComputeNodeState": "RUNNING",
        "Mem": 2,
        "ResourceCreatedTime": "2018-03-09T13:15:44Z",
        "ResourceType": "CVM",
        "ResourceOrigin": "BATCH_CREATED",
        "ComputeNodeInstanceId": "ins-jyafz2sk",
        "AgentVersion": "1.1.9",
        "TaskInstanceNumAvailable": 1,
        "Cpu": 1
      }
    ],
    "DesiredComputeNodeCount": 2,
    "AttachedComputeNodeCount": 0,
    "RequestId": "274cbd4f-77d2-4bf6-9984-643318ed3ef8"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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 Internal error
InvalidParameter.EnvIdMalformed Invalid compute environment ID format.
ResourceNotFound.ComputeEnv The specified compute environment does not exist.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help