获取项目中的Atlas 集群

获取 /api/v1/atlas/projects/{project_id}/clusters/{cluster_name}
持有者身份验证

使用人工调用者的委托令牌或配对的代理引擎服务帐户，首先查找Atlas Flex集群，然后查找专用集群。详细响应包括Atlas从空闲 Flex 集群的列表响应中省略的连接字符串。不接受代理引擎API密钥。在任何Atlas调用之前，无效的 project_id 或 cluster_name 会被拒绝。

路径参数

  • PROJECT_ID 字符串 必需

    Atlas项目ID

  • cluster_name 字符串 必需

    Atlas 集群名称

响应

  • 406

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

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

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

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

        验证失败的字段。

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

        字段及其验证失败。

        • 描述 字符串 必需

          人类可读的验证失败。

        • 字段 字符串 必需

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

    • 详细信息 字符串 必需

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

    • 错误 整型 必需

      HTTP status code.

    • 错误代码 字符串 必需

      机器可读的错误代码。

    • 参数 array[string]

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

    • 原因 字符串 必需

      HTTP状态原因短语。

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

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

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

        验证失败的字段。

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

        字段及其验证失败。

        • 描述 字符串 必需

          人类可读的验证失败。

        • 字段 字符串 必需

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

    • 详细信息 字符串 必需

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

    • 错误 整型 必需

      HTTP status code.

    • 错误代码 字符串 必需

      机器可读的错误代码。

    • 参数 array[string]

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

    • 原因 字符串 必需

      HTTP状态原因短语。
  • 200

    正常

    隐藏响应属性 显示响应属性 对象
    • connection_string_srv 字符串
    • id 字符串
    • is_Flex 布尔
    • 名称 字符串
    • provider 字符串
    • 区域 字符串
    • state_name 字符串
    • tier 字符串
    隐藏响应属性 显示响应属性 对象
    • connection_string_srv 字符串
    • id 字符串
    • is_Flex 布尔
    • 名称 字符串
    • provider 字符串
    • 区域 字符串
    • state_name 字符串
    • tier 字符串
  • 400

    INVALID_ID 或 INVALID_REQUEST

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

    PLATFORM_OAUTH_REQUIRED 或 PLATFORM_OAUTH_RESOURCE_REJECTED

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

    ATLAS_PERMISSION_REQUIRED、ATLAS_SERVICE_ACCOUNT_NOT_PAIRED 或 FORBIDDEN

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

    NOT_FOUND

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

    INTERNAL_ERROR

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

    Atlas无法访问/非 OK 响应

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

    PLATFORM_OAUTH_NOT_CONFIGURED 或 SERVICE_UNAVAILABLE（当委托令牌刷新已在进行中时）

    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
GET /api/v1/atlas/projects/{project_id}/clusters/{cluster_name} 
curl \
 --request GET 'https://agentengine.mongodb.com/api/v1/atlas/projects/{project_id}/clusters/{cluster_name}' \
 --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) 
{
  "connection_string_srv": "string",
  "id": "string",
  "is_flex": true,
  "name": "string",
  "provider": "string",
  "region": "string",
  "state_name": "string",
  "tier": "string"
}
响应示例 (200) 
{
  "connection_string_srv": "string",
  "id": "string",
  "is_flex": true,
  "name": "string",
  "provider": "string",
  "region": "string",
  "state_name": "string",
  "tier": "string"
}
响应示例 (400) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (400) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (401) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (401) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (403) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (403) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (404) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (404) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (500) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (500) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (502) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (502) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (503) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (503) 
{
  "code": "string",
  "error": "string",
  "success": true
}