Liste des collections
L’exécution d’un GET sur la ressource de collections d’une base de données particulière, c’est-à-dire le chemin d’URI de colls, retourne une liste des collections dans la base de données.
Remarque
Ces articles de référence sur les API montrent comment créer des ressources à l’aide de l’API de plan de données Azure Cosmos DB. Avec l’API de plan de données, vous pouvez configurer des options de base telles que la stratégie d’indexation et les clés de partition, comme vous le pouvez avec les kits SDK Cosmos DB. Si vous avez besoin d’une prise en charge complète des fonctionnalités pour toutes les ressources Azure Cosmos DB, nous vous recommandons d’utiliser le fournisseur de ressources Cosmos DB.
Requête
| Méthode | URI de demande | Description |
|---|---|---|
| GET | https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls | {databaseaccount} est le nom du compte Azure Cosmos DB créé dans le cadre de votre abonnement. La valeur {db-id} correspond au nom/id généré par l’utilisateur de la base de données, et non à l’ID généré par le système (rid). |
En-têtes
Consultez En-têtes de requête REST Azure Cosmos DB communs pour les en-têtes utilisés par toutes les requêtes Cosmos DB.
Corps
Aucun.
response
Répertorier les collections retourne un tableau de collections dans la base de données spécifiée.
En-têtes
Consultez En-têtes de réponse REST Azure Cosmos DB communs pour les en-têtes retournés par toutes les réponses Cosmos DB.
Codes d’état
Le tableau suivant répertorie les codes d'état courants renvoyés par cette opération. Pour obtenir la liste complète des codes status, consultez Codes d’état HTTP.
| Code d'état HTTP | Description |
|---|---|
| 200 OK | L'opération a réussi. |
body
| Propriété | Description |
|---|---|
| _Débarrasser | Cette propriété est l’ID de ressource de la base de données où résident les collections. |
| _Compter | Cette propriété indique le nombre de connexions renvoyées dans le cadre de l'opération de liste. |
| DocumentCollections | Cette propriété est le tableau contenant les collections retournées dans le cadre de l’opération de liste. Pour plus d’informations sur les propriétés contenues dans une collection, consultez Collections. |
{
"_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
}
Exemple
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
}