获取计算环境详情

最近更新时间:2018-11-08 20:28:51

1. 接口描述

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

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

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

2. 输入参数

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

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

3. 输出参数

参数名称 类型 描述
EnvId String 计算环境ID
EnvName String 计算环境名称
Placement Placement 位置信息
CreateTime String 计算环境创建时间
ComputeNodeSet Array of ComputeNode 计算节点列表信息
ComputeNodeMetrics ComputeNodeMetrics 计算节点统计指标
DesiredComputeNodeCount Integer 计算节点期望个数
EnvType String 计算环境类型
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

输入示例

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

输出示例

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

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

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