파티션 키 범위 가져오기

  • 아티클

GET 특정 컬렉션의 pkranges 자식 리소스에서 를 수행하면 컬렉션의 파티션 키 범위 목록이 검색됩니다.

참고

이러한 API 참조 문서에서는 Azure Cosmos DB 데이터 평면 API를 사용하여 리소스를 만드는 방법을 보여 줍니다. 데이터 평면 API를 사용하면 Cosmos DB SDK와 마찬가지로 인덱싱 정책, 파티션 키와 같은 기본 옵션을 구성할 수 있습니다. 모든 Azure Cosmos DB 리소스에 대한 완전한 기능 지원이 필요한 경우 Cosmos DB 리소스 공급자를 사용하는 것이 좋습니다.

요청

메서드 요청 URI 설명
GET https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/pkranges 는 {databaseaccount} 구독에서 만든 Azure Cosmos DB 계정의 이름입니다. {db-id} 데이터베이스의 ID와 {coll-id} 값은 컬렉션의 ID입니다.

헤더

모든 Cosmos DB 요청 에서 사용되는 헤더는 일반적인 Azure Cosmos DB REST 요청 헤더를 참조하세요.

본문

없음

응답

컬렉션의 파티션 키 범위 목록을 반환합니다.

헤더

모든 Cosmos DB 응답 에서 반환되는 헤더는 일반적인 Azure Cosmos DB REST 응답 헤더를 참조하세요.

상태 코드

다음 표에는 이 작업에서 반환하는 일반적인 상태 코드가 나열되어 있습니다. 상태 코드의 전체 목록은 HTTP 상태 코드를 참조하세요.

HTTP 상태 코드 Description
200 정상 작업이 완료되었습니다.
404 찾을 수 없음 컬렉션을 찾을 수 없습니다.

본문

속성 Description
id 컬렉션을 식별하는 고유한 이름입니다.
_rid 시스템 생성 속성으로, 리소스 ID(_rid)는 리소스 모델의 리소스 스택에 따라 계층적인 고유 식별자입니다. 사용 권한 리소스의 배치와 탐색용으로 내부적으로 사용됩니다.
_ts 시스템 생성 속성으로, 리소스가 마지막으로 업데이트된 시간의 타임스탬프를 지정합니다. 값은 타임스탬프입니다.
_self 시스템 생성 속성으로, 고유한 주소를 지정할 수 있는 리소스의 URI입니다.
_etag 낙관적 동시성 제어에 필요한 리소스 etag 를 나타내는 시스템 생성 속성입니다.
PartitionKeyRanges 컬렉션의 파티션 키 범위 목록입니다. 헤더를 사용하는 증분 읽기 피드 x-ms-documentdb-partitionkeyrangeid 에 사용할 수 있습니다.

PartitionKeyRanges의 속성

속성 Description
id

파티션 키 범위에 대한 ID입니다. 각 컬렉션 내에서 안정적이고 고유한 ID입니다.

파티션 키 범위별로 문서를 읽는 데 사용할 수 있습니다.
maxExclusive 파티션 키 범위에 대한 파티션 키 해시의 최대 값입니다. 내부적으로만 사용할 수 있습니다.
minInclusive 파티션 키 범위에 대한 파티션 키 해시의 최소 값입니다. 내부적으로만 사용할 수 있습니다.

예제

컬렉션 내에서 pkranges 리소스를 요청하여 파티션 키 범위를 검색할 수 있습니다. 예를 들어, 다음 요청은 serverlogs 컬렉션에 대한 파티션 키 범위 목록을 검색합니다.

    GET https://querydemo.documents.azure.com/dbs/bigdb/colls/serverlogs/pkranges HTTP/1.1
    x-ms.date: 04/20/2021
    authorization: type%3dmaster%26ver%3d1.0%26sig%3dEConYmRgDExu6q%2bZ8GjfUGOH0AcOx%2behkancw3LsGQ8%3d
    x-ms-consistency-level: Session
    x-ms-version: 2016-07-11
    Accept: application/json
    Host: querydemo.documents.azure.com

이 요청에는 파티션 키 범위에 대한 메타데이터가 포함된 다음과 같은 응답을 반환합니다.

    HTTP/1.1 200 Ok
    Content-Type: application/json
    x-ms-item-count: 25
    x-ms-schemaversion: 1.1
    Date: Tue, 15 Nov 2016 07:26:51 GMT

    {
       "_rid":"qYcAAPEvJBQ=",
       "PartitionKeyRanges":[
          {
             "_rid":"qYcAAPEvJBQCAAAAAAAAUA==",
             "id":"0",
             "_etag":"\"00002800-0000-0000-0000-580ac4ea0000\"",
             "minInclusive":"",
             "maxExclusive":"05C1CFFFFFFFF8",
             "_self":"dbs\/qYcAAA==\/colls\/qYcAAPEvJBQ=\/pkranges\/qYcAAPEvJBQCAAAAAAAAUA==\/",
             "_ts":1477100776
          },
          ...
       ],
       "_count": 25
    }

참고 항목