Domain name for API request: tem.tencentcloudapi.com.
This API is used to obtain the list of environments.
A maximum of 20 requests can be initiated per second for this API.
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: 2021-07-01. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
Limit | No | Integer | Pagination limit |
Offset | No | Integer | Page offset |
SourceChannel | No | Integer | Source |
Filters.N | No | Array of QueryFilter | Filters for query |
SortInfo | No | SortType | Sorting field |
EnvironmentId | No | String | Environment ID |
Parameter Name | Type | Description |
---|---|---|
Result | NamespacePage | Returned result |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to obtain the list of environments.
POST / HTTP/1.1
Host: tem.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeEnvironments
<Common request parameters>
{}
{
"Response": {
"Result": {
"Current": 0,
"Records": [
{
"SubAccountUin": "xx",
"Channel": "xx",
"Status": 0,
"EnvironmentName": "xx",
"HasAuthority": true,
"ModifyDate": "xx",
"Description": "xx",
"Tags": [
{
"TagKey": "xx",
"TagValue": "xx"
}
],
"RegionId": "xx",
"ClusterId": "xx",
"RunInstancesNum": 0,
"Vpc": "xx",
"SubnetId": "xx",
"CreateDate": "xx",
"Locked": 0,
"Region": "xx",
"EnableTswTraceService": true,
"Modifier": "xx",
"EnvironmentId": "xx",
"Creator": "xx",
"EnvType": "xx",
"Uin": "xx",
"AppId": "xx",
"ClusterStatus": "xx",
"ApplicationNum": 0
}
],
"Total": 0,
"Pages": 0,
"Size": 0
},
"RequestId": "xx"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.ActionReadTimeout | Request timed out |
InternalError.DefaultInternalError | The server is busy. Retry later. |
InvalidParameterValue.InvalidTenantInfo | Unable to identify the tenant information |
ResourceNotFound.MicroserviceOffline | The target microservice is offline. |
ResourceNotFound.NamespaceNotFound | The environment does not exist. |
Was this page helpful?