错误处理

当调用Reactor API时出现问题时,可能会通过以下方式之一返回错误:

  • 立即错误:执行导致立即错误的请求时,API会返回错误响应,HTTP状态反映所发生错误的一般类型。
  • 延迟错误:执行导致延迟错误(如异步活动)的API请求时,API可能会在相关资源中返 meta.status_details 回错误。

错误格式

错误响应旨在符合JSON:API错误规范,并且通常遵循以下结构:

{
  "errors": [
    {
      "id": "8a5526da-ab12-4be9-b084-2efe537f388c",
      "status": "404",
      "code": "not-found",
      "title": "Record Not Found",
      "meta": {
        "request_id": "jfb0dQ2e0XVTkQ6AOfEJFfTDjguw9x3d"
      },
      "source": {
        "pointer": "/data"
      }
    }
  ]
}
属性 描述
id 此问题特定发生情况的唯一标识符。
status 适用于此问题的HTTP状态代码,以字符串值表示。
code 特定于应用程序的错误代码,以字符串值表示。
title 关于​不应将​从发生变为发生的问题的简短、人类可读的摘要,但出于本地化目的除外。
detail 特定于此问题发生的人类可读解释。 与title类似,此字段的值也可以本地化。
source 包含对错误源的引用的对象,可选包括以下任一成员:
  • pointer:引用请求文档中关联实体(例如,主数据对象或特定属性)的 JSON指针( RFC6901) /data /data/attributes/title 字符串。
meta 包含有关错误的非标准元数据的对象。

错误引用

下表列出了API可返回的不同错误。

错误标题 描述
authentication-failure 您的IMS访问令牌无效。 您可以通过再次登录来获取新的访问令牌。 或者,对于技术帐户,生成新JWT并交换IMS访问令牌。
connection-refused 无法建立与服务器的连接。
decrypt-bad-passphrase 无法使用提供的密码对数据进行解密。
decrypt-failed 无法使用提供的私钥解密数据。 确保键可在本地工作,并且已裁剪空格。
decrypt-no-data 如果没有私钥,数据将无法解密。 请提供加密私钥。
delegate-descriptor-unresolved 扩展未提供此委托描述符的预期定义。 可能需要更新扩展。
deleted-resources 您尝试添加到库的资源已被删除。
environment-in-use 一次只能将环境分配到一个库。 选项1是选择其他环境。 选项2是通过将库移动到其他环境或删除库来释放此环境。
environment-required 在创建内部版本之前,您的库必须已分配环境。
extension-not-found 定义数据元素或规则组件的扩展未包含在库中。 确保将所有必需的扩展添加到您的库中。
extension-package-path-error extension.json中定义的路径构造不正确。
extension-package-transform-definition-error 您为对象属性定义了无效的转换。 每个对象属性都可以定义一个转换,它必须是文件转换或函数转换。
extension-package-zip-error 解压缩ExtensionPackage或压缩文件以进行分发时出错。
host-in-use 如果一个或多个环境正在使用主机,则不能删除该主机。
host-required 分配给此库的环境没有有效的主机。 检查为库分配的环境。 然后,为该环境分配一个有效的主机。
host-type-error 只有SFTP主机需要先验证凭据才能使用,因此预测仅适用于该主机类型。
illegal-custom-code-transform 不允许使用customCode转换。 请指定函数或文件转换。
ims-not-authorized 授权您的帐户时出现未知错误。 请稍后再试。
ims-session-error 登录会话存在问题。 请注销并重新登录。
internal-error 发生内部错误。 请等待几分钟,然后重试。 如果问题仍然存在,请联系客户关怀团队。
invalid-data_element 无法将无效的数据元素添加到库中。
invalid-embed_code 这不是有效的嵌入代码,或者您正在尝试将其链接到开发或暂存环境。 动态标签管理(DTM)嵌入代码只能链接到生产环境。
invalid-extension 无法将无效的扩展添加到库。
invalid-extension_package_id 您只能修改扩展包的某些对象属性。 您尝试修改其中一个不允许的。
invalid-new-owner-org-id 您尝试分配的组织ID不是有效的组织ID。
invalid-org 您的活动组织无权访问API。 检查您使用的组织是否正确。
invalid-rule 无法将无效规则添加到库。
invalid-settings-syntax 解析设置JSON时遇到语法错误。
library-file-not-found 在zip包中找不到extension.json中定义的必需文件。
minification-error 由于代码或ES6代码无效,无法编译代码。
multiple-revisions 库中只能包含每个资源的一个修订版本。
no-available-orgs 此用户帐户不属于有权访问标记的产品配置文件。 使用Admin Console将此用户添加到具有标记权限的产品配置文件中。
not-authorized 此用户帐户没有执行此操作所需的权限。
not-found 找不到记录。 验证您尝试检索的对象的id。
not-unique 您尝试使用的名称已在使用中。 对于此资源,“name”属性必须唯一。
public-release-not-authorized 扩展的公开发布由launch-ext-dev@adobe.com协调。 有关详细信息,请参阅发行扩展的文档。
read-only 此资源为只读,无法修改。
session-timeout 用户会话已过期。 请注销并重新登录。
sftp-authentication-failed SFTP连接的身份验证失败。
sftp-connection-timeout SFTP连接已超时。
sftp-exception 使用SFTP连接到服务器时遇到异常。
sftp-status-exception 尝试与服务器通信时遇到SFTP异常。
socket-error 尝试与服务器通信时遇到套接字错误。
ssh-disconnect SSH会话已断开。
timeout-error 与服务器的连接超时。
unknown-error 发生意外错误。 您可以稍后重试,或致电客户关怀,并说明发生时您正在执行的操作。
unsupported-custom-code-language 提供了不支持的自定义代码语言。
upgraded-extension-required 安装扩展升级后,必须将其包含在所有库中,直到升级到生产环境为止。 唯一的例外是扩展尚未发布。
upstream-build-required 需要成功生成上游库,然后才能生成此库。

在此页面上