文档平台 API 中心 批量计算 计算环境相关接口 查看计算环境创建信息列表

查看计算环境创建信息列表

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

1. 接口描述

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

用于查看计算环境创建信息列表,包括名称、描述、类型、环境参数、通知及期望节点数等。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeComputeEnvCreateInfos
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. 输出参数

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

    4. 示例

    示例1 查看计算环境创建信息列表

    输入示例

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

    输出示例

    {
      "Response": {
        "ComputeEnvCreateInfoSet": [
          {
            "DesiredComputeNodeCount": 1,
            "EnvData": {
              "ImageId": "img-8toqc6s3",
              "InstanceType": "S3.4XLARGE32",
              "InternetAccessible": {
                "InternetMaxBandwidthOut": "50",
                "PublicIpAssigned": "TRUE"
              },
              "LoginSettings": {
                "Password": "B1[habcd"
              },
              "SystemDisk": {
                "DiskSize": "50",
                "DiskType": "CLOUD_BASIC"
              }
            },
            "EnvDescription": "batch env ",
            "EnvId": "env-lcx7qbbr",
            "EnvName": "batch-spot",
            "EnvType": "MANAGED"
          },
          {
            "DesiredComputeNodeCount": 1,
            "EnvData": {
              "ImageId": "img-8toqc6s3",
              "InstanceType": "S3.4XLARGE32",
              "InternetAccessible": {
                "InternetMaxBandwidthOut": "50",
                "PublicIpAssigned": "TRUE"
              },
              "LoginSettings": {
                "Password": "B1[habcd"
              },
              "SystemDisk": {
                "DiskSize": "50",
                "DiskType": "CLOUD_BASIC"
              }
            },
            "EnvDescription": "batch env ",
            "EnvId": "env-lcpcej85",
            "EnvName": "batch-spot",
            "EnvType": "MANAGED"
          }
        ],
        "RequestId": "c50bfbf1-d214-4e41-90f6-39270dc9f071",
        "TotalCount": 2
      }
    }

    5. 开发者资源

    API Explorer

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

    SDK

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

    命令行工具

    6. 错误码

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

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