@dynatrace-sdk/client-app-settings-v2

中文文档

1.3.2发布于 2026/11/10Apache-2.0TypeScriptESM + CJS近 30 天下载 1.5万

文档目录56 节

安装
获得帮助
许可证
应用程序设置对象
删除 AppSettings 所有用户
删除修改对象
删除 AppSettings 发送对象和访问对象
获得所有用户的列表
获得对对象的设定
获取修改对象
获得 AppSettings 任务对象和加入者
获得 AppSettings 选项
获得有效的选项
后选项
页面存档备份,存于互联网档案馆
后AppSettings 任务对象
设置所有用户的设置
设置对象
设置 AppSettings 任务对象和加入者
解析有效任务
类型
获得者许可
用户列表
应用程序对象
应用程序对象创建
应用程序对象响应
应用设置对象更新
应用程序对象列表
应用程序列表
应用安排转让
更新请求
最新响应
约束暴力
有效安排值
有效选项表
有效许可
有效许可
错误
错误细节
错误不完整
答错
身份
修改信息
修改
权限链接
决议要求
资源关联
单一许可请求
数字
AppSettings 任务列表项目
约束活性
有效许可
Get AppSettings 任务对象和获得者列表
身份类型
资源连接操作项目
单次请求

@ dynatrace- sdk/ 客户端- app- settings- v2

获取、更新和管理应用程序设置.

安装

npm install @dynatrace-sdk/client-app-settings-v2

获得帮助

访问用于打字的 SDK 指南中 Dynatrace 开发者
问个问题 Dynatrace社区

许可证

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

API 参考

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

应用程序设置对象

import { appSettingsObjectsClient } from '@dynatrace-sdk/client-app-settings-v2';

删除 AppSettings 所有用户

appSettings ObjectsClient.deleteAppSettings All Uservers Permission By ObjectId(配置):保证<void>

所需范围 : app- 设置: 对象: 写入

删除此对象上已有的所有用户访问器的权限, 任何拥有写入权限的人都可以删除权限

参数

名称	类型	说明
配置.admin 访问	布尔	如果设定为真, 而用户有 app- 设置: objects: admin 权限, 端点将像用户是所有对象的拥有者一样默认 : `false`
配置.objectId 数据^*必须	字符串	需要设置对象的ID

回返

返回类型	状态代码	说明
无效	204 (韩语)	成功

掷出

错误类型	错误消息
答错错误	给定对象Id 或所有用户访问器都没有任何权限
太多请求	失败。请求太多.
服务不可用	失败。服务不可用 .
常规错误	错误.

代码示例

import { appSettingsObjectsClient } from "@dynatrace-sdk/client-app-settings-v2";

const data =
  await appSettingsObjectsClient.deleteAppSettingsAllUsersPermissionByObjectId(
    { objectId: "..." },
  );

删除修改对象

appSettings ObjectsClient.deleteAppSObjectByObjectId(配置):承诺<void>

删除指定的设置对象

所需范围 : app- 设置: 对象: 写入

参数

名称类型说明

配置.admin 访问布尔如果设定为真, 而用户有 app- 设置: objects: admin 权限, 端点将像用户是所有对象的拥有者一样

默认 : false

配置.objectId 数据^*必须字符串需要设置对象的ID

配置. 乐观 LockingVersion^*必须

字符串

用于乐观锁定的对象的版本. 你可以用它来检测不同的用户同时进行的修改.

它是在检索时产生的(GET请求)。如果设定在更新(PUT request)或删除上,只有在检索与更新之间没有任何变化的情况下,才会允许更新/删除.

回返

返回类型	状态代码	说明
无效	204 (韩语)	圆满. 反应没有尸体.

掷出

错误类型	错误消息
答错错误	失败。输入无效。失败。禁止失败。请求的资源不存在.
冲突资源	失败。相冲突资源.
太多请求	失败。请求太多.
服务不可用	失败。服务不可用 .
常规错误	错误.

代码示例

import { appSettingsObjectsClient } from "@dynatrace-sdk/client-app-settings-v2";

const data =
  await appSettingsObjectsClient.deleteAppSettingsObjectByObjectId(
    { objectId: "...", optimisticLockingVersion: "..." },
  );

删除 AppSettings 发送对象和访问对象

appSettings ObjectsClient.deleteAppSettings 百事求是ObjectIdAndAccessorId(配置):承诺<void>

所需范围 : app- 设置: 对象: 写入

删除此对象上已有访问器的权限, 任何拥有写入权限的人都可以删除权限

参数

