创建通知订阅。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求语法
POST /notify/subscription/create HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| body | object | 否 | 请求 Body。 | |
| subscriptionTitle | string | 是 | 通知订阅名称。 | testSubscription |
| scope | long | 是 | 订阅范围类型。 | SERVICE |
| notifyObjectType | long | 是 | 通知对象类型。 | USER |
| expiredType | long | 是 | 订阅时效。 | LONG_TERM |
| period | string | 否 | 短期时间段。 | 20天 |
| scopeObjectList | array<object> | 是 | 订阅范围列表。 | |
| object | 是 | 订阅范围对象。 | ||
| scopeObjectId | long | 是 | 订阅范围对象 ID。 | 1 |
| notifyObjectList | array<object> | 是 | 通知对象列表。 | |
| object | 是 | 通知对象。 | ||
| notifyObjectId | long | 是 | 通知对象 ID。 | 2 |
| notifyStrategyList | array<object> | 是 | 通知策略列表。 | |
| object | 是 | 订阅范围类型。 | ||
| instanceType | long | 是 | 订阅实例类型:
| INCIDENT |
| strategies | array<object> | 是 | 条件。json 格式,包含多个条件,如级别、影响程度、kv 格式。 | |
| object | 否 | 订阅范围。 | ||
| conditions | array<object> | 否 | 通知策略条件。 | |
| object | 否 | 订阅范围。 | ||
| effection | string | 否 | 影响范围。 | HIGH |
| problemNotifyType | string | 否 | 故障通知类型。 | PROBLEM_UPDATE |
| level | string | 否 | 等级。 | P1 |
| action | string | 否 | 动作。 | INCIDENT_TRIGGER |
| channels | string | 是 | 渠道,多个逗号分隔。 | SMS,PHONE |
| periodChannel | object | 否 | 分时段通知订阅渠道。 | |
| workday | string | 否 | 工作日通知订阅渠道。 | SMS,PHONE |
| nonWorkday | string | 否 | 非工作日通知订阅渠道。 | SMS,PHONE |
| clientToken | string | 否 | 幂等参数。 | 601FA6A2-AC5C-4B59-BE11-378FTOKENA11 |
| startTime | string | 否 | 生效开始时间。 | 2021-02-03 10:10:10 |
| endTime | string | 否 | 失效时间。 | 2021-11-03 10:10:10 |
返回参数
示例
正常返回示例
JSON格式
{
"requestId": "10REQUES-AC5C-4B59-BE11-378F117A6A88",
"data": {
"subscriptionId": 101
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 403 | NotifySubsAlreadyExists | The specified subscription already exists. | 通知订阅已存在 |
访问错误中心查看更多错误码。
