모든 기능 정책 조회

이 페이지의 내용

필수 역할

Resource
요청 경로 매개변수
요청 쿼리 매개변수
요청 본문 매개변수
응답
요청 예시
응답 예시
응답 헤더
응답 본문

MongoDB Ops Manager v6.0 는 2025 1월에 EOL됩니다. 가능한 한 빨리 상위 MongoDB Ops Manager 버전으로 업그레이드하세요.

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

필수 역할

이 리소스에는 인증된 사용자 또는 API 키가 필요합니다.

Resource

GET /groups/availablePolicies

요청 경로 매개변수

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

요청 쿼리 매개변수

다음 쿼리 매개변수는 선택 사항입니다.

이름

유형

설명

기본값

pageNum

integer

페이지 번호(1-인덱스 기준)입니다.

1

itemsPerPage

integer

페이지당 반환할 항목 수. 최대 500개까지 가능합니다.

100

pretty

부울

응답 본문이 프리티프린트 에 있어야 하는지 여부를 나타냅니다. 형식.

false

envelope

부울

응답을 엔벨로프에 래핑할지 여부를 나타냅니다.

일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 "envelope" : true를 설정합니다.

하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.

상태	HTTP 응답 코드
envelope	예상되는 응답 본문

결과 목록을 반환하는 엔드포인트의 경우 results 객체는 엔벨로프입니다. Ops Manager가 응답 본문에 status 필드를 추가합니다.

none

요청 본문 매개변수

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

응답

이름

유형

설명

_id

문자열

이 정책을 설정하는 프로젝트의 고유 식별자입니다.

created

문자열

ISO 8601 의 타임스탬프 이 기능 제어 정책이 생성된 시점의 UTC 날짜 및 시간 형식입니다.

updated

문자열

ISO 8601 의 타임스탬프 이 기능 제어 정책이 업데이트된 날짜 및 시간 형식(UTC )입니다.

externalManagementSystem

객체

이 Ops Manager 프로젝트를 managed하는 외부 시스템의 매개변수 식별.

externalManagementSystem

.name

문자열

이 Ops Manager 프로젝트를 managed하는 외부 시스템의 식별 레이블입니다.

externalManagementSystem

.systemId

문자열

이 Ops Manager 프로젝트를 managed하는 외부 시스템의 고유 식별자입니다.

externalManagementSystem

.version

문자열

이 Ops Manager 프로젝트를 managed하는 외부 시스템의 활성 릴리스입니다.

policies

배열

외부 시스템이 이 Ops Manager 프로젝트에 적용하는 정책 목록입니다.

policies

.policy[n]

객체

이 Ops Manager 프로젝트에 대해 설정된 단일 정책입니다. 이 매개변수는 policies 배열에서 한 번 이상 설정할 수 있습니다.

가능한 값은 다음과 같습니다.

값	목적
`EXTERNALLY_MANAGED_LOCK`	사용자는 Ops Manager를 사용하여 `policies.policy[n]` 배열에 지정된 다른 설정을 managed할 수 없습니다. 동일한 사용자가 Kubernetes 연산자와 같이 구성된 외부 시스템을 사용하여 이러한 설정을 managed 할 수 있습니다.
`DISABLE_USER_MANAGEMENT`	사용자는 사용자나 역할을 managed 수 없습니다.
`DISABLE_AUTHENTICATION_` `MECHANISMS`	사용자는 인증 설정을 변경할 수 없습니다.
`DISABLE_SET_MONGOD_` `CONFIG`	사용자는 `policies[n].disabledParams` 배열에 나열된 `mongod` 설정을 변경할 수 없습니다.
`DISABLE_SET_MONGOD_` `VERSION`	사용자는 `mongod` 또는 `mongos` 의 버전을 변경할 수 없습니다.
`DISABLE_BACKUP_AGENT`	사용자는 백업 에이전트를 활성화하거나 비활성화할 수 없습니다.
`DISABLE_MONGOD_LOG_` `MANAGEMENT`	사용자는 로그 관리 설정을 변경할 수 없습니다.
`DISABLE_IMPORT_TO_` `AUTOMATION`	사용자는 자동화를 사용하여 배포를 managed 수 없습니다.
`DISABLE_AGENT_API_KEY_` `MANAGEMENT`	사용자는 에이전트 API 키를 생성하거나 업데이트할 수 없습니다.
`DISABLE_MONGOD_HOST_` `MANAGEMENT`	사용자는 호스트의 서버 유형을 변경할 수 없습니다.

policies[n]

.disabledParams

배열

DISABLE_SET_MONGOD_CONFIG 정책을 적용 하는 경우 비활성화할 mongod 설정 목록입니다. 자동화는 모든 MongoDB 옵션을 지원 하지 않으므로 가져오기 시도가 실패할 수 있습니다. 학습 내용은 MongoDB 설정 및 자동화 지원을 참조하세요.

요청 예시

curl --user "{USERNAME}:{APIKEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/availablePolicies?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}

응답 본문

1 {
2   "_id": "{PROJECT-ID}",
3   "created": "2019-08-29T15:03:24Z",
4   "updated": "2019-08-29T15:03:24Z",
5   "externalManagementSystem":
6   {
7     "name": "Operator",
8     "systemId": "6d6c139ae5528707b6e8e3b2",
9     "version": "0.2.1"
10   },
11   "policies": [
12     {"policy": "ExternallyManagedLock"},
13     {"policy": "DisableUserManagement"},
14     {"policy": "DisableAuthenticationMechanisms"},
15     {"policy": "DisableSetMongodVersion"},
16     {
17       "policy": "DisableSetMongodConfig",
18       "disabledParams": ["net.tls.CAFile"]
19     }
20   ]
21 }

돌아가기

1개의 프로젝트에 대한 기능 정책 업데이트

백업 관리

1	{
2	"_id": "{PROJECT-ID}",
3	"created": "2019-08-29T15:03:24Z",
4	"updated": "2019-08-29T15:03:24Z",
5	"externalManagementSystem":
6	{
7	"name": "Operator",
8	"systemId": "6d6c139ae5528707b6e8e3b2",
9	"version": "0.2.1"
10	},
11	"policies": [
12	{"policy": "ExternallyManagedLock"},
13	{"policy": "DisableUserManagement"},
14	{"policy": "DisableAuthenticationMechanisms"},
15	{"policy": "DisableSetMongodVersion"},
16	{
17	"policy": "DisableSetMongodConfig",
18	"disabledParams": ["net.tls.CAFile"]
19	}
20	]
21	}