Listy kolekcji
Wykonanie polecenia GET w zasobie kolekcji określonej bazy danych, tj. ścieżki identyfikatora URI sortowania, zwraca listę kolekcji w bazie danych.
Uwaga
Te artykuły referencyjne dotyczące interfejsu API pokazują, jak tworzyć zasoby przy użyciu interfejsu API płaszczyzny danych usługi Azure Cosmos DB. Za pomocą interfejsu API płaszczyzny danych można skonfigurować podstawowe opcje, takie jak zasady indeksowania, klucze partycji, podobnie jak w przypadku zestawów SDK usługi Cosmos DB. Jeśli potrzebujesz pełnej obsługi funkcji dla wszystkich zasobów usługi Azure Cosmos DB, zalecamy użycie dostawcy zasobów usługi Cosmos DB.
Żądanie
| Metoda | Identyfikator URI żądania | Opis |
|---|---|---|
| GET | https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls | {databaseaccount} to nazwa konta usługi Azure Cosmos DB utworzonego w ramach subskrypcji. Wartość {db-id} to wygenerowana przez użytkownika nazwa/identyfikator bazy danych, a nie identyfikator wygenerowany przez system (rid). |
Nagłówki
Zobacz Typowe nagłówki żądań REST usługi Azure Cosmos DB dla nagłówków , które są używane przez wszystkie żądania usługi Cosmos DB.
Treść
Brak.
Reakcja
Funkcja List Collections zwraca tablicę kolekcji w określonej bazie danych.
Nagłówki
Zobacz Typowe nagłówki odpowiedzi REST usługi Azure Cosmos DB dla nagłówków zwracanych przez wszystkie odpowiedzi usługi Cosmos DB.
Kody stanu
Poniższa tabela zawiera listę typowych kodów stanu zwracanych przez tę operację. Aby uzyskać pełną listę kodów stanu, zobacz Kody stanu HTTP.
| Kod stanu HTTP | Opis |
|---|---|
| 200 OK | Operacja zakończyła się pomyślnie. |
Treść
| Właściwość | Opis |
|---|---|
| _Rid | Ta właściwość jest identyfikatorem zasobu bazy danych, w której znajdują się kolekcje. |
| _Liczba | Ta właściwość pokazuje liczbę połączeń zwracanych w ramach operacji listy. |
| DocumentCollections | Ta właściwość to tablica zawierająca kolekcje zwrócone w ramach operacji listy. Aby uzyskać szczegółowe informacje o właściwościach zawartych w kolekcji, zobacz Kolekcje. |
{
"_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
}
Przykład
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
}