获取计算环境详情

最近更新时间:2024-03-12 01:09:50

我的收藏

1. 接口描述

接口请求域名: batch.tencentcloudapi.com 。

用于查询计算环境的详细信息

默认接口请求频率限制:2次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeComputeEnv。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
EnvId String 计算环境ID
示例值:env-lcpcej85

3. 输出参数

参数名称 类型 描述
EnvId String 计算环境ID
示例值:env-lcpcej85
EnvName String 计算环境名称
示例值:test compute env
Placement Placement 位置信息
CreateTime String 计算环境创建时间
示例值:2018-03-08T11:48:43Z
ComputeNodeSet Array of ComputeNode 计算节点列表信息
ComputeNodeMetrics ComputeNodeMetrics 计算节点统计指标
DesiredComputeNodeCount Integer 计算节点期望个数
示例值:2
EnvType String 计算环境类型
示例值:MANAGED
ResourceType String 计算环境资源类型,当前为CVM和CPM(黑石)
示例值:CVM
NextAction String 下一步动作
AttachedComputeNodeCount Integer 用户添加到计算环境中的计算节点个数
示例值:0
Tags Array of Tag 计算环境绑定的标签列表。
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查看计算环境详细信息

输入示例

https://batch.tencentcloudapi.com/?Action=DescribeComputeEnv
&EnvId=env-lcpcej85
&<公共请求参数>

输出示例

{
    "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. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameter.EnvIdMalformed 非法的计算环境ID格式。
ResourceNotFound.ComputeEnv 指定计算环境不存在。