获取 /api/v1/projects/{id}/workspaces/{workspace_id}/deployments

ECP 代理,用于列出具有基于游标的分页和可选状态过滤的工作区的部署。项目范围由路由 ID 路径参数承载,而组织则派生自该项目。

路径参数

  • id 字符串 必需

    项目 ID

  • Workspace_id 字符串 必需

    工作区ID

查询参数

  • cursor 字符串

    不透明分页游标

  • limit 整型

    页面大小(1-100,默认20)

  • 状态 字符串

    部署状态过滤(已排队、进行中、清理、成功、失败、已回滚、已取消)

  • shipped_in_release 字符串

    返回此发布中附带的部署:其自己的工件部署加上在其削减之前落地的非版本部署。不包括回滚。

响应

  • 不支持或格式不正确的API版本、所选已发布合约中不可用的操作或不可接受的表示形式(包括不支持的媒体类型参数或排除的 SSE)。现有的身份验证、授权和速率限制失败优先。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      标准错误模式定义的可选验证详细信息; API协商错误不会发出此字段。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        验证失败的字段。

        隐藏字段属性 显示字段属性 对象

        字段及其验证失败。

        • 描述 字符串 必需

          人类可读的验证失败。

        • 字段 字符串 必需

          无效请求字段的名称或路径。

    • 详细信息 字符串 必需

      人类可读的错误详细信息。

    • 错误 整型 必需

      HTTP status code.

    • 错误代码 字符串 必需

      机器可读的错误代码。

    • 参数 array[string]

      与错误相关的请求参数名称;不应用时省略。

    • 原因 字符串 必需

      HTTP状态原因短语。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      标准错误模式定义的可选验证详细信息; API协商错误不会发出此字段。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        验证失败的字段。

        隐藏字段属性 显示字段属性 对象

        字段及其验证失败。

        • 描述 字符串 必需

          人类可读的验证失败。

        • 字段 字符串 必需

          无效请求字段的名称或路径。

    • 详细信息 字符串 必需

      人类可读的错误详细信息。

    • 错误 整型 必需

      HTTP status code.

    • 错误代码 字符串 必需

      机器可读的错误代码。

    • 参数 array[string]

      与错误相关的请求参数名称;不应用时省略。

    • 原因 字符串 必需

      HTTP状态原因短语。

  • 200

    正常

    隐藏响应属性 显示响应属性 对象
    • 部署 大量[对象]
      隐藏部署属性 显示部署属性 对象
      • aer_http_endpoint 字符串

        AERHTTPEndpoint 是代理沙箱HTTP端点的旧名称。

      • agent_http_endpoint 字符串

        AgentHTTPEndpoint 是代理沙箱HTTP端点。与 aer_http_endpoint 的值相同。

      • agent_stack_name 字符串
      • app_id 字符串
      • 分支 字符串
      • build_id 字符串
      • commit_sha 字符串
      • completed_at 字符串
      • component_images 对象
        隐藏component_images属性 显示component_images 属性 对象
        • aer 字符串

          AER 是代理沙盒映像的旧名称。

        • 助手 字符串

          代理是代理沙盒映像。与 aer 的值相同。

        • memory_server 字符串
        • oe 字符串
        • 工具 字符串
      • 组件 大量[对象]

        每个组件的运行状况 — 从 ECP 中按原样转发,用于详细信息视图。

        隐藏组件属性 显示组件属性 对象
        • available 布尔
        • failure_message 字符串
        • failure_reason 字符串
        • 名称 字符串
        • ready_replicas 整型
        • replicas 整型

          Replicas 是所需的 Pod 数量。零表示平台尚未报告 1;消费者不得将零视为从零开始。

        • sandbox 字符串

          Sandbox 是已知组件值(代理、工具)的规范沙箱名称。对于未知的上游名称,则省略。

        • 类型 字符串
      • 条件 大量[对象]
        隐藏条件属性 显示条件属性 对象
        • last_transition_time 字符串
        • message 字符串
        • 原因 字符串
        • 状态 字符串
        • 类型 字符串
      • created_at 字符串

        时间戳。

      • deployment_id 字符串

        Identity &核心状态(始终存在)。

      • duration_ms 整型
      • error_message 字符串

        故障上下文 — 浮出水面,以便管理员用户界面可以进行分类,而无需先访问 Splunk。

      • executor_type 字符串
      • first_deploy 布尔

        在工作区首次成功部署(包括)之前,FirstDeploy 对于每次尝试都为 true。未知时省略。

      • 健康 对象

        扩展字段。

        隐藏健康属性 显示运行状况属性 对象
        • available 布尔
        • checked_at 字符串
        • 组件 大量[对象]
          隐藏组件属性 显示组件属性 对象
          • 名称 字符串
          • 准备就绪 布尔
          • ready_replicas 整型
          • sandbox 字符串

            Sandbox 是已知组件值(代理、工具)的规范沙箱名称。对于未知的上游名称,则省略。

      • image_uri 字符串

        图片/来源。

      • 语言 字符串

        Language 是从 ECP 转发的代理运行时语言("Python" | "TypeScript")。未设置时省略(较旧的版本默认为 python 下游)。

      • last_event_seq 整型
      • memory_enabled 布尔

        MemoryEnabled 是部署的有效运行时内存设置。不可用时省略。

      • missing_secrets array[string]
      • operator_namespace 字符串
      • org_id 字符串
      • post_deploy_error_message 字符串
      • previous_image_uri 字符串
      • project_deleted 布尔

        当部署的所属项目已被软删除时为 true。始终发出,以便消费者可以在字段时进行分支,而不是在字段缺失时进行分支。

      • PROJECT_ID 字符串
      • release_number 整型

        ReleaseNumber 是每个工作区的单调版本标识符(驱动用户界面中的 v{N} 标签)。 0/省略回填迁移之前的旧记录。

      • requests_images 大量[对象]

        RequestedImages 是摘要固定的部署意图。对于在启用映像摘要跟踪之前创建的传统部署,则省略; [] 表示作者已运行但未解决任何问题。

        隐藏 requests_images 属性 显示requested_images 属性 对象
        • 组件 字符串
        • 摘要 字符串
        • sandbox 字符串

          Sandbox 是已知组件值的规范沙箱名称。对于未知的上游名称,则省略。

      • requested_target_id 字符串

        RequestedTargetID 源自内部队列,并且故意不在网关响应中显示。为了保持兼容性,它保留为空。

      • rollback_error 字符串
      • rollback_from_id 字符串

        设立此部署何时回滚

      • rollback_of 字符串

        回滚链接。

      • shipped_in_release 字符串

        ShippedInRelease 是发布此部署的发布。如果不属于任何一个,则省略。从 ECP 转发;在读取时派生。

      • source_build_id 字符串
      • source_project_id 字符串
      • source_promotion_id 字符串
      • source_workspace_id 字符串
      • started_at 字符串
      • 状态 字符串
      • target_namespace 字符串

        Kubernetes放置。

      • 触发器 字符串
      • updated_at 字符串
      • 版本 字符串

        版本是开发者声明的从 ECP 转发的代理版本。对于未进行版本控制的记录,可省略。

    • limit 整型

      由偏移分页的全平台管理员列表设置。每个工作区端点将这些零值保留,并在线上省略。

    • next_cursor 字符串

      由按工作区的游标分页管理员列表设置。全平台端点将其保留为零。

    • 偏移量 整型
    • 总计 整型
    隐藏响应属性 显示响应属性 对象
    • 部署 大量[对象]
      隐藏部署属性 显示部署属性 对象
      • aer_http_endpoint 字符串

        AERHTTPEndpoint 是代理沙箱HTTP端点的旧名称。

      • agent_http_endpoint 字符串

        AgentHTTPEndpoint 是代理沙箱HTTP端点。与 aer_http_endpoint 的值相同。

      • agent_stack_name 字符串
      • app_id 字符串
      • 分支 字符串
      • build_id 字符串
      • commit_sha 字符串
      • completed_at 字符串
      • component_images 对象
        隐藏component_images属性 显示component_images 属性 对象
        • aer 字符串

          AER 是代理沙盒映像的旧名称。

        • 助手 字符串

          代理是代理沙盒映像。与 aer 的值相同。

        • memory_server 字符串
        • oe 字符串
        • 工具 字符串
      • 组件 大量[对象]

        每个组件的运行状况 — 从 ECP 中按原样转发,用于详细信息视图。

        隐藏组件属性 显示组件属性 对象
        • available 布尔
        • failure_message 字符串
        • failure_reason 字符串
        • 名称 字符串
        • ready_replicas 整型
        • replicas 整型

          Replicas 是所需的 Pod 数量。零表示平台尚未报告 1;消费者不得将零视为从零开始。

        • sandbox 字符串

          Sandbox 是已知组件值(代理、工具)的规范沙箱名称。对于未知的上游名称,则省略。

        • 类型 字符串
      • 条件 大量[对象]
        隐藏条件属性 显示条件属性 对象
        • last_transition_time 字符串
        • message 字符串
        • 原因 字符串
        • 状态 字符串
        • 类型 字符串
      • created_at 字符串

        时间戳。

      • deployment_id 字符串

        Identity &核心状态(始终存在)。

      • duration_ms 整型
      • error_message 字符串

        故障上下文 — 浮出水面,以便管理员用户界面可以进行分类,而无需先访问 Splunk。

      • executor_type 字符串
      • first_deploy 布尔

        在工作区首次成功部署(包括)之前,FirstDeploy 对于每次尝试都为 true。未知时省略。

      • 健康 对象

        扩展字段。

        隐藏健康属性 显示运行状况属性 对象
        • available 布尔
        • checked_at 字符串
        • 组件 大量[对象]
          隐藏组件属性 显示组件属性 对象
          • 名称 字符串
          • 准备就绪 布尔
          • ready_replicas 整型
          • sandbox 字符串

            Sandbox 是已知组件值(代理、工具)的规范沙箱名称。对于未知的上游名称,则省略。

      • image_uri 字符串

        图片/来源。

      • 语言 字符串

        Language 是从 ECP 转发的代理运行时语言("Python" | "TypeScript")。未设置时省略(较旧的版本默认为 python 下游)。

      • last_event_seq 整型
      • memory_enabled 布尔

        MemoryEnabled 是部署的有效运行时内存设置。不可用时省略。

      • missing_secrets array[string]
      • operator_namespace 字符串
      • org_id 字符串
      • post_deploy_error_message 字符串
      • previous_image_uri 字符串
      • project_deleted 布尔

        当部署的所属项目已被软删除时为 true。始终发出,以便消费者可以在字段时进行分支,而不是在字段缺失时进行分支。

      • PROJECT_ID 字符串
      • release_number 整型

        ReleaseNumber 是每个工作区的单调版本标识符(驱动用户界面中的 v{N} 标签)。 0/省略回填迁移之前的旧记录。

      • requests_images 大量[对象]

        RequestedImages 是摘要固定的部署意图。对于在启用映像摘要跟踪之前创建的传统部署,则省略; [] 表示作者已运行但未解决任何问题。

        隐藏 requests_images 属性 显示requested_images 属性 对象
        • 组件 字符串
        • 摘要 字符串
        • sandbox 字符串

          Sandbox 是已知组件值的规范沙箱名称。对于未知的上游名称,则省略。

      • requested_target_id 字符串

        RequestedTargetID 源自内部队列,并且故意不在网关响应中显示。为了保持兼容性,它保留为空。

      • rollback_error 字符串
      • rollback_from_id 字符串

        设立此部署何时回滚

      • rollback_of 字符串

        回滚链接。

      • shipped_in_release 字符串

        ShippedInRelease 是发布此部署的发布。如果不属于任何一个,则省略。从 ECP 转发;在读取时派生。

      • source_build_id 字符串
      • source_project_id 字符串
      • source_promotion_id 字符串
      • source_workspace_id 字符串
      • started_at 字符串
      • 状态 字符串
      • target_namespace 字符串

        Kubernetes放置。

      • 触发器 字符串
      • updated_at 字符串
      • 版本 字符串

        版本是开发者声明的从 ECP 转发的代理版本。对于未进行版本控制的记录,可省略。

    • limit 整型

      由偏移分页的全平台管理员列表设置。每个工作区端点将这些零值保留,并在线上省略。

    • next_cursor 字符串

      由按工作区的游标分页管理员列表设置。全平台端点将其保留为零。

    • 偏移量 整型
    • 总计 整型
  • Bad Request

    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
  • Forbidden

    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
  • 错误网关

    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
