1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
新增或修改一条通知策略。ID > 0 表示修改;ID = 0 或不传表示新增。MemberAppIds 配置为空时,策略仅作用于当前主账号事件;非空时同时作用于自身账号 + 所列成员账号。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ModifyWebhookPolicy。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| Name | 是 | String | 策略名称 示例值:policy1 |
| Status | 是 | String | 启用状态 示例值:ON |
| NotifyItems.N | 是 | Array of WebhookNotifyItem | 通知项列表 |
| AssetScope | 是 | WebhookAssetScope | 通知资产范围 |
| ReceiveFormat | 是 | String | 接收格式 示例值:TEXT |
| ReceiverIDList.N | 是 | Array of Integer | 接收机器人 ID 列表 示例值:[19] |
| MemberId.N | 否 | Array of String | 集团账号的成员id 示例值:["mem-xxx"] |
| ID | 否 | Integer | 策略 ID。大于 0 表示修改;等于 0 或不传表示新增 示例值:5 |
| MsgLanguage | 否 | String | 推送语言 示例值:zh |
| CustomFields.N | 否 | Array of WebhookCustomField | 自定义透传字段列表 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ID | Integer | 新增或被修改的策略 ID 示例值:5 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyWebhookPolicy
<公共请求参数>
{
"Name": "policy1",
"Status": "ON",
"NotifyItems": [
{
"Module": "Alert",
"SubModule": "MALWARE_FILE",
"Levels": [
"HIGH"
]
}
],
"AssetScope": {
"AssetRange": 1
},
"ReceiveFormat": "TEXT",
"ReceiverIDList": [
19
],
"MemberId": [
"mem-xxx"
],
"ID": 5,
"MsgLanguage": "zh"
}
输出示例
{
"Response": {
"ID": 5,
"RequestId": "45347672-c912-4e38-a153-cb3cadf4eb53"
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。