1개의 롤링 인덱스 만들기

POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index

롤링 방식으로 이름으로 식별되는 클러스터에 인덱스를 생성합니다. 이러한 방식으로 인덱스를 생성하면 세컨더리 멤버부터 시작하여 한 번에 복제본 세트 멤버 한 개에 대해 독립형으로 인덱스 생성이 가능합니다. 이 방식으로 인덱스를 생성하려면 적어도 한 번의 복제본 세트 선출이 필요합니다. 이 리소스를 사용하려면, 요청하는 서비스 계정 또는 API 키에 프로젝트 데이터 액세스 관리자 역할이 있어야 합니다.

복제본 세트에 대한 롤링 인덱스 빌드

경로 매개변수

  • groupId 문자열 필수 사항

    프로젝트 식별하는 고유한 24-16진수 문자열입니다. 인증된 사용자가 액세스 할 수 있는 모든 프로젝트를 조회 하려면 /groups 엔드포인트를 사용합니다.

    참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

    형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

  • clusterName 문자열 필수 사항

    MongoDB Cloud가 인덱스를 생성하는 cluster를 식별하는 사람이 읽을 수 있는 레이블입니다.

    형식은 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ 패턴 과 일치해야 합니다.

쿼리 매개변수

  • envelope 부울

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

    기본값은 false 입니다.

  • pretty 부울

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

    기본값은 false 입니다.

    Prettyprint
application/vnd.atlas.2023-01-01+json

body 필수 사항

