# @dynatrace-sdk/shared-errors 中文文档

规范地址：https://npmcn.com/package/%40dynatrace-sdk/shared-errors/

版本：1\.1\.0
npm 元数据更新时间：2026-10-29T14:39:16.774Z
中文译文更新时间：2026-11-13T02:33:03.179Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：41.5 kB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2024-09-10T13:29:34.971Z
- 最新版本发布：2026-10-29T14:39:16.213Z
- 近 30 天下载量：26014（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 1 个）

## 中文简介

自动生成 Dynatrace SDK 包的共享错误分类 .

## 安装

```sh
npm install @dynatrace-sdk/shared-errors
```

也可以使用：`pnpm add @dynatrace-sdk/shared-errors`、`yarn add @dynatrace-sdk/shared-errors`、`bun add @dynatrace-sdk/shared-errors`

## README

* * *

## 标题: "@dynatrace-sdk/shared-errors" 说明:自动生成 Dynatrace SDK 包的共享错误分类.

自动生成 Dynatrace SDK 包的共享错误分类 .

```bash
npm install @dynatrace-sdk/shared-errors
```

## 类

### ApiClient 错误

所有客户端 SDK 的基准错误 。 所有其它错误都扩展了这一类.

#### 构造器

##### 新的 ApiClientError( 名称、 消息? 因为 )

#### 参数

| 名称 | 类型 |
| --- | --- |
| 名称\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) |
| 消息 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) |
| 原因 | [任意](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any) |

#### 属性

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 原因 | [任意](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any) |  |
| 错误类型\*必须 | 错误类型 |  |
| 是 Apiclient 错误\*必须 | 真实 |  |

### ApiGateway 错误

API Gateway所抛出错误的专门错误响应类. 自动生成 SDK 客户端已经为 API Gateway 错误设置了内置处理器, 以丢出此错误 .

#### 构造器

##### 新建 ApiGateway Error( 响应, 机构)

#### 参数

| 名称 | 类型 |
| --- | --- |
| 回应\*必须 | Http 客户端响应 |
| 机构\*必须 | ApiGateway 错误反应 |

#### 属性

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 机构\*必须 | ApiGateway 错误反应 |  |
| 原因 | [任意](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any) |  |
| 代码\*必须 | [编号](https://developer.mozilla.org/en-US/docs/Glossary/Number) |  |
| 错误类型\*必须 | 错误类型 |  |
| 是 Apiclient 错误\*必须 | 真实 |  |
| 是 ApiGateway 错误\*必须 | 真实 |  |
| 是 client 请求错误\*必须 | 真实 |  |
| 回应\*必须 | Http 客户端响应 |  |
| 秒后重试\*必须 | 未定义qq [编号](https://developer.mozilla.org/en-US/docs/Glossary/Number) |  |

### 客户端请求错误

用于处理预期和意外的服务级别错误的通用错误类.

#### 构造器

##### 新的客户端请求错误( 名称、 回复、 机构、 消息? ) 因为

#### 参数

| 名称 | 类型 |
| --- | --- |
| 名称\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) |
| 回应\*必须 | Http 客户端响应 |
| 机构\*必须 | 数字 |
| 消息 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) |
| 原因 | [任意](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any) |

#### 属性

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 机构\*必须 | 数字 |  |
| 原因 | [任意](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any) |  |
| 错误类型\*必须 | 错误类型 |  |
| 是 Apiclient 错误\*必须 | 真实 |  |
| 是 client 请求错误\*必须 | 真实 |  |
| 回应\*必须 | Http 客户端响应 |  |

### 无效的响应错误

专为响应序列化相关的出错分类. 接收到的服务响应后抛出,不能被去序列化.

#### 构造器

##### 新建无效的响应错误( name, nestedError, body, expect Type?, 消息?, 答复 ?)

#### 参数

| 名称 | 类型 |
| --- | --- |
| 名称\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) |
| 嵌入错误\*必须 | [任意](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any) |
| 机构\*必须 | [任意](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any) |
| 预期类型 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) |
| 消息 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) |
| 回应 | [任意](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any) |

