tencent cloud

批量计算

产品简介
什么是批量计算?
应用场景
产品优势
名词解释
配额限制
数据安全
购买指南
快速入门
开始前的准备
命令行快速开始
命令行快速开始-计算环境
作业配置说明
控制台快速开始
控制台使用指南
任务模板管理
作业管理
用户指南
如何制作批量计算可用的镜像
Windows 自定义镜像
环境变量
COS、CFS 路径填写
事件通知和回调
访问管理
命令行工具
前置准备
简单开始
执行远程代码包
远程存储映射
实践教程
使用计算环境搭建集群
3ds Max 2018 渲染示例
深度学习示例
API 文档
History
Introduction
API Category
Making API Requests
Compute Environment APIs
Configuration Viewing-related APIs
Task Template-related APIs
Job-related APIs
Data Types
Error Codes
SDK文档
使用指南
常见问题
联系我们
词汇表

DescribeComputeEnv

PDF
聚焦模式
字号
最后更新时间: 2025-10-30 21:28:53

1. API Description

Domain name for API request: batch.intl.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.intl.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.

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