名称	类型	说明
配置。访问器Id^*必须	字符串	用户 uuid 或访问者的组 uuid, 取决于类型
配置. 访问器Type^*必须	"用户" qq "组"	访问者的类型
配置.admin 访问	布尔	如果设定为真, 而用户有 app- 设置: objects: admin 权限, 端点将像用户是所有对象的拥有者一样默认 : `false`
配置.objectId 数据^*必须	字符串	需要设置对象的ID

回返

返回类型	状态代码	说明
无效	204 (韩语)	成功

掷出

错误类型	错误消息
答错错误	给定对象Id 可用的任何对象或访问器对此对象没有任何权限
太多请求	失败。请求太多.
服务不可用	失败。服务不可用 .
常规错误	错误.

代码示例

import { appSettingsObjectsClient } from "@dynatrace-sdk/client-app-settings-v2";

const data =
  await appSettingsObjectsClient.deleteAppSettingsPermissionByObjectIdAndAccessorId(
    {
      objectId: "...",
      accessorType: "user",
      accessorId: "...",
    },
  );

获得所有用户的列表

应用设置对象 Client.get AppSettings All Users Permission By ObjectId(配置): 保证 <获得者许可> 翻译:

所需范围 : 应用程序设置: 对象:已读

获取此对象上所有用户的访问器的当前权限

参数

名称	类型	说明
配置.admin 访问	布尔	如果设定为真, 而用户有 app- 设置: objects: admin 权限, 端点将像用户是所有对象的拥有者一样默认 : `false`
配置.objectId 数据^*必须	字符串	需要设置对象的ID

回返

返回类型	状态代码	说明
获得者许可	200个	成绩

掷出

错误类型	错误消息
答错错误	给定对象Id 或所有用户访问器都没有任何权限
太多请求	失败。请求太多.
服务不可用	失败。服务不可用 .
常规错误	错误.

代码示例

import { appSettingsObjectsClient } from "@dynatrace-sdk/client-app-settings-v2";

const data =
  await appSettingsObjectsClient.getAppSettingsAllUsersPermissionByObjectId(
    { objectId: "..." },
  );

获得对对象的设定

应用程序设置对象 Client.getAppS设置对象ByObjectId(配置):承诺 <应用程序对象> 翻译:

获取指定的设置对象

所需范围 : 应用程序设置: 对象:已读

获取指定的设置对象。类型属性隐藏如果调用来自您的应用程序的无服务器功能, 则会包含在纯文本中; 否则, 调用将不可逆地被掩盖。这能保护这些秘密不被泄露给您的应用软件或其他第三方的用户.

参数

名称	类型	说明
配置.admin 访问	布尔	如果设定为真, 而用户有 app- 设置: objects: admin 权限, 端点将像用户是所有对象的拥有者一样默认 : `false`
配置.objectId 数据^*必须	字符串	需要设置对象的ID

回返

返回类型	状态代码	说明
应用程序对象	200个	成绩

掷出

错误类型	错误消息
答错错误	失败。输入无效。失败。禁止你这么做给定对象Id 没有可用的对象
太多请求	失败。请求太多.
服务不可用	失败。服务不可用 .
常规错误	错误.

代码示例

import { appSettingsObjectsClient } from "@dynatrace-sdk/client-app-settings-v2";

const data =
  await appSettingsObjectsClient.getAppSettingsObjectByObjectId(
    { objectId: "..." },
  );

获取修改对象

应用程序设置对象Client.getAppS设置对象(配置):承诺 <应用程序对象列表> 翻译:

列表持续设置对象

所需范围 : 应用程序设置: 对象:已读

列出选定方案的持续设置对象 .

如果不存在任何问题,或者由于权限缺失而无法访问所有持续存在的设置对象,则不会返回任何项目.

要查询有效值(包括schema默认值),请参见weatheriveAppSettingsValues.

类型属性隐藏如果调用来自您的应用程序的无服务器功能, 则会包含在纯文本中; 否则, 调用将不可逆地被掩盖。这能保护这些秘密不被泄露给您的应用软件或其他第三方的用户.

参数

