이 MongoDB 애플리케이션의 상태 반환

얻다 /api/atlas/v2

이 리소스는 API 키 메타 데이터와 함께 MongoDB 애플리케이션에 대한 정보를 반환합니다.

쿼리 매개변수

envelope 부울

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

기본값은 false 입니다.
pretty 부울

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

기본값은 false 입니다.

Prettyprint

응답

200 application/vnd.atlas.2023-01-01+json

확인
응답 속성 숨기기 응답 속성 표시 객체
- apiKey 객체 | null 필수 사항
  
  하나의 API 키에 포함된 세부 정보입니다.
  
  apiKey 속성 숨기기 apiKey 속성 표시 객체 | null
  
  accessList 배열[객체]
  
  이 API 키를 사용하여 이 API 에 대한 액세스 부여된 네트워크 주소 목록입니다.
  
  accessList 속성 숨기기 accessList 속성 표시 객체
  
  cidrBlock 문자열
  
  이 프로젝트의 액세스 목록에 있는 클래스 없는 도메인 간 라우팅(Classless Inter-Domain Routing, CIDR) 표기법의 IP 주소 범위입니다.
  
  형식은 ^((([0-9]{1,3}\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$ 패턴 과 일치해야 합니다.
  
  ipAddress 문자열 필수 사항
  
  API 액세스 목록에 포함된 IP 주소 입니다.
  
  형식은 ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$ 패턴 과 일치해야 합니다.
  
  id 문자열 필수 사항
  
  이 조직 API 키를 식별하는 고유한 24자리 16진수 문자열입니다.
  
  형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.
  
  publicKey 문자열 필수 사항
  
  지정된 조직 API 키에 대해 설정하다 공개 API 키 값입니다.
  
  최소 길이는 8, 최대 길이는 8입니다.
  
  roles 배열[객체]
  
  API 키에 필요한 역할이 포함된 목록입니다. 제공하는 모든 역할은 지정된 프로젝트 또는 조직 대해 유효해야 합니다. 각 요청 유효한 역할 하나 이상 포함되어야 합니다. 리소스 클라우드 사용자에게 할당된 모든 프로젝트 및 조직 역할을 반환합니다.
  
  MongoDB Cloud 사용자의 역할과 해당 역할 적용되는 해당 조직 또는 프로젝트 . 각 역할 하나의 조직 또는 하나의 프로젝트 에 적용 할 수 있지만 둘 다 적용할 수는 없습니다.
  
  역할 속성 숨기기 역할 속성 표시 객체
  
  groupId 문자열
  
  24이 역할 속한 프로젝트 식별하는 고유한 -16진수 문자열입니다. 동일한 요청 에서 이 매개변수 또는 orgId의 값을 설정하다 수 있지만 둘 다 설정할 수는 없습니다.
  
  최소 길이는 24, 최대 길이는 24입니다. 형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.
  
  orgId 문자열
  
  24이 역할 속한 조직 식별하는 고유한 -16진수 문자열입니다. 동일한 요청 에서 이 매개변수 또는 groupId의 값을 설정하다 수 있지만 둘 다 설정할 수는 없습니다.
  
  최소 길이는 24, 최대 길이는 24입니다. 형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.
  
  roleName 문자열
  
  MongoDB Cloud가 특정 API 키, MongoDB Cloud 사용자 또는 MongoDB Cloud 팀 부여하는 권한 컬렉션 을 식별하는 사람이 읽을 수 있는 레이블입니다. 이러한 역할에는 조직 및 프로젝트 수준의 역할이 포함됩니다.
  
  값은 ORG_MEMBER, ORG_READ_ONLY, ORG_STREAM_PROCESSING_ADMIN, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, ORG_GROUP_CREATOR, ORG_OWNER, GROUP_OWNER, GROUP_READ_ONLY, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_CLUSTER_MANAGER, GROUP_SEARCH_INDEX_EDITOR, GROUP_STREAM_PROCESSING_OWNER, GROUP_BACKUP_MANAGER, GROUP_OBSERVABILITY_VIEWER 또는 GROUP_DATABASE_ACCESS_ADMIN.
- 앱 이름 문자열 필수 사항
  
  이 응답을 요청한 서비스를 식별하는 사람이 읽을 수 있는 레이블입니다.
  
  값은 MongoDB Atlas입니다.
- 빌드 문자열 필수 사항
  
  이 애플리케이션 에 대해 병합된 최신 git 커밋 식별하는 고유한 40-16진수 해시입니다.
- 링크 배열[객체]
  
  API 하위 리소스, 관련 API 리소스 또는 둘 다를 점 하나 이상의 URL(Uniform Resource Locator) 목록입니다. RFC 5988 는 이러한 관계를 간략하게 설명합니다.
  
  웹 연결 사양(RFC...
  
  링크 속성 숨기기 링크 속성 표시 객체
  
  href 문자열
  
  이 응답과 관계 있는 다른 API 리소스 가리키는 URL (Uniform Resource Locator)입니다. 이 URL https://cloud.mongodb.com/api/atlas로 시작하는 경우가 많습니다.
  
  rel 문자열
  
  이 리소스 와 다른 API 리소스 간의 의미론적 관계 정의하는 URL (Uniform Resource Locator)입니다. 이 URL https://cloud.mongodb.com/api/atlas로 시작하는 경우가 많습니다.
- 스로틀링 부울 필수 사항
  
  누군가가 이 서비스에서 스로틀링을 활성화했는지 여부를 나타내는 플래그입니다.
401

승인되지 않았습니다.
403 application/json

Forbidden.
응답 속성 숨기기 응답 속성 표시 객체
- badRequestDetail 객체
  
  요청 세부 정보가 잘못되었습니다.
  
  badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
  
  필드 배열[객체]
  
  클라이언트 요청 의 모든 위반 사항을 설명합니다.
  
  필드 속성 숨기기 필드 속성 표시 객체
  
  description 문자열 필수 사항
  
  요청 요소가 잘못된 이유에 대한 설명입니다.
  
  필드 문자열 필수 사항
  
  요청 본문의 필드 로 연결되는 경로입니다.
- 세부 정보 문자열
  
  각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.
- 오류 integer(int32) 필수 사항
  
  이 오류와 함께 HTTP 상태 코드가 반환되었습니다.
  
  외부 문서
- 오류 코드 문자열 필수 사항
  
  이 오류와 함께 반환된 애플리케이션 오류 코드입니다.
- 매개변수 배열[객체]
  
  오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.
- 이유 문자열
  
  이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.
500 application/json

내부 서버 오류입니다.
응답 속성 숨기기 응답 속성 표시 객체
- badRequestDetail 객체
  
  요청 세부 정보가 잘못되었습니다.
  
  badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
  
  필드 배열[객체]
  
  클라이언트 요청 의 모든 위반 사항을 설명합니다.
  
  필드 속성 숨기기 필드 속성 표시 객체
  
  description 문자열 필수 사항
  
  요청 요소가 잘못된 이유에 대한 설명입니다.
  
  필드 문자열 필수 사항
  
  요청 본문의 필드 로 연결되는 경로입니다.
- 세부 정보 문자열
  
  각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.
- 오류 integer(int32) 필수 사항
  
  이 오류와 함께 HTTP 상태 코드가 반환되었습니다.
  
  외부 문서
- 오류 코드 문자열 필수 사항
  
  이 오류와 함께 반환된 애플리케이션 오류 코드입니다.
- 매개변수 배열[객체]
  
  오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.
- 이유 문자열
  
  이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

GET /api/atlas/v2

atlas api root getSystemStatus --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250219001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.GetSystemStatusApiParams{}
	sdkResp, httpResp, err := client.RootApi.
		GetSystemStatusWithParams(ctx, params).
		Execute()
}

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-02-19+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2025-02-19+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2?pretty=true"

응답 예시(200)

{
  "apiKey": {
    "accessList": [
      {
        "cidrBlock": "string",
        "ipAddress": "string"
      }
    ],
    "id": "32b6e34b3d91647abb20e7b8",
    "publicKey": "string",
    "roles": [
      {
        "groupId": "32b6e34b3d91647abb20e7b8",
        "orgId": "32b6e34b3d91647abb20e7b8",
        "roleName": "ORG_MEMBER"
      }
    ]
  },
  "appName": "MongoDB Atlas",
  "build": "83be55e140f493c88e7f578aae96548dd881587b",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "throttling": true
}

응답 예시(403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

응답 예시(500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}