일반 Azure Cosmos DB REST 요청 헤더
다음 요청 헤더는 SQL API로 수행할 수 있는 모든 작업에 공통적으로 적용됩니다.
| 헤더 | 필수 | 형식 | Description |
|---|---|---|---|
| 권한 부여 | 필수 | 문자열 | 요청에 대한 권한 부여 토큰입니다. 유효한 권한 부여 토큰을 생성하는 방법에 대한 자세한 내용은 Cosmos DB 리소스의 Access Control 참조하세요. |
| Content-Type | 필수(PUT, PATCH 및 POST) | 문자열 | 쿼리 작업에 대한 POST의 경우 application/query+json이어야 합니다. PATCH 작업의 경우 application/json_patch+json이어야 합니다. 첨부 파일의 경우 을 첨부 파일의 Mime 형식으로 설정해야 합니다. Mime 형식에 대한 자세한 내용은 첨부 파일 만들기를 참조하세요. 다른 모든 작업의 경우 는 application/json이어야 합니다. |
| If-Match | 선택 사항(PUT 및 DELETE에만 적용) | 문자열 | 낙관적 동시성을 위한 작업을 조건부로 만드는 데 사용됩니다. 값은 리소스의 etag 값이어야 합니다. |
| If-None-Match | 선택 사항(GET에만 해당) | 문자열 | 리소스가 변경된 경우에만 작업을 조건부로 실행합니다. 값은 리소스의 etag여야 합니다. |
| If-Modified-Since | 선택 사항(GET에만 해당) | Date | 지정된 날짜 이후에 수정된 리소스의 etag를 RFC 1123 형식으로 반환합니다. If-None-Match가 지정된 경우 무시됨 |
| User-Agent | 선택 사항 | 문자열 | 요청을 수행하는 클라이언트 사용자 에이전트를 지정하는 문자열입니다. 권장되는 형식은 {사용자 에이전트 이름}/{버전}입니다. 예를 들어 공식 SQL API .NET SDK는 User-Agent 문자열을 Microsoft.Document.Client/1.0.0.0으로 설정합니다. 사용자 지정 사용자 에이전트는 ContosoMarketingApp/1.0.0과 같은 것일 수 있습니다. |
| x-ms-activity-id | 선택 사항 | 문자열 | 서버 응답에 에코되는 작업에 대한 클라이언트 제공 식별자입니다. 권장되는 값은 고유 식별자입니다. |
| x-ms-consistency-level | 선택 사항 | 문자열 | 문서 및 첨부 파일에 대한 읽기 옵션에 대한 일관성 수준이 재정의됩니다. 유효한 값은 Strong, Bounded, Session 또는 Eventual입니다(가장 강력한 순서에서 가장 약한 값으로). 재정의는 계정의 구성된 일관성 수준과 동일하거나 약해야 합니다. |
| x-ms-continuation | 선택 사항 | 문자열 | 더 많은 결과를 읽을 수 있는 경우 쿼리 및 읽기 피드 작업에 대해 반환되는 문자열 토큰입니다. 클라이언트는 x-ms-continuation 요청 헤더가 이 값으로 설정된 요청을 다시 제출하여 결과의 다음 페이지를 검색할 수 있습니다. |
| x-ms-date | 필수 | 날짜 | 협정 세계시(예: 2015년 4월 08일 금요일 03:52:31 GMT)로 표현된 RFC 1123 날짜별 요청 날짜입니다. |
| x-ms-max-item-count | 선택 사항 | 숫자 | 페이지당 반환할 최대 항목 수를 나타내는 정수입니다. 서비스에서 최적의 항목 수를 결정할 수 있도록 x-ms-max-item-count -1을 지정할 수 있습니다. x-ms-max-item-count에 권장되는 구성 값입니다. |
| x-ms-documentdb-partitionkey | 선택 사항 | Array | 요청된 문서 또는 첨부 파일 작업의 파티션 키 값입니다. 컬렉션 정의에 파티션 키 정의가 포함된 경우 문서 및 첨부 파일에 대한 작업에 필요합니다. 이 값은 파티션 키 조건과 일치하는 문서에 쿼리를 scope 데 사용됩니다. 디자인상 단일 파티션 쿼리입니다. API 버전 2015-12-16 이상에서 지원됨 현재 SQL API는 단일 파티션 키를 지원하므로 값이 하나만 포함된 배열입니다. |
| x-ms-documentdb-query-enablecrosspartition | 선택 사항 | 부울 | 이 헤더가 true로 설정되고 쿼리에 파티션 키가 없는 경우 Azure Cosmos DB는 파티션 간에 쿼리를 팬아웃합니다. 팬 아웃은 모든 파티션에 개별 쿼리를 발급하여 수행됩니다. 쿼리 결과를 읽으려면 클라이언트 애플리케이션에서 FeedResponse의 결과를 사용하고 ContinuationToken 속성을 확인해야 합니다. 모든 결과를 읽으려면 ContinuationToken이 null이 될 때까지 데이터를 계속 반복합니다. |
| x-ms-session-token | 필수(세션 일관성에만 해당) | 문자열 | 세션 수준 일관성에 사용되는 문자열 토큰입니다. 자세한 내용은 다음을 참조하세요. Cosmos DB에서 일관성 수준 사용 |
| x-ms-version | 필수 | 문자열 | Cosmos DB REST 서비스의 버전입니다. 지원되는 API 버전 목록은 Azure Cosmos DB REST API 참조를 참조하세요. |
| A-IM | 선택 사항 | 문자열 | 변경 피드 요청을 나타냅니다. "증분 피드"로 설정하거나, 그렇지 않으면 생략해야 합니다. |
| x-ms-documentdb-partitionkeyrangeid | 선택 사항 | 숫자 | 변경 피드 요청에 사용됩니다. 데이터를 읽는 파티션 키 범위 ID입니다. |
| x-ms-cosmos-allow-미정-쓰기 | 선택 사항 | 부울 | 여러 쓰기 위치로 구성된 Azure Cosmos 계정에 대해 이 헤더가 true로 설정되면 Azure Cosmos DB는 모든 위치에 대한 쓰기를 허용합니다. 이 헤더 값이 false로 설정된 쓰기 요청(또는 헤더가 없는 경우)은 "지역에서 쓰기가 허용되지 않습니다"라는 오류 메시지와 함께 403 응답 상태 코드와 함께 실패합니다. |
참고 항목