名称	类型	说明
配置. 添加字段	字符串	响应中要包含的字段列表。提供的一组字段扩展默认集 . 指定所需的顶层字段,用逗号分隔(例如, 汇总,数值) (中文(简体) ). 支持的字段 : 对象, (中文(简体) ), 版本, (中文(简体) ), 目录, (中文(简体) ), 搜索摘要, (中文(简体) ), 计划, (中文(简体) ), 计划, (中文(简体) ), 修改资讯, (中文(简体) ), 资源背景, (中文(简体) ), 价值, (中文(简体) ), 拥有者。。。 . 默认字段:objectId,版本. 默认 : `objectId, version`
配置.admin 访问	布尔	如果设定为真, 而用户有 app- 设置: objects: admin 权限, 端点将像用户是所有对象的拥有者一样默认 : `false`
配置. filter	字符串	所解释的过滤参数这里。。。 . 下列字段支持过滤 : `modificationInfo.createdBy` `modificationInfo.createdTime` `modificationInfo.lastModifiedBy` `modificationInfo.lastModifiedTime` `value` 属性和子属性以点分隔(例如, `value.owningApp = 'Notebooks'`(中文(简体) ) `owner.type` `owner.id` 如果省略了此参数,则会返回所有设置对象。最大巢穴深度(通过括号)为5. 最大表达长度为1024个字符. 请注意,仅包含通过下列方式对响应的字段: `add-fields` 可用于过滤.
配置.page 键	字符串	下一页结果的光标。你可以在电影里找到它下一个PageKey 字段. 首页总是返回,如果你没有指定页面键查询参数. 当页面键要获取后续页面,您必须省略所有其他查询参数.
配置.页面大小	编号	单个响应有效载荷中的设置对象数量. 如果设置为 0,则所有可用的设置对象都将包含在响应中. 允许的最大页面大小是500个. 如果没有设置,则使用100. 默认 : `100` 最小值 : `0`
配置. schemaId	字符串	请求对象所属的Schema ID. 装入第一页时下一个PageKey 未设置,需要此参数.
配置. sort (帮助)	字符串	如所解释的排序参数这里。。。 . 下列字段支持排序 : `modificationInfo.createdBy` `modificationInfo.createdTime` `modificationInfo.lastModifiedBy` `modificationInfo.lastModifiedTime` `value` 属性和子属性以点分隔(例如, `value.owningApp`(中文(简体) ) 请注意,仅包含通过下列方式对响应的字段: `add-fields` 可用于排序.

回返

返回类型	状态代码	说明
应用程序对象列表	200个	圆满. 使用块化编码.

即使一个响应返回一个成功的响应代码,也有可能由于内部出错导致结果不完整.

在此情况下,将添加一个“ 错误” 财产, 并提供有关此问题的信息。呼叫者可决定对操作结果不完全进行工作,或进行重试

掷出

错误类型	错误消息
答错错误	失败。输入无效。失败。禁止失败。未找到指定的方案 .
太多请求	失败。请求太多.
服务不可用	失败。服务不可用 .
常规错误	错误.

代码示例

import { appSettingsObjectsClient } from "@dynatrace-sdk/client-app-settings-v2";

const data =
  await appSettingsObjectsClient.getAppSettingsObjects();

获得 AppSettings 任务对象和加入者

应用程序设置对象Client.getAppSettings 对象AndAccessorId(配置):承诺 <获得者许可> 翻译:

所需范围 : 应用程序设置: 对象:已读

获取此对象上访问者的当前权限

参数

名称	类型	说明
配置。访问器Id^*必须	字符串	用户 uuid 或访问者的组 uuid, 取决于类型
配置. 访问器Type^*必须	"用户" qq "组"	访问者的类型
配置.admin 访问	布尔	如果设定为真, 而用户有 app- 设置: objects: admin 权限, 端点将像用户是所有对象的拥有者一样默认 : `false`
配置.objectId 数据^*必须	字符串	需要设置对象的ID

回返

返回类型	状态代码	说明
获得者许可	200个	成绩

掷出

错误类型	错误消息
答错错误	给定对象Id 可用的任何对象或访问器对此对象没有任何权限
太多请求	失败。请求太多.
服务不可用	失败。服务不可用 .
常规错误	错误.

代码示例

import { appSettingsObjectsClient } from "@dynatrace-sdk/client-app-settings-v2";

const data =
  await appSettingsObjectsClient.getAppSettingsPermissionByObjectIdAndAccessorId(
    {
      objectId: "...",
      accessorType: "user",
      accessorId: "...",
    },
  );

获得 AppSettings 选项

应用程序设置对象Client.getAppSettings 对象ByObjectId(配置):承诺 <用户列表> 翻译:

所需范围 : 应用程序设置: 对象:已读

获取此对象的当前权限

参数

名称	类型	说明
配置.admin 访问	布尔	如果设定为真, 而用户有 app- 设置: objects: admin 权限, 端点将像用户是所有对象的拥有者一样默认 : `false`
配置.objectId 数据^*必须	字符串	需要设置对象的ID

回返

返回类型	状态代码	说明
用户列表	200个	成绩

掷出

错误类型	错误消息
答错错误	给定对象Id 没有可用的对象
太多请求	失败。请求太多.
服务不可用	失败。服务不可用 .
常规错误	错误.

代码示例

import { appSettingsObjectsClient } from "@dynatrace-sdk/client-app-settings-v2";

const data =
  await appSettingsObjectsClient.getAppSettingsPermissionsByObjectId(
    { objectId: "..." },
  );

获得有效的选项

appSettings ObjectsClient.getiveAppSettingsValues(配置):承诺 <有效选项表> 翻译:

列出有效的设置值

所需范围 : 应用程序设置: 对象:已读

列出选定方案的有效设置值. 如果一个计划没有坚持对象 “多对象”:虚假,将返回计划中定义的默认值.

参数

名称	类型	说明
配置. 添加字段	字符串	响应中要包含的字段列表。提供的一组字段扩展默认集 . 指定所需的顶层字段,用逗号分隔(例如, 概要,摘要) (中文(简体) ). 支持的字段 : 目录, (中文(简体) ), 搜索摘要, (中文(简体) ), 计划, (中文(简体) ), 计划, (中文(简体) ), 修改资讯, (中文(简体) ), 价值。。。 . 默认字段:值. 默认 : `value`
配置.admin 访问	布尔	如果设定为真, 而用户有 app- 设置: objects: admin 权限, 端点将像用户是所有对象的拥有者一样默认 : `false`
配置.page 键	字符串	下一页结果的光标。你可以在电影里找到它下一个PageKey 字段. 首页总是返回,如果你没有指定页面键查询参数. 当页面键要获取后续页面,您必须省略所有其他查询参数.
配置.页面大小	编号	单个响应有效载荷中的设置对象数量. 如果设置为 0,则所有可用的设置对象都将包含在响应中. 允许的最大页面大小是500个. 如果没有设置,则使用100. 默认 : `100` 最小值 : `0`
配置. schemaId	字符串	请求对象所属的Schema ID. 只在第一页装入时考虑下一个PageKey 未设置.

回返

返回类型	状态代码	说明
有效选项表	200个	圆满. 使用块化编码.

即使一个响应返回一个成功的响应代码,也有可能由于内部出错导致结果不完整.

在此情况下,将添加一个“ 错误” 财产, 并提供有关此问题的信息。呼叫者可决定对操作结果不完全进行工作,或进行重试

掷出

错误类型	错误消息
答错错误	失败。输入无效。失败。未找到指定的方案 .
太多请求	失败。请求太多.
服务不可用	失败。服务不可用 .
常规错误	错误.

代码示例

import { appSettingsObjectsClient } from "@dynatrace-sdk/client-app-settings-v2";

const data =
  await appSettingsObjectsClient.getEffectiveAppSettingsValues();

后选项

appSettings Objects Client. postAppSettings Object(配置): 保证<void }\} 应用程序对象响应> 翻译:

