- Product Introduction
- Purchase Guide
- Getting Started
- Console User Guide
- User Guide
- Command Line Interface
- Practical Tutorial
- API Documentation
- SDK Documentation
- FAQs
- Contact Us
- Glossary
- Product Introduction
- Purchase Guide
- Getting Started
- Console User Guide
- User Guide
- Command Line Interface
- Practical Tutorial
- API Documentation
- SDK Documentation
- FAQs
- Contact Us
- Glossary
1. API Description
Domain name for API request: batch.tencentcloudapi.com.
This API is used to view the list of information of compute environment creation, including name, description, type, environment parameters, notifications, and number of desired nodes.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeComputeEnvCreateInfos. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| EnvIds.N | No | Array of String | List of compute environment IDs, which cannot be specified together with the Filters parameter. |
| Filters.N | No | Array of Filter | Filter conditionszone - String - Optional - Filter by the availability zone.env-id - String - Optional - Filter by the compute environment ID.env-name - String - Optional - Filter by the compute environment name.It cannot be specified together with EnvIds. |
| Offset | No | Integer | Offset |
| Limit | No | Integer | Maximum number of returned items |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of compute environments |
| ComputeEnvCreateInfoSet | Array of ComputeEnvCreateInfo | List of compute environment creation information |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Querying the list of compute environment creation information
Input Example
https://batch.tencentcloudapi.com/?Action=DescribeComputeEnvCreateInfos
&EnvIds.0=env-lcx7qbbr
&<Common request parameters>
Output Example
{
"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. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InvalidParameter.EnvIdMalformed | Invalid compute environment ID format. |
| InvalidParameter.InvalidParameterCombination | Invalid parameter combination. |
| InvalidParameterValue | Incorrect parameter value. |
| InvalidZone.MismatchRegion | The specified zone does not exist. |
| UnknownParameter | Unknown parameter error. |
Yes
No
Was this page helpful?