@natrace-sdk/客户端-通知-v2
与通知服务API管理资源/事件通知.
安装
npm install @dynatrace-sdk/client-notification-v2
获得帮助
许可证
此 SDK 分布于 Apache 许可证,2.0版本,更多信息见LICENSE.
API 参考
最新版本SDK的API 完整参考文件也可在 Dynatrace 开发者。 。 。 .
通知
import { eventNotificationsClient } from '@dynatrace-sdk/client-notification-v2';
创建事件通知
通知 创建 Event Notification( 配置): 承诺 <事件> 翻译:
参数
回返
掷出
代码示例
import { eventNotificationsClient } from "@dynatrace-sdk/client-notification-v2";
const data =
await eventNotificationsClient.createEventNotification({
body: {
resourceId: "...",
notificationType: "...",
triggerConfiguration: {
type: "event",
value: { query: "..." },
},
},
});
删除事件通知
通知 Client.deleteEvention(配置):承诺<void>
参数
| 名称 | 类型 | 说明 |
|---|
| 配置.id*必须 | 字符串 | 一个UUID字符串识别此自通知 . |
回返
| 返回类型 | 状态代码 | 说明 |
|---|
| 无效 | 204 (韩语) | 无反应机构 |
掷出
代码示例
import { eventNotificationsClient } from "@dynatrace-sdk/client-notification-v2";
const data =
await eventNotificationsClient.deleteEventNotification({
id: "...",
});
获取终止通知
通知 Client.getEvention(配置):承诺 <事件> 翻译:
参数
| 名称 | 类型 | 说明 |
|---|
| 配置.id*必须 | 字符串 | 一个UUID字符串识别此自通知 . |
回返
掷出
代码示例
import { eventNotificationsClient } from "@dynatrace-sdk/client-notification-v2";
const data =
await eventNotificationsClient.getEventNotification({
id: "...",
});
获取事件通知
通知 Client.getEventions(配置):承诺 <标签式通知列表> 翻译:
参数
| 名称 | 类型 | 说明 |
|---|
| 配置. appId | 字符串 | 与通知有关的申请id。 可选,默认是从请求头自动推断出. 仅与手动测试目的有关,通过斯瓦克. |
| 配置.限制 | 编号 | 每页返回的结果数量. |
| 配置. 通知Type | 字符串 | 字符串,用于定义应用程序上下文中通知的类型。 允许在一个应用程序中区分多种类型的通知. |
| 配置。 关闭 | 编号 | 初始指数用来返回结果. |
| 配置. 顺序 | 字符串 | 命令结果时要使用哪个字段 . |
| 配置。 拥有者 | 字符串 | |
| 配置. 资源Id | 字符串 | 要通知的资源唯一标识符 。 用于确定在应用程序和用户通知类型中是否有已登记的资源通知. |
| 配置. 搜索 | 字符串 | 一个搜索术语. |
回返
掷出
代码示例
import { eventNotificationsClient } from "@dynatrace-sdk/client-notification-v2";
const data =
await eventNotificationsClient.getEventNotifications();
补丁事件通知
通知 Client.patchEvention(配置):承诺 <事件> 翻译:
参数
| 名称 | 类型 | 说明 |
|---|
| 配置. 身体*必须 | 事件通知日期 | |
| 配置.id*必须 | 字符串 | 一个UUID字符串识别此自通知 . |
回返
掷出
代码示例
import { eventNotificationsClient } from "@dynatrace-sdk/client-notification-v2";
const data =
await eventNotificationsClient.patchEventNotification({
id: "...",
body: {
triggerConfiguration: {
type: "event",
value: { query: "..." },
},
},
});
更新事件通知
通知 Client.update Evention(配置):承诺 <事件> 翻译:
参数
| 名称 | 类型 | 说明 |
|---|
| 配置. 身体*必须 | 事件通知日期 | |
| 配置.id*必须 | 字符串 | 一个UUID字符串识别此自通知 . |
回返
掷出
代码示例
import { eventNotificationsClient } from "@dynatrace-sdk/client-notification-v2";
const data =
await eventNotificationsClient.updateEventNotification({
id: "...",
body: {
triggerConfiguration: {
type: "event",
value: { query: "..." },
},
},
});
资源 通知
import { resourceNotificationsClient } from '@dynatrace-sdk/client-notification-v2';
创建资源通知
资源通知 创建资源通知( 配置): 承诺 <资源> 翻译:
参数
回返
掷出
代码示例
import { resourceNotificationsClient } from "@dynatrace-sdk/client-notification-v2";
const data =
await resourceNotificationsClient.createResourceNotification(
{
body: { notificationType: "...", resourceId: "..." },
},
);
删除资源
资源通知 Client.deleteResource 通知(配置):承诺<void>
参数
| 名称 | 类型 | 说明 |
|---|
| 配置. appId | 字符串 | 与通知有关的申请id。 可选,默认是从请求头自动推断出. 仅与手动测试目的有关,通过斯瓦克. |
| 配置.id*必须 | 字符串 | 定义此资源通知的UUID字符串 . |
回返
| 返回类型 | 状态代码 | 说明 |
|---|
| 无效 | 204 (韩语) | 无反应机构 |
掷出
代码示例
import { resourceNotificationsClient } from "@dynatrace-sdk/client-notification-v2";
const data =
await resourceNotificationsClient.deleteResourceNotification(
{ id: "..." },
);
删除资源通知
资源通知 Client.deleteResource 通知 ByTypeAndResource(配置):承诺<void>
参数
| 名称 | 类型 | 说明 |
|---|
| 配置. appId | 字符串 | 与通知有关的申请id。 可选,默认是从请求头自动推断出. 仅与手动测试目的有关,通过斯瓦克. |
| 配置. 通知Type*必须 | 字符串 | 字符串,用于定义应用程序上下文中通知的类型。 允许在一个应用程序中区分多种类型的通知. |
| 配置. 资源Id*必须 | 字符串 | 要通知的资源唯一标识符 。 用于确定在应用程序和用户通知类型中是否有已登记的资源通知. |
回返
| 返回类型 | 状态代码 | 说明 |
|---|
| 无效 | 204 (韩语) | 无反应机构 |
掷出
代码示例
import { resourceNotificationsClient } from "@dynatrace-sdk/client-notification-v2";
const data =
await resourceNotificationsClient.deleteResourceNotificationByTypeAndResource(
{ notificationType: "...", resourceId: "..." },
);
获取资源
资源通知( 配置): 承诺 <资源> 翻译:
参数
| 名称 | 类型 | 说明 |
|---|
| 配置. appId | 字符串 | 与通知有关的申请id。 可选,默认是从请求头自动推断出. 仅与手动测试目的有关,通过斯瓦克. |
| 配置.id*必须 | 字符串 | 定义此资源通知的UUID字符串 . |
回返
掷出
代码示例
import { resourceNotificationsClient } from "@dynatrace-sdk/client-notification-v2";
const data =
await resourceNotificationsClient.getResourceNotification(
{ id: "..." },
);
获得资源
资源通知( 配置): 承诺 <通知列表> 翻译:
参数
| 名称 | 类型 | 说明 |
|---|
| 配置. appId | 字符串 | 与通知有关的申请id。 可选,默认是从请求头自动推断出. 仅与手动测试目的有关,通过斯瓦克. |
| 配置.限制 | 编号 | 每页返回的结果数量. |
| 配置. 通知Type | 字符串 | 字符串,用于定义应用程序上下文中通知的类型。 允许在一个应用程序中区分多种类型的通知. |
| 配置。 关闭 | 编号 | 初始指数用来返回结果. |
| 配置. 顺序 | 字符串 | 命令结果时要使用哪个字段 . |
| 配置. 资源Id | 字符串 | 要通知的资源唯一标识符 。 用于确定在应用程序和用户通知类型中是否有已登记的资源通知. |
| 配置. 搜索 | 字符串 | 一个搜索术语. |
回返
掷出
代码示例
import { resourceNotificationsClient } from "@dynatrace-sdk/client-notification-v2";
const data =
await resourceNotificationsClient.getResourceNotifications();
类型
戴维斯EventConfig
| 名称 | 类型 | 说明 |
|---|
| 自定义过滤器 | 无效 字符串 | 额外的 DQL 匹配器表达式以进一步过滤事件以匹配. 默认 : "" |
| 实体标签 | 无效 实体标签 | |
| 实体标签游戏 | 无效的"所有""任何" | |
| 维护Window Trigger行为 | "总是" "里面" "外面" | 默认 : "always" |
| 名称 | 无效QQ阵列 <戴维斯事件Name> 翻译: | |
问题关闭被否决 | 布尔 | Davis事件的触发器只开放或关闭。 已贬值的 - 使用触发 On 代替 . 默认 : false |
| 触发 | "打开" "打开" "关闭" "关闭" | 要启动事件状态 。 "开放"(只活动),"开放"和"关闭"(两个阶段),或"关闭"(只关闭). 当未设定时, 返回到 ProblemClose 上, 以进行后向相容性 . |
类型被否决 | 无效QQ阵列 <字符串> 翻译: | |
戴维斯事件Name
| 名称 | 类型 | 说明 |
|---|
| 匹配*必须 | "等分" =========================================================================================================== (========================= (================================================ (================== | Davis 事件名称必须等于或包含提供的字符串 . |
| 名称*必须 | 字符串 | |
戴维斯Event Trigger 图形
戴维斯问题类别
| 名称 | 类型 | 默认 |
|---|
| 可用性 | 布尔 | false |
| 自定义 | 布尔 | false |
| 错误 | 布尔 | false |
| 资讯 | 布尔 | false |
| 无法使用 | 布尔 | false |
| 资源 | 布尔 | false |
| 减速 | 布尔 | false |
戴维斯问题组
| 名称 | 类型 | 说明 |
|---|
| 准备 | 布尔 | 仅在第一个根源分析完成后运行 . 默认 : false |
| 类别*必须 | 戴维斯问题类别 | |
| 自定义过滤器 | 无效 字符串 | 额外的 DQL 匹配器表达式以进一步过滤事件以匹配. 默认 : "" |
| 实体标签 | 无效 实体标签 | |
| 实体标签游戏 | 无效的"所有""任何" | |
问题关闭被否决 | 布尔 | 戴维斯问题的触发器只打开或关闭。 已贬值的 - 使用触发 On 代替 . 默认 : false |
| 问题打开时间 | 无效 5,10,15,30,60,120,240,1440,10080 | 最小问题持续时间在起火前几分钟. |
| 严重性 阈值 | 无效 编号 | 触发只针对其严重程度为这一价值或更严重的问题。 人数较少更严重(1=临界,5=信息),因此有3个匹配断裂 1,2和3. |
| 触发 | "打开" "打开" "关闭" "关闭" | 问题状态启动。 "开放"(只活动),"开放"和"关闭"(两个阶段),或"关闭"(只关闭). 当未设定时, 返回到 ProblemClose 上, 以进行后向相容性 . |
| 更新字段时触发 | Array <'dt.davis. 被影响的 用户 计数'\"dt.davis. 被影响的 级别"\"活动. 类别"\"活动. 严重"\"根-因为 实体 id"\"智能scape.被影响的 实体" | 跟踪值变化的问题事件字段 。 任何选定字段的更改都会导致再触发 . |
Davis Problem Trigger 图形
按键和(可选)值匹配的实体标记 。 例如{"foo": [],"bar": ["a","b","c"]
类型: 记录 < 字符串, 字符串 {} > 字符串
错误
错误细节
信封错误
事件
事件 通知请求
事件通知日期
事件查询
| 名称 | 类型 | 说明 |
|---|
| 事件类型 | "活""活""活""活""活""活""活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活"活 | 圣杯事件类型. |
| 查询*必须 | 字符串 | DQL 匹配器表达式定义要匹配的事件 . |
事件查询
修改信息
| 名称 | 类型 |
|---|
| 创建By*必须 | 无效 字符串 |
| 创建时间*必须 | 日期 |
| 上次修改By*必须 | 无效 字符串 |
| 上次修改的时间*必须 | 日期 |
标签式通知列表
| 名称 | 类型 |
|---|
| 计数*必须 | 编号 |
| 结果*必须 | 矩阵 <事件> 翻译: |
通知列表
| 名称 | 类型 |
|---|
| 计数*必须 | 编号 |
| 结果*必须 | 矩阵 <资源> 翻译: |
资源
| 名称 | 类型 | 说明 |
|---|
| 应用 | 无效 字符串 | 注册通知的应用代号。 可选,默认是从请求中自动推断出来的。 仅与手动测试目的有关,通过斯瓦克. |
| 编号*必须 | 字符串 | |
| 修改 资讯*必须 | 修改信息 | |
| 通知类型*必须 | 字符串 | 字符串,用于定义应用程序上下文中通知的类型。 允许在一个应用程序中区分多种类型的通知. |
| 拥有用户*必须 | 字符串 | |
| 资源索引*必须 | 字符串 | 要通知的资源唯一标识符 。 用于确定在应用程序和用户通知类型中是否有已登记的资源通知. |
资源通知请求
| 名称 | 类型 | 说明 |
|---|
| 应用 | 无效 字符串 | 注册通知的应用代号。 可选,默认是从请求中自动推断出来的。 仅与手动测试目的有关,通过斯瓦克. |
| 通知类型*必须 | 字符串 | 字符串,用于定义应用程序上下文中通知的类型。 允许在一个应用程序中区分多种类型的通知. |
| 资源索引*必须 | 字符串 | 要通知的资源唯一标识符 。 用于确定在应用程序和用户通知类型中是否有已登记的资源通知. |
事件调试器配置
类型:<a href="#eventquerytrigger config" >EventQuery-trigger Config </a> <a href="#davis problemtrigger config"目标="" blank"rel="诺开尔诺开尔诺开尔诺开尔诺开尔诺开尔诺开尔诺开尔诺开尔诺开尔诺开尔诺开尔诺开尔诺开尔诺开尔诺开尔诺开尔诺开尔诺开尔诺开尔诺开尔
数字
戴维斯事件Name 游戏
⚠️ 折旧
使用字面值.
Davis 事件名称必须等于或包含提供的字符串 .
Enum 键
戴维斯EventTrigger 字体
⚠️ 折旧
使用字面值.
Davis Problem Probleg Problem 开放期限
⚠️ 折旧
使用字面值.
最小问题持续时间在起火前几分钟.
Enum 键
DavisProblemConfigProblemOpenDuration_10 | DavisProblemConfigProblemOpenDuration_10080 | DavisProblemConfigProblemOpenDuration_120 | DavisProblemConfigProblemOpenDuration_1440 | DavisProblemConfigProblemOpenDuration_15 | DavisProblemConfigProblemOpenDuration_240 | DavisProblemConfigProblemOpenDuration_30 | DavisProblemConfigProblemOpenDuration_5 | DavisProblemConfigProblemOpenDuration_60
Davis Problem Trigger 图形化
⚠️ 折旧
使用字面值.
⚠️ 折旧
使用字面值.
事件查询
⚠️ 折旧
使用字面值.
事件类型
⚠️ 折旧
使用字面值.
圣杯事件类型.
Enum 键
Bizevents | DtSystemEvents | Events | SecurityEvents
维护窗口
⚠️ 折旧
使用字面值.
根据维护窗口状态指定何时触发.
Enum 键
Always | Inside | Outside
触发
⚠️ 折旧
使用字面值.
Enum 键
Close | Open | OpenAndClose
触发更新字段
⚠️ 折旧
使用字面值.
Enum 键
DtDavisAffectedUsersCount | DtDavisImpactLevel | EventCategory | EventSeverity | RootCauseEntityId | SmartscapeAffectedEntities