标题: "@dynatrace-sdk/shared-errors" 说明:自动生成 Dynatrace SDK 包的共享错误分类.
自动生成 Dynatrace SDK 包的共享错误分类 .
npm install @dynatrace-sdk/shared-errors
类
ApiClient 错误
所有客户端 SDK 的基准错误 。 所有其它错误都扩展了这一类.
构造器
新的 ApiClientError( 名称、 消息? 因为 )
属性
| 名称 | 类型 | 说明 |
|---|---|---|
| 原因 | 任意 | |
| 错误类型*必须 | 错误类型 | |
| 是 Apiclient 错误*必须 | 真实 |
ApiGateway 错误
API Gateway所抛出错误的专门错误响应类. 自动生成 SDK 客户端已经为 API Gateway 错误设置了内置处理器, 以丢出此错误 .
构造器
新建 ApiGateway Error( 响应, 机构)
参数
| 名称 | 类型 |
|---|---|
| 回应*必须 | Http 客户端响应 |
| 机构*必须 | ApiGateway 错误反应 |
属性
| 名称 | 类型 | 说明 |
|---|---|---|
| 机构*必须 | ApiGateway 错误反应 | |
| 原因 | 任意 | |
| 代码*必须 | 编号 | |
| 错误类型*必须 | 错误类型 | |
| 是 Apiclient 错误*必须 | 真实 | |
| 是 ApiGateway 错误*必须 | 真实 | |
| 是 client 请求错误*必须 | 真实 | |
| 回应*必须 | Http 客户端响应 | |
| 秒后重试*必须 | 未定义qq 编号 |
客户端请求错误
用于处理预期和意外的服务级别错误的通用错误类.
构造器
新的客户端请求错误( 名称、 回复、 机构、 消息? ) 因为
属性
| 名称 | 类型 | 说明 |
|---|---|---|
| 机构*必须 | 数字 | |
| 原因 | 任意 | |
| 错误类型*必须 | 错误类型 | |
| 是 Apiclient 错误*必须 | 真实 | |
| 是 client 请求错误*必须 | 真实 | |
| 回应*必须 | Http 客户端响应 |
无效的响应错误
专为响应序列化相关的出错分类. 接收到的服务响应后抛出,不能被去序列化.
构造器
新建无效的响应错误( name, nestedError, body, expect Type?, 消息?, 答复 ?)
属性
| 名称 | 类型 | 说明 |
|---|---|---|
| 原因 | 任意 | |
| 错误类型*必须 | 错误类型 | |
| 预期类型 | 字符串 | |
| 是 Apiclient 错误*必须 | 真实 | |
| 无效响应错误*必须 | 真实 | |
| 嵌入错误 | 错误 | |
| 回应*必须 | 任意 | |
| 回应Body*必须 | 任意 |
职能
是 Apiclient 错误
ApiClientError 类型守护功能 . 对通过的对象进行结构检查.
参数
| 名称 | 类型 |
|---|---|
| 电子*必须 | 任意 |
代码示例
try {
doSomething();
} catch (e: unknown) {
if(isApiClientError(e)) {
handleTheError();
}
}
是 ApiGateway 错误
APIGateway Error 类型守护功能. 对通过的对象进行结构检查.
参数
| 名称 | 类型 |
|---|---|
| 电子*必须 | 任意 |
代码示例
try {
doSomething();
} catch (e: unknown) {
if(isApiClientError(e)) {
handleTheError();
}
}
是 client 请求错误
客户端请求错误类型守护功能 . 对通过的对象进行结构检查.
参数
| 名称 | 类型 |
|---|---|
| 电子*必须 | 任意 |
代码示例
try {
doSomething();
} catch (e: unknown) {
if(isClientRequestError(e)) {
handleTheError();
}
}
无效响应错误
无效的响应 Error 类型守护功能 . 对通过的对象进行结构检查.
还返回 true 页:1 DataTypeError 所抛出的例子
@dynatrace-sdk/http-client 当一个响应机构不能解码为
预期类型( 如服务器返回) text/html 但SDK请求
application/json) (中文(简体) ). 将这些人视为 InvalidResponseError 让应用程序代码
处理“响应不匹配预期计划”与单项
类型警卫.
参数
| 名称 | 类型 |
|---|---|
| 电子*必须 | 任意 |
代码示例
try {
doSomething();
} catch (e: unknown) {
if (isInvalidResponseError(e)) {
throw e;
}
}
类型
ApiGateway 错误细节
参考文献 ApiGateway 错误 细节对象。 包含关于已收到的 API Getaway 错误的信息 .
属性
| 名称 | 类型 | 说明 |
|---|---|---|
| 约束 | 矩阵 <约束暴力> 翻译: | 数组 约束暴力 对象,可参考 ConstractViolation 对象的更详细信息. |
| 错误代码 | 字符串 | 字符串值代表比仅http响应代码更详细的错误信息. 在CamelCase中必须是单词,所有可能的值都必须被记录. |
| 错误代码Propertys | 对象 | |
| 引用错误 | 字符串 | UUID 字符串代表错误的引用,例如服务日志文件. |
| 失踪 | 矩阵 <字符串> 翻译: | 必须是包含一个完整列表的字符串,其中包含成功执行请求所必需的缺失的IAM权限. 如果 API 返回一个 403 - 在 OAuth 用户权限缺失时禁止响应, 则应该设置 . |
| 缺少缩写 | 矩阵 <字符串> 翻译: | 必须是包含一个完整列表的字符串,其中包含成功执行请求所必需的缺失的IAM范围. 如果 API 返回一个 403 - 在 OAuth 范围缺失时禁止响应, 则应设定 . |
| 跟踪 | 字符串 | 字符串包含用于追踪的32个特征的十六进制整数值. |
常见错误
常见的API错误结构,由Dynatrace API准则所建立.
属性
| 名称 | 类型 | 说明 |
|---|---|---|
| 代码*必须 | 编号 | 错误代码应默认设置为 HTTP 错误代码 . 错误代码可以设置为API特定错误代码,必须正确记录. |
| 细节 | T级 | 关于错误的更多细节可以在一个细节字段中添加. 参见 常见错误细节 |
| 帮助 | 字符串 | 可添加一个额外的帮助字段,该字段必须是一个URL,以进一步了解如何处理错误. 这可能是一些详细的错误文档页面或连接到Dynatrace支持系统的链接等. |
| 消息*必须 | 字符串 | 错误信息应当简短,准确,不应包含细节. |
常见错误细节
常见错误 细节对象参考. 包含常见的 API 错误信息 . 这个对象用于传递关于错误的额外信息,例如,查询参数完全违反了先决条件.
细节可能包含进一步描述错误的任何字段
属性
| 名称 | 类型 | 说明 |
|---|---|---|
| 约束 | 矩阵 <约束暴力> 翻译: | 数组 约束暴力 对象,可参考 ConstractViolation 对象的更详细信息. |
| 错误代码 | 字符串 | 字符串值代表比仅http响应代码更详细的错误信息. 在CamelCase中必须是单词,所有可能的值都必须被记录. |
| 引用错误 | 字符串 | UUID 字符串代表错误的引用,例如服务日志文件. |
| 失踪 | 矩阵 <字符串> 翻译: | 必须是包含一个完整列表的字符串,其中包含成功执行请求所必需的缺失的IAM权限. 如果 API 返回一个 403 - 在 OAuth 用户权限缺失时禁止响应, 则应该设置 . |
| 缺少缩写 | 矩阵 <字符串> 翻译: | 必须是包含一个完整列表的字符串,其中包含成功执行请求所必需的缺失的IAM范围. 如果 API 返回一个 403 - 在 OAuth 范围缺失时禁止响应, 则应设定 . |
| 跟踪 | 字符串 | 字符串包含用于追踪的32个特征的十六进制整数值. |
约束暴力
包含关于输入参数(路径、查询或请求正文)的信息 这违反了服务API的一些验证规则并引起警告.
可能包含进一步描述警告的附加字段.
属性
| 名称 | 类型 | 说明 |
|---|---|---|
| 消息*必须 | 字符串 | 描述警告的强制字段消息 . |
| 参数位置 | 字符串 | 描述违反参数(query参数,请求正文等)的一般位置 |
| 路径 | 字符串 | 指参数Location中的违反参数. |
回复错误
基本错误信封,即强制所有错误具有强制的"错误"属性.
属性
| 名称 | 类型 | 说明 |
|---|---|---|
| 错误*必须 | T级 | 错误 对象必须有两个强制字段(代码、消息)并可能有两个额外的字段(帮助, 细节: 参考 常见错误 更多细节. |