atlas api rateLimiting listRateLimits

--endpointPath

/rateLimits?endpointPath=%2Fapi%2Fatlas%2Fv2%2Fclusters&endpointPath=%2Fapi%2Fatlas%2Fv2%2Fgroups%2F%7BgroupId%7D%2F

거짓

제공된 엔드포인트 경로를 기준으로 반환된 엔드포인트 세트를 필터링합니다. 여러 경로를 제공할 수 있습니다( 예시 : /rateLimits?endpointPath=%2Fapi%2Fatlas%2Fv2%2Fclusters&endpointPath=%2Fapi%2Fatlas%2Fv2%2Fgroups%2F%7BgroupId%7D%2F. /, { 및 } 을 URL 인코딩 값(각각 %2F, %7B, %7D)으로 바꿉니다.

--envelope

envelope

거짓

애플리케이션이 응답을 엔벨로프 JSON 객체 로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스 할 수 없습니다. 이 문제를 해결하려면 쿼리 에서 envelope=true 를 설정하다 . 결과 목록을 반환하는 엔드포인트는 결과 객체 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

--groupId

문자열

거짓

속도 제한을 요청 Atlas 프로젝트를 식별하는 고유한 24-16진수 문자열입니다. 이 매개변수가 제공되면 그룹 범위 엔드포인트 세트만 반환되며 반환된 제한은 지정된 프로젝트 에 적용됩니다. 요청하는 사용자에게는 지정된 프로젝트 에 대한 프로젝트 읽기 전용 역할 있어야 합니다.

-h, --help

거짓

listRateLimits에 대한 도움말

--ipAddress

문자열

거짓

속도 제한을 요청 IP 주소 입니다. 이 매개변수를 제공하면 IP 범위 엔드포인트 세트만 반환되며 반환된 제한은 지정된 IP 주소 에 적용됩니다. 요청하는 사용자는 요청 에 제공된 것과 동일한 IP 주소 가져야 합니다.

--itemsPerPage

int

거짓

페이지당 응답이 반환하는 항목 수입니다.

--name

/rateLimits?name=Name1&name=Name2

거짓

제공된 엔드포인트 세트 이름 기준으로 반환된 엔드포인트 세트를 필터링합니다. /rateLimits?name=Name1&name=Name2과 예시 여러 이름을 제공할 수 있습니다. 공백을 사용하는 이름의 경우 공백을 URL 인코딩 값(%20)으로 바꿉니다.

--orgId

문자열

거짓

속도 제한을 요청 Atlas 조직을 식별하는 고유한 24-16진수 문자열입니다. 이 매개변수를 제공하면 조직 범위 엔드포인트 세트만 반환되며 반환된 제한은 지정된 조직 에 적용됩니다. 요청하는 사용자는 지정된 조직 에 대해 조직 읽기 전용 역할 있어야 합니다.

-o, --output

문자열

거짓

기본 설정 API 형식은 ["JSON", go- Template] 일 수 있습니다. 이 값의 기본값은 "JSON" 입니다.

--outputFile

문자열

거짓

API 출력을 쓰기 (write) 파일 입니다. 이 플래그는 엔드포인트의 출력이 바이너리(예: gzip)이고 명령이 파이프되지 않은 경우(예: Atlas 명령 > out.zip)에 필요합니다.

--pageNum

int

거짓

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

--pretty

거짓

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

--userId

문자열

거짓

속도 제한을 요청 Atlas user 식별하는 문자열입니다. 예시 를 들어 ID 는 서비스 계정 클라이언트 ID 또는 API 공개 키일 수 있습니다. 이 매개변수를 제공하면 사용자 범위의 엔드포인트 세트만 반환되며 반환된 제한은 지정된 사용자에게 적용됩니다. 요청하는 사용자는 지정된 사용자와 동일해야 합니다.

--version

문자열

거짓

Atlas API 엔드포인트 [options: "2025-03-12"]를 호출할 때 사용할 API 버전입니다. 사용자가 설정하다 하지 않은 경우 기본값은 최신 버전이거나 설정하다 경우 프로필의 api_version 구성 값입니다. 이 값의 기본값은 '2025-03-12'입니다.