Ops Manager 설치는 ID 키를 생성합니다. 이 키 쌍은 설치가 MongoDB에 연결할 때 설치의 신원을 증명하는 데 사용됩니다. 조직 외부의 누군가가 개인 키를 획득하면 키가 손상되어 해당 사용자가 설치를 사칭할 수 있습니다.
이 엔드포인트를 사용하여 ID 키를 교체하십시오. 키를 교체하면 기존 키가 새 키 쌍으로 대체됩니다. 교체에 실패하면 Ops Manager는 변경 사항을 적용하지 않고 현재 키를 계속 사용합니다. 응답에는 항상 교체 결과가 포함됩니다.
중요
Your Ops Manager installation must be able to connect to MongoDB to rotate the key. If it can't, the endpoint returns the HTTP status 502 with the outcome UNREACHABLE or EA_UNAVAILABLE.
필수 역할
To access this resource, your API key must have the Global Owner role. The Global Owner role is the highest role in Ops Manager. Only users with this role can view and manage license keys.
요청
Send a POST request to start the rotation.
기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
POST /admin/artifacts/identity/rotate요청 경로 매개변수
이 엔드포인트는 HTTP 요청 경로 매개변수를 사용하지 않습니다.
요청 쿼리 매개변수
이 엔드포인트는 다음 쿼리 매개변수를 허용합니다.
이름 | 유형 | 필요성 | 설명 | 기본값 |
|---|---|---|---|---|
pretty | 부울 | 옵션 | 응답 본문이 pretty-print 형식인지 여부를 나타내는 플래그입니다. |
|
envelope | 부울 | 옵션 | 응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.
|
|
요청 본문 매개변수
이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.
응답
응답에는 다음 필드가 포함되어 있습니다.
필드 | 유형 | 설명 |
|---|---|---|
| 문자열 | 순환 결과입니다. Ops Manager는 다음 표에 있는 값 중 하나를 반환합니다. |
| 문자열 | Sentence that describes why Ops Manager didn't apply the rotation. This field is |
다음 표는 각 결과와 해당 HTTP 상태 및 메시지를 나열합니다.
결과 | HTTP Status | 메시지 |
|---|---|---|
| 200 | 운영 관리자는 아무런 메시지도 반환하지 않습니다. |
| 502 | MongoDB에 연결하여 키 순환을 완료할 수 없습니다. 변경 사항이 적용되지 않았으며 현재 키가 계속 활성화됩니다. 잠시 후 다시 시도해 주세요. |
| 502 | MongoDB Enterprise Advanced 서비스를 사용할 수 없습니다. 변경 사항이 적용되지 않았으며 현재 키가 활성 상태로 유지됩니다. 잠시 후 다시 시도해 주세요. |
| 409 | 아직 변경할 등록 ID가 없습니다. 등록 ID는 최초 설치 시 생성됩니다. |
| 409 | MongoDB는 키 순환에 대한 소유권 증명을 거부했습니다. 현재 키는 계속 활성화 상태입니다. MongoDB 계정 담당 팀에 문의하십시오. |
| 409 | 등록 정보가 동시에 변경되었습니다. 변경 사항이 적용되지 않았습니다. 잠시 후 다시 시도해 주세요. |
| 409 | MongoDB에서 키 순환 요청을 거부했습니다. 현재 키가 계속 활성화 상태로 유지됩니다. |
요청 예시
Use curl to send a POST request to the /admin/artifacts/identity/rotate endpoint:
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request POST \ "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/artifacts/identity/rotate?pretty=true"응답 예시
다음 예시는 요청이 성공적으로 처리되었을 때의 응답 헤더와 응답 본문을 보여줍니다.
응답 헤더
다음 헤더는 권한 없음 응답과 권한 성공 응답을 보여줍니다.
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}응답 본문
다음 예시는 응답 본문을 보여줍니다.
{ "outcome": "ROTATED", "message": null}