获取计算环境列表

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

1. 接口描述

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

用于查看计算环境列表

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeComputeEnvs
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
EnvIds.N Array of String 计算环境ID
Filters.N Array of Filter 过滤条件
  • zone - String - 是否必填:否 -(过滤条件)按照可用区过滤。
  • env-id - String - 是否必填:否 -(过滤条件)按照计算环境ID过滤。
  • env-name - String - 是否必填:否 -(过滤条件)按照计算环境名称过滤。
  • Offset Integer 偏移量
    Limit Integer 返回数量

    3. 输出参数

    参数名称 类型 描述
    ComputeEnvSet Array of ComputeEnvView 计算环境列表
    TotalCount Integer 计算环境数量
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查看计算环境列表

    输入示例

    https://batch.tencentcloudapi.com/?Action=DescribeComputeEnvs
    &EnvIds.0=env-lcx7qbbr
    &EnvIds.1=env-lcpcej85
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "ComputeEnvSet": [
          {
            "ComputeNodeMetrics": {
              "AbnormalCount": 1,
              "CreatedCount": 0,
              "CreatingCount": 0,
              "CreationFailedCount": 0,
              "DeletingCount": 0,
              "RunningCount": 1,
              "SubmittedCount": 0
            },
            "CreateTime": "2018-03-08T11:48:43Z",
            "DesiredComputeNodeCount": 2,
            "EnvId": "env-lcpcej85",
            "EnvName": "test compute env",
            "EnvType": "MANAGED",
            "Placement": {
              "Zone": "ap-guangzhou-2"
            }
          },
          {
            "ComputeNodeMetrics": {
              "AbnormalCount": 0,
              "CreatedCount": 0,
              "CreatingCount": 0,
              "CreationFailedCount": 0,
              "DeletingCount": 0,
              "RunningCount": 1,
              "SubmittedCount": 0
            },
            "CreateTime": "2018-03-08T11:48:42Z",
            "DesiredComputeNodeCount": 1,
            "EnvId": "env-lcx7qbbr",
            "EnvName": "test compute env",
            "EnvType": "MANAGED",
            "Placement": {
              "Zone": "ap-guangzhou-2"
            }
          }
        ],
        "RequestId": "5d5bc973-d924-4c95-90b5-1ace7b5e41b9",
        "TotalCount": 2
      }
    }

    5. 开发者资源

    API Explorer

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError 内部错误
    InvalidParameter.EnvIdMalformed 非法的计算环境ID格式。
    InvalidParameterValue 非法的参数值。
    InvalidZone.MismatchRegion 指定的zone不存在。
    UnknownParameter 未知参数错误