프로젝트 1개 만들기
- 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
POST /groups
요청 매개변수
요청 경로 매개변수
이 엔드포인트는 HTTP 요청 경로 매개변수를 사용하지 않습니다.
요청 쿼리 매개변수
요청 본문 매개변수
이름 | 유형 | 필요성 | 설명 |
---|---|---|---|
이름 | 문자열 | 필수 사항 | 프로젝트를 식별하는 사람이 읽을 수 있는 레이블입니다. |
orgId | 문자열 | 필수 사항 | 프로젝트를 생성할 조직을 식별하는 고유한 24-16진수 string 입니다. Cloud Manager 설정하다 지정된 조직 의 가장 오래된 |
응답
이름 | 유형 | 설명 |
---|---|---|
activeAgentCount | integer | Cloud Manager 에 일반 핑을 전송하는 활성 에이전트의 수입니다. 이 값은 약 24 시간마다 새로 고쳐지고 캐시됩니다. 새 에이전트를 시작하거나 기존 에이전트를 중지하는 경우 |
hostCounts | 객체 | 유형별 총 호스트 수입니다. 포함된 필드는 설명이 필요 없습니다. |
id | 문자열 | 그룹 의 고유 식별자입니다. |
lastActiveAgent | 문자열 | Cloud Manager가 프로젝트의 총 |
링크 | 객체 배열 | 하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 |
이름 | 문자열 | 프로젝트의 표시 이름입니다. |
orgId | 문자열 | 프로젝트가 속한 조직의 고유 식별자입니다. |
publicApiEnabled | 부울 | 이 프로젝트에 대해 API 가 활성화되어 있음을 나타내는 플래그입니다. 이 필드는 항상 |
replicaSetCount | integer | 이 프로젝트의 총 복제본 세트 수입니다. |
shardCount | integer | 이 프로젝트의 총 샤드 수입니다. |
요청 예시
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://cloud.mongodb.com/api/public/v1.0/groups?pretty=true" \ --data ' { "name": "Create Project API Example", "orgId": "deffb2031b938da53f16d714" }'
응답 예시
응답 헤더
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
201 Created 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}
응답 본문
{ "activeAgentCount" : 0, "agentApiKey" : "{GROUP-API-KEY}", "hostCounts" : { "arbiter" : 0, "config" : 0, "mongos" : 0, "primary" : 0, "secondary" : 0 }, "id" : "{PROJECT-ID}", "links" : [], "name" : "Create Project API Example", "orgId" : "{ORG-ID}", "publicApiEnabled" : true, "replicaSetCount" : 0, "shardCount" : 0, "tags" : [ ] }