1개의 글로벌 API 키 업데이트

이 페이지의 내용

Resource

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

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

해당 키의 고유 식별자를 사용하여 Ops Manager에서 하나의 글로벌 API 키 값을 업데이트합니다.

특정 글로벌 API 키를 찾으려면 글로벌 API 키 목록을 가져온 다음 필요한 {API-KEY-ID} 을(를) 찾습니다.

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

Resource

PATCH /admin/apiKeys/{API-KEY-ID}

필수 역할

이 엔드포인트를 호출하는 API 키에 Global Owner 역할이 있어야 합니다.

요청 매개변수

요청 경로 매개변수

모든 요청 경로 매개변수는 필수입니다.

이름	유형	설명
`API-KEY-ID`	문자열	업데이트하려는 글로벌 API 키의 고유 식별자입니다.

요청 쿼리 매개변수

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

이름

유형

필요성

설명

기본값

pretty

부울

옵션

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

false

envelope

부울

옵션

응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다.

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

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

이름	설명
상태	HTTP 응답 코드
envelope	예상되는 응답 본문

false

요청 본문 매개변수

두 본문 매개변수 중 하나 또는 둘 다를 제공해야 합니다.

이름

유형

필요성

설명

desc

문자열

조건부

키에 대한 설명입니다. 이 매개변수는 선택 사항입니다. 그러나 요청에는 desc 매개변수 또는 roles 매개변수가 포함되어야 합니다. desc 가 제공되는 경우 길이는 1~250자 사이여야 합니다.

roles

문자열 배열

조건부

글로벌 API 키가 보유해야 하는 역할 목록입니다. roles 배열이 제공되는 경우:

하나 이상의 역할 제공
모든 역할이 유효한지 확인합니다.

기본적으로 허용되는 전역 역할은 다음과 같습니다.

API의 역할 값	역할
`GLOBAL_AUTOMATION_ADMIN`	`Global Automation Admin`
`GLOBAL_BACKUP_ADMIN`	`Global Backup Admin`
`GLOBAL_MONITORING_ADMIN`	`Global Monitoring Admin`
`GLOBAL_OWNER`	`Global Owner`
`GLOBAL_READ_ONLY`	`Global Read Only`
`GLOBAL_USER_ADMIN`	`Global User Admin`

응답

이름

유형

설명

desc

문자열

이 글로벌 API 키에 대한 설명입니다.

id

문자열

이 글로벌 API 키의 고유 식별자입니다.

links

문자열

하나 이상의 하위 리소스 및/또는 관련 리소스(예:목록 페이지 매김 )에 대한 링크 를 나타내는 문서 배열입니다. 자세한 내용은 연결 을 참조하세요.

privateKey

문자열

이 글로벌 API 키에 대한 비공개 키가 수정되었습니다.

publicKey

문자열

이 글로벌 API 키의 공개 키입니다.

roles

객체 배열

이 글로벌 API 키가 갖는 역할입니다. 이 배열은 사용자가 Ops Manager에서 가지고 있는 모든 전역 역할을 반환합니다.

roles.roleName

문자열

역할의 이름입니다. 이 리소스는 사용자가 Ops Manager에서 가지고 있는 모든 역할을 반환합니다. 가능한 값은 다음과 같습니다.

API의 역할 값	역할
`GLOBAL_AUTOMATION_ADMIN`	`Global Automation Admin`
`GLOBAL_BACKUP_ADMIN`	`Global Backup Admin`
`GLOBAL_MONITORING_ADMIN`	`Global Monitoring Admin`
`GLOBAL_OWNER`	`Global Owner`
`GLOBAL_READ_ONLY`	`Global Read Only`
`GLOBAL_USER_ADMIN`	`Global User Admin`

요청 예시

참고

요청을 하는 사용자의 형식은 {USERNAME}:{APIKEY} 또는 {PUBLIC-KEY}:{PRIVATE-KEY}로 지정할 수 있습니다.

1 curl --user "{USERNAME}:{APIKEY}" --digest \
2   --header "Accept: application/json" \
3   --header "Content-Type: application/json" \
4   --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys/{API-KEY-ID}?pretty=true" \
5   --data '{
6     "desc" : "Updated API key description for test purposes"
7   }'

응답 예시

응답 헤더

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   "created": "2019-09-04T15:37:40Z",
3   "desc": "Updated API key description for test purposes",
4   "globalRoles": ["GLOBAL_READ_ONLY"],
5   "groupRoles": [],
6   "numGroups": 0,
7   "orgRoles": [],
8   "orgRolesString": "",
9   "privateKey": "********-****-****-cfe60e9f1f72",
10   "userId": "5d6fda44ff4ab7133648a852",
11   "username": "dczverfw"
12 }

돌아가기

1개의 글로벌 API 키 생성

1개의 글로벌 API 키 삭제

1	curl --user "{USERNAME}:{APIKEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys/{API-KEY-ID}?pretty=true" \
5	--data '{
6	"desc" : "Updated API key description for test purposes"
7	}'

1	{
2	"created": "2019-09-04T15:37:40Z",
3	"desc": "Updated API key description for test purposes",
4	"globalRoles": ["GLOBAL_READ_ONLY"],
5	"groupRoles": [],
6	"numGroups": 0,
7	"orgRoles": [],
8	"orgRolesString": "",
9	"privateKey": "******--**-cfe60e9f1f72",
10	"userId": "5d6fda44ff4ab7133648a852",
11	"username": "dczverfw"
12	}