创建新设置对象

所需范围 : app- 设置: 对象: 写入

创建新设置对象.

参数

名称	类型	说明
配置. 身体^*必须	应用程序对象创建
配置. validate 只限	布尔	若为 `true`,请求只运行已提交的设置对象的验证,而不保存它们. 默认 : `false`

回返

返回类型	状态代码	说明
无效	200个	圆满. 没有验证错误 .
应用程序对象响应	201 (韩语)	已创建

掷出

错误类型	错误消息
答错错误	失败。输入无效。失败。禁止失败。请求的资源不存在.
冲突资源	失败。相冲突资源.
太多请求	失败。请求太多.
服务不可用	失败。服务不可用 .
常规错误	错误.

代码示例

import { appSettingsObjectsClient } from "@dynatrace-sdk/client-app-settings-v2";

const data =
  await appSettingsObjectsClient.postAppSettingsObject({
    body: { schemaId: "jira-connection", value: {} },
  });

页面存档备份,存于互联网档案馆

appSettings Objects Client. post AppSettings Ownership By ObjectId(配置): 保证<void>

所需范围 : app- 设置: 对象: 写入

转让对象的所有权,只允许所有者或主要管理员转让所有权(所需的IAM许可).

参数

名称	类型	说明
配置.admin 访问	布尔	如果设定为真, 而用户有 app- 设置: objects: admin 权限, 端点将像用户是所有对象的拥有者一样默认 : `false`
配置. 身体^*必须	应用安排转让
配置.objectId 数据^*必须	字符串	需要设置对象的ID

回返

返回类型	状态代码	说明
无效	204 (韩语)	成绩

掷出

错误类型	错误消息
答错错误	给定对象Id 没有可用的对象
太多请求	失败。请求太多.
服务不可用	失败。服务不可用 .
常规错误	错误.

