Domain name for API request: tem.tencentcloudapi.com.
This API is used to query the status of all applications in an envrionment.
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: DescribeApplicationsStatus. |
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. |
SourceChannel | No | Integer | Source channel. Please keep the default value. |
EnvironmentId | No | String | Environment ID |
Parameter Name | Type | Description |
---|---|---|
Result | Array of ServiceVersionBrief | Returned result. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This document shows you how to query the status of all application in the specified envirionment.
POST / HTTP/1.1
Host: tem.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApplicationsStatus
<Common request parameters>
{
"SourceChannel": 0,
"EnvironmentId": "xx"
}
{
"Response": {
"Result": [
{
"Status": "xx",
"CurrentInstances": 0,
"LogOutputConf": {
"ClsLogTopicId": "xx",
"ClsLogsetName": "xx",
"ClsLogsetId": "xx",
"ClsLogTopicName": "xx",
"OutputType": "xx"
},
"EnableEs": 0,
"PodList": {
"TotalCount": 0,
"Limit": 0,
"RequestId": "xx",
"PodList": [
{
"Webshell": "xx",
"Status": "xx",
"RestartCount": 0,
"StartTime": "xx",
"Zone": "xx",
"PodId": "xx",
"NodeInfo": {
"SubnetId": "xx",
"Cidr": "xx",
"AvailableIpCount": "xx",
"Name": "xx",
"Zone": "xx"
},
"VersionId": "xx",
"UnhealthyWarningMsg": "xx",
"DeployVersion": "xx",
"PodIp": "xx",
"ContainerState": "xx",
"Ready": true,
"ApplicationName": "xx",
"CreateTime": "xx",
"Unhealthy": true
}
],
"Offset": 0
},
"EnvironmentId": "xx",
"CreateDate": "xx",
"BuildTaskId": "xx",
"DeployMode": "xx",
"WorkloadInfo": {
"ApplicationName": "xx",
"UpdateRevision": "xx",
"UpdatedReadyReplicas": 0,
"Replicas": 0,
"ClusterId": "xx",
"UpdatedReplicas": 0,
"VersionName": "xx",
"CurrentRevision": "xx",
"ReadyReplicas": 0
},
"Zones": [
"xx"
],
"VersionId": "xx",
"UnderDeploying": true,
"BatchDeployStatus": "xx",
"VersionName": "xx",
"ExpectedInstances": 0,
"NodeInfos": [
{
"SubnetId": "xx",
"Cidr": "xx",
"AvailableIpCount": "xx",
"Name": "xx",
"Zone": "xx"
}
],
"ApplicationId": "xx",
"EnvironmentName": "xx",
"ApplicationName": "xx"
}
],
"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.DefaultInternalError | The server is busy. Retry later. |
InvalidParameterValue.NamespaceNotBelongToAppid | The namespace does not belong to the current account. |
InvalidParameterValue.TemIdInvalid | The TEM ID is incorrect. |
MissingParameter.NamespaceIdNull | The environment ID can not be left empty. |
ResourceNotFound.MicroserviceOffline | The target microservice is offline. |
ResourceNotFound.VersionNamespaceNotFound | The environment corresponding to this version is not found. |
UnauthorizedOperation.UnauthorizedOperation | Not authorized |
Was this page helpful?