1. 接口描述
接口请求域名： lighthouse.tencentcloudapi.com 。
查询实例内的容器列表。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDockerContainers。 |
| Version | 是 | String | 公共参数，本接口取值：2020-03-24。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例ID。 示例值：lhins-nwycpjl3 |
| ContainerIds.N | 否 | Array of String | 容器ID列表。 示例值：["edbc15ffac7074bf28cbc6071f422f90029154aefd9bf0392f33b247a3577a57"] |
| Limit | 否 | Integer | 返回数量，默认为 20，最大值为 100。 示例值：20 |
| Offset | 否 | Integer | 偏移量，默认为 0。 示例值：0 |
| Filters.N | 否 | Array of Filter | 过滤器列表。 类型：String 必选：否 类型：String 必选：否 每次请求的 Filters 的上限为 10，Filter.Values 的上限为 5。参数不支持同时指定 ContainerIds 和 Filters。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 总数量。 示例值：1 |
| DockerContainerSet | Array of DockerContainer | 容器列表。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询Docker容器列表
查询Docker容器列表
输入示例
POST / HTTP/1.1
Host: lighthouse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDockerContainers
<公共请求参数>
{
"InstanceId": "lhins-nwycpjl3"
}输出示例
{
"Response": {
"DockerContainerSet": [
{
"Command": "/docker-entrypoint.sh nginx -g 'daemon off;'",
"ContainerId": "edbc15ffac7074bf28cbc6071f422f90029154aefd9bf0392f33b247a3577a57",
"ContainerImage": "nginx",
"ContainerName": "mynginx",
"CreatedTime": "2021-07-13T08:09:27Z",
"PublishPortSet": [
{
"ContainerPort": 80,
"HostPort": 8081,
"Ip": "0.0.0.0",
"Protocol": "tcp"
}
],
"State": "running",
"Status": "Up 19 hours",
"VolumeSet": [
{
"ContainerPath": "/data/container",
"HostPath": "/data/host"
}
]
}
],
"RequestId": "54ff6139-244a-4074-938a-26b5d321d4c1",
"TotalCount": 1
}
}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.DockerContainersListTooLarge | 容器列表过长。 |
| FailedOperation.DockerOperationFailed | 指定Docker环境操作失败, 请检查Docker环境。 |
| FailedOperation.TATInvocationNotFinished | TAT命令未完成。 |
| InternalError | 内部错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.LimitExceeded | 参数值非法，参数值的数量超过最大限制。 |
| InvalidParameterValue.TooLarge | 参数值非法，大于有效值。 |
| InvalidParameterValue.TooLong | 参数取值过长，超过最大长度。 |
| ResourceNotFound.InstanceNotFound | 实例不存在。 |
| ResourceNotFound.RoleNotFound | 服务角色不存在, 请为账号添加这个角色。 |
| ResourceUnavailable.BlueprintInvalid | 指定实例镜像不符合要求。 |
| ResourceUnavailable.DockerUnavailable | Docker资源不可用。 |
| ResourceUnavailable.TATAgentUnavailable | TAT agent不可用。 |
| ResourceUnavailable.TATServiceError | TAT 服务错误。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.InvalidToken | 无效 Token。 |
| UnsupportedOperation.InvalidInstanceState | 不支持的操作，实例状态不合法。 |
| UnsupportedOperation.LatestOperationUnfinished | 不支持的操作，实例最近一次的操作尚未完成。 |