Abrufen eines Dokuments
Azure Cosmos DB ist eine global verteilte Mehrmodelldatenbank mit Unterstützung für mehrere APIs. Dieser Artikel enthält Informationen zur SQL-API für Azure Cosmos DB.
Der Get Document Vorgang ruft ein Dokument anhand seines Partitionsschlüssels und Dokumentschlüssels ab.
Anforderung
| Methode | Anforderungs-URI | BESCHREIBUNG |
|---|---|---|
| GET | https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/docs/{doc-id} | Beachten Sie, dass {databaseaccount} der Name des Azure Cosmos DB-Kontos ist, das unter Ihrem Abonnement erstellt wurde. Der Wert {db-id} ist der vom Benutzer generierte Name/die ID der Datenbank, nicht die vom System generierte ID (rid). Der Wert {coll-id} ist der Name der Auflistung. Der Wert {doc-id} ist die ID des abzurufenden Dokuments. |
Header
Informationen zu Headern, die von allen Cosmos DB-Anforderungen verwendet werden, finden Sie unter Allgemeine Azure Cosmos DB-REST-Anforderungsheader . Die wichtigsten Antwortheader für "Dokument lesen" lauten wie folgt:
| Header | Erforderlich | type | BESCHREIBUNG |
|---|---|---|---|
| If-None-Match | Optional | String | Der Wert sollte das Etag der Ressource sein. Macht den Vorgang bedingt, d. h. die Antwort enthält einen Text, nur der Wert in der Datenbank unterscheidet sich vom angegebenen Wert im Header. |
| x-ms-documentdb-partitionkey | Optional | Array | Der Partitionsschlüsselwert für das zu lesende Dokument. Muss nur eingefügt werden, wenn die Auflistung mit einer partitionKey-Definition erstellt wird. |
| x-ms-consistency-level | Optional | String | Dabei handelt es sich um die Außerkraftsetzung der Konsistenzebene. Die gültigen Werte sind: Strong, Bounded, Session oder Eventual (in der Reihenfolge der stärksten bis schwächsten). Die Außerkraftsetzung muss identisch oder schwächer als die konfigurierte Konsistenzebene des Kontos sein. |
| x-ms-session-token | Optional | String | Ein Zeichenfolgentoken, das mit Konsistenz auf Sitzungsebene verwendet wird. Clients müssen den letzten Lesewert dieses Headers bei Leseanforderungen für Sitzungskonsistenz wiederholen. |
Text
Keine.
Antwort
Gibt den Inhalt des angeforderten Dokuments zurück.
Header
Informationen zu Headern, die von allen Azure Cosmos DB-Antworten zurückgegeben werden, finden Sie unter Allgemeine Azure Cosmos DB-REST-Antwortheader . Die wichtigen Antwortheader für "Dokument abrufen" sind wie folgt:
| Header | type | BESCHREIBUNG |
|---|---|---|
| x-ms-request-charge | Number | Die Anzahl der vom Vorgang verbrauchten Anforderungseinheiten. |
Statuscodes
In der folgenden Tabelle sind die allgemeinen Statuscodes aufgeführt, die von diesem Vorgang zurückgegeben werden. Eine vollständige Liste der status Codes finden Sie unter HTTP-Statuscodes.
| HTTP-Statuscode | BESCHREIBUNG |
|---|---|
| 200 Ok | Der Vorgang wurde durchgeführt. |
| 304 Nicht geändert | Das angeforderte Dokument wurde seit dem angegebenen eTag-Wert im If-Match-Header nicht geändert. Der Dienst gibt einen leeren Antwortkörper zurück. |
| 400 – Ungültige Anforderung | Der Überschreibungssatz im x-ms-consistency-level-Header ist stärker als der , der während der Kontoerstellung festgelegt wurde. Wenn die Konsistenzebene beispielsweise Sitzung ist, kann die Außerkraftsetzung nicht stark oder begrenzt sein. |
| 404 – Nicht gefunden | Das Dokument ist keine Ressource mehr, d. h., das Dokument wurde gelöscht. |
Body
| Eigenschaft | BESCHREIBUNG |
|---|---|
| id | Es ist der eindeutige Name, der zum Identifizieren eines Dokuments verwendet wird, d. h., keine zwei Dokumente können dieselbe ID verwenden. Die ID darf 255 Zeichen nicht überschreiten. |
| custom | Beliebiger benutzerdefinierter JSON-Code. |
| _los | Es handelt sich um eine vom System generierte Eigenschaft. Die Ressourcen-ID (_rid) ist ein eindeutiger Bezeichner, der auch für den Ressourcenstapel im Ressourcenmodell hierarchisch ist. Sie wird intern für die Platzierung und Navigation der Dokumentressource verwendet. |
| _Ts | Es handelt sich um eine vom System generierte Eigenschaft. Sie gibt den zuletzt aktualisierten Zeitstempel der Ressource an. Der Wert ist in Unix-Zeit. |
| _Selbst | Es handelt sich um eine vom System generierte Eigenschaft. Es handelt sich um den eindeutigen, adressierbaren URI für die Ressource. |
| _Etag | Es handelt sich um eine vom System generierte Eigenschaft, die das Ressourcen-etag angibt, das für die Steuerung der optimistischen Parallelität erforderlich ist. |
| attachments | Es handelt sich um eine vom System generierte Eigenschaft, die den adressierbaren Pfad für die Anlageressource angibt. |
{
"id": "SalesOrder1",
"ponumber": "PO18009186470",
"OrderDate": "2005-07-01T00:00:00",
"ShippedDate": "0001-01-01T00:00:00",
"AccountNumber": "Account1",
"SubTotal": 419.4589,
"TaxAmount": 12.5838,
"Freight": 472.3108,
"TotalDue": 985.018,
"Items": [
{
"OrderQty": 1,
"ProductId": 760,
"UnitPrice": 419.4589,
"LineTotal": 419.4589
}
],
"_rid": "d9RzAJRFKgwBAAAAAAAAAA==",
"_self": "dbs/d9RzAA==/colls/d9RzAJRFKgw=/docs/d9RzAJRFKgwBAAAAAAAAAA==/",
"_etag": "\"0000d986-0000-0000-0000-56f9e25b0000\"",
"_ts": 1459216987,
"_attachments": "attachments/"
}
Beispiel
GET https://querydemo.documents.azure.com/dbs/testdb/colls/testcoll/docs/SalesOrder1 HTTP/1.1
x-ms-documentdb-partitionkey: ["Account1"]
x-ms-date: Tue, 29 Mar 2016 02:03:06 GMT
authorization: type%3dmaster%26ver%3d1.0%26sig%3dyhmbeaUDy6NCOyWr0t7Cxx4aMT4Yx%2bJnRAs%2br8Theyw%3d
Cache-Control: no-cache
User-Agent: Microsoft.Azure.Documents.Client/1.6.0.0
x-ms-version: 2015-12-16
Accept: application/json
Host: querydemo.documents.azure.com
Cookie: x-ms-session-token#0=772; x-ms-session-token=772
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/testdb/colls/testcoll/docs/SalesOrder1
Server: Microsoft-HTTPAPI/2.0
Strict-Transport-Security: max-age=31536000
x-ms-last-state-change-utc: Mon, 28 Mar 2016 14:47:03.949 GMT
etag: "0000d986-0000-0000-0000-56f9e25b0000"
x-ms-resource-quota: documentSize=10240;documentsSize=10485760;collectionSize=10485760;
x-ms-resource-usage: documentSize=0;documentsSize=2;collectionSize=2;
x-ms-schemaversion: 1.1
x-ms-alt-content-path: dbs/testdb/colls/testcoll
x-ms-content-path: d9RzAJRFKgw=
x-ms-request-charge: 1
x-ms-serviceversion: version=1.6.52.5
x-ms-activity-id: c22bc349-2c02-4b80-81b9-a2d758c92902
x-ms-session-token: 0:772
Set-Cookie: x-ms-session-token#0=772; Domain=querydemo.documents.azure.com; Path=/dbs/testdb/colls/testcoll
Set-Cookie: x-ms-session-token=772; Domain=querydemo.documents.azure.com; Path=/dbs/testdb/colls/testcoll
x-ms-gatewayversion: version=1.6.52.5
Date: Tue, 29 Mar 2016 02:03:06 GMT
{
"id": "SalesOrder1",
"ponumber": "PO18009186470",
"OrderDate": "2005-07-01T00:00:00",
"ShippedDate": "0001-01-01T00:00:00",
"AccountNumber": "Account1",
"SubTotal": 419.4589,
"TaxAmount": 12.5838,
"Freight": 472.3108,
"TotalDue": 985.018,
"Items": [
{
"OrderQty": 1,
"ProductId": 760,
"UnitPrice": 419.4589,
"LineTotal": 419.4589
}
],
"_rid": "d9RzAJRFKgwBAAAAAAAAAA==",
"_self": "dbs/d9RzAA==/colls/d9RzAJRFKgw=/docs/d9RzAJRFKgwBAAAAAAAAAA==/",
"_etag": "\"0000d986-0000-0000-0000-56f9e25b0000\"",
"_ts": 1459216987,
"_attachments": "attachments/"
}