Docs Menu
Docs Home
/ /

글로벌 API 키에 대한 모든 액세스 목록 항목 가져오기

Ops Manager에 대한 모든 글로벌 액세스 목록 항목을 반환합니다.

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

GET /admin/accessList

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

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

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

이름
유형
필요성
설명
기본값

pageNum

숫자

옵션

결과의 하위 섹션을 반환하는 1부터 시작하는 정수입니다.

1

itemsPerPage

숫자

옵션

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

100

pretty

부울

옵션

응답 본문이 pretty-print 형식이어야 하는지 여부를 나타내는 플래그입니다.

false

envelope

부울

옵션

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

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

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

false

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

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

이름
유형
설명

results

배열

배열에는 내장된 results 문서 섹션에 자세히 설명된 각 항목에 대해 하나의 객체 포함됩니다.

links

배열

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

totalCount

숫자

결과 집합에 있는 총 항목 수의 정수 개수입니다. 전체 결과 집합이 페이지로 매겨진 경우 results 배열의 객체 수보다 클 수 있습니다.

결과 는 하나의 글로벌 액세스 목록 항목입니다.

이름
유형
설명

cidrBlock

문자열

IPv4 또는 IPv6 CIDR 표기법으로 표시된 액세스 목록의 IP 주소 범위입니다.

created

문자열

타임스탬프(글로벌 액세스 목록에 이 CIDR 차단 추가한 UNIX 에포크 이후 경과된 시간(초))입니다.

description

문자열

이 글로벌 액세스 목록 항목의 목적에 대한 설명입니다.

id

문자열

이 글로벌 액세스 목록 항목의 고유 식별자입니다.

type

문자열

글로벌 액세스 목록 항목의 범위.

updated

문자열

이 글로벌 액세스 목록 항목의 CIDR차단 마지막으로 변경한 UNIX 에포크 이후 경과된 시간(초)으로 표시한 타임스탬프입니다.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/accessList?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}
{
"results" : [ {
"cidrBlock" : "251.207.34.78/32",
"created" : "2019-09-05T04:02:46Z",
"description" : "Test Global Access List Entry 1",
"id" : "5d4d7b9cf20ce440466a30bd",
"type" : "GLOBAL_ROLE",
"updated" : "2019-09-05T04:02:46Z"
}, {
"cidrBlock" : "2001:db8::/48",
"created" : "2019-09-05T04:02:46Z",
"description" : "Test Global Access List Entry 2",
"id" : "5d6fe33787d9d6689b3427ec",
"type" : "GLOBAL_ROLE",
"updated" : "2019-09-05T04:02:46Z"
} ]
"totalCount" : 2
}

돌아가기

글로벌 액세스 목록

이 페이지의 내용