하나의 프로젝트 업데이트

이 페이지의 내용

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는 동일하게 유지됩니다. 이 페이지에서는 설명에 대해 얘기할 때 더욱 친숙한 용어 그룹을 사용합니다. 엔드포인트는 문서에 명시된 대로 유지됩니다.

프로젝트 이름 1개를 변경합니다.

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

Resource

PATCH /groups/{PROJECT-ID}

요청 매개변수

요청 경로 매개변수

이름	유형	설명
프로젝트 ID	문자열	(필수 사항) 프로젝트의 고유 식별자입니다.

요청 쿼리 매개변수

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

이름

유형

필요성

설명

기본값

pretty

부울

옵션

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

false

envelope

부울

옵션

응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다.

일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다.

하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.

이름	설명
`status`	HTTP 응답 코드
`content`	예상되는 응답 본문

false

요청 본문 매개변수

이름	유형	필요성	설명
이름	문자열	필수 사항	프로젝트의 새 이름입니다.

응답

이름	유형	설명
activeAgentCount	integer	Cloud Manager 에 일반 핑을 전송하는 활성 에이전트의 수입니다. 이 값은 약 24 시간마다 새로 고쳐지고 캐시됩니다. 새 에이전트를 시작하거나 기존 에이전트를 중지하는 경우 `activeAgentCount` 필드에 변경 사항이 표시되는 데 최대 30 분이 걸릴 수 있습니다.
hostCounts	객체	유형별 총 호스트 수입니다. 포함된 필드는 설명이 필요 없습니다.
id	문자열	그룹 의 고유 식별자입니다.
lastActiveAgent	문자열	Cloud Manager가 프로젝트의 총 `activeAgentCount` 개를 마지막으로 업데이트한 시간입니다. Cloud Manager는 24 시간마다 이 값을 새로 고치고 캐시하여 활성 MongoDB Agent 수를 기록합니다.
링크	객체 배열	하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 `links` 배열에는 `self` 이라는 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에설명되어 있습니다.
이름	문자열	프로젝트의 표시 이름입니다.
orgId	문자열	프로젝트가 속한 조직의 고유 식별자입니다.
publicApiEnabled	부울	이 프로젝트에 대해 API 가 활성화되어 있음을 나타내는 플래그입니다. 이 필드는 항상 `true` 인 읽기 전용 필드입니다.
replicaSetCount	integer	이 프로젝트의 총 복제본 세트 수입니다.
shardCount	integer	이 프로젝트의 총 샤드 수입니다.

요청 예시

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}?pretty=true" \
     --data '
     {
       "name" :  "Project Name 1"
     }'

응답 예시

응답 헤더

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}

응답 본문

1 {
2   "id": "{PROJECT-ID}",
3   "name":  "Project Name 1",
4   "orgId" : "{ORG-ID}",
5   "hostCounts": {
6     "arbiter": 2,
7     "config": 1,
8     "primary": 4,
9     "secondary": 8,
10     "mongos": 2
11   },
12   "lastActiveAgent": ISODate("2016-08-05T07:23:34Z"),
13   "activeAgentCount": 1,
14   "replicaSetCount": 3,
15   "shardCount": 2,
16   "publicApiEnabled": true,
17   "agentApiKey": "{API-KEY}",
18   "links" : []
19 }

돌아가기

만들기

삭제

1	{
2	"id": "{PROJECT-ID}",
3	"name": "Project Name 1",
4	"orgId" : "{ORG-ID}",
5	"hostCounts": {
6	"arbiter": 2,
7	"config": 1,
8	"primary": 4,
9	"secondary": 8,
10	"mongos": 2
11	},
12	"lastActiveAgent": ISODate("2016-08-05T07:23:34Z"),
13	"activeAgentCount": 1,
14	"replicaSetCount": 3,
15	"shardCount": 2,
16	"publicApiEnabled": true,
17	"agentApiKey": "{API-KEY}",
18	"links" : []
19	}