1개의 프로젝트에 대해 유형별 에이전트 가져오기

이 페이지의 내용

Resource

요청 경로 매개변수
요청 쿼리 매개변수
요청 본문 매개변수
응답
요청 예시
응답 예시
응답 헤더
응답 본문

Cloud Manager는 2024년 8월 30일부터 더 이상 MongoDB 3.6 및 4.0에 대한 자동화, 백업 및 모니터링을 지원하지 않습니다. MongoDB 배포를 업그레이드하거나 Atlas로 마이그레이션하세요.

Cloud Manager 에 대한 프로그래밍 방식의 액세스 를 위한 OAuth 2.0 인증 은 Preview 기능 으로 제공됩니다.: 기능 및 해당 설명서는 미리 보기 기간에 언제든지 변경될 수 있습니다. OAuth 2.0 인증 을 사용하려면 Cloud Manager 공개 API 에 대한 요청에 사용할서비스 계정을 만듭니다.

지정된 유형의 모든 에이전트를 가져옵니다(예: 모니터링, 백업 또는 자동화) 프로젝트를 위해.

참고

그룹과 프로젝트는 동의어입니다. {PROJECT-ID}는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 이 페이지에서는 설명에 대해 얘기할 때 더욱 친숙한 용어 그룹을 사용합니다. 엔드포인트는 문서에 명시된 대로 유지됩니다.

기본 URL: https://cloud.mongodb.com/api/public/v1.0

Resource

GET /groups/{PROJECT-ID}/agents/{TYPE}

요청 경로 매개변수

이름	유형	설명
프로젝트 ID	문자열	에이전트 API 키를 소유한 프로젝트 의 고유 식별자입니다.
유형	문자열	검색할 에이전트 유형입니다. TYPE 은 다음 값 중 하나일 수 있습니다. `MONITORING` `BACKUP` `AUTOMATION`

요청 쿼리 매개변수

다음 쿼리 매개변수는 선택 사항입니다.

이름	유형	필요성	설명	기본값
pageNum	숫자	옵션	결과의 하위 섹션을 반환하는 1부터 시작하는 정수입니다.	`1`
itemsPerPage	숫자	옵션	페이지당 반환할 항목 수. 최대 500개까지 가능합니다.	`100`
pretty	부울	옵션	응답 본문을 프리티프린트 에 넣어야 하는지 여부를 나타내는 플래그입니다. 형식.	`false`
envelope	부울	옵션	응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 `envelope : true`를 설정합니다. 결과 목록을 반환하는 엔드포인트의 경우 `content` 객체는 엔벨로프입니다. Cloud Manager가 `status` 필드를 응답 본문에 추가합니다.	`false`
backupJobsEnabledOnly	부울	옵션	데이터베이스 백업에 활성화되지 않은 데몬을 응답에서 제외할지 여부를 나타내는 플래그입니다. `backupJobsEnabled` 플래그가 `false` 로 설정된 daemon 구성을 포함하려면 이 값을 `false` 로 설정합니다.	`true`

요청 본문 매개변수

이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.

응답

이름	유형	설명
`typeName`	문자열	에이전트 유형: `MONITORING`, `BACKUP` 또는 `AUTOMATION`.
`hostname`	문자열	프라이머리 호스트 이름입니다. 호스트에는 일반적으로 별칭이 있을 수 있으므로 Cloud Manager가 결정한 대로 프라이머리는 사용 가능한 최상의 이름입니다.
`confCount`	숫자	구성 호출 수입니다.
`lastConf`	timestamp	마지막 구성 호출 날짜 및 시간입니다.
`stateName`	문자열	에이전트의 현재 상태입니다. `stateName` 은 다음 값을 반환할 수 있습니다. `ACTIVE`: 에이전트가 활성 상태이고 작동 중입니다. `STANDBY`: 에이전트가 대기 중입니다. `NO_PROCESSES`: 에이전트가 프로세스를 관리, 모니터링 또는 백업하지 않습니다.
`pingCount`	숫자	모니터링 에이전트에만 적용됩니다. 모니터링 에이전트가 `hostname` URL로 전송한 핑의 수입니다.
`isManaged`	부울	모니터링 및 백업 에이전트에만 적용됩니다. Cloud Manager가 에이전트를 managed 여부를 지정합니다.
`lastPing`	timestamp	모니터링 에이전트에만 적용됩니다. 가장 최근의 핑 시간입니다.
`tag`	문자열	백업 에이전트에만 적용됩니다. 에이전트의 태그(있는 경우)입니다.

요청 예시

1개의 프로젝트에 대해 모든 모니터링 에이전트를 가져옵니다.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/agents/MONITORING"

응답 예시

응답 헤더

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

응답 본문

{
  "links" : [],
  "results": [
    {
      "confCount": 59,
      "hostname": "example",
      "isManaged": true,
      "lastConf": "2015-06-18T14:21:42Z",
      "lastPing": "2015-06-18T14:21:42Z",
      "pingCount": 6,
      "stateName": "ACTIVE",
      "typeName": "MONITORING"
    }
  ],
  "totalCount": 1
}

돌아가기

링크 가져오기

API 키 생성