1. 接口描述
接口请求域名: lighthouse.tencentcloudapi.com 。
查询实例内的Docker活动列表。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeDockerActivities。 |
Version | 是 | String | 公共参数,本接口取值:2020-03-24。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 实例ID。可通过DescribeInstances接口返回值中的InstanceId获取。 示例值:lhins-nwycpjl3 |
ActivityIds.N | 否 | Array of String | Docker活动ID列表。可通过DescribeDockerActivities接口返回值中的ActivityId获取。 示例值:["lhda-nn82v77w"] |
Offset | 否 | Integer | 偏移量,默认为 0。 示例值:0 |
Limit | 否 | Integer | 返回数量,默认为 20,最大值为 100。 示例值:20 |
CreatedTimeBegin | 否 | Integer | 活动创建时间的起始值,时间戳秒数。 示例值:1553056487 |
CreatedTimeEnd | 否 | Integer | 活动创建时间的结束值,时间戳秒数。 示例值:1553056687 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 总数量。 示例值:1 |
DockerActivitySet | Array of DockerActivity | Docker活动列表。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询Docker容器列表
输入示例
POST / HTTP/1.1
Host: lighthouse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDockerActivities
<公共请求参数>
{
"ActivityIds": [
"lhda-nn82v77w"
],
"InstanceId": "lhins-nwycpjl3"
}
输出示例
{
"Response": {
"DockerActivitySet": [
{
"ActivityCommandOutput": "ODM4YjA3ODE5MjVmOGVhOThmZjE4MzFjNjBmMWU2MTc4YzIxOTIzMTkyZWM3NzNjYjBjYjg0MjdmZTE5NmZhMwo=",
"ActivityId": "lhda-8jkefl3i",
"ActivityName": "RestartDockerContainers",
"ActivityState": "SUCCESS",
"ContainerIds": [
"838b0781925f8ea98ff1831c60f1e6178c21923192ec773cb0cb8427fe196fa3"
],
"CreatedTime": "2021-07-13T08:08:00Z",
"EndTime": "2021-07-13T08:08:06Z"
}
],
"RequestId": "6d88ebe5-9267-41af-9797-cb02603b6909",
"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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.FieldsCompare | 列值不正确。 |
InvalidParameterValue.LimitExceeded | 参数值非法,参数值的数量超过最大限制。 |
InvalidParameterValue.TooLong | 参数取值过长,超过最大长度。 |
ResourceUnavailable.BlueprintInvalid | 指定实例镜像不符合要求。 |
ResourceUnavailable.DockerUnavailable | Docker资源不可用。 |
UnauthorizedOperation | 未授权操作。 |
UnauthorizedOperation.InvalidToken | 无效 Token。 |
UnsupportedOperation.InvalidInstanceState | 不支持的操作,实例状态不合法。 |
UnsupportedOperation.LatestOperationUnfinished | 不支持的操作,实例最近一次的操作尚未完成。 |