上报心跳
最近更新时间: 2024-10-18 10:38:40
1. 接口描述
接口请求域名： cls.api3.fincloud.tencent.cn。
上报当前采集机器的心跳
默认接口请求频率限制：20次/秒。
接口更新时间：2022-10-31 11:10:35。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：HeartBeat |
| Version | 是 | 否 | String | 公共参数，本接口取值：2020-10-16 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| AgentVersion | 是 | 否 | String | agent的版本号 |
| AgentIp | 是 | 否 | String | agent的IP地址 |
| TotalSize | 否 | 否 | Uint64 | agent采集的数据大小 |
| InstanceId | 是 | 否 | String | 实例ID |
| AgentSeq | 否 | 否 | String | agent序列号 |
| Labels | 否 | 否 | Array of String | 标签列表 |
| AutoUpdate | 否 | 否 | String | Agent是否开启自动升级功能 |
| CheckUpdate | 否 | 否 | String | 是否需要检查自动升级任务 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| UpdateInfo | AgentUpdateInfo | 此参数对外不可见。 agent升级任务信息 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | |
| MissingParameter | |
| InternalError | |
| FailedOperation | |
| AuthFailure | |
| OperationDenied | |
| OperationDenied.AccountIsolate | |
| OperationDenied.AccountDestroy | |
| OperationDenied.AccountNotExists |