@ dynatrace- sdk/ 客户端- 过滤器- 分区- 管理
圣杯的过滤-分区管理.
切片,骰子和上下文化你的数据,以方便查找,理解和配合.
安装
npm install @dynatrace-sdk/client-filter-segment-management
获得帮助
- 访问 用于打字的 SDK 指南中 Dynatrace 开发者
- 问个问题 Dynatrace社区
许可证
此 SDK 分布于 Apache 许可证,2.0版本,更多信息见LICENSE.
API 参考
最新版本SDK的API 完整参考文件也可在 Dynatrace 开发者。 。 。 .
过滤器分类
import { filterSegmentsClient } from '@dynatrace-sdk/client-filter-segment-management';
创建Filter 分区
创建一个新的过滤区.
所需范围 : 存储 : filter- segments: write
创建新段并定义数据 .
所需范围 :
storage:filter-segments:writestorage:filter-segments:share若为isPublic设置为true
新建过滤区
为过滤区提供名称和可选描述.
变量
创建变量以应用在过滤器分区数据过滤器中
包括(分部数据)
包含应用过滤器区块时应当可以访问的所有数据
公开性(可见性)
false: 过滤块是私有的, 并且只能为所有者所看到true: 过滤区块对环境中的每一个人都可见
参数
| 名称 | 类型 |
|---|---|
| 配置. 身体*必须 | 新建部分 |
回返
| 返回类型 | 状态代码 | 说明 |
|---|---|---|
| 详细 过滤区域 | 201 (韩语) | 过滤分区已成功创建 . |
掷出
| 错误类型 | 错误消息 |
|---|---|
| 信封错误 | Filter-secment Bad Request. QQ 未经授权 QQ 权限缺失 QQ 出错 . |
代码示例
import { filterSegmentsClient } from "@dynatrace-sdk/client-filter-segment-management";
const data = await filterSegmentsClient.createFilterSegment(
{
body: {
name: "dev_environment",
description:
"only includes data of the dev environment",
variables: {
type: "query",
value: "fetch logs | limit 1",
},
isPublic: false,
includes: [
{
filter:
'{"type":"Group","range":{"from":0,"to":19},"logicalOperator":"AND","explicit":false,"children":[{"type":"Statement","range":{"from":0,"to":19},"key":{"type":"Key","textValue":"content","value":"content","range":{"from":0,"to":7}},"operator":{"type":"ComparisonOperator","textValue":"=","value":"=","range":{"from":8,"to":9}},"value":{"type":"String","textValue":"\\"[debug]\\"","value":"[debug]","range":{"from":10,"to":19},"isEscaped":true}}]}',
dataObject: "logs",
},
{
filter:
'{"type":"Group","range":{"from":0,"to":18},"logicalOperator":"AND","explicit":false,"children":[{"type":"Statement","range":{"from":0,"to":18},"key":{"type":"Key","textValue":"content","value":"content","range":{"from":0,"to":7}},"operator":{"type":"ComparisonOperator","textValue":"=","value":"=","range":{"from":8,"to":9}},"value":{"type":"String","textValue":"\\"[info]\\"","value":"[info]","range":{"from":10,"to":18},"isEscaped":true}}]}',
dataObject: "events",
},
],
},
},
);
删除过滤片段
删除过滤部分.
所需范围 : 存储: filter- 分区: 删除
从环境中删除所有用户的过滤区块.
所需范围 :
storage:filter-segments:delete
参数
| 名称 | 类型 | 说明 |
|---|---|---|
| 配置. filter 组件Uid*必须 | 字符串 | 过滤单元的 UID 示例 D82a1jdA23a |
回返
| 返回类型 | 状态代码 | 说明 |
|---|---|---|
| 无效 | 204 (韩语) | 过滤分区已成功删除 . |
掷出
| 错误类型 | 错误消息 |
|---|---|
| 信封错误 | 错误请求 QQ 未经授权 QQ 权限缺失 QQ 未找到: 服务器无法找到请求的过滤区 。 QQ 发生了错误 . |
代码示例
import { filterSegmentsClient } from "@dynatrace-sdk/client-filter-segment-management";
const data = await filterSegmentsClient.deleteFilterSegment(
{ filterSegmentUid: "D82a1jdA23a" },
);
获取过滤区块
由 UID 获取过滤区域 .
所需范围 : 存储: filter- 组件: 已读
在它的UID中获取过滤块 .
所需范围 :
storage:filter-segments:read
参数
| 名称 | 类型 | 说明 |
|---|---|---|
| 配置. 添加字段 | (原始内容存档于2018-03-29) (英语). field QQ Array <"INCLUDES" "VARIALES" "EXTERNALID" "ResourceCONTEXT" | 添加额外的字段 . |
| 配置. filter 组件Uid*必须 | 字符串 | 过滤单元的 UID 示例 D82a1jdA23a |
回返
| 返回类型 | 状态代码 | 说明 |
|---|---|---|
| 详细 过滤区域 | 200个 | 过滤分区已成功检索 . |
掷出
| 错误类型 | 错误消息 |
|---|---|
| 信封错误 | 错误请求 QQ 未经授权 QQ 权限缺失 QQ 未找到: 服务器无法找到请求的过滤区 。 QQ 发生了错误 . |
代码示例
import { filterSegmentsClient } from "@dynatrace-sdk/client-filter-segment-management";
const data = await filterSegmentsClient.getFilterSegment({
filterSegmentUid: "D82a1jdA23a",
});
获取过滤组件
获取所有过滤器.
所需范围 : 存储: filter- 组件: 已读
返回所有过滤区.
如果不需要像描述那样的细节,则考虑使用 :lean 终点.
所需范围 :
storage:filter-segments:read
参数
| 名称 | 类型 | 说明 |
|---|---|---|
| 配置. 添加字段 | 无效 QQ 矩阵 < “ 变量 ” < “ 排外 ” > “ 资源 ” | 添加额外的字段 . |
回返
| 返回类型 | 状态代码 | 说明 |
|---|---|---|
| 过滤组件 | 200个 | 过滤组件已成功检索 . |
掷出
| 错误类型 | 错误消息 |
|---|---|
| 信封错误 | 错误请求 QQ 未经授权 QQ 缺少权限 QQ 发生错误 . |
代码示例
import { filterSegmentsClient } from "@dynatrace-sdk/client-filter-segment-management";
const data = await filterSegmentsClient.getFilterSegments();
获取筛选单元
获取过滤单元 -实体 -模型.
所需范围 : 存储: filter- 组件: 已读
返回过滤单元-实体-模型.
所需范围 :
storage:filter-segments:read
回返
| 返回类型 | 状态代码 | 说明 |
|---|---|---|
| 过滤区域Name spaceDto | 200个 | 过滤单元 - 实体 - 模型成功检索 . |
掷出
| 错误类型 | 错误消息 |
|---|---|
| 信封错误 | 错误请求 QQ 未经授权 QQ 缺少权限 QQ 发生错误 . |
代码示例
import { filterSegmentsClient } from "@dynatrace-sdk/client-filter-segment-management";
const data =
await filterSegmentsClient.getFilterSegmentsEntityModel();
获取 LeanFilter 组件
以最小/ 干净的形式获取所有过滤块 .
所需范围 : 存储: filter- 组件: 已读
以最小的表示形式返回所有过滤部分。 此端点节省资源 因此,可以预计在更详细的情况下,反应时间会更快 终点.
所需范围 :
storage:filter-segments:read
参数
| 名称 | 类型 | 说明 |
|---|---|---|
| 配置. 添加字段 | 无效 QQ 阵列 < "VARIABLES" < "Externalid" > "Resourcenetext" < "OWNER" > | 添加额外的字段 . |
回返
| 返回类型 | 状态代码 | 说明 |
|---|---|---|
| 倾斜部分 | 200个 | 过滤组件已成功检索 . |
掷出
| 错误类型 | 错误消息 |
|---|---|
| 信封错误 | 错误请求 QQ 未经授权 QQ 缺少权限 QQ 发生错误 . |
代码示例
import { filterSegmentsClient } from "@dynatrace-sdk/client-filter-segment-management";
const data =
await filterSegmentsClient.getLeanFilterSegments();
部分更新过滤部分
部分更新过滤部分 .
所需范围 : 存储 : filter- segments: write
更新一个或多个过滤区域.
所需范围 :
storage:filter-segments:writestorage:filter-segments:share更改isPublic改为true
以下字段可更新:
namedescriptionisPublicvariables* 联合国includes* 联合国
* 如果给出的数值被推翻.
未给定的字段将被忽略 .
参数
| 名称 | 类型 | 说明 |
|---|---|---|
| 配置. 身体*必须 | 部分更新 Filter 分区 | |
| 配置. filter 组件Uid*必须 | 字符串 | 过滤单元的 UID 示例 D82a1jdA23a |
| 配置. 乐观 LockingVersion*必须 | 编号 | 应更新的版本。 用于乐观锁. 示例 1最小值 : 0 |
回返
| 返回类型 | 状态代码 | 说明 |
|---|---|---|
| 无效 | 200个 | 过滤部分成功更新 . |
掷出
| 错误类型 | 错误消息 |
|---|---|
| 信封错误 | 错误请求 QQ 未经授权 QQ 权限缺失 QQ 未找到: 服务器无法找到请求的过滤区 。 QQ 发生了错误 . |
代码示例
import { filterSegmentsClient } from "@dynatrace-sdk/client-filter-segment-management";
const data =
await filterSegmentsClient.partiallyUpdateFilterSegment({
filterSegmentUid: "D82a1jdA23a",
optimisticLockingVersion: 1,
body: {
description:
"only includes data of the development environment",
},
});
更新过滤部分
更新过滤区域。 所有字段都将被覆盖(也有未定义或无效字段).
所需范围 : 存储 : filter- segments: write
更新一个或多个过滤区域.
所需范围 :
storage:filter-segments:writestorage:filter-segments:share更改isPublic改为true
以下字段可更新:
namedescriptionisPublicvariables* 联合国includes* 联合国
* 未给出的字段值将被推翻或删除.
提供所有其他字段的数值不变.
参数
| 名称 | 类型 | 说明 |
|---|---|---|
| 配置. 身体*必须 | 更新过滤片段 | |
| 配置. filter 组件Uid*必须 | 字符串 | 过滤单元的 UID 示例 D82a1jdA23a |
| 配置. 乐观 LockingVersion*必须 | 编号 | 应更新的版本。 用于乐观锁. 示例 1最小值 : 0 |
回返
| 返回类型 | 状态代码 | 说明 |
|---|---|---|
| 无效 | 200个 | 过滤部分成功更新 . |
掷出
| 错误类型 | 错误消息 |
|---|---|
| 信封错误 | 错误请求 QQ 未经授权 QQ 权限缺失 QQ 未找到: 服务器无法找到请求的过滤区 。 QQ 发生了错误 . |
代码示例
import { filterSegmentsClient } from "@dynatrace-sdk/client-filter-segment-management";
const data = await filterSegmentsClient.updateFilterSegment(
{
filterSegmentUid: "D82a1jdA23a",
optimisticLockingVersion: 1,
body: {
uid: "D82a1jdA23a",
name: "dev_environment",
description:
"only includes data of the development environment",
variables: {
type: "query",
value: "fetch logs | limit 1",
},
isPublic: false,
owner: "john.doe",
includes: [
{
filter:
'{"type":"Group","range":{"from":0,"to":19},"logicalOperator":"AND","explicit":false,"children":[{"type":"Statement","range":{"from":0,"to":19},"key":{"type":"Key","textValue":"content","value":"content","range":{"from":0,"to":7}},"operator":{"type":"ComparisonOperator","textValue":"=","value":"=","range":{"from":8,"to":9}},"value":{"type":"String","textValue":"\\"[debug]\\"","value":"[debug]","range":{"from":10,"to":19},"isEscaped":true}}]}',
dataObject: "logs",
},
{
filter:
'{"type":"Group","range":{"from":0,"to":18},"logicalOperator":"AND","explicit":false,"children":[{"type":"Statement","range":{"from":0,"to":18},"key":{"type":"Key","textValue":"content","value":"content","range":{"from":0,"to":7}},"operator":{"type":"ComparisonOperator","textValue":"=","value":"=","range":{"from":8,"to":9}},"value":{"type":"String","textValue":"\\"[info]\\"","value":"[info]","range":{"from":10,"to":18},"isEscaped":true}}]}',
dataObject: "events",
},
],
},
},
);
类型
自定义校验错误信息
| 名称 | 类型 |
|---|---|
| 消息*必须 | 字符串 |
详细 过滤区域
| 名称 | 类型 | 说明 |
|---|---|---|
| 允许操作 | 无效 QQ 阵列 < "READ" > "WRITE" > "DELETE" > "SHARE" > | 定义当前用户的允许操作. |
| 说明 | 无效 字符串 | 过滤片段描述. 示例 only includes data of the dev environment |
| 外部图像 | 无效 字符串 | 可选的过滤区独有标识符 。 作为代码用于 Dynathrace 配置 |
| 包含 | 无效QQ阵列 <包含> 翻译: | 包含过滤区列表. |
| 公开 | 布尔 | 说明在租户内是否可公开进入过滤区. 示例 false |
| 正在读取 | 无效 布尔 | 说明该段是否为现成. 示例 false |
| 名称*必须 | 字符串 | 过滤区的名称 . 示例 dev_environment |
| 拥有者*必须 | 字符串 | 定义过滤区的所有者. 示例 john.doe |
| 用户*必须 | 字符串 | 过滤区段的独特标识符 . 示例 D82a1jdA23a |
| 变量 | 过滤区划变量 | 滤波段的变量 . |
| 版本 | 编号 | 用于乐观地锁定. 更新请求以此定义更新数据所依据的哪个版本. 这必须与存储的版本相匹配,否则由于同时进行修改,更新将失败. 示例 1 |
信封错误
| 名称 | 类型 |
|---|---|
| 错误 | 特别回归 |
错误信息
| 名称 | 类型 |
|---|---|
| 消息*必须 | 字符串 |
特别回归
| 名称 | 类型 |
|---|---|
| 代码 | 编号 |
| 细节*必须 | 矩阵 <自定义校验错误信息 | 无效的审计事件ErrorInfo | Media Type 错误信息 | 参数错误信息 | 代理编辑器 | 查询FrontendRawErrorInfo 数据 | 请求Body Error信息> 翻译: |
| 消息*必须 | 字符串 |
过滤区域
过滤分集列表.
| 名称 | 类型 | 说明 |
|---|---|---|
| 允许操作 | 无效 QQ 阵列 < "READ" > "WRITE" > "DELETE" > "SHARE" > | 定义当前用户的允许操作. |
| 说明 | 无效 字符串 | 过滤片段描述. 示例 only includes data of the dev environment |
| 外部图像 | 无效 字符串 | 可选的过滤区独有标识符 。 作为代码用于 Dynathrace 配置 |
| 公开 | 布尔 | 说明在租户内是否可公开进入过滤区. 示例 false |
| 正在读取 | 无效 布尔 | 说明该段是否为现成. 示例 false |
| 名称*必须 | 字符串 | 过滤区的名称 . 示例 dev_environment |
| 拥有者*必须 | 字符串 | 定义过滤区的所有者. 示例 john.doe |
| 用户*必须 | 字符串 | 过滤区段的独特标识符 . 示例 D82a1jdA23a |
| 变量 | 过滤区划变量 | 滤波段的变量 . |
| 版本 | 编号 | 用于乐观地锁定. 更新请求以此定义更新数据所依据的哪个版本. 这必须与存储的版本相匹配,否则由于同时进行修改,更新将失败. 示例 1 |
过滤区域Name spaceDto
| 名称 | 类型 | 说明 |
|---|---|---|
| 允许筛选操作 | 矩阵 <过滤区块 PushDown Filterable Dto> 翻译: | 允许过滤操作 . |
| 名称*必须 | 字符串 | 名称空间. 示例 dt.entity |
| 类型 | 矩阵 <过滤区块TypeDto> 翻译: | 命名空间的类型 . |
过滤器区块
| 名称 | 类型 |
|---|---|
| 名称 | 字符串 |
| 类型 | 字符串 |
过滤区块 PushDown Filterable Dto
允许过滤操作 .
| 名称 | 类型 |
|---|---|
| 过滤器Name | 字符串 |
| 属性 | 矩阵 <字符串> 翻译: |
过滤分类关系Dto
| 名称 | 类型 |
|---|---|
| 名称 | 字符串 |
| 目标 | 字符串 |
过滤区块TypeDto
命名空间的类型 .
| 名称 | 类型 |
|---|---|
| 显示Name | 字符串 |
| 仅过滤实体 | 布尔 |
| 从字节 | 矩阵 <过滤分类关系Dto> 翻译: |
| 名称 | 字符串 |
| 属性 | 矩阵 <过滤器区块> 翻译: |
| 相关目标实体 | 布尔 |
| 有限父母财产 | 矩阵 <字符串> 翻译: |
过滤区划变量
滤波段的变量 .
| 名称 | 类型 | 说明 |
|---|---|---|
| 类型*必须 | 字符串 | 变量的类型 . |
| 价值*必须 | 字符串 | 变量的值 . |
过滤组件
| 名称 | 类型 | 说明 |
|---|---|---|
| 过滤器组件*必须 | 矩阵 <过滤区域> 翻译: | 过滤分集列表. |
包含
包含过滤区列表.
| 名称 | 类型 | 说明 |
|---|---|---|
| 应用到 | 无效QQ阵列 <字符串> 翻译: | [实验] 用于实体过滤器的表格. 示例 ["logs","events"] |
| 数据对象*必须 | 字符串 | 用于过滤器的数据对象。 使用 “ all data object” 来应用到所有数据对象 . 示例 logs |
| 过滤器*必须 | 字符串 | 数据将被此值过滤 。 字段名称必须只包含字母,数字和下划线,否则需要用引号来躲避. ("). |
| 关系 | 关系 | [实验] 当数据对象是实体视图时,必须指明的内容之间的关系. |
无效的审计事件ErrorInfo
| 名称 | 类型 |
|---|---|
| 无效的审计事件索引*必须 | 矩阵 <编号> 翻译: |
| 无效事件索引 | 矩阵 <编号> 翻译: |
| 消息*必须 | 字符串 |
精益页
过滤分集列表.
| 名称 | 类型 | 说明 |
|---|---|---|
| 允许操作 | 无效 QQ 阵列 < "READ" > "WRITE" > "DELETE" > "SHARE" > | 定义当前用户的允许操作. |
| 外部图像 | 无效 字符串 | 可选的过滤区独有标识符 。 作为代码用于 Dynathrace 配置 |
| 公开 | 布尔 | 说明在租户内是否可公开进入过滤区. 示例 false |
| 正在读取 | 无效 布尔 | 说明该段是否为现成. 示例 false |
| 名称*必须 | 字符串 | 过滤区的名称 . 示例 dev_environment |
| 拥有者 | 无效 字符串 | 定义过滤区的所有者. 示例 john.doe |
| 用户*必须 | 字符串 | 过滤区段的独特标识符 . 示例 D82a1jdA23a |
| 变量 | 过滤区划变量 | 滤波段的变量 . |
倾斜部分
| 名称 | 类型 | 说明 |
|---|---|---|
| 过滤器组件*必须 | 矩阵 <精益页> 翻译: | 过滤分集列表. |
Media Type 错误信息
| 名称 | 类型 |
|---|---|
| 消息*必须 | 字符串 |
| 支持的媒体类型*必须 | 矩阵 <字符串> 翻译: |
新建部分
| 名称 | 类型 | 说明 |
|---|---|---|
| 说明 | 无效 字符串 | 过滤片段描述. 示例 only includes data of the dev environment |
| 外部图像 | 无效 字符串 | 可选的过滤区独有标识符 。 作为代码用于 Dynathrace 配置 |
| 包含 | 无效QQ阵列 <新建插件> 翻译: | 包含过滤区列表. |
| 公开*必须 | 布尔 | 说明在租户内是否可公开进入过滤区. 示例 false |
| 名称*必须 | 字符串 | 过滤区的名称 . 示例 dev_environment |
| 变量 | 过滤区划变量 | 滤波段的变量 . |
新建插件
包含过滤区列表.
| 名称 | 类型 | 说明 |
|---|---|---|
| 应用到 | 无效QQ阵列 <字符串> 翻译: | [实验] 用于实体过滤器的表格. 示例 ["logs","events"] |
| 数据对象*必须 | 字符串 | 用于过滤器的数据对象。 使用 “ all data object” 来应用到所有数据对象 . 示例 logs |
| 过滤器*必须 | 字符串 | 数据将被此值过滤 。 字段名称必须只包含字母,数字和下划线,否则需要用引号来躲避. ("). |
| 关系 | 新关系 | [实验] 当数据对象是实体视图时,必须指明的内容之间的关系. |
新关系
[实验] 当数据对象是实体视图时,必须指明的内容之间的关系.
| 名称 | 类型 | 说明 |
|---|---|---|
| 名称*必须 | 字符串 | 关系名称. 示例 belongs_to |
| 目标*必须 | 字符串 | 关系的目标. 示例 dt.entity.host |
参数错误信息
| 名称 | 类型 |
|---|---|
| 消息*必须 | 字符串 |
| 参数描述符*必须 | 字符串 |
部分更新 Filter 分区
| 名称 | 类型 | 说明 |
|---|---|---|
| 说明 | 无效 字符串 | 过滤片段描述. 示例 only includes data of the dev environment |
| 外部图像 | 无效 字符串 | 可选的过滤区独有标识符 。 作为代码用于 Dynathrace 配置 |
| 包含 | 无效QQ阵列 <新建插件> 翻译: | 包含过滤区列表. |
| 公开 | 无效 布尔 | 说明在租户内是否可公开进入过滤区. 示例 false |
| 名称 | 无效 字符串 | 过滤区的名称 . 示例 dev_environment |
| 变量 | 过滤区划变量 | 滤波段的变量 . |
代理编辑器
| 名称 | 类型 |
|---|---|
| 消息*必须 | 字符串 |
查询FrontendRawErrorInfo 数据
| 名称 | 类型 |
|---|---|
| 消息*必须 | 字符串 |
| 原始查询出错*必须 | 字符串 |
关系
[实验] 当数据对象是实体视图时,必须指明的内容之间的关系.
| 名称 | 类型 | 说明 |
|---|---|---|
| 名称*必须 | 字符串 | 关系名称. 示例 belongs_to |
| 目标*必须 | 字符串 | 关系的目标. 示例 dt.entity.host |
请求Body Error信息
| 名称 | 类型 |
|---|---|
| 主体描述符*必须 | 字符串 |
| 消息*必须 | 字符串 |
更新过滤片段
| 名称 | 类型 | 说明 |
|---|---|---|
| 说明 | 无效 字符串 | 过滤片段描述. 示例 only includes data of the dev environment |
| 外部图像 | 无效 字符串 | 可选的过滤区独有标识符 。 作为代码用于 Dynathrace 配置 |
| 包含 | 无效QQ阵列 <新建插件> 翻译: | 包含过滤区列表. |
| 公开*必须 | 布尔 | 说明在租户内是否可公开进入过滤区. 示例 false |
| 名称*必须 | 字符串 | 过滤区的名称 . 示例 dev_environment |
| 拥有者*必须 | 字符串 | 定义过滤区的所有者. 示例 john.doe |
| 用户*必须 | 字符串 | 过滤区段的独特标识符 . 示例 D82a1jdA23a |
| 变量 | 过滤区划变量 | 滤波段的变量 . |
数字
详细筛选分组 全部操作项目
⚠️ 折旧 使用字面值.
定义当前用户的允许操作.
Enum 键
Delete | Read | Share | Write
FilterSegment Alloaded 操作项目
⚠️ 折旧 使用字面值.
定义当前用户的允许操作.
Enum 键
Delete | Read | Share | Write
GetFilter 分类查询栏目
⚠️ 折旧 使用字面值.
Enum 键
Externalid | Includes | Resourcecontext | Variables
GetFilter 组件查询
⚠️ 折旧 使用字面值.
Enum 键
Externalid | Resourcecontext | Variables
Get LeanFilter 组件查询栏目
⚠️ 折旧 使用字面值.
Enum 键
Externalid | Owner | Resourcecontext | Variables
项目
⚠️ 折旧 使用字面值.
定义当前用户的允许操作.
Enum 键
Delete | Read | Share | Write