모든 S3 블록 저장소 구성 가져오기

모든 s3 블록 저장소의 구성을 조회합니다.

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

Resource

GET /snapshot/s3Configs

요청 경로 매개변수

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

요청 쿼리 매개변수

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

AssignableOnly	부울	이 S3 블록 저장소에 새 백업 작업을 할당할 수 있는지 여부를 나타내는 플래그입니다.	`true`

요청 본문 매개변수

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

응답

응답 문서

응답 JSON 문서에는 result 객체 배열, link 객체 배열, 조회된 result 객체의 총 개수가 포함되어 있습니다.

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

`results` embeddedDocument

각 결과 는 하나의 S3 블록 저장소입니다.

이름

유형

설명

acceptTos

부울

Ops Manager에서 S3 호환 스토리지를 사용하기 위한 텀에 동의했는지 여부를 나타내는 플래그입니다. S3 호환 스토리지 저장소를 생성하려면 이 값을 true 으로 설정해야 합니다.

AssignmentEnabled

부울

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

AWS 액세스 키

문자열

s3BucketName 에 지정된 S3 호환 스토리지 버킷에 액세스할 수 있는 Amazon Web Services 액세스 키 ID입니다.

AWS 비밀 키

문자열

s3BucketName 에 지정된 S3 호환 스토리지 버킷에 액세스할 수 있는 Amazon Web Services 비밀 액세스 키입니다.

customCertificates

배열

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

customCertificates[n].filename

문자열

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

customCertificates[n].certString

문자열

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

disableProxyS3

부울

S3 호환 스토리지에 연결할 때 HTTP 프록시 를 사용해야 하는지 여부를 나타내는 플래그입니다.

암호화된 자격증명

부울

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

문자열

이 S3 호환 저장소 블록 저장소를 고유하게 식별하는 이름입니다.

labels

문자열 배열

MongoDB Ops Manager가 어떤 S3 블록 저장소 에 할당할 수 있는 백업 작업 을 관리하기 위한 태그 배열입니다.

링크

객체 배열

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

부하 계수

integer

이 스냅샷 저장소 가 다른 스냅샷 저장소와 비교하여 수행하는 백업 작업의 양을 나타내는 0이 아닌 양의 정수입니다. 이 옵션은 둘 이상의 스냅샷 저장소를 사용 중인 경우에만 필요합니다.

Load Factor 에 학습 보려면 기존 블록 저장소 1개 편집을 참조하세요.

경로 스타일 액세스 활성화

부울

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

값	S3 블록 저장소 엔드포인트 스타일	예시
`true`	경로 스타일 URL 엔드포인트	`s3.amazonaws.com/<bucket>`
`false`	가상 호스트 스타일 URL 엔드포인트	`<bucket>.s3.amazonaws.com`

S 호환3저장소 버킷 URL 규칙을 검토하려면 Amazon Web Services S 설명서를3 참조하세요.

s3AuthMethod

문자열

s3BucketName 에 지정된 S3 호환 스토리지 버킷에 대한 액세스 권한을 부여하는 데 사용되는 메서드입니다.

이 옵션에 허용되는 값은 KEYS, IAM_ROLE 입니다.

`KEYS` 또는 없음	Ops Manager는 `awsAccessKey` 및 `awsSecretKey` 를 사용하여 `s3BucketName` 에 지정된 S3 호환 스토리지 버킷에 대한 액세스 권한을 부여합니다.
`IAM_ROLE`	MongoDB Ops Manager는 Amazon Web Services IAM 역할을 사용하여 `s3BucketName` 에 지정된 S3호환 스토리지 버킷에 대한 액세스 권한을 부여합니다. `awsAccessKey` 및 `awsSecretKey` 필드는 무시됩니다. 자세한 내용은 Amazon Web Services 설명서 를 참조하세요.

s3BucketEndpoint

문자열

Ops Manager가 이 S3 호환 스토리지 버킷에 액세스할 때 사용하는 URL 입니다.

S3 버킷 이름

문자열

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

S3 최대 연결

integer

이 S3 호환 저장소 블록 저장소에 대한 최대 연결 수를 나타내는 양의 정수입니다.

s3RegionOverride

문자열

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

Ops Manager는 이 S3 호환 스토리지 블록 저장소를 생성 하거나 업데이트 할 때 포함한 경우에만 이 필드를 반환합니다.

sseEnabled

부울

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

ssl

부울

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

uri

문자열

이 S3호환 스토리지 블록 저장소의 메타데이터 데이터베이스에 연결하는 연결 string 입니다. 이 데이터베이스는 Amazon Web Services S3호환 스토리지 버킷에 블록 위치를 저장합니다.

쓰기 고려

문자열

이 블록 저장소에 사용되는 쓰기 고려 (write concern)입니다.

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/snapshot/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/snapshot/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/snapshot/s3Configs/{S3-BLOCKSTORE-ID}",
        "rel": "self"
      }
    ],
    "loadFactor": 50,
    "s3BucketEndpoint": "http://example.com/backupbucket",
    "s3BucketName": "buck1",
    "uri": "mongodb://localhost:27017",
    "ssl": true,
    "writeConcern": "W2"
  } ],
  "totalCount" : 1
}

돌아가기

ID 로 가져오기

만들기