代码示例

import { appSettingsObjectsClient } from "@dynatrace-sdk/client-app-settings-v2";

const data =
  await appSettingsObjectsClient.postAppSettingsOwnershipByObjectId(
    {
      objectId: "...",
      body: { newOwner: { type: "user" } },
    },
  );

后AppSettings 任务对象

appSettings ObjectsClient.postAppSettings PermissionByObjectId(配置):承诺 <获得者许可> 翻译:

所需范围 : app- 设置: 对象: 写入

在此对象上添加一个访问器的权限, 任何拥有写入权限的人都可以添加更多权限

参数

名称	类型	说明
配置.admin 访问	布尔	如果设定为真, 而用户有 app- 设置: objects: admin 权限, 端点将像用户是所有对象的拥有者一样默认 : `false`
配置. 身体^*必须	获得者许可
配置.objectId 数据^*必须	字符串	需要设置对象的ID

回返

返回类型	状态代码	说明
获得者许可	201 (韩语)	成绩

掷出

错误类型	错误消息
答错错误	如果访问者 id 已经存在 QQ 给定对象Id 没有可用的对象
太多请求	失败。请求太多.
服务不可用	失败。服务不可用 .
常规错误	错误.

代码示例

import { appSettingsObjectsClient } from "@dynatrace-sdk/client-app-settings-v2";

const data =
  await appSettingsObjectsClient.postAppSettingsPermissionByObjectId(
    {
      objectId: "...",
      body: { accessor: { type: "user" }, permissions: {} },
    },
  );

设置所有用户的设置

appSettings ObjectsClient.putAppSettings All Users Permission By ObjectId(配置):保证<void>

所需范围 : app- 设置: 对象: 写入

更新此对象上现有的所有用户访问器的权限, 任何拥有写入权限的人都可以更新权限

参数

名称	类型	说明
配置.admin 访问	布尔	如果设定为真, 而用户有 app- 设置: objects: admin 权限, 端点将像用户是所有对象的拥有者一样默认 : `false`
配置. 身体^*必须	更新请求
配置.objectId 数据^*必须	字符串	需要设置对象的ID

回返

返回类型	状态代码	说明
无效	200个	成功

掷出

错误类型	错误消息
答错错误	如果权限列表为空,则包含不支持的条目或不支持的条目组合 QQ 给定对象Id 或所有用户访问器都没有任何权限
太多请求	失败。请求太多.
服务不可用	失败。服务不可用 .
常规错误	错误.

代码示例

import { appSettingsObjectsClient } from "@dynatrace-sdk/client-app-settings-v2";

const data =
  await appSettingsObjectsClient.putAppSettingsAllUsersPermissionByObjectId(
    { objectId: "...", body: { permissions: {} } },
  );

设置对象

应用程序设置对象 Client.putAppS设置对象ByObjectId(配置):承诺 <最新响应> 翻译:

更新已有设置对象

所需范围 : app- 设置: 对象: 写入

以新值更新已有设置对象。更新财产 secret 类型,您需要通过新值。要保留当前值,请发送当前被掩盖的秘密. 可以通过对象端点获取.

有些计划不允许蒙面的秘密被传递. 在这种情况下,你需要发送未蒙面的秘密与对象的每一更新.

参数

名称	类型	说明
配置.admin 访问	布尔	如果设定为真, 而用户有 app- 设置: objects: admin 权限, 端点将像用户是所有对象的拥有者一样默认 : `false`
配置. 身体^*必须	应用设置对象更新
配置.objectId 数据^*必须	字符串	需要设置对象的ID
配置. 乐观 LockingVersion^*必须	字符串	用于乐观锁定的对象的版本. 你可以用它来检测不同的用户同时进行的修改. 它是在检索时产生的(GET请求)。如果设定在更新(PUT request)或删除上,只有在检索与更新之间没有任何变化的情况下,才会允许更新/删除.

回返

返回类型	状态代码	说明
最新响应	200个	成绩

掷出

错误类型	错误消息
答错错误	失败。输入无效。失败。禁止失败。请求的资源不存在.
冲突资源	失败。相冲突资源.
太多请求	失败。请求太多.
服务不可用	失败。服务不可用 .
常规错误	错误.

代码示例

import { appSettingsObjectsClient } from "@dynatrace-sdk/client-app-settings-v2";

const data =
  await appSettingsObjectsClient.putAppSettingsObjectByObjectId(
    {
      objectId: "...",
      optimisticLockingVersion: "...",
      body: { value: {} },
    },
  );

设置 AppSettings 任务对象和加入者

