1. 接口描述
接口请求域名： tem.tencentcloudapi.com 。
单环境下所有应用状态查看
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeApplicationsStatus。 |
| Version | 是 | String | 公共参数，本接口取值：2021-07-01。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| EnvironmentId | 是 | String | 环境ID 示例值：en-xxxxxx |
| SourceChannel | 否 | Integer | 来源渠道 示例值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | Array of ServiceVersionBrief | 返回结果 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 单环境下所有应用状态查看
单环境下所有应用状态查看
输入示例
POST / HTTP/1.1
Host: tem.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApplicationsStatus
<公共请求参数>
{
"SourceChannel": 0,
"EnvironmentId": "en-xxxxxx"
}输出示例
{
"Response": {
"RequestId": "dda3b8c7-b536-4842-92a2-6756688a337e",
"Result": [
{
"VersionName": "bj",
"VersionId": "revision-jbzmeq7j",
"Status": "normal",
"BatchDeployStatus": "",
"EnableEs": -1,
"LogOutputConf": null,
"ExpectedInstances": 1,
"CurrentInstances": 1,
"DeployMode": "JAR",
"BuildTaskId": "build-5enzamz5",
"EnvironmentId": "en-dpxydml5",
"EnvironmentName": "bugfix-bj",
"ApplicationId": "app-5vaz8x85",
"ApplicationName": "app0925",
"Zones": [
"ap-beijing-3"
],
"NodeInfos": [
{
"Name": "eklet-subnet-1ebj4rp9-766511",
"Zone": "ap-beijing-3",
"SubnetId": "subnet-1ebj4rp9",
"AvailableIpCount": "232",
"Cidr": "10.0.0.0-24"
}
],
"PodList": {
"Offset": -1,
"Limit": -1,
"TotalCount": 1,
"PodList": [
{
"Zone": "ap-beijing-3",
"NodeInfo": {
"Name": "eklet-subnet-1ebj4rp9-766511",
"Zone": "ap-beijing-3",
"SubnetId": "subnet-1ebj4rp9",
"AvailableIpCount": "232",
"Cidr": "10.0.0.0-24"
},
"DeployVersion": "",
"RestartCount": 0,
"Ready": true,
"StartTime": "2024-09-25T03:39:59Z",
"ContainerState": "running",
"Unhealthy": null,
"UnhealthyWarningMsg": "",
"VersionId": "revision-jbzmeq7j",
"ApplicationName": "app0925",
"Status": "Running",
"CreateTime": "2024-09-25T03:39:08Z",
"Webshell": "https://tkecache.cloud.tencent.com/xxx",
"PodId": "app0925-p728w",
"PodIp": "10.0.0.7"
}
],
"RequestId": ""
},
"WorkloadInfo": {
"ApplicationName": "app0925",
"ClusterId": "cls-1trz6x5l",
"VersionName": "bj",
"ReadyReplicas": 1,
"Replicas": 1,
"UpdatedReplicas": 1,
"UpdatedReadyReplicas": 1,
"UpdateRevision": "app0925-868b68987",
"CurrentRevision": "app0925-868b68987"
},
"CreateDate": null,
"UnderDeploying": false,
"RegionId": "8"
},
{
"VersionName": "hello-world",
"VersionId": "revision-jordnl7j",
"Status": "normal",
"BatchDeployStatus": "",
"EnableEs": -1,
"LogOutputConf": null,
"ExpectedInstances": 1,
"CurrentInstances": 1,
"DeployMode": "IMAGE",
"BuildTaskId": "",
"EnvironmentId": "en-dpxydml5",
"EnvironmentName": "bugfix-bj",
"ApplicationId": "app-57477ag5",
"ApplicationName": "bugfix-test",
"Zones": [
"ap-beijing-3"
],
"NodeInfos": [
{
"Name": "eklet-subnet-1ebj4rp9-766511",
"Zone": "ap-beijing-3",
"SubnetId": "subnet-1ebj4rp9",
"AvailableIpCount": "232",
"Cidr": "10.0.0.0-24"
}
],
"PodList": {
"Offset": -1,
"Limit": -1,
"TotalCount": 1,
"PodList": [
{
"Zone": "ap-beijing-3",
"NodeInfo": {
"Name": "eklet-subnet-1ebj4rp9-766511",
"Zone": "ap-beijing-3",
"SubnetId": "subnet-1ebj4rp9",
"AvailableIpCount": "232",
"Cidr": "10.0.0.0-24"
},
"DeployVersion": "",
"RestartCount": 0,
"Ready": true,
"StartTime": "2024-08-05T08:15:26Z",
"ContainerState": "running",
"Unhealthy": null,
"UnhealthyWarningMsg": "",
"VersionId": "revision-jordnl7j",
"ApplicationName": "bugfix-test",
"Status": "Running",
"CreateTime": "2024-08-05T08:14:28Z",
"Webshell": "https://tkecache.cloud.tencent.com/xxx",
"PodId": "bugfix-test-lvn56",
"PodIp": "10.0.0.16"
}
],
"RequestId": ""
},
"WorkloadInfo": {
"ApplicationName": "bugfix-test",
"ClusterId": "cls-1trz6x5l",
"VersionName": "hello-world",
"ReadyReplicas": 1,
"Replicas": 1,
"UpdatedReplicas": 1,
"UpdatedReadyReplicas": 1,
"UpdateRevision": "bugfix-test-648f6b456d",
"CurrentRevision": "bugfix-test-648f6b456d"
},
"CreateDate": null,
"UnderDeploying": false,
"RegionId": "8"
}
]
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.DefaultInternalError | 服务器繁忙,请稍后再试。 |
| InvalidParameterValue.NamespaceNotBelongToAppid | 命名空间不属于用户。 |
| InvalidParameterValue.TemIdInvalid | 不是合法的TEM ID。 |
| MissingParameter.NamespaceIdNull | 环境ID不能为空。 |
| ResourceNotFound.MicroserviceOffline | 目标微服务已离线。 |
| ResourceNotFound.VersionNamespaceNotFound | 找不到版本对应的环境。 |
| UnauthorizedOperation.UnauthorizedOperation | 未授权。 |
