@dynatrace-sdk/client-filter-segment-management

中文文档
2.0.3发布于 2026/11/10Apache-2.0TypeScriptESM + CJS近 30 天下载 1.4万
中文使用文档
文档目录49 节
  1. 安装
  2. 获得帮助
  3. 许可证
  4. 过滤器分类
  5. 创建Filter 分区
  6. 新建过滤区
  7. 删除过滤片段
  8. 获取过滤区块
  9. 获取过滤组件
  10. 获取筛选单元
  11. 获取 LeanFilter 组件
  12. 部分更新过滤部分
  13. 更新过滤部分
  14. 类型
  15. 自定义校验错误信息
  16. 详细 过滤区域
  17. 信封错误
  18. 错误信息
  19. 特别回归
  20. 过滤区域
  21. 过滤区域Name spaceDto
  22. 过滤器区块
  23. 过滤区块 PushDown Filterable Dto
  24. 过滤分类关系Dto
  25. 过滤区块TypeDto
  26. 过滤区划变量
  27. 过滤组件
  28. 包含
  29. 无效的审计事件ErrorInfo
  30. 精益页
  31. 倾斜部分
  32. Media Type 错误信息
  33. 新建部分
  34. 新建插件
  35. 新关系
  36. 参数错误信息
  37. 部分更新 Filter 分区
  38. 代理编辑器
  39. 查询FrontendRawErrorInfo 数据
  40. 关系
  41. 请求Body Error信息
  42. 更新过滤片段
  43. 数字
  44. 详细筛选分组 全部操作项目
  45. FilterSegment Alloaded 操作项目
  46. GetFilter 分类查询栏目
  47. GetFilter 组件查询
  48. Get LeanFilter 组件查询栏目
  49. 项目

@ dynatrace- sdk/ 客户端- 过滤器- 分区- 管理

npm License

圣杯的过滤-分区管理.

切片,骰子和上下文化你的数据,以方便查找,理解和配合.

安装

npm install @dynatrace-sdk/client-filter-segment-management

获得帮助

许可证

此 SDK 分布于 Apache 许可证,2.0版本,更多信息见LICENSE.

API 参考

最新版本SDK的API 完整参考文件也可在 Dynatrace 开发者。 。 。 .

过滤器分类

import { filterSegmentsClient } from '@dynatrace-sdk/client-filter-segment-management';

创建Filter 分区

filterSegmentsClient.createFilterSegment(配置):承诺 <详细 过滤区域> 翻译:

创建一个新的过滤区.

所需范围 : 存储 : filter- segments: write

创建新段并定义数据 .

所需范围 :

  • storage:filter-segments:write
  • storage: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",
        },
      ],
    },
  },
);

删除过滤片段

filterSegmentsClient.deleteFilterSegment(配置):承诺<void>

删除过滤部分.

所需范围 : 存储: 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" },
);

获取过滤区块

过滤器组件Client.getFilter组件(配置):承诺 <详细 过滤区域> 翻译:

由 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",
});

获取过滤组件

过滤器组件Client.getFilter组件(配置):承诺 <过滤组件> 翻译:

获取所有过滤器.

所需范围 : 存储: 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();

获取筛选单元

filterSegmentsClient.getFilterSegments 实体模型(配置):承诺 <过滤区域Name spaceDto> 翻译:

获取过滤单元 -实体 -模型.

所需范围 : 存储: filter- 组件: 已读

返回过滤单元-实体-模型.

所需范围 :

  • storage:filter-segments:read

回返

返回类型状态代码说明
过滤区域Name spaceDto200个过滤单元 - 实体 - 模型成功检索 .

掷出

错误类型错误消息
信封错误错误请求 QQ 未经授权 QQ 缺少权限 QQ 发生错误 .
代码示例
import { filterSegmentsClient } from "@dynatrace-sdk/client-filter-segment-management";

const data =
  await filterSegmentsClient.getFilterSegmentsEntityModel();

获取 LeanFilter 组件

filterSegmentsClient.get LeanFilterSegments(配置):承诺 <倾斜部分> 翻译:

以最小/ 干净的形式获取所有过滤块 .

所需范围 : 存储: 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分区( 配置): 保证< void>

部分更新过滤部分 .

所需范围 : 存储 : filter- segments: write

更新一个或多个过滤区域.

所需范围 :

  • storage:filter-segments:write
  • storage:filter-segments:share 更改 isPublic 改为 true

以下字段可更新:

  • name
  • description
  • isPublic
  • variables* 联合国
  • 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",
    },
  });

更新过滤部分

filterSegmentsClient.updateFilterSegment(配置):承诺<void>

更新过滤区域。 所有字段都将被覆盖(也有未定义或无效字段).

所需范围 : 存储 : filter- segments: write

更新一个或多个过滤区域.

所需范围 :

  • storage:filter-segments:write
  • storage:filter-segments:share 更改 isPublic 改为 true

以下字段可更新:

  • name
  • description
  • isPublic
  • variables* 联合国
  • 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

版本与发布记录

@dynatrace-sdk/client-filter-segment-management 共发布 18 个版本,首次发布于 2024/09/10;过去 12 个月发布了 2 个版本。

版本发布日期距今
2.0.3latest2026/11/103 天前
2.0.1tmp-2.0.12026/10/051 个月前
1.7.12025/09/261.1 年前
1.6.72025/09/041.2 年前
1.6.62025/09/011.2 年前
1.6.52025/07/151.3 年前

关于 @dynatrace-sdk/client-filter-segment-management 的常见问题

@dynatrace-sdk/client-filter-segment-management 是什么?

[[(]https://opensource.org/licenses/Apache-2.0 (英语)

如何安装 @dynatrace-sdk/client-filter-segment-management?

在项目目录运行 npm install @dynatrace-sdk/client-filter-segment-management,或使用 pnpm add / yarn add / bun add。

@dynatrace-sdk/client-filter-segment-management 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@dynatrace-sdk/client-filter-segment-management 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@dynatrace-sdk/client-filter-segment-management 可以商用吗?

@dynatrace-sdk/client-filter-segment-management 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@dynatrace-sdk/client-filter-segment-management 的下载量有多少?

根据 npm 官方下载统计,@dynatrace-sdk/client-filter-segment-management 在 2026/10/13 – 2026/11/11 这 30 天内被下载 14,292 次,日均约 476 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@dynatrace-sdk/client-filter-segment-management 还在维护吗?

最新版本 2.0.3 发布于 2026/11/10(3 天前);至今共发布 18 个版本,其中过去 12 个月发布了 2 个;首次发布于 2024/09/10。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。