- 产品动态
- 产品简介
- 购买指南
- 快速入门
- 操作指南
- 实践教程
- API 文档
- 常见问题
- 联系我们
- 词汇表
- 产品动态
- 产品简介
- 购买指南
- 快速入门
- 操作指南
- 实践教程
- API 文档
- 常见问题
- 联系我们
- 词汇表
1. API Description
Domain name for API request: tem.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.
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: 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 |
3. Output Parameters
| 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. |
4. Example
Example1 Obtaining the list of running applications
This example show you how to obtain the list of running applications.
Input Example
POST / HTTP/1.1
Host: tem.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApplications
<Common request parameters>
{}
Output Example
{
"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"
}
}
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 |
|---|---|
| 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. |
是
否
本页内容是否解决了您的问题？