1. 接口描述
接口请求域名： weilingwith.tencentcloudapi.com 。
变更告警状态
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ChangeAlarmStatus。 |
| Version | 是 | String | 公共参数，本接口取值：2023-04-27。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Id | 是 | String | 告警的id，返回的列表中的id 示例值：40b52dda-c596-4510-84c4-a5e1aa6ae359 |
| Status | 是 | String | 告警状态 processed unprocessed processing misreport shield 示例值：processed |
| ProcessTime | 是 | Integer | 告警处理时间 示例值：1683343450674 |
| ProcessType | 是 | String | 处理类型 示例值：kill_warning-other |
| WorkspaceId | 是 | Integer | 工作空间id 示例值：1016 |
| UserId | 是 | String | 当前操作用户id 示例值：1 |
| UserName | 是 | String | 当前操作用户名称 示例值：atest |
| ApplicationToken | 是 | String | 应用token 示例值：xxx |
| Processor | 否 | String | 平台告警处理人 示例值：a |
| ProcessDescription | 否 | String | 告警处理的描述信息 示例值：描述 |
| ProcessExtend | 否 | String | 告警处理的扩展信息，可以为JSON字符串 示例值：aaa |
| ExtendOne | 否 | String | 扩展字段1，目前存的应用告警处理人 示例值：extend |
| ApplicationId | 否 | Integer | 应用id 示例值：123 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | EmptyRes | 返回空结果 示例值：{"Msg":"ok"} |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 变更告警状态
成功响应
输入示例
POST / HTTP/1.1
Host: weilingwith.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChangeAlarmStatus
<公共请求参数>
{
"Id": "40b52dda-c596-4510-84c4-a5e1aa6ae359",
"Status": "processed",
"ProcessTime": 1693416387,
"ProcessType": "kill_warning",
"WorkspaceId": 1016,
"UserId": "1",
"UserName": "a",
"ApplicationToken": "YVySZSL1Lp5UtSJ5uJVLJYOKDEGfCCH2"
}输出示例
{
"Response": {
"RequestId": "9544b470-8b37-4aeb-b7ea-d6cb0175ada1",
"Result": {
"Msg": "ok"
}
}
}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.ApiRuleConfigError | Api规则配置信息错误 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InvalidAlarmContent | 告警content无效 |
| InvalidParameter.StatusNotMatchProcessType | 状态与处理类型不符 |
| InvalidParameterValue.InvalidAlarmStatus | 告警状态无效 |
| InvalidParameterValue.InvalidTenantId | metadata租户信息无效 |
| InvalidParameterValue.InvalidWorkspaceId | 错误的工作空间Id |
| MissingParameter.EmptyAlarmId | 告警id为空 |
| OperationDenied.ApiPermissionDenied | Api没有操作权限 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.AlarmIDNotFound | 告警id找不到 |
| UnauthorizedOperation.UnauthorizedApi | 应用api的数据授权未配置，请先配置权限 |