1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
告警接收人详情
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeAlarmReceiver。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| AlarmId | 是 | String | 告警ID 示例值：8726 |
| PageNumber | 是 | Integer | 当前页 示例值：1 |
| PageSize | 是 | Integer | 每页记录数 示例值：10 |
| ProjectId | 是 | String | 项目ID 示例值：9867 |
| TaskType | 否 | Integer | 类型 示例值：201 |
| AlarmRecipient | 否 | String | 告警接收人ID(逗号分隔) 示例值：8675 |
| AlarmRecipientName | 否 | String | 告警接收人姓名(逗号分隔) 示例值：jtyhdf |
| AlarmTime | 否 | String | 告警时间 示例值：2022-02-02 11:11:11 |
| MessageId | 否 | String | 消息ID 示例值：1213421 |
| RecordId | 否 | Integer | 告警记录id 示例值：100 |
| MonitorType | 否 | Integer | 监控对象类型(1:所有任务,2:指定任务,3:指定责任人,4:指定资源组) 示例值：4 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| AlarmReceiverInfoList | Array of AlarmReceiverInfo | 告警接收人列表 注意：此字段可能返回 null，表示取不到有效值。 |
| TotalCount | Integer | 总记录数 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 告警接收人详情
告警接收人详情
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAlarmReceiver
<公共请求参数>
{
"AlarmRecipientName": "用户A",
"PageSize": 1,
"ProjectId": "12948023",
"MessageId": "124089323",
"AlarmTime": "2023-11-10 18:31:06",
"AlarmId": "1",
"PageNumber": 1,
"TaskType": 1,
"AlarmRecipient": "887"
}输出示例
{
"Response": {
"AlarmReceiverInfoList": [
{
"Http": 1,
"Sms": 1,
"AlarmId": "1",
"Wechat": 1,
"AlarmReceiver": "887",
"Wecom": 1,
"Voice": 1,
"Email": 1,
"WecomGroup": 1
}
],
"RequestId": "1fs3g-g0903-fsd0",
"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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.SignatureExpire | 未登录或登录已过期。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| ResourceNotFound | 资源不存在。 |
| UnsupportedOperation | 操作不支持。 |
