1. 接口描述
接口请求域名： tem.tencentcloudapi.com 。
获取应用实例列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeApplicationPods。 |
| Version | 是 | String | 公共参数，本接口取值：2021-07-01。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| EnvironmentId | 是 | String | 环境id 示例值：en-xxxxxx |
| ApplicationId | 是 | String | 应用id 示例值：app-xxxxxx |
| Limit | 否 | Integer | 单页条数，默认值20 示例值：10 |
| Offset | 否 | Integer | 分页下标，默认值0 示例值：1 |
| Status | 否 | String | 实例状态 - Running - Pending - Error 示例值：Running |
| PodName | 否 | String | 实例名字 示例值：pod-a |
| SourceChannel | 否 | Integer | 来源渠道 示例值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | DescribeRunPodPage | 返回结果 示例值：page |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取应用实例列表
获取应用实例列表
输入示例
POST / HTTP/1.1
Host: tem.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApplicationPods
<公共请求参数>
{
"Status": "Running",
"EnvironmentId": "en-xxxxxx",
"Offset": 0,
"SourceChannel": 0,
"Limit": 20,
"PodName": "pod-name-xxx",
"ApplicationId": "app-xxxxxx"
}输出示例
{
"Response": {
"RequestId": "0f09d0d3-3414-48ba-b8cc-e1c543b1fc1a",
"Result": {
"Offset": 0,
"Limit": 3,
"TotalCount": 3,
"PodList": [
{
"Zone": "ap-shanghai-2",
"NodeInfo": {
"Name": "eklet-subnet-kctzw7nj-711231",
"Zone": "ap-shanghai-2",
"SubnetId": "subnet-kctzw7nj",
"AvailableIpCount": "243",
"Cidr": "10.0.10.0-24"
},
"DeployVersion": "20241202165113",
"RestartCount": 0,
"Ready": false,
"StartTime": "2024-12-20T09:01:01Z",
"ContainerState": "waiting",
"Unhealthy": null,
"UnhealthyWarningMsg": "",
"VersionId": "revision-jorxnl6j",
"ApplicationName": "app0925",
"Status": "CrashLoopBackOff",
"CreateTime": "2024-12-20 17:00:23",
"Webshell": "https://tkecache.cloud.tencent.com/xxx",
"PodId": "app0925-4sbct",
"PodIp": "10.0.10.220"
},
{
"Zone": "ap-shanghai-2",
"NodeInfo": {
"Name": "eklet-subnet-qau65gm1-638453",
"Zone": "ap-shanghai-2",
"SubnetId": "subnet-qau65gm1",
"AvailableIpCount": "246",
"Cidr": "10.0.20.0-24"
},
"DeployVersion": "20241202165113",
"RestartCount": 0,
"Ready": false,
"StartTime": "2024-12-20T09:01:11Z",
"ContainerState": "waiting",
"Unhealthy": null,
"UnhealthyWarningMsg": "",
"VersionId": "revision-jorxnl6j",
"ApplicationName": "app0925",
"Status": "CrashLoopBackOff",
"CreateTime": "2024-12-20 17:00:23",
"Webshell": "https://tkecache.cloud.tencent.com/xxx",
"PodId": "app0925-s4vpj",
"PodIp": "10.0.20.37"
},
{
"Zone": "ap-shanghai-2",
"NodeInfo": {
"Name": "eklet-subnet-8indzsuv-457482",
"Zone": "ap-shanghai-2",
"SubnetId": "subnet-8indzsuv",
"AvailableIpCount": "226",
"Cidr": "10.0.30.0-24"
},
"DeployVersion": "20241202165113",
"RestartCount": 0,
"Ready": true,
"StartTime": "2024-12-19T03:12:44Z",
"ContainerState": "running",
"Unhealthy": null,
"UnhealthyWarningMsg": "",
"VersionId": "revision-57moqvm5",
"ApplicationName": "app0925",
"Status": "Running",
"CreateTime": "2024-12-19 11:11:32",
"Webshell": "https://tkecache.cloud.tencent.com/xxx",
"PodId": "app0925-jt5bn",
"PodIp": "10.0.30.158"
}
],
"RequestId": "0f09d0d3-xxx-xxx-xxx"
}
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.DefaultInternalError | 服务器繁忙,请稍后再试。 |
| FailedOperation.DescribeRunPodListError | 查询实例信息失败。 |
| InternalError.DefaultInternalError | 服务器繁忙,请稍后再试。 |
| InternalError.DescribeRunPodListError | 查询实例信息失败。 |
| InvalidParameterValue.NamespaceNotBelongToAppid | 命名空间不属于用户。 |
| InvalidParameterValue.TemIdInvalid | 不是合法的TEM ID。 |
| ResourceNotFound.MicroserviceOffline | 目标微服务已离线。 |
| ResourceNotFound.ServiceNotFound | 找不到应用。 |
| ResourceNotFound.ServiceRunningVersionNotFound | 找不到运行的服务实例。 |
| ResourceNotFound.VersionNamespaceNotFound | 找不到版本对应的环境。 |
| UnauthorizedOperation.UnauthorizedOperation | 未授权。 |
