컬렉션 나열
특정 데이터베이스의 컬렉션 리소스(예: colls URI 경로)에서 GET을 수행하면 데이터베이스의 컬렉션 목록이 반환됩니다.
참고
이러한 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 | {databaseaccount}는 구독에서 만든 Azure Cosmos DB 계정의 이름입니다. {db-id} 값은 시스템 생성 ID(rid)가 아니라 사용자가 생성한 데이터베이스의 이름/ID입니다. |
헤더
모든 Cosmos DB 요청에 사용되는 헤더는 일반적인 Azure Cosmos DB REST 요청 헤더를 참조하세요.
본문
없음
응답
List Collections는 지정된 데이터베이스 내의 컬렉션 배열을 반환합니다.
헤더
모든 Cosmos DB 응답 에서 반환되는 헤더는 일반적인 Azure Cosmos DB REST 응답 헤더를 참조하세요.
상태 코드
다음 표에는 이 작업에서 반환하는 일반적인 상태 코드가 나열되어 있습니다. 상태 코드의 전체 목록은 HTTP 상태 코드를 참조하세요.
| HTTP 상태 코드 | Description |
|---|---|
| 200 정상 | 작업이 완료되었습니다. |
본문
| 속성 | Description |
|---|---|
| _제거 | 이 속성은 컬렉션이 있는 데이터베이스의 리소스 ID입니다. |
| _횟수 | 이 속성은 나열 작업의 일부로 반환된 연결 수를 보여 줍니다. |
| DocumentCollections | 이 속성은 목록 작업의 일부로 반환되는 컬렉션을 포함하는 배열입니다. 컬렉션에 포함된 속성에 대한 자세한 내용은 컬렉션을 참조하세요. |
{
"_rid": "PaYSAA==",
"DocumentCollections": [
{
"id": "SampleCollection",
"indexingPolicy": {
"indexingMode": "consistent",
"automatic": true,
"includedPaths": [
{
"path": "/*",
"indexes": [
{
"kind": "Range",
"dataType": "Number",
"precision": -1
},
{
"kind": "Hash",
"dataType": "String",
"precision": 3
}
]
}
],
"excludedPaths": []
},
"_rid": "PaYSAPH7qAo=",
"_ts": 1459194239,
"_self": "dbs/PaYSAA==/colls/PaYSAPH7qAo=/",
"_etag": "\"00001300-0000-0000-0000-56f9897f0000\"",
"_docs": "docs/",
"_sprocs": "sprocs/",
"_triggers": "triggers/",
"_udfs": "udfs/",
"_conflicts": "conflicts/"
},
{
"id": "SampleCollectionWithCustomIndexPolicy",
"indexingPolicy": {
"indexingMode": "lazy",
"automatic": true,
"includedPaths": [
{
"path": "/*",
"indexes": [
{
"kind": "Range",
"dataType": "Number",
"precision": -1
},
{
"kind": "Hash",
"dataType": "String",
"precision": 3
}
]
}
],
"excludedPaths": []
},
"_rid": "PaYSAIxUPws=",
"_ts": 1459194241,
"_self": "dbs/PaYSAA==/colls/PaYSAIxUPws=/",
"_etag": "\"00001500-0000-0000-0000-56f989810000\"",
"_docs": "docs/",
"_sprocs": "sprocs/",
"_triggers": "triggers/",
"_udfs": "udfs/",
"_conflicts": "conflicts/"
}
],
"_count": 2
}
예제
GET https://querydemo.documents.azure.com/dbs/SampleDatabase/colls HTTP/1.1
x-ms.date: 04/20/2021
authorization: type%3dmaster%26ver%3d1.0%26sig%3dQdp6TjZxdeJAKSiUfG%2fd7dS46USXy1IF%2bt5ToLdvOaA%3d
Cache-Control: no-cache
User-Agent: Microsoft.Azure.Documents.Client/1.6.0.0Internal Azure DocumentDB Studio/0.61
x-ms-version: 2015-12-16
Accept: application/json
Host: querydemo.documents.azure.com
HTTP/1.1 200 Ok
Cache-Control: no-store, no-cache
Pragma: no-cache
Transfer-Encoding: chunked
Content-Type: application/json
Content-Location: https://querydemo.documents.azure.com/dbs/SampleDatabase/colls
Server: Microsoft-HTTPAPI/2.0
Strict-Transport-Security: max-age=31536000
x-ms-last-state-change-utc: Fri, 25 Mar 2016 22:55:02.762 GMT
x-ms-resource-quota: collections=5000;
x-ms-resource-usage: collections=27;
x-ms-item-count: 2
x-ms-schemaversion: 1.1
x-ms-alt-content-path: dbs/SampleDatabase
x-ms-content-path: PaYSAA==
x-ms-request-charge: 2
x-ms-serviceversion: version=1.6.52.5
x-ms-activity-id: 9c102725-4c2b-48ba-8f51-7ac1dc6dbce7
x-ms-session-token: M:7860
x-ms-gatewayversion: version=1.6.52.5
Date: Mon, 28 Mar 2016 21:25:59 GMT
{
"_rid": "PaYSAA==",
"DocumentCollections": [
{
"id": "SampleCollection",
"indexingPolicy": {
"indexingMode": "consistent",
"automatic": true,
"includedPaths": [
{
"path": "/*",
"indexes": [
{
"kind": "Range",
"dataType": "Number",
"precision": -1
},
{
"kind": "Hash",
"dataType": "String",
"precision": 3
}
]
}
],
"excludedPaths": []
},
"_rid": "PaYSAPH7qAo=",
"_ts": 1459194239,
"_self": "dbs/PaYSAA==/colls/PaYSAPH7qAo=/",
"_etag": "\"00001300-0000-0000-0000-56f9897f0000\"",
"_docs": "docs/",
"_sprocs": "sprocs/",
"_triggers": "triggers/",
"_udfs": "udfs/",
"_conflicts": "conflicts/"
},
{
"id": "SampleCollectionWithCustomIndexPolicy",
"indexingPolicy": {
"indexingMode": "lazy",
"automatic": true,
"includedPaths": [
{
"path": "/*",
"indexes": [
{
"kind": "Range",
"dataType": "Number",
"precision": -1
},
{
"kind": "Hash",
"dataType": "String",
"precision": 3
}
]
}
],
"excludedPaths": []
},
"_rid": "PaYSAIxUPws=",
"_ts": 1459194241,
"_self": "dbs/PaYSAA==/colls/PaYSAIxUPws=/",
"_etag": "\"00001500-0000-0000-0000-56f989810000\"",
"_docs": "docs/",
"_sprocs": "sprocs/",
"_triggers": "triggers/",
"_udfs": "udfs/",
"_conflicts": "conflicts/"
}
],
"_count": 2
}