Obtener un documento
Azure Cosmos DB es una base de datos multimodelo distribuida globalmente que admite varias API. En este artículo se describe SQL API de Azure Cosmos DB.
La Get Document operación recupera un documento por su clave de partición y clave de documento.
Solicitud
| Método | URI de solicitud | Descripción |
|---|---|---|
| GET | https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/docs/{doc-id} | Tenga en cuenta que {databaseaccount} es el nombre de la cuenta de Azure Cosmos DB creada en la suscripción. El valor {db-id} es el nombre o identificador generado por el usuario de la base de datos, no el identificador generado por el sistema (rid). El valor {coll-id} es el nombre de la colección. El valor {doc-id} es el identificador del documento que se va a recuperar. |
encabezados
Consulte Encabezados de solicitud REST comunes de Azure Cosmos DB para los encabezados que usan todas las solicitudes de Cosmos DB. Los encabezados de respuesta importantes para Read Document son los siguientes:
| Encabezado | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| If-None-Match | Opcionales | String | El valor debe ser la etag del recurso. Hace que la operación sea condicional, es decir, la respuesta incluye un cuerpo solo el valor de la base de datos es diferente del valor especificado en el encabezado. |
| x-ms-documentdb-partitionkey | Opcionales | Array | Valor de clave de partición del documento que se va a leer. Debe incluirse si y solo si la colección se crea con una definición partitionKey . |
| x-ms-consistency-level | Opcionales | String | Es la invalidación del nivel de coherencia. Los valores válidos son: Strong, Bounded, Session o Eventual (en orden de mayor a menor). La invalidación debe ser la misma o más débil que el nivel de coherencia configurado de la cuenta. |
| x-ms-session-token | Opcionales | String | Token de cadena usado con coherencia de nivel de sesión. Los clientes deben hacer eco del último valor de lectura de este encabezado durante las solicitudes de lectura para la coherencia de la sesión. |
Cuerpo
Ninguno.
Response
Devuelve el contenido del documento solicitado.
encabezados
Consulte Encabezados de respuesta REST comunes de Azure Cosmos DB para ver los encabezados devueltos por todas las respuestas de Azure Cosmos DB. Los encabezados de respuesta importantes para Obtener documento son los siguientes:
| Encabezado | Tipo | Descripción |
|---|---|---|
| x-ms-request-charge | Number | Número de unidades de solicitud consumidas por la operación. |
Códigos de estado
La tabla siguiente muestra los códigos de estado comunes que devuelve esta operación. Para obtener una lista completa de los códigos de estado, consulte Códigos de estado HTTP.
| Código de estado HTTP | Descripción |
|---|---|
| 200 Ok | La operación se realizó correctamente. |
| 304 No modificado | El documento solicitado no se modificó desde el valor eTag especificado en el encabezado If-Match. El servicio devuelve un cuerpo de respuesta vacío. |
| 400 - Solicitud incorrecta | El conjunto de invalidación en el encabezado x-ms-consistency-level es más seguro que el establecido durante la creación de la cuenta. Por ejemplo, si el nivel de coherencia es Session, la invalidación no puede ser Segura o Limitada. |
| 404 No encontrado | El documento ya no es un recurso, es decir, el documento se eliminó. |
Body
| Propiedad | Descripción |
|---|---|
| id | Es el nombre único que se usa para identificar un documento, es decir, ningún dos documentos pueden compartir el mismo identificador. El identificador no debe superar los 255 caracteres. |
| custom | Cualquier JSON definida por el usuario. |
| _Librar | Es una propiedad generada por el sistema. El identificador de recurso (_rid) es un identificador único que también es jerárquico por la pila de recursos en el modelo de recursos. Se usa de forma interna para la ubicación y la navegación del recurso de documento. |
| _Ts | Es una propiedad generada por el sistema. Especifica la última marca de tiempo actualizada del recurso. El valor está en tiempo de Unix. |
| _propio | Es una propiedad generada por el sistema. Es el URI direccionable único para el recurso. |
| _Etag | Es una propiedad generada por el sistema que especifica la etag de recursos necesaria para el control de simultaneidad optimista. |
| attachments | Es una propiedad generada por el sistema que especifica la ruta de acceso direccionable para el recurso de datos adjuntos. |
{
"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/"
}
Ejemplo
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/"
}