当前位置：主页 > 查看内容

批量计算 获取计算环境列表 - API 文档

发布时间：2021-09-13 00:00| 有 位朋友查看

简介：1. 接口描述 接口请求域名： batch.tencentcloudapi.com 。 用于查看计算环境列表 默认接口请求频率限制：2次/秒。 推荐使用 API Explorer 点击调试 API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容……

1. 接口描述

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

用于查看计算环境列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeComputeEnvs。
Version 是 String 公共参数，本接口取值：2017-03-12。
Region 是 String 公共参数，详见产品支持的 地域列表。
EnvIds.N 否 Array of String 计算环境ID列表，与Filters参数不能同时指定。
Filters.N 否 Array of Filter 过滤条件
  • zone - String - 是否必填：否 -（过滤条件）按照可用区过滤。
  • env-id - String - 是否必填：否 -（过滤条件）按照计算环境ID过滤。
  • env-name - String - 是否必填：否 -（过滤条件）按照计算环境名称过滤。
  • resource-type - String - 是否必填：否 -（过滤条件）按照计算资源类型过滤，取值CVM或者CPM(黑石)。
  • tag-key - String - 是否必填：否 -（过滤条件）按照标签键进行过滤。
  • tag-value - String - 是否必填：否 -（过滤条件）按照标签值进行过滤。
  • tag:tag-key - String - 是否必填：否 -（过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。

    • 与EnvIds参数不能同时指定。
    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
&<公共请求参数>

    输出示例

    {
  "Response": {
    "TotalCount": 1,
    "ComputeEnvSet": [
      {
        "EnvId": "env-lcx7qbbr",
        "ComputeNodeMetrics": {
          "CreatedCount": 0,
          "DeletingCount": 0,
          "CreationFailedCount": 0,
          "SubmittedCount": 0,
          "CreatingCount": 0,
          "AbnormalCount": 1,
          "RunningCount": 0
        },
        "Tags": [
          {
            "Key": "batch-test-tag-env-key",
            "Value": "batch-test-tag-env-value"
          }
        ],
        "ResourceType": "CVM",
        "EnvType": "MANAGED",
        "AttachedComputeNodeCount": 0,
        "DesiredComputeNodeCount": 1,
        "EnvName": "test-compute-env",
        "Placement": {
          "Zone": "ap-guangzhou-4"
        },
        "NextAction": "",
        "CreateTime": "2020-09-22T06:51:42Z"
      }
    ],
    "RequestId": "bedb1750-a09f-4c4d-9f25-6afccda50dea"
  }
}

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    • Tencent Cloud SDK 3.0 for Python
    • Tencent Cloud SDK 3.0 for Java
    • Tencent Cloud SDK 3.0 for PHP
    • Tencent Cloud SDK 3.0 for Go
    • Tencent Cloud SDK 3.0 for NodeJS
    • Tencent Cloud SDK 3.0 for .NET
    • Tencent Cloud SDK 3.0 for C++
    • Tencent Cloud SDK 3.0 for Ruby

    命令行工具

    • Tencent Cloud CLI 3.0

    6. 错误码

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

    错误码 描述
    InternalError 内部错误。
    InvalidFilter 指定的Filter不被支持。
    InvalidParameter.EnvIdMalformed 非法的计算环境ID格式。
    InvalidParameter.InvalidParameterCombination 非法的参数组合。
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.ResourceType 指定的ResourceType不合法。
    InvalidZone.MismatchRegion 指定的zone不存在。
    UnknownParameter 未知参数错误。

    本站部分内容转载于网络，版权归原作者所有，转载之目的在于传播更多优秀技术内容，如有侵权请联系QQ/微信：153890879删除，谢谢！
    上一篇：DescribeInstanceTypes - 云服务器 ECS 下一篇：没有了

    推荐图文

    • 周排行
    • 月排行
    • 总排行

    随机推荐