지정된 cluster에 생성할 롤링 인덱스입니다.

  • 데이터 정렬 객체

    이 인덱스 내에서 문자열을 비교하기 위한 언어별 규칙을 지정하는 하나 이상의 설정입니다.

    데이터 정렬 옵션
    데이터 정렬 속성 숨기기 데이터 정렬 속성 표시 객체
    • 대체 문자열

      비교를 위해 공백과 구두점을 기본 문자로 처리하다 하는 메서드입니다. "non-ignorable" 은 공백과 구두점을 기본 문자로 평가합니다. "shifted" 는 그렇지 않으며, MongoDB Cloud는 "strength" > 3일 때 이러한 문자를 구분합니다.

      값은 non-ignorable 또는 shifted입니다. 기본값은 non-ignorable입니다.

    • 이전 부울

      분음 부호가 있는 문자열을 문자열 뒤쪽부터 정렬할지 여부를 나타내는 플래그입니다. 일부 프랑스어 사전은 이러한 방식으로 문자열을 정렬합니다. true 을(를) 뒤에서 앞으로 비교합니다. false 앞뒤로 비교합니다.

      기본값은 false 입니다.

    • caseFirst 문자열

      3차 수준 비교 중 대소문자 차이의 정렬 순서를 처리하다 하는 메서드입니다. "upper" 은 대문자를 소문자보다 먼저 정렬합니다. "lower" 은(는) 소문자를 대문자보다 먼저 정렬합니다. "off" 는 'lower'와 유사하지만 약간의 차이점이 있습니다.

      값은 lower, off 또는 upper입니다. 기본값은 off입니다.

    • caseLevel 부울

      "strength" : 1 또는 "strength" : 2일 때 대소문자 비교를 포함할지 여부를 나타내는 플래그입니다.

      • true - 비교에 케이스 포함
        • 강도 수준: 1 - 기본 문자 및 대소문자.
        • 강도 수준: 2 - 기본 문자, 발음 부호(및 가능한 기타 세컨더리 차이점) 및 대소문자.
      • false - 케이스는 비교 대상에 포함되지 않습니다.

      기본값은 false 입니다.

    • 국가 및 언어 설정 문자열 필수 사항

      현지화된 언어 나타내는 국제 유니코드(ICU) 코드입니다. 단순 이진 비교를 지정하려면 "locale" : "simple"을(를) 설정하다 .

      값은 af, sq, am, ar, hy, as, az, bn, be, bs, bs_Cyrl, bg, my, ca, chr, zh, zh_Hant, hr, cs, da, nl, dz, en, en_US, en_US_POSIX, eo, et, ee, fo, fil, fi_FI, fr, fr_CA, gl, ka, de, de_AT, el, gu, ha, haw, he, hi, hu, is, ig, smn, id, ga, it, ja, kl, kn, kk, km, kok, ko, ky, lk, lo, lv, li, lt, dsb, lb, mk, ms, ml, mt, mr, mn, ne, se, nb, nn, or, om, ps, fa, fa_AF, pl, pt, pa, ro, ru, sr, sr_Latn, si, sk, sl, es, sw, sv, ta, te, th, bo, to, tr, uk, hsb, ur, ug, vi, wae, cy, yi, yo, zu 또는 simple.

    • maxVariable 문자열

      "alternate" : "shifted"."punct" 이(가) 공백과 구두점을 모두 무시할 때 무시할 수 있는 문자를 나타내는 필드입니다. "space" 는 공백을 무시합니다. "alternate" : "non-ignorable"인 경우에는 영향을 주지 않습니다.

      값은 punct 또는 space입니다.

    • 정규화 부울

      텍스트에 정규화가 필요한지 확인한 다음 수행할지 여부를 나타내는 플래그입니다. 대부분의 텍스트에는 이러한 정규화 처리 필요하지 않습니다.

      true 완전히 정규화되었는지 확인하고 정규화를 수행하여 텍스트를 비교합니다. false 은(는) 확인하지 않습니다.

      기본값은 false 입니다.

    • numericOrdering 부울

      숫자 시퀀스를 숫자 또는 문자열로 비교할지 여부를 나타내는 플래그입니다. true 은(는) 숫자로 비교되므로 결과는 10 > 2이(가) 됩니다. false 는 문자열로 비교합니다. 결과는 "10" < "2"입니다.

      기본값은 false 입니다.

    • integer(int32)

      단어를 정렬할 때 수행할 비교의 정도입니다.

      MongoDB Cloud는 비교 수준 및 해당 비교 메서드에 해당하는 다음 숫자 값을 허용합니다.

      • 1 - "Primary" - 분음 부호 및 대소문자와 같은 다른 차이점을 무시하고 기본 문자만 비교합니다.
      • 2 - "Secondary" - 기본 문자(프라이머리)와 분음 부호(세컨더리)를 비교합니다. 1차 차이는 세컨더리 차이보다 우선합니다.
      • 3 - "3차" - 기본 문자(프라이머리), 분음 부호(세컨더리), 대소문자 및 변형(3차 )을 비교합니다. 기본 문자 간의 차이는 세컨더리 차이보다 우선하는 2차 차이보다 우선합니다.
      • 4 - "4차" - 1 ~ 3 수준에서 구두점을 고려하거나 일본어 텍스트를 처리 할 때 구두점을 고려하기 위해 특정 사용 사례 비교합니다.
      • 5 - '동일한' - 타이 브레이커의 특정 사용 사례 비교합니다.

      최소값은 1, 최대값은 5입니다. 기본값은 3입니다.

  • 컬렉션 문자열 필수 사항

    MongoDB Cloud가 인덱스를 생성하는 컬렉션의 사람이 읽을 수 있는 레이블입니다.

  • db 문자열 필수 사항

    MongoDB Cloud가 인덱스를 생성하는 컬렉션을 보유하는 데이터베이스의 사람이 읽을 수 있는 레이블입니다.

  • 배열[객체]

    인덱싱하려는 매개변수를 설명하는 객체가 한 개 이상 포함된 목록입니다.

    인덱스 할 매개변수를 키로 설정하고 인덱스 유형을 값으로 설정하는 키-값 쌍입니다. 멀티키 인덱스 만들려면 이 배열 내의 자체 객체에 각 매개 변수를 나열합니다.

    키 속성 숨기기 키 속성 표시 객체
    • * 문자열 additionalProperties

      인덱스 할 매개변수를 키로 설정하고 인덱스 유형을 값으로 설정하는 키-값 쌍입니다. 멀티키 인덱스 만들려면 이 배열 내의 자체 객체에 각 매개 변수를 나열합니다.

      인덱스 유형
  • 옵션 객체

    MongoDB Cloud가 이 MongoDB 인덱스를 생성하는 방법을 결정하는 하나 이상의 설정입니다.

    인덱스 옵션
    옵션 속성 숨기기 옵션 속성 표시 객체
    • 2dsphereIndexVersion integer(int32)

      2dsphere 인덱스 에 적용된 인덱스 버전 번호입니다. MongoDB 3.2 이상 버전은 3 버전을 사용합니다. 이 옵션을 사용하여 기본값 버전 번호를 재정의할 수 있습니다. 이 옵션은 2dsphere 인덱스 유형에만 적용됩니다.

      기본값은 3 입니다.

    • 배경 부울

      MongoDB 배경 에서 인덱스 빌드 해야 하는지 여부를 나타내는 플래그입니다. 이는 기능 호환성 버전 4.0 이하를 실행 MongoDB 데이터베이스에 적용됩니다. FCV 4.2 이상을 실행 MongoDB 데이터베이스는 최적화된 빌드 프로세스 사용하여 인덱스를 빌드 . 이 프로세스 빌드 프로세스 의 시작과 끝에서만 배타 락 유지합니다. 빌드 프로세스 의 나머지 부분은 읽기 및 쓰기 (write) 작업과 교차하여 진행됩니다. FCV 4.2 이상을 실행 MongoDB 데이터베이스는 이 옵션을 무시합니다. 이 옵션은 모든 인덱스 유형에 적용됩니다.

      기본값은 false 입니다.

    • 비트 integer(int32)

      위치 데이터의 저장된 geohash 값에 적용되는 정밀도의 수입니다. 이 옵션은 2d 인덱스 유형에만 적용됩니다.

      기본값은 26 입니다.

    • bucketSize integer(int32)

      위치 값을 그룹 할 단위 수입니다. 지정된 단위 수 내의 위치 값을 동일한 버킷으로 그룹 할 수 있습니다. 이 옵션은 geoHaystack 인덱스 유형에만 적용됩니다.

      MongoDB 5.0 에서 geoHaystack 인덱스와 geoSearch 명령을 제거했습니다.

    • columnstoreProjection 객체

      columnstoreProjection 문서 사용하면 하위 스키마 스키마 포함하거나 제외할 수 있습니다. 포함 진술과 제외 진술을 결합할 수 없습니다. 따라서 다음 중 하나일 수 있습니다. 1 또는 인덱스 0 에 필드 와 접두사가 있는 모든 필드를 재귀적으로 포함하려면 true, 접두사 필드 있는 모든 필드를 재귀적으로 제외하려면 false를 선택합니다. 인덱스.

      columnstoreProjection 속성 숨기기 columnstoreProjection 속성 표시 객체
      • * integer(int32) additionalProperties

        columnstoreProjection 문서 사용하면 하위 스키마 스키마 포함하거나 제외할 수 있습니다. 포함 진술과 제외 진술을 결합할 수 없습니다. 따라서 다음 중 하나일 수 있습니다. 1 또는 인덱스 0 에 필드 와 접두사가 있는 모든 필드를 재귀적으로 포함하려면 true, 접두사 필드 있는 모든 필드를 재귀적으로 제외하려면 false를 선택합니다. 인덱스.

    • default_language 문자열

      중지 단어 목록과 형태소 분석기 및 토크나이저 에 대한 규칙을 결정하는 인간의 언어 . 이 옵션은 영어 소문자 이름 또는 ISO 639-2 코드를 사용하여 지원되는 언어를 허용합니다. 이 매개 변수를 "none"로 설정하다 텍스트 검색 중지 단어 목록과 형태소 분석 없이 간단한 토큰화를 사용합니다. 이 옵션은 텍스트 인덱스 유형에만 적용됩니다.

      기본값은 english 입니다.

    • expireAfterSeconds integer(int32)

      MongoDB TTL(Time To Live) 인덱스 에 문서를 보관하는 시간(초)입니다.

    • 숨김 부울

      쿼리 플래너에서 인덱스 숨길지 여부를 결정하는 플래그입니다. 숨겨진 인덱스 쿼리 계획 선택의 일부로 평가되지 않습니다.

      기본값은 false 입니다.

    • language_override 문자열

      문서 의 재정의 언어 포함된 문서 매개변수를 식별하는 사람이 읽을 수 있는 레이블입니다. 이 옵션은 텍스트 인덱스 유형에만 적용됩니다.

      기본값은 language 입니다.

    • 최대 integer(int32)

      경도 및 위도 값을 제한하는 상위 포함 경계입니다. 이 옵션은 2d 인덱스 유형에만 적용됩니다.

      기본값은 180 입니다.

    • min integer(int32)

      경도 및 위도 값을 제한하는 하한 포함 경계입니다. 이 옵션은 2d 인덱스 유형에만 적용됩니다.

      기본값은 -180 입니다.

    • 이름 문자열

      이 인덱스 식별하는 사람이 읽을 수 있는 레이블입니다. 이 옵션은 모든 인덱스 유형에 적용됩니다.

    • 부분 필터 표현식 객체

      인덱스 참조하는 문서를 필터하다 표현식 으로 제한하는 규칙입니다. 모든 MongoDB 인덱스 유형은 partialFilterExpression 옵션을 허용합니다. partialFilterExpression 에는 다음 표현식이 포함될 수 있습니다.

      • 등호("parameter" : "value" 또는 $eq 연산자 사용)
      • "$exists": true , 최대값: $gt, $gte, $lt, $lte 비교
      • $type
      • $and (최상위 수준에만 해당) 이 옵션은 모든 인덱스 유형에 적용됩니다.
      partialFilterExpression 속성 숨기기 partialFilterExpression 속성 표시 객체
      • * 객체 additionalProperties

        인덱스 참조하는 문서를 필터하다 표현식 으로 제한하는 규칙입니다. 모든 MongoDB 인덱스 유형은 partialFilterExpression 옵션을 허용합니다. partialFilterExpression 에는 다음 표현식이 포함될 수 있습니다.

        • 등호("parameter" : "value" 또는 $eq 연산자 사용)
        • "$exists": true , 최대값: $gt, $gte, $lt, $lte 비교
        • $type
        • $and (최상위 수준에만 해당) 이 옵션은 모든 인덱스 유형에 적용됩니다.
    • 희박 부울

      인덱스 지정된 매개변수만 있는 문서를 참조하는지 여부를 나타내는 플래그입니다. 이러한 인덱스는 공간을 덜 사용하지만 정렬과 같은 일부 상황에서는 다르게 동작합니다. 다음 인덱스 유형은 기본값 희소(sparse)로 설정되며 이 옵션을 무시합니다: 2dsphere, 2d, geoHaystack, text.

      다른 키 유형과 함께 2dsphere 키가 있는 인덱스를 하나 이상 포함하는 복합 인덱스는 2dsphere 인덱스 매개변수만이 인덱스 참조하는 문서를 결정합니다. MongoDB 3.2 이상을 실행 경우 부분 인덱스를 사용합니다. 이 옵션은 모든 인덱스 유형에 적용됩니다.

      기본값은 false 입니다.

    • storageEngine 객체

      특정 인덱스 에 대해 설정하다 스토리지 엔진 입니다. 이 값은 생성 시에만 설정하다 수 있습니다. 이 옵션은 다음 형식을 사용합니다: "storageEngine" : { "<storage-engine-name>" : "<options>" } MongoDB 인덱스를 생성할 때 스토리지 엔진 구성 옵션의 유효성을 검사합니다. 저장 엔진이 다른 멤버가 있는 복제본 세트를 지원 위해 MongoDB 복제 중에 이러한 옵션을 oplog 에 기록합니다. 이 옵션은 모든 인덱스 유형에 적용됩니다.

      MongoDB Server 스토리지 엔진
      storageEngine 속성 숨기기 storageEngine 속성 표시 객체
      • * 객체 additionalProperties

        특정 인덱스 에 대해 설정하다 스토리지 엔진 입니다. 이 값은 생성 시에만 설정하다 수 있습니다. 이 옵션은 다음 형식을 사용합니다: "storageEngine" : { "<storage-engine-name>" : "<options>" } MongoDB 인덱스를 생성할 때 스토리지 엔진 구성 옵션의 유효성을 검사합니다. 저장 엔진이 다른 멤버가 있는 복제본 세트를 지원 위해 MongoDB 복제 중에 이러한 옵션을 oplog 에 기록합니다. 이 옵션은 모든 인덱스 유형에 적용됩니다.

        MongoDB Server 스토리지 엔진
    • textIndexVersion integer(int32)

      이 텍스트 인덱스 에 적용된 버전입니다. MongoDB 3.2 이상 버전은 3 버전을 사용합니다. 이 옵션을 사용하여 기본값 버전 번호를 재정의할 수 있습니다. 이 옵션은 텍스트 인덱스 유형에만 적용됩니다.

      기본값은 3 입니다.

    • 가중치 객체

      제공된 인덱스 매개변수에 부여할 상대적 중요도입니다. 이 객체 이를 해당 매개변수에 적용 할 인덱스 매개변수와 가중치의 키/값 쌍으로 표현합니다. 인덱싱된 매개변수의 일부 또는 전부에 가중치를 지정할 수 있습니다. 가중치는 1 에서 99999 사이의 정수여야 합니다. MongoDB 5.0 이상에서는 텍스트 인덱스에만 가중치 를 적용 할 수 있습니다.

      가중치 속성 숨기기 가중치 속성 표시 객체
      • * 객체 additionalProperties

        제공된 인덱스 매개변수에 부여할 상대적 중요도입니다. 이 객체 이를 해당 매개변수에 적용 할 인덱스 매개변수와 가중치의 키/값 쌍으로 표현합니다. 인덱싱된 매개변수의 일부 또는 전부에 가중치를 지정할 수 있습니다. 가중치는 1 에서 99999 사이의 정수여야 합니다. MongoDB 5.0 이상에서는 텍스트 인덱스에만 가중치 를 적용 할 수 있습니다.

