- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Practical Tutorial
- API
- FAQs
- Service Agreement
- Related Protocol
- Contact Us
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Practical Tutorial
- API
- FAQs
- Service Agreement
- Related Protocol
- Contact Us
DescribeEnvironments
Last updated: 2024-07-26 15:26:21
1. API Description
Domain name for API request: omics.tencentcloudapi.com.
This API is used to query the environment list.
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: DescribeEnvironments. |
| Version | Yes | String | Common Params. The value used for this API: 2022-11-28. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| Offset | No | Integer | Offset, which defaults to 0. |
| Limit | No | Integer | Quantity of returns. It is 20 by default, and the maximum value is 100. |
| Filters.N | No | Array of Filter | Filter, which supports filtering fields: - EnvironmentId: Environment ID - Name: Name - Status: Environmental status |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of qualified items |
| Environments | Array of Environment | List of Environment details |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Querying the Environment List
This example shows you how to query the environment list.
Input Example
POST / HTTP/1.1
Host: omics.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeEnvironments
<Common request parameters>
{
"Offset": 0,
"Limit": 1
}
Output Example
{
"Response": {
"Environments": [
{
"Available": true,
"CreationTime": "2022-12-14T16:14:49+08:00",
"Description": "test description",
"EnvironmentId": "env-lljckw12",
"LastWorkflowUuid": "94922fcd-107e-4220-9a0f-cc3cd84a9a27",
"Message": "",
"Name": "test",
"Region": "ap-guangzhou",
"ResourceIds": {
"CFSId": "cfs-iwee8gk3",
"CFSStorageType": "SD",
"CVMId": "ins-jcbptifa",
"EKSId": "cls-9j9zh13o",
"SecurityGroupId": "sg-gzsfk3r5",
"SubnetId": "subnet-qdkfn4xe",
"TDSQLCId": "cynosdbmysql-kzwghvxj",
"VPCId": "vpc-8yhq1v63"
},
"Status": "RUNNING",
"Type": "KUBERNETES"
}
],
"RequestId": "1bc7ec7d-5fa9-42af-ac6d-1ef56f3bf625",
"TotalCount": 10
}
}
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 Node.js
- 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 |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue | Parameter value error. |
| OperationDenied | Operation rejected. |
Yes
No
Was this page helpful?