tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribeComputeEnv

最后更新时间：2023-05-04 15:47:11

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 Params. The value used for this API: DescribeComputeEnv.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
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
ResourceType String Compute environment resource type. Values: CVM, CPM (Bare Metal)
NextAction String Next action
AttachedComputeNodeCount Integer Number of compute nodes added to the compute environment
Tags Array of Tag Tag list bound to the compute environment.
Note: This field may return null, indicating that no valid value was found.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the 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",
        "NextAction": "",
        "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,
                "PublicIpAddresses": [
                    "132.20.19.18"
                ],
                "PrivateIpAddresses": [
                    "10.10.8.3"
                ]
            },
            {
                "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,
                "PublicIpAddresses": [
                    "132.20.19.18"
                ],
                "PrivateIpAddresses": [
                    "10.10.8.3"
                ]
            }
        ],
        "DesiredComputeNodeCount": 2,
        "AttachedComputeNodeCount": 0,
        "Tags": [
            {
                "Key": "batch-test-tag-env-key",
                "Value": "batch-test-tag-env-value1"
            }
        ],
        "RequestId": "274cbd4f-77d2-4bf6-9984-643318ed3ef8"
    }
}

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 Internal error.
InvalidParameter.EnvIdMalformed Invalid compute environment ID format.
ResourceNotFound.ComputeEnv The specified compute environment does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款