GET /api/v1/projects/{id}/workspaces/{workspace_id}/deployments
curl \
 --request GET 'https://agentengine.mongodb.com/api/v1/projects/{id}/workspaces/{workspace_id}/deployments' \
 --header "Authorization: $API_KEY"
响应示例 (406)
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "This operation supports text/event-stream, which the Accept header excludes. Remove unsupported media-type parameters or accept this type with a positive q value.",
  "error": 406,
  "errorCode": "UNACCEPTABLE_MEDIA_TYPE",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "The requested API version is not supported. Supported versions: 2026-09-20-preview.",
  "error": 406,
  "errorCode": "UNSUPPORTED_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
响应示例 (406)
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
响应示例 (200)
{
  "deployments": [
    {
      "aer_http_endpoint": "string",
      "agent_http_endpoint": "string",
      "agent_stack_name": "string",
      "app_id": "string",
      "branch": "string",
      "build_id": "string",
      "commit_sha": "string",
      "completed_at": "string",
      "component_images": {
        "aer": "string",
        "agent": "string",
        "memory_server": "string",
        "oe": "string",
        "tool": "string"
      },
      "components": [
        {
          "available": true,
          "failure_message": "string",
          "failure_reason": "string",
          "name": "string",
          "ready_replicas": 42,
          "replicas": 42,
          "sandbox": "string",
          "type": "string"
        }
      ],
      "conditions": [
        {
          "last_transition_time": "string",
          "message": "string",
          "reason": "string",
          "status": "string",
          "type": "string"
        }
      ],
      "created_at": "string",
      "deployment_id": "string",
      "duration_ms": 42,
      "error_message": "string",
      "executor_type": "string",
      "first_deploy": true,
      "health": {
        "available": true,
        "checked_at": "string",
        "components": [
          {
            "name": "string",
            "ready": true,
            "ready_replicas": 42,
            "sandbox": "string"
          }
        ]
      },
      "image_uri": "string",
      "language": "string",
      "last_event_seq": 42,
      "memory_enabled": true,
      "missing_secrets": [
        "string"
      ],
      "operator_namespace": "string",
      "org_id": "string",
      "post_deploy_error_message": "string",
      "previous_image_uri": "string",
      "project_deleted": true,
      "project_id": "string",
      "release_number": 42,
      "requested_images": [
        {
          "component": "string",
          "digest": "string",
          "sandbox": "string"
        }
      ],
      "requested_target_id": "string",
      "rollback_error": "string",
      "rollback_from_id": "string",
      "rollback_of": "string",
      "shipped_in_release": "string",
      "source_build_id": "string",
      "source_project_id": "string",
      "source_promotion_id": "string",
      "source_workspace_id": "string",
      "started_at": "string",
      "status": "string",
      "target_namespace": "string",
      "trigger": "string",
      "updated_at": "string",
      "version": "string"
    }
  ],
  "limit": 42,
  "next_cursor": "string",
  "offset": 42,
  "total": 42
}
响应示例 (200)
{
  "deployments": [
    {
      "aer_http_endpoint": "string",
      "agent_http_endpoint": "string",
      "agent_stack_name": "string",
      "app_id": "string",
      "branch": "string",
      "build_id": "string",
      "commit_sha": "string",
      "completed_at": "string",
      "component_images": {
        "aer": "string",
        "agent": "string",
        "memory_server": "string",
        "oe": "string",
        "tool": "string"
      },
      "components": [
        {
          "available": true,
          "failure_message": "string",
          "failure_reason": "string",
          "name": "string",
          "ready_replicas": 42,
          "replicas": 42,
          "sandbox": "string",
          "type": "string"
        }
      ],
      "conditions": [
        {
          "last_transition_time": "string",
          "message": "string",
          "reason": "string",
          "status": "string",
          "type": "string"
        }
      ],
      "created_at": "string",
      "deployment_id": "string",
      "duration_ms": 42,
      "error_message": "string",
      "executor_type": "string",
      "first_deploy": true,
      "health": {
        "available": true,
        "checked_at": "string",
        "components": [
          {
            "name": "string",
            "ready": true,
            "ready_replicas": 42,
            "sandbox": "string"
          }
        ]
      },
      "image_uri": "string",
      "language": "string",
      "last_event_seq": 42,
      "memory_enabled": true,
      "missing_secrets": [
        "string"
      ],
      "operator_namespace": "string",
      "org_id": "string",
      "post_deploy_error_message": "string",
      "previous_image_uri": "string",
      "project_deleted": true,
      "project_id": "string",
      "release_number": 42,
      "requested_images": [
        {
          "component": "string",
          "digest": "string",
          "sandbox": "string"
        }
      ],
      "requested_target_id": "string",
      "rollback_error": "string",
      "rollback_from_id": "string",
      "rollback_of": "string",
      "shipped_in_release": "string",
      "source_build_id": "string",
      "source_project_id": "string",
      "source_promotion_id": "string",
      "source_workspace_id": "string",
      "started_at": "string",
      "status": "string",
      "target_namespace": "string",
      "trigger": "string",
      "updated_at": "string",
      "version": "string"
    }
  ],
  "limit": 42,
  "next_cursor": "string",
  "offset": 42,
  "total": 42
}
响应示例 (400)
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (400)
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (403)
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (403)
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (502)
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (502)
{
  "code": "string",
  "error": "string",
  "success": true
}