Kolekce seznamů
Provedení příkazu GET u prostředku kolekcí konkrétní databáze, tj. cesty identifikátoru URI colls, vrátí seznam kolekcí v databázi.
Poznámka
Tyto referenční články k rozhraní API ukazují, jak vytvářet prostředky pomocí rozhraní API roviny dat služby Azure Cosmos DB. Pomocí rozhraní API roviny dat můžete nakonfigurovat základní možnosti, jako jsou zásady indexování, klíče oddílů podobně jako u sad SDK služby Cosmos DB. Pokud potřebujete úplnou podporu funkcí pro všechny prostředky Azure Cosmos DB, doporučujeme použít poskytovatele prostředků Cosmos DB.
Žádost
Metoda | Identifikátor URI žádosti | Popis |
---|---|---|
GET | https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls | {databaseaccount} je název účtu služby Azure Cosmos DB vytvořeného v rámci vašeho předplatného. Hodnota {db-id} je uživatelem vygenerované jméno nebo ID databáze, nikoli id vygenerované systémem (RID). |
Hlavičky
Viz Běžné hlavičky požadavků REST služby Azure Cosmos DB pro hlavičky, které používají všechny požadavky služby Cosmos DB.
Text
Žádné
Odpověď
Funkce List Collections vrátí pole kolekcí v rámci zadané databáze.
Hlavičky
Viz Běžné hlavičky odpovědi REST služby Azure Cosmos DB pro hlavičky, které jsou vráceny všemi odpověďmi služby Cosmos DB.
Stavové kódy
Následující tabulka uvádí běžné stavové kódy vrácené touto operací. Úplný seznam stavových kódů najdete v tématu Stavové kódy HTTP.
Stavový kód HTTP | Popis |
---|---|
200 OK | Operace byla úspěšná. |
Text
Vlastnost | Popis |
---|---|
_Zbavit | Tato vlastnost je ID prostředku databáze, ve které se nacházejí kolekce. |
_Počet | Tato vlastnost zobrazuje počet připojení vrácených jako součást operace seznamu. |
Kolekce dokumentů | Tato vlastnost je pole obsahující kolekce vrácené jako součást operace seznamu. Podrobnosti o vlastnostech obsažených v kolekci najdete v tématu Kolekce. |
{
"_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
}
Příklad
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
}