하나의 속도 제한 엔드포인트 설정하다 가져옵니다.
Atlas API 하위 명령은 MongoDB Atlas 관리자 API 에서 자동으로 생성되며 관리자 API 에 대한 전체 커버리지를 제공합니다. 관리자 API 역량에는 자체 출시 수명 주기가 있으며, 이는 제공된 API 엔드포인트 문서 링크를 통해 확인할 수 있습니다.
이 명령은 자동으로 1 생성되며:1 Atlas API 엔드포인트 https://www.mongodb.com/ko-kr/docs/api/doc/atlas-admin-api-v2/operation/에 해당합니다. operation-getratelimit.
자세한 내용과 예시는 위에 링크된 참조 API 문서를 참조하세요.
구문
atlas api rateLimiting getRateLimit [options]
옵션
이름 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
--endpointSetId | 문자열 | true | 속도 제한 엔드포인트 설정하다 의 ID 입니다. |
--envelope | envelope | 거짓 | 애플리케이션이 응답을 엔벨로프 JSON 객체 로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스 할 수 없습니다. 이 문제를 해결하려면 쿼리 에서 envelope=true 를 설정하다 . 결과 목록을 반환하는 엔드포인트는 결과 객체 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다. |
--groupId | 문자열 | 거짓 | 속도 제한을 요청 Atlas 프로젝트를 식별하는 고유한 24-16진수 문자열입니다. 이 매개변수를 제공하면 반환된 제한이 지정된 프로젝트 에 적용됩니다. 요청하는 사용자에게는 지정된 프로젝트 에 대한 프로젝트 읽기 전용 역할 있어야 합니다. |
-h, --help | 거짓 | getRateLimit에 대한 도움말 | |
--ipAddress | 문자열 | 거짓 | 속도 제한을 요청 IP 주소 입니다. 이 매개변수를 제공하면 반환된 제한이 지정된 IP 주소 에 적용됩니다. 요청하는 사용자는 요청 에 제공된 것과 동일한 IP 주소 가져야 합니다. |
--orgId | 문자열 | 거짓 | 속도 제한을 요청 Atlas 조직을 식별하는 고유한 24-16진수 문자열입니다. 이 매개변수를 제공하면 반환된 제한이 지정된 조직 에 적용됩니다. 요청하는 사용자는 지정된 조직 에 대해 조직 읽기 전용 역할 있어야 합니다. |
-o, --output | 문자열 | 거짓 | 기본 설정 API 형식은 ["JSON", go- Template] 일 수 있습니다. 이 값의 기본값은 "JSON" 입니다. |
--outputFile | 문자열 | 거짓 | API 출력을 쓰기 (write) 파일 입니다. 이 플래그는 엔드포인트의 출력이 바이너리(예: gzip)이고 명령이 파이프되지 않은 경우(예: Atlas 명령 > out.zip)에 필요합니다. |
--pretty | 거짓 | 응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다. | |
--userId | 문자열 | 거짓 | 속도 제한을 요청 Atlas user 식별하는 문자열입니다. 예시 를 들어 ID 는 서비스 계정 클라이언트 ID 또는 API 공개 키일 수 있습니다. 이 매개변수를 제공하면 반환된 제한이 지정된 사용자에게 적용됩니다. 요청하는 사용자는 지정된 사용자와 동일해야 합니다. |
--version | 문자열 | 거짓 | API 호출 시 사용할 API 버전 [옵션: "2025-03-12", "미리 보기"], 기본값은 최신 버전 또는 프로필 api_version 구성 값( 설정하다 경우) 값 이 값의 기본값은 '미리 보기'입니다. ". |
상속된 옵션
이름 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
-P, --profile | 문자열 | 거짓 | 구성 파일 에서 사용할 프로필의 이름입니다. Atlas CLI 의 프로필에 대해 학습 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings를 참조하세요. |
예시
atlas api rateLimiting getRateLimit --version preview --endpointSetId rateLimitsInspection_group --groupId 32b6e34b3d91647abb20e7b8 --ipAddress 127.0.0.1 --orgId 32b6e34b3d91647abb20e7b8 --userId mdb_sa_id_1234567890abcdef12345678