- Product Introduction
- Purchase Guide
- Getting Started
- Console User Guide
- User Guide
- Command Line Interface
- Best Practices
- API Documentation
- SDK Documentation
- FAQs
- Contact Us
- Glossary
- Product Introduction
- Purchase Guide
- Getting Started
- Console User Guide
- User Guide
- Command Line Interface
- Best Practices
- API Documentation
- SDK Documentation
- FAQs
- Contact Us
- Glossary
1. API Description
Domain name for API request: batch.tencentcloudapi.com.
This API is used to get the list of compute environments.
A maximum of 2 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: DescribeComputeEnvs. |
| 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 | Filterszone - String - Optional - Availability zone.env-id - String - Optional - Compute environment ID.env-name - String - Optional - Compute environment name.resource-type - String - Optional - Compute resource type (CVM or CPM).tag-key - String - Optional - Tag key.tag-value - String - Optional - Tag value.tag:tag-key - String - Optional - Tag key-value pair. Replace tag-key with the actual tag key.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 |
|---|---|---|
| ComputeEnvSet | Array of ComputeEnvView | List of compute environments |
| TotalCount | Integer | Number of compute environments |
| 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 environments
Input Example
https://batch.tencentcloudapi.com/?Action=DescribeComputeEnvs
&EnvIds.0=env-lcx7qbbr
&<Common request parameters>
Output Example
{
"Response": {
"TotalCount": 1,
"ComputeEnvSet": [
{
"EnvId": "env-lcx7qbbr",
"ComputeNodeMetrics": {
"CreatedCount": 0,
"DeletingCount": 0,
"CreationFailedCount": 0,
"SubmittedCount": 0,
"CreatingCount": 0,
"AbnormalCount": 1,
"RunningCount": 0
},
"Tags": [
{
"Key": "batch-test-tag-env-key",
"Value": "batch-test-tag-env-value"
}
],
"ResourceType": "CVM",
"EnvType": "MANAGED",
"AttachedComputeNodeCount": 0,
"DesiredComputeNodeCount": 1,
"EnvName": "test-compute-env",
"Placement": {
"Zone": "ap-guangzhou-4"
},
"NextAction": "",
"CreateTime": "2020-09-22T06:51:42Z"
}
],
"RequestId": "bedb1750-a09f-4c4d-9f25-6afccda50dea"
}
}
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 |
|---|---|
| InternalError | Internal error. |
| InvalidFilter | The specified filter is not supported. |
| InvalidParameter.EnvIdMalformed | Invalid compute environment ID format. |
| InvalidParameter.InvalidParameterCombination | Invalid parameter combination. |
| InvalidParameterValue | Incorrect parameter value. |
| InvalidParameterValue.InvalidFilter | Incorrect Filter parameter. |
| InvalidParameterValue.ResourceType | The specified ResourceType is invalid. |
| InvalidZone.MismatchRegion | The specified zone does not exist. |
| UnknownParameter | Unknown parameter error. |
Yes
No
Was this page helpful?