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

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

最近更新时间:2024-03-12 01:09:49

我的收藏

1. 接口描述

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

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeComputeEnvCreateInfos。
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 - 是否必填:否 -(过滤条件)按照计算环境名称过滤。

  • 与EnvIds参数不能同时指定。
    Offset Integer 偏移量
    示例值:0
    Limit Integer 返回数量
    示例值:100

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 计算环境数量
    示例值:2
    ComputeEnvCreateInfoSet Array of ComputeEnvCreateInfo 计算环境创建信息列表
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

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

    输入示例

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

    输出示例

    {
        "Response": {
            "TotalCount": 1,
            "RequestId": "bb976df4-42a0-41cc-82d4-69bea1007083",
            "ComputeEnvCreateInfoSet": [
                {
                    "EnvId": "env-lcx7qbbr",
                    "Notifications": [
                        {
                            "EventConfigs": [
                                {
                                    "EventName": "COMPUTE_ENV_CREATED_SUCCESS",
                                    "EventVars": [
                                        {
                                            "Name": "COMPUTE_ENV_CREATED_SUCCESS",
                                            "Value": "COMPUTE_ENV_CREATED_SUCCESS"
                                        }
                                    ]
                                }
                            ],
                            "TopicName": "compute-env-topic"
                        }
                    ],
                    "Tags": [
                        {
                            "Value": "test",
                            "Key": "test-env"
                        }
                    ],
                    "Authentications": [
                        {
                            "SecretKey": "xx",
                            "SecretId": "xx",
                            "Scene": "xx"
                        }
                    ],
                    "EnvData": {
                        "VirtualPrivateCloud": {
                            "SubnetId": "subnet-23syenxk",
                            "AsVpcGateway": true,
                            "Ipv6AddressCount": 1,
                            "VpcId": "vpc-1xnwrxw2",
                            "PrivateIpAddresses": [
                                "10.10.2.29"
                            ]
                        },
                        "LoginSettings": {
                            "Password": "xx",
                            "KeepImageLogin": "True",
                            "KeyIds": [
                                "xx"
                            ]
                        },
                        "InstanceMarketOptions": {
                            "SpotOptions": {
                                "SpotInstanceType": "one-time",
                                "MaxPrice": "1"
                            },
                            "MarketType": "spot"
                        },
                        "SystemDisk": {
                            "DiskSize": 0,
                            "CdcId": "xx",
                            "DiskId": "disk-sdfk23nw",
                            "DiskType": "CLOUD_SSD"
                        },
                        "InstanceTypes": [
                            "S5.SMALL2"
                        ],
                        "Zones": [
                            "ap-guangzhou-2"
                        ],
                        "InstanceChargeType": "POSTPAID_BY_HOUR",
                        "EnhancedService": {
                            "SecurityService": {
                                "Enabled": true
                            },
                            "MonitorService": {
                                "Enabled": true
                            },
                            "AutomationService": {
                                "Enabled": true
                            }
                        },
                        "SecurityGroupIds": [
                            "xx"
                        ],
                        "InternetAccessible": {
                            "PublicIpAssigned": true,
                            "InternetChargeType": "POSTPAID_BY_HOUR",
                            "BandwidthPackageId": "xx",
                            "InternetMaxBandwidthOut": 0
                        },
                        "VirtualPrivateClouds": [
                            {
                                "SubnetId": "subnet-23syenxk",
                                "AsVpcGateway": true,
                                "Ipv6AddressCount": 1,
                                "VpcId": "vpc-1xnwrxw2",
                                "PrivateIpAddresses": [
                                    "10.10.2.29"
                                ]
                            }
                        ],
                        "ImageId": "img-3sdke3x2",
                        "InstanceName": "test-env",
                        "InstanceType": "S5.SMALL2",
                        "InstanceTypeOptions": {
                            "Memory": 1,
                            "CPU": 1,
                            "InstanceCategories": [
                                "ALL"
                            ]
                        },
                        "DataDisks": [
                            {
                                "DeleteWithInstance": true,
                                "Encrypt": true,
                                "CdcId": "xx",
                                "DiskType": "CLOUD_SSD",
                                "ThroughputPerformance": 0,
                                "KmsKeyId": "kms-213k73kx",
                                "DiskSize": 0,
                                "SnapshotId": "snap-fsdekxe2",
                                "DiskId": "xx"
                            }
                        ]
                    },
                    "EnvDescription": "test-env",
                    "MountDataDisks": [
                        {
                            "FileSystemType": "ext4",
                            "LocalPath": "/mnt"
                        }
                    ],
                    "DesiredComputeNodeCount": 1,
                    "EnvName": "test-env",
                    "InputMappings": [
                        {
                            "SourcePath": "cos://test-1111123424.cos.ap-guangzhou.myqcloud.com/batchtest/input/",
                            "DestinationPath": "/opt/data",
                            "MountOptionParameter": ""
                        }
                    ],
                    "EnvType": "MANAGED"
                }
            ]
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

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