本接口用于创建告警推送的联系人
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
sysom:CreateAlertDestination |
create |
*全部资源
|
无 | 无 |
请求语法
POST /api/v1/alertPusher/alert/createDestination HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| body |
object |
否 |
请求 Body |
|
| app_id |
string |
否 |
||
| app_secret |
string |
否 |
||
| group_id |
array |
否 |
||
|
string |
否 |
|||
| imbot |
boolean |
否 |
||
| name |
string |
否 |
告警联系人名称 |
test_name |
| params |
object |
否 |
告警联系人配置参数 |
|
|
string |
否 |
邮件 |
xxx@email.com |
|
| phone |
string |
否 |
电话 |
1xxx |
| sec |
string |
否 |
机器人密钥 |
SECxxx |
| webhook |
string |
否 |
机器人链接 |
https://oapi.dingtalk.com/robot/send?access_token=xxx |
| source |
string |
否 |
配置来源 |
console |
| target |
string |
否 |
推送目标,目前仅支持钉钉机器人 |
dingtalk |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| code |
string |
错误码 |
Success |
| data |
object |
返回数据。 |
|
| createdAt |
integer |
创建时间。 |
1753669116286 |
| id |
integer |
策略 ID |
1 |
| name |
string |
策略名称 |
SysOM |
| params |
object |
告警联系人配置参数 |
|
|
string |
邮箱 |
xxx@email.com |
|
| phone |
string |
电话 |
1xxx |
| sec |
string |
机器人密钥 |
SECxxx |
| webhook |
string |
机器人地址 |
https://oapi.dingtalk.com/robot/send?access_token=xxx |
| source |
string |
配置来源 |
console |
| target |
string |
推送目标,目前仅支持钉钉机器人 |
dingtalk |
| uid |
string |
用户 ID |
1222933234714935 |
| updatedAt |
integer |
更新时间 |
1751254826285 |
| message |
string |
错误信息
|
SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict |
| requestId |
string |
请求 ID。 |
2D693121-C925-5154-8DF6-C09A8B369822 |
示例
正常返回示例
JSON格式
{
"code": "Success",
"data": {
"createdAt": 1753669116286,
"id": 1,
"name": "SysOM",
"params": {
"email": "xxx@email.com",
"phone": "1xxx",
"sec": "SECxxx",
"webhook": "https://oapi.dingtalk.com/robot/send?access_token=xxx"
},
"source": "console",
"target": "dingtalk",
"uid": "1222933234714935",
"updatedAt": 1751254826285
},
"message": "SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict",
"requestId": "2D693121-C925-5154-8DF6-C09A8B369822\n"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | Sysom.ServerError | Server error, please correct the code according to the error message. %s. | 服务端错误,请根据错误提示信息修正代码 |
| 400 | SysomOpenAPI.ServerError | Server error, please correct the code according to the error message. | 服务端错误,请根据错误提示信息修正代码 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。