Listagyűjtemények
Ha get műveletet hajt végre egy adott adatbázis gyűjtemény-erőforrásán, azaz a colls URI elérési útján, visszaadja az adatbázisban lévő gyűjtemények listáját.
Megjegyzés
Ezek az API-referenciacikkek bemutatják, hogyan hozhat létre erőforrásokat az Azure Cosmos DB adatsík API használatával. Az adatsík API-val olyan alapvető beállításokat konfigurálhat, mint az indexelési szabályzat, a partíciókulcsok pedig ugyanúgy, mint a Cosmos DB SDK-k esetében. Ha teljes körű szolgáltatástámogatásra van szüksége az összes Azure Cosmos DB-erőforráshoz, javasoljuk, hogy használja a Cosmos DB erőforrás-szolgáltatót.
Kérés
Metódus | Kérés URI-ja | Leírás |
---|---|---|
GET | https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls | A(z) {databaseaccount} az előfizetése alatt létrehozott Azure Cosmos DB-fiók neve. A(z) {db-id} érték az adatbázis felhasználó által létrehozott neve/azonosítója, nem pedig a rendszer által létrehozott azonosító (rid). |
Fejlécek
Az összes Cosmos DB-kérés által használt fejlécekhez tekintse meg az Azure Cosmos DB REST-kérések gyakori fejléceit .
Törzs
Nincsenek.
Reagálás
A listagyűjtemények a megadott adatbázisban lévő gyűjtemények tömböt adnak vissza.
Fejlécek
Az összes Cosmos DB-válasz által visszaadott fejléceket az Azure Cosmos DB REST-válaszfejlécei között tekintheti meg.
Állapotkódok
Az alábbi táblázat a művelet által visszaadott gyakori állapotkódokat sorolja fel. Az állapotkódok teljes listáját lásd: HTTP-állapotkódok.
HTTP-állapotkód | Leírás |
---|---|
200 OK | A művelet sikeres volt. |
Törzs
Tulajdonság | Leírás |
---|---|
_Megszabadulni | Ez a tulajdonság annak az adatbázisnak az erőforrás-azonosítója, amelyben a gyűjtemények találhatók. |
_Számít | Ez a tulajdonság a listaművelet részeként visszaadott kapcsolatok számát jeleníti meg. |
DocumentCollections | Ez a tulajdonság a listaművelet részeként visszaadott gyűjteményeket tartalmazó tömb. A gyűjteményben található tulajdonságokról további információt a Gyűjtemények című témakörben talál. |
{
"_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élda
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
}