检查集成状态和设置

您正在查看 Apigee Edge 文档。
前往 Apigee X 文档。 info

本页面介绍了如何在启用 Apigee Edge API Hub 连接器集成后，检查 Apigee Edge 组织中的该集成的状态和设置。

检查 API Hub 连接器集成设置

如需检索组织的 API Hub 连接器集成设置，请发出 GET 请求以发送以下请求：

curl -X GET https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/settings -H "Authorization: Bearer OAUTH_TOKEN"

其中：

  • ORG_NAME 是您的 Apigee Edge 组织的名称。
  • OAUTH_TOKEN 是用于对请求进行身份验证的 OAuth 令牌。如需详细了解如何创建 OAuth 令牌，请参阅获取令牌。

成功的响应类似于以下内容：

  {
    "enabled": true,
    "gatewayId": "my-gateway-id"
  }

"enabled": true 确认已为组织启用 API Hub 连接器集成。

"gatewayId" 显示此 Apigee Edge 组织所连接到的实例资源名称。

检查整合状态

如需获取包含详细上传进度的整合状态 ，请向 Edge 管理 API 发出 GET 请求：

curl -X GET https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/status
  -H "Authorization: Bearer OAUTH_TOKEN

其中：

  • ORG_NAME 是您的 Apigee Edge 组织的名称。

成功的整合响应类似于以下内容，显示了代理和环境的上传进度。以下示例显示了 Queued 阶段：

{
  "phase": "Preparing",
  "lastUpdated": "2025-09-15T02:23:50.706Z",
  "components": {
    "proxy": {
      "lastUpdated": "2025-09-15T02:23:50.706Z",
      "progress": {
        "totalItems": 10,
        "pendingItems": 1,
        "completedItems": 9,
        "failedItems": 0
      }
    },
    "environment": {
      "lastUpdated": "2025-09-15T02:23:50.706Z",
      "progress": {
        "totalItems": 5,
        "pendingItems": 0,
        "completedItems": 4,
        "failedItems": 1
      }
    }
  }
}

整合状态字段

字段 说明
phase 组织的当前处理阶段。可能的值如下：
  • Queued：组织是最近添加的，并且已加入初始处理队列。
  • Preparing：组织处于冷传输状态，所有现有代理都将上传到 API Hub。当组织是最近添加的并且正在准备时，会出现此状态。
  • Processing：组织处于持续更新状态，对代理和环境的更改会持续上传到 API Hub。
lastUpdated 为此组织处理的最后一个事件的时间戳。
components 一个映射，提供有关已处理的代理和环境的详细信息。该映射可以包含以下键：
  • proxy：提供 Edge 系统中已处理并上传到 API Hub 的 API 代理的详细计数。
  • environment：提供 Edge 系统中已处理并上传到 API Hub 的环境的详细计数。
progress proxy 或 environment 部分中的值如下：
  • totalItems：项总数。
  • pendingItems：待处理的项数。
  • completedItems：已成功完成的项数。
  • failedItems：上传期间失败的项数。

检查详细上传状态

您可以使用 /details 端点和查询参数检查单个 API 代理或环境的详细状态，或按状态过滤的项组的详细状态。

特定项的状态

如需检查特定项的详细状态，请使用 filter 和 name 查询参数。对于组织 acme 中名为 myproxy 的 API 代理，请按如下方式调用状态 API：

curl -X GET https://api.enterprise.apigee.com/v1/organizations/acme/uapim/status/details?filter=proxy&name=myproxy \
  -H "Authorization: Bearer OAUTH_TOKEN"

对于组织 acme 中名为 myenv 的环境，请按如下方式调用状态 API：

GET http://enterprise.apigee.com/organizations/acme/uapim/status/details?filter=environment&name=myenv

调用上述 API 将生成类似于以下内容的 JSON 输出，适用于最近上传的代理：

{
  "name": "myProxy",
  "status": "Pending Upload",
  "lastSuccessfulUploadTime": "2025-09-15T02:23:50.706Z",
}

包含修订版本信息的详细状态

您可以提供额外的查询参数 showRevisions=true，以获取给定代理的各个代理修订版本的相关信息。此处生成的输出将提供有关已为给定代理上传的每个修订版本的详细信息。

GET http://enterprise.apigee.com/organizations/acme/uapim/status/details?filter=proxy&name=myproxy&showRevisions=true

使用 showrevisions 参数调用上述 API 将生成类似于以下内容的 JSON 输出：

{
  "name": "myProxy",
  "status": "Pending Upload",
  "lastSuccessfulUploadTime": "2025-09-15T02:23:50.706Z",
  "revisions": [
    {
      "name": "1",
      "status": "Up to date",
      "lastSuccessfulUploadTime": "2025-09-15T02:23:50.706Z",
    },  
    {
      "name": "2",
      "status": "Pending upload",
      "lastSuccessfulUploadTime": "2025-09-15T02:23:55.000Z",
    }  
  ]
}

群组上传状态

您可以使用群组过滤条件和 state 查询参数获取一组项的上传状态。

如需获取组织 acme 中处于失败 状态的所有 API 代理的状态，请按如下方式调用状态 API：

GET http://enterprise.apigee.com/organizations/acme/uapim/status/details?filter=proxy&state=failed

同样，如需获取组织 acme 中待上传 的所有环境的详细列表，请按如下方式调用状态 API：

GET http://enterprise.apigee.com/organizations/acme/uapim/status/details?filter=environment&state=pending

调用此 API 的结果将是与过滤条件匹配的各个状态项的 JSON 集合。示例：

[
  {
    "name": "myProxy",
    "status": "last upload failed",
    "lastSuccessfulUploadTime": "2025-09-12T02:23:50.706Z",
    "lastFailedUploadTime": "2025-09-13T02:23:50.706Z",
    "lastUploadError": "Errors connecting to API Hub"
  },
  {
    "name": "secondProxy",
    "status": "last upload failed",
    "lastSuccessfulUploadTime": "2025-09-12T02:23:51.706Z",
    "lastFailedUploadTime": "2025-09-13T02:23:51.706Z",
    "lastUploadError": "Errors connecting to API Hub"
  }
]

详细状态的查询参数

该 API 提供三个查询参数。这些值区分大小写。

查询参数 可能的值 说明
filter proxy、environment 此查询参数表示需要按代理或环境过滤结果。
state failed、pending、all 此查询参数表示除了 filter 之外，还需要按状态过滤结果。
name 特定项的名称 此查询参数表示除了 filter 之外，还需要按名称过滤结果。
showrevisions true、false 如果提供此查询参数，则会在输出中生成修订版本状态（仅当 filter=proxy 时有效）。

详细状态的参数组合

下表介绍了可以传递给 REST API 以获取详细状态的可能参数组合。NA 表示该参数将被忽略。NULL 表示未提供该参数。

过滤条件 状态 名称 结果
proxy all NULL 报告所有代理的状态详情。
proxy failed NULL 报告上传失败的所有代理的状态详情。
proxy pending NULL 报告待上传或重新上传的所有代理的状态详情。
proxy NULL myproxy 报告名为 myproxy 的代理的状态详情。
proxy NON-NULL NON-NULL 报告错误。
environment all NULL 报告所有环境的状态详情。
environment failed NULL 报告上传失败的所有环境的状态详情。
environment pending NULL 报告待上传或重新上传的所有环境的状态详情。
environment NULL myenv 报告名为 myenv 的环境的状态详情。
environment NON-NULL NON-NULL 报告错误。