1. 接口描述
接口请求域名： cls.api3.fincloud.tencent.cn。
本接口用于获取告警任务历史
默认接口请求频率限制：100次/秒。
接口更新时间：2025-01-17 19:54:57。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：GetAlarmLog |
| Version | 是 | 否 | String | 公共参数，本接口取值：2020-10-16 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| From | 是 | 否 | Int64 | 要查询的日志的起始时间，Unix时间戳，单位ms 示例值： 1702569600000 |
| To | 是 | 否 | Int64 | 要查询的日志的结束时间，Unix时间戳，单位ms 示例值： 1702655999999 |
| Query | 是 | 否 | String | 查询语句，语句长度最大为1024 示例值： alert_id:notice-dd1e5d83-fee5-cd35-ac57-20823c21b8cd |
| Limit | 否 | 否 | Int64 | 单次查询返回的执行详情条数，最大值为1000 示例值： 100 |
| Context | 否 | 否 | String | 透传上次接口返回的Context值，可获取后续更多日志，总计最多可获取1万条原始日志，过期时间1小时。 注意： 透传该参数时，请勿修改除该参数外的其它参数 仅当检索分析语句(Query)不包含SQL时有效，SQL获取后续结果参考SQL LIMIT语法 示例值： context |
| Sort | 否 | 否 | String | 原始日志是否按时间排序返回；可选值：asc(升序)、desc(降序)，默认为 desc 注意： 仅当检索分析语句(Query)不包含SQL时有效 SQL结果排序方式参考SQL ORDER BY语法 示例值： asc |
| UseNewAnalysis | 否 | 否 | Bool | true：代表使用新的检索结果返回方式，输出参数AnalysisRecords和Columns有效； false：代表使用老的检索结果返回方式，输出AnalysisResults和ColNames有效； 两种返回方式在编码格式上有少量区别，建议使用true。 示例值： false |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Context | String | 加载后续内容的Context 示例值： eda234f5-e060-483a-b1a1-1f76208dcb2b:eda234f5-e060-483a-b1a1-1f76208dcb2b@30@1732020030000000@1732020930000000:10 |
| ListOver | Bool | 指定时间范围内的告警执行详情是否完整返回 示例值： false |
| Analysis | Bool | 返回的结果是否为SQL分析结果 示例值： 1 |
| ColNames | Array of String | 分析结果的列名，如果Query语句有SQL查询，则返回查询字段的列名； 否则为空。 示例值： ["time","pv","uv"] |
| Results | Array of LogInfo | 执行详情查询结果。 当Query字段无SQL语句时，返回查询结果。 当Query字段有SQL语句时，可能返回null。 示例值：查看 |
| AnalysisResults | Array of LogItems | 执行详情统计分析结果。当Query字段有SQL语句时，返回SQL统计结果，否则可能返回null。 示例值：查看 |
| AnalysisRecords | Array of String | 执行详情统计分析结果；UseNewAnalysis为true有效。 示例值： ["status:200"] |
| Columns | Array of Column | 分析结果的列名， UseNewAnalysis为true有效 示例值：查看 |
| Query | String | 返回语法优化后的语句（入参如有QueryOptimize 且为 1 时返回，其他情况返回空字符串） 示例值： alert_id:notice-57f5808c-4a55-11eb-b378-0242ac130002 |
| SamplingRate | Float | 当前系统使用的采样率，入参如有SamplingRate时生效（主要是当客户输入0时，返回真实后台的AutoSamplingRate值） 示例值： 0.1 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| MissingParameter | 缺少参数错误。 |
| InternalError | 内部错误。 |
| FailedOperation | 操作失败。 |
| OperationDenied | 操作被拒绝。 |
| ResourceNotFound.TopicNotExist | 日志主题不存在。 |
| FailedOperation.SearchTimeout | 查询超时。 |
| FailedOperation.TopicIsolated | 日志主题已隔离。 |
| FailedOperation.QueryError | 查询语句运行失败。 |
| FailedOperation.InvalidContext | 检索游标已失效或不存在。 |
| FailedOperation.GetlogReachLimit | 检索日志触发最大条数限制。 |
| FailedOperation.SyntaxError | 查询语句解析错误。 |
| LimitExceeded.LogSearch | 并发查询超过限制，单topic并发最大值15。 |
| OperationDenied.AccountIsolate | 账户欠费。 |
| OperationDenied.AccountDestroy | 账户已销毁。 |
| OperationDenied.AccountNotExists | 账户不存在。 |