#### 属性

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 原因 | [任意](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any) |  |
| 错误类型\*必须 | 错误类型 |  |
| 预期类型 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) |  |
| 是 Apiclient 错误\*必须 | 真实 |  |
| 无效响应错误\*必须 | 真实 |  |
| 嵌入错误 | 错误 |  |
| 回应\*必须 | [任意](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any) |  |
| 回应Body\*必须 | [任意](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any) |  |

## 职能

### 是 Apiclient 错误

**是 ApiClientError( e) : (帮助)**

ApiClientError 类型守护功能 . 对通过的对象进行结构检查.

#### 参数

| 名称 | 类型 |
| --- | --- |
| 电子\*必须 | [任意](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any) |

代码示例

```ts
try {
  doSomething();
} catch (e: unknown) {
  if(isApiClientError(e)) {
    handleTheError();
  }
}
```

### 是 ApiGateway 错误

**是 ApiGateway Error( e) : (帮助)**

APIGateway Error 类型守护功能. 对通过的对象进行结构检查.

#### 参数

| 名称 | 类型 |
| --- | --- |
| 电子\*必须 | [任意](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any) |

代码示例

```ts
try {
  doSomething();
} catch (e: unknown) {
  if(isApiClientError(e)) {
    handleTheError();
  }
}
```

### 是 client 请求错误

**是 Client 请求错误( e) :**

客户端请求错误类型守护功能 . 对通过的对象进行结构检查.

#### 参数

| 名称 | 类型 |
| --- | --- |
| 电子\*必须 | [任意](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any) |

代码示例

```ts
try {
  doSomething();
} catch (e: unknown) {
  if(isClientRequestError(e)) {
    handleTheError();
  }
}
```

### 无效响应错误

**无效反应错误( E) :**

无效的响应 Error 类型守护功能 . 对通过的对象进行结构检查.

还返回 `true` 页:1 `DataTypeError` 所抛出的例子 `@dynatrace-sdk/http-client` 当一个响应机构不能解码为 预期类型( 如服务器返回) `text/html` 但SDK请求 `application/json`) (中文(简体) ). 将这些人视为 `InvalidResponseError` 让应用程序代码 处理“响应不匹配预期计划”与单项 类型警卫.

#### 参数

| 名称 | 类型 |
| --- | --- |
| 电子\*必须 | [任意](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any) |

代码示例

```ts
try {
   doSomething();
} catch (e: unknown) {
   if (isInvalidResponseError(e)) {
     throw e;
   }
}
```

## 类型

### ApiGateway 错误细节

参考文献 _ApiGateway 错误_ 细节对象。 包含关于已收到的 API Getaway 错误的信息 .

