/ /

/ /

모든 S3 Oplog 구성 가져오기

모든3 oplog 저장소의 구성을 검색합니다.

기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup

Resource

GET /oplog/s3Configs

요청 경로 매개변수

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

요청 쿼리 매개변수

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

AssignableOnly

부울

옵션

새 백업 작업을 할당할 수 있는 S3 oplog 저장소만 반환할지 여부를 나타냅니다.

true

요청 본문 매개변수

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

응답

응답 문서

응답 JSON 문서 result 객체 배열 , link 객체 배열 , 조회된 result 객체의 총 개수가 포함됩니다.

이름	유형	설명
`results`	배열	배열에는 내장된 `results` 문서 섹션에 자세히 설명된 각 항목에 대해 하나의 객체 포함됩니다.
`links`	배열	배열에 하위 리소스 및/또는 관련 리소스에 대한 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에설명되어 있습니다.
`totalCount`	숫자	결과 집합에 있는 총 항목 수의 정수 개수입니다. 전체 결과 집합이 페이지로 매겨진 경우 results 배열의 객체 수보다 클 수 있습니다.

`results` embeddedDocument

각 결과 는3 oplog 저장소입니다.

이름

유형

설명

acceptTos

부울

MongoDB Ops Manager에서 S3호환 저장소를 사용하기 위한 서비스 약관에 동의했는지 여부를 나타내는 플래그입니다. S3호환 저장 스토어를 만들려면 이것을 true로 설정해야 합니다.

AssignmentEnabled

부울

이 데이터 저장소에 백업 작업을 할당할 수 있는지 여부를 나타내는 플래그.

AWS 액세스 키

문자열

s3BucketName에 지정된 S3호환 저장 버킷에 액세스 할 수 있는AWS 액세스 키 ID .

AWS 비밀 키

문자열

s3BucketName에 지정된 S3호환 저장 버킷에 액세스 할 수 있는AWS 시크릿 액세스 키입니다.

customCertificates

배열

연결된 S3 호환 저장소 버킷에 적용되는 유효한 인증 기관 인증서 목록입니다.

customCertificates[n].filename

문자열

인증 기관 PEM 파일을 식별하는 이름입니다.

customCertificates[n].certString

문자열

인증 기관 체인을 구성하는 인증 기관 PEM 파일의 콘텐츠입니다.

disableProxyS3

부울

S3호환 저장소에 연결할 때 HTTP proxy를 사용해야 하는지 여부를 나타내는 플래그입니다.

암호화된 자격증명

부울

이 S3호환 저장 oplog 저장 의 사용자 이름 과 비밀번호가 credentialstool을 사용하여 암호화됨 되었는지 여부를 나타내는 플래그입니다 .

문자열

이 S3호환 스토리지 oplog 저장소를 고유하게 식별하는 이름입니다.

labels

문자열 배열

가 어떤 S 호환 저장 저장할 수 있는 백업 작업 을 관리 있는 태그 배열입니다. MongoDB Ops Manager 3 oplog

링크

객체 배열

하위 리소스 또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 links 배열에는 self 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에 설명되어 있습니다.

OIDC

객체

이 저장 에 대한OIDC 인증 설정입니다. oidc 객체 에는 다음 필드가 포함되어 있습니다.

enabled: 부울. 이 저장 에 대해 OIDC 인증 사용할 수 있는지 여부를 나타냅니다.
method: string. callback, azure, gcp 또는 k8s 중 하나.
tokenUri: 문자열.IdP 토큰 엔드포인트입니다. method가 callback인 경우에만 표시됩니다.
clientId: 문자열.IdP에 등록된 클라이언트 ID .
clientSecret: string. MongoDB Ops Manager는 응답에서 이 값을 수정하며 원본 클라이언트 시크릿을 반환하지 않습니다.
scope: 문자열.IdP에서 요청한 OAuth2 범위입니다. method가 callback인 경우에만 표시됩니다.
tokenResource: string. 워크로드 인덴티티 토큰의 대상 또는 리소스 식별자입니다. method이 azure 또는 gcp인 경우에만 제시됩니다.

경로 스타일 액세스 활성화

부울

이 엔드포인트의 스타일을 나타내는 플래그입니다.

값	S3 oplog 스토어 엔드포인트 스타일	예시
`true`	경로 스타일 URL 엔드포인트	`s3.amazonaws.com/<bucket>`
`false`	가상 호스트 스타일 URL 엔드포인트	`<bucket>.s3.amazonaws.com`

S3호환 저장 버킷 URL 규칙을 검토 하려면 AWS S3 문서를 참조하세요.

s3BucketEndpoint

문자열

Ops Manager 이 S3 호환 저장 버킷에 액세스 데 사용하는URL 입니다.

S3 버킷 이름

문자열

S3호환 스토리지 oplog 저장소를 호스팅하는 S3호환 스토리지 버킷의 이름입니다.

s3RegionOverride

문자열

S3 호환 스토리지 버킷이 있는 리전입니다. 이 필드는 S3 호환 스토리지 저장소의 s3BucketEndpoint 가 리전 범위를 지원하지 않는 경우에만 적용됩니다.

MongoDB Ops Manager는 이 S3호환 스토리지 저장소를 만들 거나 업데이트 할 때 포함시킨 경우에만 이 필드를 oplog 반환합니다.

sseEnabled

부울

이 S3호환 스토리지 oplog 저장소 가 서버 측 암호화를 활성화하는지 여부를 나타내는 플래그입니다.

ssl

부울

이 S3호환 스토리지 oplog 저장소가 TLS 를 사용하여 암호화된 연결만 허용하는지 여부를 나타내는 플래그입니다.

uri

문자열

이 S 호환 저장 oplog 저장 의 메타데이터 데이터베이스 에 연결하는 연결문자열입니다. 이 데이터베이스 S 호환 저장 버킷에 블록의 위치를 저장합니다. 33

쓰기 고려

문자열

이 oplog 스토어에 사용되는 쓰기 고려입니다.

Ops Manager는 다음 값 중 하나를 반환합니다.

ACKNOWLEDGED
W2
JOURNALED
MAJORITY

MongoDB 의 쓰기 (write) 승인 수준에 학습 보려면 쓰기 고려를 참조하세요 .

요청 예시

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --include \
 --request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/s3Configs?pretty=true'

응답 예시

응답 헤더

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" : [ {
    "href" : "http://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/s3Configs?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
  "assignmentEnabled": true,
  "awsAccessKey": "access",
  "awsSecretKey": "secret",
  "encryptedCredentials": false,
  "id": "id",
  "labels": [
    "l1",
    "l2"
  ],
  "links": [
    {
      "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/s3Configs/{S3-OPLOG-ID}",
      "rel": "self"
    }
  ],
  "s3BucketEndpoint": "http://backup.example.com/oplog",
  "s3BucketName": "oplog",
  "uri": "mongodb://localhost:27017",
  "ssl": true,
  "writeConcern": "W2"
  } ],
  "totalCount" : 1
}

돌아가기

ID 로 가져오기

만들기

모든 S3 Oplog 구성 가져오기

Resource

요청 경로 매개변수

요청 쿼리 매개변수

요청 본문 매개변수

응답

응답 문서

results embeddedDocument

요청 예시

응답 예시

응답 헤더

응답 본문

`results` embeddedDocument