1. 接口描述
接口请求域名： batch.tencentcloudapi.com 。
查看计算环境的创建信息。
默认接口请求频率限制：2次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeComputeEnvCreateInfo。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| EnvId | 是 | String | 计算环境ID，环境ID通过调用接口 DescribeComputeEnvs获取。 示例值：env-lcpcej85 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| EnvId | String | 计算环境 ID 示例值：env-qleawxzt |
| EnvName | String | 计算环境名称 示例值：test compute env |
| EnvDescription | String | 计算环境描述 示例值：test compute env |
| EnvType | String | 计算环境类型，仅支持“MANAGED”类型 示例值：MANAGED |
| EnvData | EnvData | 计算环境参数 |
| MountDataDisks | Array of MountDataDisk | 数据盘挂载选项 |
| InputMappings | Array of InputMapping | 输入映射 |
| Authentications | Array of Authentication | 授权信息 |
| Notifications | Array of Notification | 通知信息 |
| DesiredComputeNodeCount | Integer | 计算节点期望个数 示例值：2 |
| Tags | Array of Tag | 计算环境绑定的标签列表 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查看计算环境的创建信息
输入示例
https://batch.tencentcloudapi.com/?Action=DescribeComputeEnvCreateInfo
&EnvId=env-lcpcej85
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "578f3fae-6908-4521-ac07-17c2cffcd5ae",
"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": "demo-tag",
"Key": "demo-env1"
}
],
"Authentications": [
{
"SecretKey": "AKIDUdi1************9ThAzpuXIjNx",
"SecretId": "Udi16***********Q9ThAzpuXIjN",
"Scene": "COS"
}
],
"EnvData": {
"VirtualPrivateCloud": {
"SubnetId": "subnet-23syenxk",
"AsVpcGateway": true,
"Ipv6AddressCount": 1,
"VpcId": "vpc-1xnwrxw2",
"PrivateIpAddresses": [
"10.10.2.29"
]
},
"LoginSettings": {
"Password": "Aa12**5678",
"KeepImageLogin": "True",
"KeyIds": [
"Qa123"
]
},
"InstanceMarketOptions": {
"SpotOptions": {
"SpotInstanceType": "one-time",
"MaxPrice": "1"
},
"MarketType": "spot"
},
"SystemDisk": {
"DiskSize": 0,
"CdcId": "1",
"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": [
"sg-1234t1"
],
"InternetAccessible": {
"PublicIpAssigned": true,
"InternetChargeType": "POSTPAID_BY_HOUR",
"BandwidthPackageId": "dcaew",
"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": "2",
"DiskType": "CLOUD_SSD",
"ThroughputPerformance": 0,
"KmsKeyId": "kms-213k73kx",
"DiskSize": 0,
"SnapshotId": "snap-fsdekxe2",
"DiskId": "disk-ecqwbck"
}
]
},
"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。
- Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.EnvIdMalformed | 非法的计算环境ID格式。 |
| ResourceNotFound.ComputeEnv | 指定计算环境不存在。 |
