Hämta ett dokument

  • Artikel

Azure Cosmos DB är en globalt distribuerad databas för flera datamodeller som har stöd för flera API:er. Den här artikeln beskriver SQL-API:et för Azure Cosmos DB.

Åtgärden Get Document hämtar ett dokument med dess partitionsnyckel och dokumentnyckel.

Förfrågan

Metod URI för förfrågan Beskrivning
GET https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/docs/{doc-id} Observera att {databaseaccount} är namnet på det Azure Cosmos DB-konto som skapades under din prenumeration. Värdet {db-id} är det användargenererade namnet/ID:t för databasen, inte det systemgenererade ID:t (rid). Värdet {coll-id} är namnet på samlingen. Värdet {doc-id} är ID:t för dokumentet som ska hämtas.

Sidhuvuden

Se Vanliga REST-begärandehuvuden för Azure Cosmos DB för rubriker som används av alla Cosmos DB-begäranden. De viktiga svarshuvudena för Läs dokument är följande:

Huvud Krävs Typ Description
If-None-Match Valfritt Sträng Värdet ska vara resursens etag. Gör åtgärden villkorsstyrd, d.v.s. att svaret innehåller en brödtext som endast värdet i databasen skiljer sig från det angivna värdet i rubriken.
x-ms-documentdb-partitionkey Valfritt Matris Partitionsnyckelvärdet för dokumentet som ska läsas. Måste inkluderas om och endast om samlingen har skapats med en partitionKey-definition .
x-ms-consistency-level Valfritt Sträng Det är åsidosättningen av konsekvensnivå. Giltiga värden är: Stark, Begränsad, Session eller Slutlig (i den ordning som är starkast till svagast). Åsidosättningen måste vara samma eller svagare än kontots konfigurerade konsekvensnivå.
x-ms-session-token Valfritt Sträng En strängtoken som används med konsekvens på sessionsnivå. Klienter måste upprepa det senaste läsvärdet för den här rubriken under läsbegäranden om sessionskonsekvens.

Brödtext

Inga.

Svarsåtgärder

Returnerar innehållet i det begärda dokumentet.

Sidhuvuden

Se Vanliga REST-svarshuvuden för Azure Cosmos DB för rubriker som returneras av alla Azure Cosmos DB-svar. De viktiga svarshuvudena för Hämta dokument är följande:

Huvud Typ Description
x-ms-request-charge Tal Antalet enheter för programbegäran som förbrukas av åtgärden.

Statuskoder

I följande tabell visas vanliga statuskoder som returneras av den här åtgärden. En fullständig lista över statuskoder finns i HTTP-statuskoder..

HTTP-statuskod Beskrivning
200 Ok Åtgärden lyckades.
304 Har inte ändrats Det begärda dokumentet ändrades inte eftersom det angivna eTag-värdet i If-Match-huvudet. Tjänsten returnerar en tom svarstext.
400 Felaktig begäran Åsidosättningsuppsättningen i rubriken på x-ms-consistency-level är starkare än den som angavs när kontot skapades. Om konsekvensnivån till exempel är Session kan åsidosättningen inte vara stark eller begränsad.
404 – Hittades inte Dokumentet är inte längre en resurs, d.v.s. dokumentet har tagits bort.

Brödtext

Egenskap Beskrivning
id Det är det unika namn som används för att identifiera ett dokument, det vill sa att inga två dokument kan dela samma ID. ID:t får inte överstiga 255 tecken.
anpassad Valfri användardefinierad JSON.
_Bli Det är en systemgenererad egenskap. Resurs-ID :t (_rid) är en unik identifierare som också är hierarkisk per resursstacken i resursmodellen. Den används internt för placering och navigering i dokumentresursen.
_Ts Det är en systemgenererad egenskap. Den anger den senast uppdaterade tidsstämpeln för resursen. Värdet är i Unix-tid.
_Själv Det är en systemgenererad egenskap. Det är den unika adresserbara URI:n för resursen.
_Etag Det är en systemgenererad egenskap som anger resursetaggen som krävs för optimistisk samtidighetskontroll.
Bilagor Det är en systemgenererad egenskap som anger den adresserbara sökvägen för resursen för bifogade filer. 
{  
  "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/"  
}

Exempel

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/"  
}

Se även