appSettings ObjectsClient.putAppSettings PermissionBy ObjectIdAndAccessorId(配置):保证<void>

所需范围 : app- 设置: 对象: 写入

更新此对象上已有的访问器的权限, 任何拥有写入权限的人都可以更新权限

参数

名称	类型	说明
配置。访问器Id^*必须	字符串	用户 uuid 或访问者的组 uuid, 取决于类型
配置. 访问器Type^*必须	"用户" qq "组"	访问者的类型
配置.admin 访问	布尔	如果设定为真, 而用户有 app- 设置: objects: admin 权限, 端点将像用户是所有对象的拥有者一样默认 : `false`
配置. 身体^*必须	更新请求
配置.objectId 数据^*必须	字符串	需要设置对象的ID

回返

返回类型	状态代码	说明
无效	200个	成功

掷出

错误类型	错误消息
答错错误	如果权限列表为空,则包含不支持的条目或不支持的条目组合 QQ 给定对象Id 可用的任何对象或访问器对此对象没有任何权限
太多请求	失败。请求太多.
服务不可用	失败。服务不可用 .
常规错误	错误.

代码示例

import { appSettingsObjectsClient } from "@dynatrace-sdk/client-app-settings-v2";

const data =
  await appSettingsObjectsClient.putAppSettingsPermissionByObjectIdAndAccessorId(
    {
      objectId: "...",
      accessorType: "user",
      accessorId: "...",
      body: { permissions: {} },
    },
  );

解析有效任务

应用程序设置对象Client.resolveive Permissions(配置):承诺 <有效许可> 翻译:

在环境中获取呼叫用户的有效设置权限

需要以下所有范围:

应用程序设置: 对象:已读
app- 设置: 对象: 写入

需要下列许可之一:

应用程序设置: 对象:已读
app- 设置: 对象: 写入

参数

名称	类型
配置. 身体^*必须	决议要求

掷出

错误类型	错误消息
答错错误	失败。输入无效。失败。被禁绝. 没有任何计划.
常规错误	错误.

代码示例

import { appSettingsObjectsClient } from "@dynatrace-sdk/client-app-settings-v2";

const data =
  await appSettingsObjectsClient.resolveEffectivePermissions(
    {
      body: {
        permissions: [
          {
            permission: "app-settings:objects:read",
            context: { schemaId: "..." },
          },
        ],
      },
    },
  );

类型

获得者许可

名称	类型	说明
访问器^*必须	身份
权限^*必须	应用程序列表	授予此对象的访问者权限 . `r` 授予读取查看对象的权利; `w` 给予写入权限以修改对象。有效值 : `["r"]` 仅读, `["r", "w"]` 用于读写. 示例 `["r","w"]`

用户列表

名称	类型
访问者^*必须	矩阵 <获得者许可> 翻译:

应用程序对象

设置对象 .

名称	类型	说明
修改资讯	修改信息	修改设置信息.
对象^*必须	字符串	设置对象的ID . 示例 `Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=`
拥有者	身份
资源背景	资源关联	资源上下文,其中包含关于对象的额外权限信息.
计划	字符串	物体所依据的方案. 示例 `jira-connection`
计划	字符串	对象所基于的图案版本. 示例 `1.0.0`
搜索摘要	字符串	设置值的可搜索摘要字符串。没有Markdown的纯文本.
目录	字符串	设置简略. 这可以控制Markdown,并会相应逃脱.
价值	应用 ValueRaw	设置的值 . 它定义了设置参数的实际值. 实际内容取决于对象的策略.
版本^*必须	字符串	用于乐观锁定的对象的版本. 你可以用它来检测不同的用户同时进行的修改. 它是在检索时产生的(GET请求)。如果设定在更新(PUT request)或删除上,只有在检索与更新之间没有任何变化的情况下,才会允许更新/删除. 示例 `Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=`

应用程序对象创建

新设置对象的配置 .

名称类型说明

插入

字符串

新对象的位置。新对象将在指定对象后添加 .

若为 null中,新对象将被置于最后一个位置.

如果设置为空字符串,新对象将被置于第一个位置.

