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 示例值:env-lcpcej85 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
EnvId | String | 计算环境 ID 示例值:env-qleawxzt |
EnvName | String | 计算环境名称 示例值:test compute env |
EnvDescription | String | 计算环境描述 注意:此字段可能返回 null,表示取不到有效值。 示例值: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": {
"EnvId": "env-qleawxzt",
"EnvType": "MANAGED",
"DesiredComputeNodeCount": 2,
"MountDataDisks": [
{
"FileSystemType": "xx",
"LocalPath": "xx"
}
],
"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": "ComputeEnvCreated",
"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"
}
]
},
"Tags": [
{
"Key": "batch-test-tag-env-key",
"Value": "batch-test-tag-env-value1"
}
],
"Authentications": [
{
"SecretKey": "xx",
"SecretId": "xx",
"Scene": "xx"
}
],
"RequestId": "578f3fae-6908-4521-ac07-17c2cffcd5ae"
}
}
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 | 指定计算环境不存在。 |