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

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

接口描述

本接口(DescribeComputeEnvCreateInfos)用于查看计算环境创建信息列表。
接口请求域名:

batch.api.qcloud.com

输入参数

名称 类型 必选 描述
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 过滤可用区

输出参数

名称 类型 描述
TotalCount Integer 计算环境数量
ComputeEnvCreateInfoSet array of ComputeEnvCreateInfoView objects 计算环境创建信息列表

ComputeEnvCreateInfoView

名称 类型 描述
EnvId String 计算环境 ID
EnvName String 计算环境名称
EnvDescription String 计算环境描述
EnvType String 计算环境类型,仅支持“MANAGED”类型
EnvData EnvData object 计算环境参数
MountDataDisks array of MountDataDisk objects 数据盘挂载选项
InputMappings array of InputMapping objects 输入映射
Authentications array of Authentication objects 授权信息
Notifications array of Notification objects 通知信息
DesiredComputeNodeCount Integer 计算节点期望个数

示例

输入

输出

# 输出参数示例
{
    "Response": {
        "TotalCount": 1,
        "ComputeEnvCreateInfoSet": [
        {
            "EnvId": "env-qleawxzt",
            "EnvType": "MANAGED",
            "DesiredComputeNodeCount": 2,
            "EnvName": "test compute env",
            "EnvDescription": "test compute env",
            "InputMappings": [
            {
                "SourcePath": "cos://bucket-appid.cos.ap-hongkong.myqcloud.com/",
                "DestinationPath": "/mnt/disk/"
            },
            {
                "SourcePath": "cos://bucket-appid.cos.ap-hongkong.myqcloud.com/test/",
                "DestinationPath": "/mnt/input/"
            }
            ],
            "Notifications": [
            {
                "TopicName": "topic name",
                "EventConfigs": [
                {
                    "EventName": "COMPUTE_ENV_DELETED",
                    "EventVars": [
                    {
                        "Name": "name1",
                        "Value": "value1"
                    },
                    {
                        "Name": "name2",
                        "Value": "value2"
                    }
                    ]
                }
                ]
            }
            ],
            "EnvData": {
                "VirtualPrivateCloud": {
                    "SubnetId": "subnet-8axej2jc",
                    "VpcId": "vpc-cg18la4l"
                },
                "SystemDisk": {
                    "DiskSize": 50,
                    "DiskType": "CLOUD_BASIC"
                },
                "InternetAccessible": {
                    "PublicIpAssigned": "TRUE",
                    "InternetMaxBandwidthOut": 50
                },
                "ImageId": "img-bd78fy2t",
                "InstanceType": "S1.SMALL2",
                "DataDisks": [
                {
                    "DiskSize": 50,
                    "DiskType": "CLOUD_BASIC"
                }
                ]
            }
            }
        ],
        "RequestId": "a03a2636-8448-4890-a977-0316d83d982f"
    }
}

错误码

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