참고
그룹과 프로젝트는 동의어입니다. {PROJECT-ID}는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID가 동일하게 유지됩니다. 이 페이지에서는 설명에 대해 얘기할 때 더욱 친숙한 용어 그룹을 사용합니다. 엔드포인트는 문서에 명시된 대로 유지됩니다.
새 배포서버 가져오기 요청 생성하여 기존 MongoDB 프로세스를 Ops Manager 자동화 에 추가합니다. 이 엔드포인트는 여러 MongoDB 프로세스를 모니터링 및 자동화 관리 모두로 가져오는 프로세스 시작합니다.
중요
이 기능 Ops Manager 8.0.13부터 사용할 수 있습니다.
가져온 배포서버가 프로젝트의 자동화 구성에 추가됩니다. MongoDB Agent 프로세스 모니터링 시작하고 자동화 구성에 따라 프로세스를 관리 .
필수 역할
이 엔드포인트에는 Project Automation Admin 역할 필요합니다.
엔드포인트
기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
POST /automation/importDeployment/{PROJECT-ID}
요청
경로 매개변수
이름 | 유형 | 필요성 | 설명 |
|---|---|---|---|
프로젝트 ID | 문자열 | 필수 사항 | 가져온 배포를 소유할 프로젝트 의 고유 식별자입니다. |
쿼리 매개변수
다음 쿼리 매개변수는 선택 사항입니다.
이름 | 유형 | 필요성 | 설명 | 기본값 |
|---|---|---|---|---|
pretty | 부울 | 옵션 | 응답 본문이 pretty-print 형식인지 여부를 나타내는 플래그입니다. |
|
envelope | 부울 | 옵션 | 응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.
|
|
본문 매개변수
이름 | 유형 | 필요성 | 설명 |
|---|---|---|---|
SeedHostport | 문자열 | 필수 사항 | 검색을 위해 연결할 시드 MongoDB 프로세스 의 호스트 이름 및 포트입니다(예: |
requiredProcesses | 배열 | 필수 사항 | 가져오기를 진행하기 전에 검색해야 하는 MongoDB 프로세스를 나타내는 hostname:port 문자열 배열입니다. |
시간 초과 | 객체 | 옵션 | 다양한 가져오기 단계에 대한 시간 초과 설정. |
timeout.seedHostConnectionSec | 숫자 | 옵션 | 시드 호스팅하다 에 연결하기 위한 시간 제한(초)입니다. 범위: 60-86400 초. 기본값은 시스템 설정을 사용합니다. |
timeout.processesDiscoverySec | 숫자 | 옵션 | 필요한 모든 프로세스를 검색하기 위한 시간 제한(초)입니다. 범위: 60-86400 초. 기본값은 시스템 설정을 사용합니다. |
timeout.automationImported | 숫자 | 옵션 | 자동화 가져오기 완료 시간 제한(초)입니다. 범위: 60-86400 초. 기본값은 시스템 설정을 사용합니다. |
timeout.goalStateSec | 숫자 | 옵션 | 자동화 목표 상태 도달하기 위한 시간 제한(초)입니다. 범위: 60-86400 초. 기본값은 시스템 설정을 사용합니다. |
authMechanism | 문자열 | 옵션 | MongoDB 프로세스에 연결하기 위한 인증 메커니즘입니다. 가능한 값은 다음과 같습니다.
|
사용자 이름 | 문자열 | 조건부 | MongoDB 프로세스 인증을 위한 사용자 이름입니다. |
비밀번호 | 문자열 | 조건부 | MongoDB 프로세스 인증을 위한 비밀번호입니다. Ops Manager 응답 문서에 이 매개변수를 포함하지 않습니다. |
adminDb | 문자열 | 옵션 | 인증할 데이터베이스입니다. 기본값: |
pemKeyFilePath | 문자열 | 옵션 | TLS 클라이언트 인증 위한 PEM 키 파일 의 경로입니다. |
pemKeyFilePassword | 문자열 | 옵션 | PEM 키 파일 의 비밀번호입니다. Ops Manager 응답 문서에 이 매개변수를 포함하지 않습니다. |
adminKerberosKeytab | 문자열 | 옵션 | GSSAPI 인증 위한 Kerberos 키탭 파일 의 경로입니다. |
adminLdapGroupDn | 문자열 | 옵션 | PLAIN 인증 위한 LDAP 그룹 고유 이름 . |
saslServiceName | 문자열 | 옵션 | GSSAPI 인증 위한 SASL 서비스 이름입니다. |
caFilePath | 문자열 | 옵션 | TLS 연결을 위한 인증 기관 파일 의 경로입니다. |
clusterCaFilePath | 문자열 | 옵션 | TLS 연결을 위한 클러스터 인증 기관 파일 의 경로입니다. |
클라이언트 인증서 모드 | 문자열 | 옵션 | TLS 연결을 위한 클라이언트 인증서 모드 . |
응답
가져오기 요청 성공적으로 제출된 경우 HTTP 상태 200 인 빈 성공 응답을 반환합니다.
참고
이 엔드포인트는 생성된 가져오기 요청 의 ID 를 반환하지 않습니다. 가져오기 요청의 상태를 추적하려면 가져오기 배포 요청 가져오기 엔드포인트를 사용하여 프로젝트에 대한 모든 요청을 나열하고 생성 시간 또는 기타 속성으로 요청을 식별합니다.
요청 예시
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/automation/importDeployment/{PROJECT-ID}?pretty=true" \ --data '{ "seedHostport": "mongodb1.example.com:27017", "requiredProcesses": [ "mongodb1.example.com:27017", "mongodb2.example.com:27017", "mongodb3.example.com:27018" ], "timeouts": { "seedHostConnectionSec": 300, "processesDiscoverySec": 600, "automationImported": 600, "goalStateSec": 1200 }, "authMechanism": "MONGODB_CR", "username": "admin", "password": "password123", "adminDb": "admin" }'
응답 예시
응답 헤더
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
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}
응답 본문
{}