查看计算环境列表

最近更新时间:2018-04-16 15:54:30

1. 接口描述

本接口(DescribeComputeEnvs)用于查看计算环境列表。
接口请求域名:batch.api.qcloud.com

2. 输入参数

名称 类型 是否必选 描述
Version String API版本号
EnvIds.N Array of String 按照指定EnvId查询。每次请求的上限为100。参数不支持同时指定EnvIds和Filters
Filters.N Array of Filter objects 过滤条件,详见过滤条件表。参数不支持同时指定EnvIds和Filters
Offset Integer 偏移量,默认为0。
Limit Integer 返回数量,默认为20,最大值为100。

Filter

名称 类型 是否必选 描述
Name String 过滤键的名称
Values.N array of Strings 若干个过滤值

过滤条件表

名称 类型 是否必选 描述
env-id String 过滤计算环境Id
env-name String 过滤计算环境名称
zone String 过滤可用区

3. 输出参数

名称 类型 描述
TotalCount Integer 计算环境数量
ComputeEnvSet array of ComputeEnvView objects 计算环境列表

ComputeEnvView

名称 类型 描述
EnvId String 计算环境ID
EnvName String 计算环境名称
EnvType String 计算环境类型
DesiredComputeNodeCount Integer 计算节点期望个数
Placement Placement object 位置信息
CreateTime String 计算环境创建时间
NextAction String 下一步动作,”DELETING“表示即将删除
ComputeNodeMetrics ComputeNodeMetrics object 计算节点统计指标

ComputeNodeMetrics

名称 类型 描述
SubmittedCount String 已经完成提交的计算节点数量
CreatingCount String 创建中的计算节点数量
CreationFailedCount String 创建失败的计算节点数量
CreatedCount String 完成创建的计算节点数量
RunningCount String 运行中的计算节点数量
DeletingCount String 销毁中的计算节点数量
AbnormalCount String 异常的计算节点数量
# 输出参数示例
{
    "Response": {
        "TotalCount": 1,
        "ComputeEnvSet": [
            {
                "EnvId": "env-gzah9akx",
                "ComputeNodeMetrics": {
                    "CreatedCount": 0,
                    "DeletingCount": 0,
                    "CreationFailedCount": 0,
                    "SubmittedCount": 0,
                    "CreatingCount": 0,
                    "AbnormalCount": 0,
                    "RunningCount": 2
                },
                "EnvType": "MANAGED",
                "EnvName": "test compute env",
                "Placement": {
                    "Zone": "ap-guangzhou-2"
                },
                "CreateTime": "2017-11-21T03:51:27Z"
            }
        ],
        "RequestId": "a03a2636-8448-4890-a977-0316d83d982f"
    }
}

4. 错误码

错误码 描述
InvalidParameterValue 非法的参数值。
InvalidBatchEnvId.Malformed 非法的计算环境ID格式。
InvalidZoneMismatchRegion 非法的zone名称。
UnsupportedParams 过滤条件不支持。
InternalServerError 内部服务错误。