1. 接口描述
接口请求域名： cwp.tencentcloudapi.com 。
获取客户端异常事件
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeClientException。 |
| Version | 是 | String | 公共参数，本接口取值：2018-02-28。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| ExceptionType | 是 | Integer | 客户端异常类型 1:客户端离线，2:客户端卸载 示例值：1 |
| Offset | 是 | Integer | 分页的偏移量 示例值：0 |
| Limit | 是 | Integer | 分页单页限制数目，不为0，最大值100 示例值：10 |
| StartTime | 否 | String | 起始时间 2006-01-02 15:04:05 格式示例值：2006-01-02 15:04:05 |
| EndTime | 否 | String | 结束时间 2006-01-02 15:04:05 格式示例值：2006-01-02 15:04:05 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 事件总数量 示例值：944 |
| Records | Array of RecordInfo | 事件详情 示例值：[ { "HostIP": "172.23.16.2", "InstanceID": "ins-kz85kljw", "Uuid": "2e6353e4-0498-450a-9be5-77e2537247f6", "OfflineTime": "2022-04-24T17:52:37+08:00", "UninstallTime": "2020-11-21 15:16:00", "UninstallCmd": "" }, { "HostIP": "172.23.16.2", "InstanceID": "ins-kz85kljw", "Uuid": "2e6353e4-0498-450a-9be5-77e2537247f6", "OfflineTime": "2022-04-24T19:15:03+08:00", "UninstallTime": "2020-11-21 15:16:00", "UninstallCmd": "" }, { "HostIP": "172.23.16.2", "InstanceID": "ins-kz85kljw", "Uuid": "2e6353e4-0498-450a-9be5-77e2537247f6", "OfflineTime": "2022-04-24T19:30:19+08:00", "UninstallTime": "2020-11-21 15:16:00", "UninstallCmd": "" }, { "HostIP": "172.23.16.2", "InstanceID": "ins-kz85kljw", "Uuid": "2e6353e4-0498-450a-9be5-77e2537247f6", "OfflineTime": "2022-04-24T20:07:44+08:00", "UninstallTime": "2020-11-21 15:16:00", "UninstallCmd": "" }, { "HostIP": "172.23.16.2", "InstanceID": "ins-kz85kljw", "Uuid": "2e6353e4-0498-450a-9be5-77e2537247f6", "OfflineTime": "2022-04-25T10:58:57+08:00", "UninstallTime": "2020-11-21 15:16:00", "UninstallCmd": "" }, { "HostIP": "10.0.1.92", "InstanceID": "", "Uuid": "5878d9b1-6304-49a0-849b-c9f2132048a5", "OfflineTime": "2022-04-27T20:35:57+08:00", "UninstallTime": "2020-11-21 15:16:00", "UninstallCmd": "" }, { "HostIP": "10.0.0.6", "InstanceID": "ins-7pl19k95", "Uuid": "13bb1e16-9a7a-434d-9686-4328f72c97d7", "OfflineTime": "2022-05-01T00:55:13+08:00", "UninstallTime": "2020-11-21 15:16:00", "UninstallCmd": "" }, { "HostIP": "10.0.22.29", "InstanceID": "ins-g91krvsw", "Uuid": "71b1d8d3-8a69-4af6-9e95-f1637096c904", "OfflineTime": "2022-05-01T11:25:03+08:00", "UninstallTime": "2020-11-21 15:16:00", "UninstallCmd": "" }, { "HostIP": "10.0.22.29", "InstanceID": "ins-g91krvsw", "Uuid": "71b1d8d3-8a69-4af6-9e95-f1637096c904", "OfflineTime": "2022-05-01T12:29:54+08:00", "UninstallTime": "2020-11-21 15:16:00", "UninstallCmd": "" }, { "HostIP": "10.0.22.29", "InstanceID": "ins-g91krvsw", "Uuid": "71b1d8d3-8a69-4af6-9e95-f1637096c904", "OfflineTime": "2022-05-01T12:29:54+08:00", "UninstallTime": "2020-11-21 15:16:00", "UninstallCmd": "" } ] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例1
输入示例
POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClientException
<公共请求参数>
{
"EndTime": "2020-11-21 15:16:00",
"Limit": "10",
"ExceptionType": "1",
"StartTime": "2020-11-21 15:16:00",
"Offset": "0"
}输出示例
{
"Response": {
"Records": [
{
"HostIP": "172.23.16.2",
"InstanceID": "ins-kz85kljw",
"Uuid": "2e6353e4-0498-450a-9be5-77e2537247f6",
"OfflineTime": "2022-04-24T17:52:37+08:00",
"UninstallTime": "2020-11-21 15:16:00",
"UninstallCmd": "sh ******"
}
],
"RequestId": "1248a7df-c3fe-4930-b3ff-2af956cf8d66",
"TotalCount": 944
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
