프로젝트 의 Atlas 클러스터 나열

얻다 /api/v1/atlas/projects/{project_id}/clusters

인간 호출자의 위임된 토큰 또는 쌍을 이루는 Agent Engine 서비스 계정을 사용하여 Atlas 관리자 API GET /groups/{id}/clusters 및 GET /groups/{id}/flexClusters를 프록시합니다. Agent Engine API 키는 허용되지 않습니다. 유효하지 않은 project_id는 Atlas 호출 전에 거부됩니다.

경로 매개변수

  • PROJECT_ID 문자열 필수 사항

    Atlas 프로젝트 ID

응답

  • 지원되지 않거나 잘못된 API 버전, 선택한 게시된 계약에서 사용할 수 없는 작업 또는 허용되지 않는 표현(지원되지 않는 미디어 유형 매개변수 또는 제외된 SSE 포함). 기존 인증, 권한 부여 및 속도 제한 실패가 우선적으로 적용됩니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      표준 오류 스키마 에 정의된 선택적 유효성 검사 세부 정보입니다. API 협상 오류는 이 필드 내보내지 않습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        유효성 검사 에 실패한 필드입니다.

        필드 속성 숨기기 필드 속성 표시 객체

        필드 및 해당 유효성 검사 실패.

        • description 문자열 필수 사항

          사람이 읽을 수 있는 유효성 검사 실패.

        • 필드 문자열 필수 사항

          잘못된 요청 필드 의 이름 또는 경로입니다.

    • 세부 정보 문자열 필수 사항

      사람이 읽을 수 있는 오류 세부 정보.

    • 오류 integer 필수 사항

      HTTP status code.

    • 오류 코드 문자열 필수 사항

      기계가 읽을 수 있는 오류 코드입니다.

    • 매개변수 array[string]

      오류와 관련된 요청 매개변수 이름입니다. 적용 않는 경우 생략됩니다.

    • 이유 문자열 필수 사항

      HTTP 상태 이유 구문입니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      표준 오류 스키마 에 정의된 선택적 유효성 검사 세부 정보입니다. API 협상 오류는 이 필드 내보내지 않습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        유효성 검사 에 실패한 필드입니다.

        필드 속성 숨기기 필드 속성 표시 객체

        필드 및 해당 유효성 검사 실패.

        • description 문자열 필수 사항

          사람이 읽을 수 있는 유효성 검사 실패.

        • 필드 문자열 필수 사항

          잘못된 요청 필드 의 이름 또는 경로입니다.

    • 세부 정보 문자열 필수 사항

      사람이 읽을 수 있는 오류 세부 정보.

    • 오류 integer 필수 사항

      HTTP status code.

    • 오류 코드 문자열 필수 사항

      기계가 읽을 수 있는 오류 코드입니다.

    • 매개변수 array[string]

      오류와 관련된 요청 매개변수 이름입니다. 적용 않는 경우 생략됩니다.

    • 이유 문자열 필수 사항

      HTTP 상태 이유 구문입니다.

  • 200

    확인

    응답 속성 숨기기 응답 속성 표시 객체
    • 결과 배열[객체]
      결과 속성 숨기기 결과 속성 표시 객체
      • connection_string_srv 문자열
      • is_flex 부울
      • 이름 문자열
      • provider 문자열
      • 리전 문자열
      • state_name 문자열
      • tier 문자열

        Flex 클러스터의 경우 계층은 Flex이며, 그렇지 않은 경우에는 무료/공유 계층을 포함하여 Atlas 인스턴스 크기(M10, M0 등)가 적용됩니다. 필터링되지 않은 상태로 표시되므로 클라이언트가 무료/공유 계층을 클러스터 선택에서 제외하고 채택을 거부할 수 있습니다. 플랫폼은 서버 측에서 선택을 게이트하지 않습니다.

    • total_count integer
    응답 속성 숨기기 응답 속성 표시 객체
    • 결과 배열[객체]
      결과 속성 숨기기 결과 속성 표시 객체
      • connection_string_srv 문자열
      • is_flex 부울
      • 이름 문자열
      • provider 문자열
      • 리전 문자열
      • state_name 문자열
      • tier 문자열

        Flex 클러스터의 경우 계층은 Flex이며, 그렇지 않은 경우에는 무료/공유 계층을 포함하여 Atlas 인스턴스 크기(M10, M0 등)가 적용됩니다. 필터링되지 않은 상태로 표시되므로 클라이언트가 무료/공유 계층을 클러스터 선택에서 제외하고 채택을 거부할 수 있습니다. 플랫폼은 서버 측에서 선택을 게이트하지 않습니다.

    • total_count integer
  • 400

    INVALID_ID — project_id가 24-hex Atlas 프로젝트 ID 가 아닙니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
  • 401

    PLATFORM_OAUTH_REQUIRED 또는 PLATFORM_OAUTH_RESOURCE_REJECTED

    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
  • 402

    ATLAS_PAYMENT_METHOD_REQUIRED

    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
  • 403

    ATLAS_PERMISSION_REQUIRED, ATLAS_SERVICE_ACCOUNT_NOT_PAIRED 또는 FORBIDDEN

    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
  • 404

    NOT_FOUND

    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
  • 충돌

    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
  • 500

    INTERNAL_ERROR

    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
  • 502

    Atlas 연결할 수 없음/비정상 응답

    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
  • 503

    위임된 토큰 새로 고침이 이미 진행 중인 경우 PLATFORM_OAUTH_NOT_CONFIGURED 또는 SERVICE_UNAVAILABLE

    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
GET /api/v1/atlas/projects/{project_id}/clusters
curl \
 --request GET 'https://agentengine.mongodb.com/api/v1/atlas/projects/{project_id}/clusters' \
 --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)
{
  "results": [
    {
      "connection_string_srv": "string",
      "is_flex": true,
      "name": "string",
      "provider": "string",
      "region": "string",
      "state_name": "string",
      "tier": "string"
    }
  ],
  "total_count": 42
}
응답 예시(200)
{
  "results": [
    {
      "connection_string_srv": "string",
      "is_flex": true,
      "name": "string",
      "provider": "string",
      "region": "string",
      "state_name": "string",
      "tier": "string"
    }
  ],
  "total_count": 42
}
응답 예시(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
}
응답 예시(402)
{
  "code": "string",
  "error": "string",
  "success": true
}
응답 예시(402)
{
  "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
}
응답 예시(409)
{
  "code": "string",
  "error": "string",
  "success": true
}
응답 예시(409)
{
  "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
}