# @dynatrace-sdk/client-app-settings 中文文档

规范地址：https://npmcn.com/package/%40dynatrace-sdk/client-app-settings/

版本：1\.10\.0
npm 元数据更新时间：2026-11-03T14:38:14.002Z
中文译文更新时间：2026-11-13T02:44:06.202Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40dynatrace-sdk/client-app-settings
原文对照：https://npmcn.com/package/%40dynatrace-sdk/client-app-settings/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：202 kB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2024-02-27T22:02:44.063Z
- 最新版本发布：2026-11-03T14:38:13.814Z
- 近 30 天下载量：14412（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 1 个）

## 中文简介

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

## 安装

```sh
npm install @dynatrace-sdk/client-app-settings
```

也可以使用：`pnpm add @dynatrace-sdk/client-app-settings`、`yarn add @dynatrace-sdk/client-app-settings`、`bun add @dynatrace-sdk/client-app-settings`

## README

# @ dynatrace- sdk/ 客户端应用程序设置

[![npm](https://img.shields.io/badge/npm-v1.10.0-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-app-settings/v/1.10.0) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

这个API版本已经贬值了. 请使用 [页:1](https://developer.dynatrace.com/develop/sdks/client-app-settings-v2/) 换句话说 可以找到一个迁移指南 [在这里.](https://developer.dynatrace.com/develop/data/store-app-settings)  
获取、更新和管理应用程序设置.

## 安装

```bash
npm install @dynatrace-sdk/client-app-settings
```

## 获得帮助

-   访问 [用于打字的 SDK](https://developer.dynatrace.com/reference/sdks/) 指南中 [Dynatrace 开发者](https://developer.dynatrace.com/)
-   问个问题 [Dynatrace社区](https://community.dynatrace.com/)

## 许可证

此 SDK 分布于 [Apache 许可证,2.0版本](http://www.apache.org/licenses/LICENSE-2.0),更多信息见LICENSE.

# API 参考

最新版本SDK的API 完整参考文件也可在 [Dynatrace 开发者](https://developer.dynatrace.com/reference/sdks/client-app-settings/)。 。 。 .

## 应用程序设置对象

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

### ~删除修改对象~

> ⚠️ **折旧**

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

删除指定的设置对象

**所需范围 :** app- 设置: 对象: 写入 **需要许可 :** app- 设置: 对象: 写入

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.objectId 数据\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 所需的设置对象的ID . |
| 配置. 乐观 LockingVersion\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 
用于乐观锁定的对象的版本. 你可以用它来检测不同的用户同时进行的修改.

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

 |

#### 回返

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

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 应用设置错误信封错误 | 失败 。 输入无效 。 失败。 禁止 失败 。 请求的资源不存在. 失败。 相冲突资源. |

代码示例

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

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

### ~获得对对象的设定~

> ⚠️ **折旧**

**应用程序设置对象 Client.getAppS设置对象ByObjectId(配置):承诺 <[应用程序对象](https://npmcn.com/package/%40dynatrace-sdk/client-app-settings/#readme-appsettingsobject)\> 翻译:**

获取指定的设置对象

**所需范围 :** 应用程序设置: 对象:已读 **需要许可 :** 应用程序设置: 对象:已读

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

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置.objectId 数据\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 所需的设置对象的ID . |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [应用程序对象](https://npmcn.com/package/%40dynatrace-sdk/client-app-settings/#readme-appsettingsobject) | 200个 | 成绩 |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 应用设置错误信封错误 | 失败 。 输入无效 。 失败。 禁止你这么做 给定对象Id 没有可用的对象 |

代码示例

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

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

### ~获取修改对象~

> ⚠️ **折旧**

**应用程序设置对象Client.getAppS设置对象(配置):承诺 <[应用程序对象列表](https://npmcn.com/package/%40dynatrace-sdk/client-app-settings/#readme-appsettingsobjectslist)\> 翻译:**

列表持续设置对象

**所需范围 :** 应用程序设置: 对象:已读 **需要许可 :** 应用程序设置: 对象:已读

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

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

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

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

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置. 添加字段 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 
响应要包含的字段列表 。 提供的一组字段扩展默认集 .

指定所需的顶层字段,用逗号分隔(例如, **汇总,数值**) (中文(简体) ).

支持的字段 : **对象**, (中文(简体) ), **版本**, (中文(简体) ), **目录**, (中文(简体) ), **搜索摘要**, (中文(简体) ), **计划**, (中文(简体) ), **计划**, (中文(简体) ), **修改 资讯**, (中文(简体) ), **资源背景**, (中文(简体) ), **价值**。 。 。 .

默认字段:objectId,版本.

  
  
**默认 :** `objectId, version` |
| 配置.page 键 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 

下一页结果的光标 。 你可以在电影里找到它 **下一个PageKey** 字段.

首页总是返回,如果你没有指定 **页面键** 查询参数.

当 **页面键** 要获取后续页面,您必须省略所有其他查询参数.

 |
| 配置.页面大小 | [编号](https://developer.mozilla.org/en-US/docs/Glossary/Number) | 

单个响应有效载荷中的设置对象数量.

允许的最大页面大小是500个.

如果没有设置,则使用100.

 |
| 配置图.schemaIds | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 

被请求对象所属的逗号分隔式代码列表 .

装入第一页时 **下一个PageKey** 未设置,需要此参数.

 |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [应用程序对象列表](https://npmcn.com/package/%40dynatrace-sdk/client-app-settings/#readme-appsettingsobjectslist) | 200个 | 圆满. 返回可访问对象 . |

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

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

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 应用设置错误信封错误 | 失败 。 输入无效 。 失败。 禁止 失败 。 未找到指定的方案 . |

代码示例

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

const data =
  await appSettingsObjectsClient.getAppSettingsObjects();
```

### ~获得有效的选项~

> ⚠️ **折旧**

**appSettings ObjectsClient.getiveAppSettingsValues(配置):承诺 <[有效选项表](https://npmcn.com/package/%40dynatrace-sdk/client-app-settings/#readme-effectiveappsettingsvalueslist)\> 翻译:**

列出有效的设置值

**所需范围 :** 应用程序设置: 对象:已读 **需要许可 :** 应用程序设置: 对象:已读

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

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

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置. 添加字段 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 
响应要包含的字段列表 。 提供的一组字段扩展默认集 .

指定所需的顶层字段,用逗号分隔(例如, **概要,摘要**) (中文(简体) ).

支持的字段 : **目录**, (中文(简体) ), **搜索摘要**, (中文(简体) ), **计划**, (中文(简体) ), **计划**, (中文(简体) ), **修改 资讯**, (中文(简体) ), **价值**。 。 。 .

默认字段:值.

  
  
**默认 :** `value` |
| 配置.page 键 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 

下一页结果的光标 。 你可以在电影里找到它 **下一个PageKey** 字段.

首页总是返回,如果你没有指定 **页面键** 查询参数.

当 **页面键** 要获取后续页面,您必须省略所有其他查询参数.

 |
| 配置.页面大小 | [编号](https://developer.mozilla.org/en-US/docs/Glossary/Number) | 

单个响应有效载荷中的设置对象数量.

允许的最大页面大小是500个.

如果没有设置,则使用100.

 |
| 配置图.schemaIds | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 

被请求对象所属的逗号分隔式代码列表 .

只在第一页装入时考虑 **下一个PageKey** 未设置.

 |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| [有效选项表](https://npmcn.com/package/%40dynatrace-sdk/client-app-settings/#readme-effectiveappsettingsvalueslist) | 200个 | 成绩 |

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

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

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 应用设置错误信封错误 | 失败 。 输入无效 。 失败。 未找到指定的方案 . |

代码示例

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

const data =
  await appSettingsObjectsClient.getEffectiveAppSettingsValues();
```

### ~后选项~

> ⚠️ **折旧**

**appSettings Objects Client. postAppSettings Object(配置): 保证<void }\\} [应用程序对象响应](https://npmcn.com/package/%40dynatrace-sdk/client-app-settings/#readme-appsettingsobjectresponse)\> 翻译:**

创建新设置对象

**所需范围 :** app- 设置: 对象: 写入 **需要许可 :** app- 设置: 对象: 写入

创建新设置对象.

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置. 身体\*必须 | [应用程序对象创建](https://npmcn.com/package/%40dynatrace-sdk/client-app-settings/#readme-appsettingsobjectcreate) |  |
| 配置. validate 只限 | [布尔](https://developer.mozilla.org/en-US/docs/Glossary/Boolean) | 若为 `true`,请求只运行已提交的设置对象的验证,而不保存它们.  
  
**默认 :** `false` |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| 无效 | 200个 | 圆满. 没有验证错误 . |
| [应用程序对象响应](https://npmcn.com/package/%40dynatrace-sdk/client-app-settings/#readme-appsettingsobjectresponse) | 201 (韩语) | 已创建 |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 应用设置错误信封错误 | 失败 。 输入无效 。 失败。 禁止 失败 。 请求的资源不存在. 失败。 相冲突资源. |

代码示例

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

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

### ~设置对象~

> ⚠️ **折旧**

**appSettings ObjectsClient.putAppSettings ObjectByObjectId(配置):保证<void>**

更新已有设置对象

**所需范围 :** app- 设置: 对象: 写入 **需要许可 :** app- 设置: 对象: 写入

以新值更新已有设置对象。 更新财产 `secret` 类型,您需要通过新值。 要保留当前值,请发送当前被掩盖的秘密. 你可以通过 [获取对象](https://dt-url.net/kj036oj) 终点.

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

#### 参数

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 配置. 身体\*必须 | [应用设置对象更新](https://npmcn.com/package/%40dynatrace-sdk/client-app-settings/#readme-appsettingsobjectupdate) |  |
| 配置.objectId 数据\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 所需的设置对象的ID . |
| 配置. 乐观 LockingVersion\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 
用于乐观锁定的对象的版本. 你可以用它来检测不同的用户同时进行的修改.

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

 |

#### 回返

| 返回类型 | 状态代码 | 说明 |
| --- | --- | --- |
| 无效 | 200个 | 成绩 |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 应用设置错误信封错误 | 失败 。 输入无效 。 失败。 禁止 失败 。 请求的资源不存在. 失败。 相冲突资源. |

代码示例

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

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

### ~解析有效任务~

> ⚠️ **折旧**

**应用程序设置对象Client.resolveive Permissions(配置):承诺 <[有效许可](https://npmcn.com/package/%40dynatrace-sdk/client-app-settings/#readme-effectivepermissions)\> 翻译:**

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

**所需范围 :** app- settings:objects: read 或 app- settings:objects:write (中文(简体) ) **需要许可 :** app- settings:objects: read 或 app- settings:objects:write (中文(简体) )

#### 参数

| 名称 | 类型 |
| --- | --- |
| 配置. 身体\*必须 | [决议要求](https://npmcn.com/package/%40dynatrace-sdk/client-app-settings/#readme-resolutionrequest) |

#### 掷出

| 错误类型 | 错误消息 |
| --- | --- |
| 应用设置错误信封错误 | 失败 。 输入无效 。 失败。 被禁绝. 没有任何计划 失败. |

代码示例

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

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

## 类型

### 设置错误

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 代码 | [编号](https://developer.mozilla.org/en-US/docs/Glossary/Number) | HTTP 状态代码 |
| 细节 | [AppSettings 错误细节](https://npmcn.com/package/%40dynatrace-sdk/client-app-settings/#readme-appsettingserrordetails) | 错误细节 |
| 消息\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 错误消息 |

### AppSettings 错误细节

错误细节

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 约束 | 矩阵 <[约束暴力](https://npmcn.com/package/%40dynatrace-sdk/client-app-settings/#readme-constraintviolation)\> 翻译: | 违反强制规定行为清单 |
| 缺少缩写 | 矩阵 <[字符串](https://developer.mozilla.org/en-US/docs/Glossary/String)\> 翻译: | 403 - 禁止响应, 列出成功执行请求所需的缺失范围 |

### 应用设置错误信封

| 名称 | 类型 |
| --- | --- |
| 错误\*必须 | [设置错误](https://npmcn.com/package/%40dynatrace-sdk/client-app-settings/#readme-appsettingserror) |

### 应用程序错误

不完整响应出错对象

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 代码 | [编号](https://developer.mozilla.org/en-US/docs/Glossary/Number) | HTTP 状态代码 |
| 细节 | [AppSettings 错误细节](https://npmcn.com/package/%40dynatrace-sdk/client-app-settings/#readme-appsettingserrordetails) | 错误细节 |
| 消息\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 错误消息 |

### AppSettings 修改信息

应用程序设置的修改信息.

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 创建By | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 创建应用程序设置的用户的独特标识符 .  
  
**示例** `fab17b7a-2eb2-4c95-b818-743d94be2c30` |
| 创建时间 | 日期 | 应用设置以ISO 8601格式创建的时间戳(yyyy-MM-d'T'HH:mm:s. (原始内容存档于2019-03-29). SSS'Z' |
| 上次修改By | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 进行最新修改的用户的独特标识符 .  
  
**示例** `fab17b7a-2eb2-4c95-b818-743d94be2c30` |
| 上次修改的时间 | 日期 | 应用程序设置在ISO 8601格式(yyyy-MM-d'T'HH:mm:s. (原始内容存档于2019-03-29). SSS'Z' |

### 应用程序对象

设置对象 .

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 修改 资讯 | [AppSettings 修改信息](https://npmcn.com/package/%40dynatrace-sdk/client-app-settings/#readme-appsettingsmodificationinfo) | 应用程序设置的修改信息. |
| 对象\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 设置对象的ID .  
  
**示例** `Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=` |
| 资源背景 | [资源关联](https://npmcn.com/package/%40dynatrace-sdk/client-app-settings/#readme-resourcecontext) | 资源上下文,其中包含关于对象的额外权限信息. |
| 计划 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 物体所依据的方案.  
  
**示例** `jira-connection` |
| 计划 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 对象所基于的图案版本.  
  
**示例** `1.0.0` |
| 搜索摘要 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 设置值的可搜索摘要字符串 。 没有Markdown的纯文本. |
| 目录 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 设置简略. 这可以控制Markdown,并会相应逃脱. |
| 价值 | 选择值 | 
设置的值 .

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

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

 |
| 版本\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 

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

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

  
  
**示例** `Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=` |

### 应用程序对象创建

新设置对象的配置 .

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 插入 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 
新对象的位置 。 新对象将在指定对象后添加 .

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

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

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

  
  
**示例** `Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=` |
| 计划\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 物体所依据的方案.  
  
**示例** `jira-connection` |
| 价值\*必须 | 选择值 | 

设置的值 .

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

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

 |

### 应用程序对象响应

对创建请求的回应.

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 对象\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 创建的设置对象的ID .  
  
**示例** `Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=` |
| 版本\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 
用于乐观锁定的对象的版本. 你可以用它来检测不同的用户同时进行的修改.

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

  
  
**示例** `Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=` |

### 应用设置对象更新

设置对象的更新.

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 插入 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 
更新对象的位置 。 新对象将移动到指定对象后.

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

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

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

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

  
  
**示例** `Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=` |
| 插入之前 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 

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

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

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

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

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

  
  
**示例** `Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=` |
| 价值\*必须 | 选择值 | 

设置的值 .

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

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

 |

### 应用程序对象列表

设置对象列表 .

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 错误 | [应用程序错误](https://npmcn.com/package/%40dynatrace-sdk/client-app-settings/#readme-appsettingserrorincomplete) | 不完整响应出错对象 |
| 项目\*必须 | 矩阵 <[应用程序对象](https://npmcn.com/package/%40dynatrace-sdk/client-app-settings/#readme-appsettingsobject)\> 翻译: | 设置对象列表 . |
| 下一个PageKey | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 
下一页结果的光标 。 具有 `null` 在最后一页.

用在那个 **下一个PageKey** 查询参数以获取结果的后几页.

  
  
**示例** `AQAAABQBAAAABQ==` |
| 页面大小\*必须 | [编号](https://developer.mozilla.org/en-US/docs/Glossary/Number) | 每页条目数. |
| 总计\*必须 | [编号](https://developer.mozilla.org/en-US/docs/Glossary/Number) | 结果的条目总数. |

### 约束暴力

违反强制规定行为清单

| 名称 | 类型 |
| --- | --- |
| 地点 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) |
| 消息 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) |
| 参数位置 | "HEADER""PATH""PAYLAAD BODY""QUERY""UE"" |
| 路径 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) |

### 有效安排值

有效的设置值 .

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 修改 资讯 | [AppSettings 修改信息](https://npmcn.com/package/%40dynatrace-sdk/client-app-settings/#readme-appsettingsmodificationinfo) | 应用程序设置的修改信息. |
| 计划 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 物体所依据的方案.  
  
**示例** `jira-connection` |
| 计划 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 对象所基于的图案版本.  
  
**示例** `1.0.0` |
| 搜索摘要 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 设置值的可搜索摘要字符串 。 没有Markdown的纯文本. |
| 目录 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 设置简略. 这可以控制Markdown,并会相应逃脱. |
| 价值 | 选择值 | 
设置的值 .

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

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

 |

### 有效选项表

有效设置值列表 .

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 错误 | [应用程序错误](https://npmcn.com/package/%40dynatrace-sdk/client-app-settings/#readme-appsettingserrorincomplete) | 不完整响应出错对象 |
| 项目\*必须 | 矩阵 <[有效安排值](https://npmcn.com/package/%40dynatrace-sdk/client-app-settings/#readme-effectiveappsettingsvalue)\> 翻译: | 有效设置值列表 . |
| 下一个PageKey | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 
下一页结果的光标 。 具有 `null` 在最后一页.

用在那个 **下一个PageKey** 查询参数以获取结果的后几页.

  
  
**示例** `AQAAABQBAAAABQ==` |
| 页面大小\*必须 | [编号](https://developer.mozilla.org/en-US/docs/Glossary/Number) | 每页条目数. |
| 总计\*必须 | [编号](https://developer.mozilla.org/en-US/docs/Glossary/Number) | 结果的条目总数. |

### 有效许可

| 名称 | 类型 |
| --- | --- |
| 上下文 | [权限链接](https://npmcn.com/package/%40dynatrace-sdk/client-app-settings/#readme-permissioncontext) |
| 获准\*必须 | "真""假""条件" |
| 权限\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) |

### 有效许可

**类型**: 阵列 <[有效许可](https://npmcn.com/package/%40dynatrace-sdk/client-app-settings/#readme-effectivepermission)\> 翻译:

### 修改

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

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

### 权限链接

| 名称 | 类型 |
| --- | --- |
| 计划\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) |

### 决议要求

| 名称 | 类型 |
| --- | --- |
| 权限\*必须 | 矩阵 <[单一许可请求](https://npmcn.com/package/%40dynatrace-sdk/client-app-settings/#readme-singlepermissionrequest)\> 翻译: |

### 资源关联

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

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 修改\*必须 | [修改](https://npmcn.com/package/%40dynatrace-sdk/client-app-settings/#readme-modifications) | 此设置对象的额外修改细节 . |
| 业务\*必须 | 矩阵 < “ 已读” QQ“ 写入 ” “ 删除 ” | 在此设置对象上允许的操作 . |

### 单一许可请求

可选的通用上下文数据集

| 名称 | 类型 |
| --- | --- |
| 上下文 | [权限链接](https://npmcn.com/package/%40dynatrace-sdk/client-app-settings/#readme-permissioncontext) |
| 权限\*必须 | "应用程序设置:对象:读""应用程序设置:对象:写" |

## 数字

### ~约束活性~

> ⚠️ **折旧** 使用字面值.

#### Enum 键

`Header` | `Path` | `PayloadBody` | `Query`

### ~有效许可~

> ⚠️ **折旧** 使用字面值.

#### Enum 键

`Condition` | `False` | `True`

### ~资源连接操作项目~

> ⚠️ **折旧** 使用字面值.

#### Enum 键

`Delete` | `Read` | `Write`

### ~单次请求~

> ⚠️ **折旧** 使用字面值.

#### Enum 键

`AppSettingsObjectsRead` | `AppSettingsObjectsWrite`

## 常见问题

### @dynatrace-sdk/client-app-settings 是什么？

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

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

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

### @dynatrace-sdk/client-app-settings 支持 TypeScript 吗？

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

### @dynatrace-sdk/client-app-settings 支持 ESM 还是 CommonJS？

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

### @dynatrace-sdk/client-app-settings 可以商用吗？

@dynatrace-sdk/client-app-settings 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @dynatrace-sdk/client-app-settings 的下载量有多少？

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

### @dynatrace-sdk/client-app-settings 还在维护吗？

最新版本 1\.10\.0 发布于 2026/11/03（10 天前）；至今共发布 16 个版本，其中过去 12 个月发布了 1 个；首次发布于 2024/02/28。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。