公告
产品动态
Domain name for API request: tem.intl.tencentcloudapi.com.
This API is to query the list of running applications.
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: DescribeApplications. |
| 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. |
| EnvironmentId | No | String | ID of the environment |
| Limit | No | Integer | Pagination limit |
| Offset | No | Integer | Pagination offset |
| SourceChannel | No | Integer | Source channel. Please keep the default value. |
| ApplicationId | No | String | Application ID |
| Keyword | No | String | Keyword for searching. |
| Filters.N | No | Array of QueryFilter | Filters for query |
| SortInfo | No | SortType | Sorting field |
| Parameter Name | Type | Description |
|---|---|---|
| Result | ServicePage | Returned result. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example show you how to obtain the list of running applications.
POST / HTTP/1.1
Host: tem.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApplications
<Common request parameters>
{}{
"Response": {
"Result": {
"Current": 0,
"Records": [
{
"ApplicationName": "xx",
"EnvironmentId": "xx",
"HasAuthority": true,
"ModifyDate": "2020-09-22 00:00:00",
"Description": "xx",
"Creator": "xx",
"InstanceId": "xx",
"CreateDate": "2020-09-22 00:00:00",
"ActiveVersions": [
{
"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"
}
],
"DeployMode": "xx",
"RepoType": 0,
"RepoName": "xx",
"EnableTracing": 1,
"Tags": [
{
"TagKey": "xx",
"TagValue": "xx"
}
],
"Modifier": "xx",
"ApplicationId": "xx",
"CodingLanguage": "xx",
"EnvironmentName": "xx"
}
],
"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. |
| ResourceNotFound.MicroserviceOffline | The target microservice is offline. |
| ResourceNotFound.VersionNamespaceNotFound | The environment corresponding to this version is not found. |
文档反馈