응답

  • 202 application/vnd.atlas.2023-01-01+json

    수락됨

  • 400 application/json

    잘못된 요청입니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

  • 401 application/json

    승인되지 않았습니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

  • 403 application/json

    Forbidden.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

  • 404 application/json

    찾을 수 없습니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

  • 429 application/json

    요청이 너무 많습니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

  • 500 application/json

    내부 서버 오류입니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/ 인덱스
atlas api rollingIndex createGroupClusterIndexRollingIndex --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20231001001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.CreateGroupClusterIndexRollingIndexApiParams{}
	sdkResp, httpResp, err := client.RollingIndexApi.
		CreateGroupClusterIndexRollingIndexWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-10-01+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index" \
  -d '{ <Payload> }'
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-10-01+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index" \
  -d '{ <Payload> }'
2dspere Index
{
  "db": "sample_airbnb",
  "keys": [
    {
      "property_type": "1"
    }
  ],
  "options": {
    "name": "PartialIndexTest",
    "partialFilterExpression": {
      "limit": {
        "$gt": 900
      }
    }
  },
  "collation": {
    "locale": "af",
    "strength": 3,
    "alternate": "non-ignorable",
    "backwards": false,
    "caseFirst": "lower",
    "caseLevel": false,
    "maxVariable": "punct",
    "normalization": false,
    "numericOrdering": false
  },
  "collection": "accounts"
}
부분 인덱스
{
  "db": "sample_airbnb",
  "keys": [
    {
      "property_type": "1"
    }
  ],
  "options": {
    "name": "PartialIndexTest",
    "partialFilterExpression": {
      "limit": {
        "$gt": 900
      }
    }
  },
  "collation": {
    "locale": "af",
    "strength": 3,
    "alternate": "non-ignorable",
    "backwards": false,
    "caseFirst": "lower",
    "caseLevel": false,
    "maxVariable": "punct",
    "normalization": false,
    "numericOrdering": false
  },
  "collection": "accounts"
}
Sparse Index
{
  "db": "sample_airbnb",
  "keys": [
    {
      "test_field": "1"
    }
  ],
  "options": {
    "name": "SparseIndexTest",
    "sparse": true
  },
  "collation": {
    "locale": "af",
    "strength": 3,
    "alternate": "non-ignorable",
    "backwards": false,
    "caseFirst": "lower",
    "caseLevel": false,
    "maxVariable": "punct",
    "normalization": false,
    "numericOrdering": false
  },
  "collection": "accounts"
}
응답 예시(400)
{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}
응답 예시(401)
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
응답 예시(403)
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
응답 예시(404)
{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}
응답 예시(429)
{
  "error": 429,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Too Many Requests",
  "errorCode": "RATE_LIMITED"
}
응답 예시(500)
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}