仅适用于基于有命令对象的图案的物体(schema's) ordered 参数设置为 true) (中文(简体) ).

示例 Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=

计划^*必须字符串物体所依据的方案.

示例 jira-connection

价值^*必须

选择值

设置的值 .

它定义了设置参数的实际值.

实际内容取决于对象的策略.

应用程序对象响应

对创建请求的回应.

名称类型说明

对象^*必须字符串创建的设置对象的ID .

示例 Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=

版本^*必须

字符串

用于乐观锁定的对象的版本. 你可以用它来检测不同的用户同时进行的修改.

它是在检索时产生的(GET请求)。如果设定在更新(PUT request)或删除上,只有在检索与更新之间没有任何变化的情况下,才会允许更新/删除.

示例 Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=

应用设置对象更新

设置对象的更新.

名称类型说明

插入

字符串

更新对象的位置。新对象将移动到指定对象后.

插入财务报告和审定财务报表 插入之前 两者中只有一个可以设定.

若为 null 财务报告和审定财务报表 插入之前 “ null ” , 现有对象保留当前位置 .

如果设置为空字符串,更新对象将被置于第一个位置.

仅适用于基于有命令对象的图案的物体(schema's) 订购参数设置为 true) (中文(简体) ).

示例 Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=

插入之前

字符串

更新对象的位置。新对象将移动到指定对象前面.

插入财务报告和审定财务报表 插入之前 两者中只有一个可以设定.

若为 null 财务报告和审定财务报表插入 “ null ” , 现有对象保留当前位置 .

如果设置为空字符串,更新的对象将被置于最后一个位置.

仅适用于基于有命令对象的图案的物体(schema's) 订购参数设置为 true) (中文(简体) ).

示例 Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=

价值^*必须

选择值

设置的值 .

它定义了设置参数的实际值.

实际内容取决于对象的策略.

应用程序对象列表

设置对象列表 .

名称	类型	说明
错误	错误不完整	不完整响应出错对象
项目^*必须	矩阵 <应用程序对象> 翻译:	设置对象列表 .
下一个PageKey	字符串	下一页结果的光标。具有 `null` 在最后一页. 用在那个下一个PageKey 查询参数以获取结果的后几页. 示例 `AQAAABQBAAAABQ==`
页面大小^*必须	编号	每页条目数.
总计^*必须	编号	结果的条目总数.

应用程序列表

授予此对象的访问者权限 . r 授予读取查看对象的权利; w 给予写入权限以修改对象。有效值 : ["r"] 仅读, ["r", "w"] 用于读写.

类型: 矩阵 <'r' \'"w"

应用安排转让

名称	类型
新奥纳	身份

更新请求

名称	类型	说明
权限^*必须	应用程序列表	授予此对象的访问者权限 . `r` 授予读取查看对象的权利; `w` 给予写入权限以修改对象。有效值 : `["r"]` 仅读, `["r", "w"]` 用于读写. 示例 `["r","w"]`

约束暴力

包含由无效输入引起的限制违反的信息.

名称	类型	说明
消息^*必须	字符串	强制违反描述信息
参数位置	"PATH""QUERY""HEADER""PAYLOAAD BODY" "PAYLOAD BODY" "PAYLOAD""Q""Q""Q""HEADER"""HEADER"""PAYLOAAD BOOY"""""""""""""""""""""""""""""""""""""""	描述违反参数的一般位置
路径	字符串	导致违反约束的参数路径

有效安排值

有效的设置值 .

名称	类型	说明
修改资讯	修改信息	修改设置信息.
计划	字符串	物体所依据的方案. 示例 `jira-connection`
计划	字符串	对象所基于的图案版本. 示例 `1.0.0`
搜索摘要	字符串	设置值的可搜索摘要字符串。没有Markdown的纯文本.
目录	字符串	设置简略. 这可以控制Markdown,并会相应逃脱.
价值	应用 ValueRaw	设置的值 . 它定义了设置参数的实际值. 实际内容取决于对象的策略.

有效选项表

有效设置值列表 .

名称	类型	说明
错误	错误不完整	不完整响应出错对象
项目^*必须	矩阵 <有效安排值> 翻译:	有效设置值列表 .
下一个PageKey	字符串	下一页结果的光标。具有 `null` 在最后一页. 用在那个下一个PageKey 查询参数以获取结果的后几页. 示例 `AQAAABQBAAAABQ==`
页面大小^*必须	编号	每页条目数.
总计^*必须	编号	结果的条目总数.

有效许可

名称	类型
上下文	权限链接
获准^*必须	"真""假""条件"
权限^*必须	字符串

有效许可

类型: 阵列 <有效许可> 翻译:

错误

标准错误反应

名称	类型	说明
代码^*必须	编号	错误代码( HTTP 响应)
细节	错误细节	错误的可选细节
消息^*必须	字符串	错误消息
秒后重试	编号	在“ 太多的请求” 错误响应后, 请求的秒数可以重审 .

错误细节

错误的可选细节

名称	类型	说明
约束	矩阵 <约束暴力> 翻译:	输入参数(路径、查询、请求正文)违反约束清单
引用错误	字符串	参考内部自监控,记录等中的出错.
失踪	矩阵 <字符串> 翻译:	403 - 禁止响应时, 列出成功执行请求所需的缺失权限
缺少缩写	矩阵 <字符串> 翻译:	403 - 禁止响应, 列出成功执行请求所需的缺失范围

错误不完整

不完整响应出错对象

名称	类型	说明
代码^*必须	编号	错误代码( HTTP 响应)
细节	错误细节	错误的可选细节
消息^*必须	字符串	错误消息
秒后重试	编号	在“ 太多的请求” 错误响应后, 请求的秒数可以重审 .

答错

名称	类型	说明
错误^*必须	错误	标准错误反应

身份

名称	类型	说明
编号	字符串	如果类型是“ 用户” 或“ 组” , 用户 id 或用户组 id, 如果类型是“ 所有用户” , 则丢失
类型^*必须	"用户""组""所有用户"

修改信息

修改设置信息.

名称	类型	说明
创建By	字符串	创建设置的用户独有的标识符 . 示例 `fab17b7a-2eb2-4c95-b818-743d94be2c30`
创建时间	日期	以 ISO 8601 格式(yyyy-MM-d'T'HH:mm:s. (原始内容存档于2019-03-29). SSS'Z'
上次修改By	字符串	进行最新修改的用户的独特标识符 . 示例 `fab17b7a-2eb2-4c95-b818-743d94be2c30`
上次修改Reason	字符串	最新修改的原因,如果有的话.
上次修改的时间	日期	上次以ISO 8601格式(yyyy-MM-d'T'HH:mm:s. (原始内容存档于2019-03-29). SSS'Z'

修改

此设置对象的额外修改细节 .

名称	类型	说明
第一个	布尔	如果不可移动设置对象位于第一组不可移动设置中,或者位于最后一组(列表的起始或结尾).
可修改的页^*必须	矩阵 <字符串> 翻译:	可修改的属性路径,无论 `write` 允许操作.
动产	布尔	如果设置对象可以移动/重排。仅适用于已订购的清单计划.
不可修改的页^*必须	矩阵 <字符串> 翻译:	无法修改的属性路径, 即使 `write` 允许操作.

权限链接

名称	类型
计划^*必须	字符串

决议要求

名称	类型
权限^*必须	矩阵 <单一许可请求> 翻译:

资源关联

资源上下文,其中包含关于对象的额外权限信息.

名称	类型	说明
修改^*必须	修改	此设置对象的额外修改细节 .
业务^*必须	矩阵 < “ 已读” QQ“ 写入 ” “ 删除 ”	在此设置对象上允许的操作 .

单一许可请求

可选的通用上下文数据集

名称	类型
上下文	权限链接
权限^*必须	"应用程序设置:对象:已读""应用程序设置:对象:已读""应用程序设置:已读""应用程序设置:已读""应用程序设置:已读" "应用程序设置:已读" "应用程序设置:已读" "应用程序设置:已读" "应用程序设置:已读"

数字

AppSettings 任务列表项目

⚠️ 折旧使用字面值.

Enum 键

R | W

约束活性

⚠️ 折旧使用字面值.

描述违反参数的一般位置

Enum 键

Header | Path | PayloadBody | Query

有效许可

⚠️ 折旧使用字面值.

Enum 键

Condition | False | True

Get AppSettings 任务对象和获得者列表

⚠️ 折旧使用字面值.

Enum 键

Group | User

身份类型

⚠️ 折旧使用字面值.

Enum 键

AllUsers | Group | User

资源连接操作项目

⚠️ 折旧使用字面值.

Enum 键

Delete | Read | Write

单次请求

⚠️ 折旧使用字面值.

Enum 键

AppSettingsObjectsAdmin | AppSettingsObjectsRead | AppSettingsObjectsWrite

版本与发布记录

@dynatrace-sdk/client-app-settings-v2 共发布 13 个版本，首次发布于 2025/01/29；过去 12 个月发布了 7 个版本。

版本	发布日期	距今
`1.3.2`latest	2026/11/10	3 天前
`1.2.1`	2026/09/11	2 个月前
`1.2.0`	2026/08/26	2 个月前
`1.1.7`	2026/07/28	3 个月前
`1.1.6`	2026/06/12	5 个月前
`1.1.5`	2026/06/12	5 个月前

关于 @dynatrace-sdk/client-app-settings-v2 的常见问题

如何安装 @dynatrace-sdk/client-app-settings-v2？

在项目目录运行 npm install @dynatrace-sdk/client-app-settings-v2，或使用 pnpm add / yarn add / bun add。