#### 属性

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 约束 | 矩阵 <[约束暴力](https://npmcn.com/package/%40dynatrace-sdk/shared-errors/#readme-constraintviolation)\> 翻译: | 数组 _约束暴力_ 对象,可参考 ConstractViolation 对象的更详细信息. |
| 错误代码 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 
字符串值代表比仅http响应代码更详细的错误信息. 在CamelCase中必须是单词,所有可能的值都必须被记录.

 |
| 错误代码Propertys | 对象 |  |
| 引用错误 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | UUID 字符串代表错误的引用,例如服务日志文件. |
| 失踪 | 矩阵 <[字符串](https://developer.mozilla.org/en-US/docs/Glossary/String)\> 翻译: | 

必须是包含一个完整列表的字符串,其中包含成功执行请求所必需的缺失的IAM权限. 如果 API 返回一个 403 - 在 OAuth 用户权限缺失时禁止响应, 则应该设置 .

 |
| 缺少缩写 | 矩阵 <[字符串](https://developer.mozilla.org/en-US/docs/Glossary/String)\> 翻译: | 

必须是包含一个完整列表的字符串,其中包含成功执行请求所必需的缺失的IAM范围. 如果 API 返回一个 403 - 在 OAuth 范围缺失时禁止响应, 则应设定 .

 |
| 跟踪 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 字符串包含用于追踪的32个特征的十六进制整数值. |

### 常见错误

常见的API错误结构,由Dynatrace API准则所建立.

#### 属性

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 代码\*必须 | [编号](https://developer.mozilla.org/en-US/docs/Glossary/Number) | 
错误代码应默认设置为 HTTP 错误代码 .

错误代码可以设置为API特定错误代码,必须正确记录.

 |
| 细节 | T级 | 

关于错误的更多细节可以在一个细节字段中添加. 参见 _常见错误细节_

 |
| 帮助 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 

可添加一个额外的帮助字段,该字段必须是一个URL,以进一步了解如何处理错误.

这可能是一些详细的错误文档页面或连接到Dynatrace支持系统的链接等.

 |
| 消息\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 错误信息应当简短,准确,不应包含细节. |

### 常见错误细节

_常见错误_ 细节对象参考. 包含常见的 API 错误信息 . 这个对象用于传递关于错误的额外信息,例如,查询参数完全违反了先决条件.

细节可能包含进一步描述错误的任何字段

#### 属性

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 约束 | 矩阵 <[约束暴力](https://npmcn.com/package/%40dynatrace-sdk/shared-errors/#readme-constraintviolation)\> 翻译: | 数组 _约束暴力_ 对象,可参考 ConstractViolation 对象的更详细信息. |
| 错误代码 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 
字符串值代表比仅http响应代码更详细的错误信息. 在CamelCase中必须是单词,所有可能的值都必须被记录.

 |
| 引用错误 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | UUID 字符串代表错误的引用,例如服务日志文件. |
| 失踪 | 矩阵 <[字符串](https://developer.mozilla.org/en-US/docs/Glossary/String)\> 翻译: | 

必须是包含一个完整列表的字符串,其中包含成功执行请求所必需的缺失的IAM权限. 如果 API 返回一个 403 - 在 OAuth 用户权限缺失时禁止响应, 则应该设置 .

 |
| 缺少缩写 | 矩阵 <[字符串](https://developer.mozilla.org/en-US/docs/Glossary/String)\> 翻译: | 

必须是包含一个完整列表的字符串,其中包含成功执行请求所必需的缺失的IAM范围. 如果 API 返回一个 403 - 在 OAuth 范围缺失时禁止响应, 则应设定 .

 |
| 跟踪 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 字符串包含用于追踪的32个特征的十六进制整数值. |

### 约束暴力

包含关于输入参数(路径、查询或请求正文)的信息 这违反了服务API的一些验证规则并引起警告.

可能包含进一步描述警告的附加字段.

#### 属性

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 消息\*必须 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 描述警告的强制字段消息 . |
| 参数位置 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 描述违反参数(query参数,请求正文等)的一般位置 |
| 路径 | [字符串](https://developer.mozilla.org/en-US/docs/Glossary/String) | 指参数Location中的违反参数. |

### 回复错误

基本错误信封,即强制所有错误具有强制的"错误"属性.

#### 属性

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| 错误\*必须 | T级 | 
_错误_ 对象必须有两个强制字段(_代码、消息_)并可能有两个额外的字段(_帮助, 细节_: 参考 _常见错误_ 更多细节.

 |

## 常见问题

### @dynatrace-sdk/shared-errors 是什么？

自动生成 Dynatrace SDK 包的共享错误分类 \.

### 如何安装 @dynatrace-sdk/shared-errors？

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

### @dynatrace-sdk/shared-errors 支持 TypeScript 吗？

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

### @dynatrace-sdk/shared-errors 支持 ESM 还是 CommonJS？

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

### @dynatrace-sdk/shared-errors 可以商用吗？

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

### @dynatrace-sdk/shared-errors 的下载量有多少？

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

### @dynatrace-sdk/shared-errors 还在维护吗？

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