Encabezados de solicitud comunes de REST en Azure Cosmos DB
Los siguientes encabezados de solicitud son comunes a todas las tareas que puede realizar con la API de SQL:
| Encabezado | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| Autorización | Obligatorio | String | Token de autorización para la solicitud. Para más información sobre cómo generar un token de autorización válido, consulte Access Control en recursos de Cosmos DB. |
| Content-Type | Obligatorio (en PUT, PATCH y POST) | String | Para POST en las operaciones de consulta, debe ser application/query+json. Para las operaciones PATCH, debe ser application/json_patch+json. Para los datos adjuntos, debe establecerse en el tipo Mime de los datos adjuntos. Para obtener más información sobre los tipos mime, vea Crear datos adjuntos. Para todas las demás tareas, debe ser application/json. |
| If-Match | Opcional (aplicable solo en PUT y DELETE) | String | Se usa para hacer que la operación sea condicional para la simultaneidad optimista. El valor debe ser el valor etag del recurso. |
| If-None-Match | Opcional (aplicable solo en GET) | String | Hace que la operación solo se ejecute si el recurso ha cambiado. El valor debe ser la etag del recurso. |
| If-Modified-Since | Opcional (aplicable solo en GET) | Fecha | Devuelve etag del recurso modificado después de la fecha especificada en formato RFC 1123. Se omite cuando se especifica If-None-Match |
| User-Agent | Opcionales | String | Una cadena que especifica el agente de usuario de cliente que realiza la solicitud. El formato recomendado es {nombre del agente de usuario}/{versión}. Por ejemplo, el SDK oficial de .NET de la API de SQL establece la cadena de User-Agent en Microsoft.Document.Client/1.0.0.0. Un agente de usuario personalizado podría ser algo como ContosoMarketingApp/1.0.0. |
| x-ms-activity-id | Opcionales | String | Identificador proporcionado por el cliente para la operación, que se repite en la respuesta del servidor. El valor recomendado es un identificador único. |
| x-ms-consistency-level | Opcionales | String | Invalidación del nivel de coherencia para las opciones de lectura en documentos y datos adjuntos. 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-continuation | Opcionales | String | Un token de cadena devuelto para las consultas y las operaciones de fuente de lectura si hay más resultados que se van a leer. Los clientes pueden recuperar la siguiente página de resultados reenviando la solicitud con el encabezado de solicitud x-ms-continuation establecido en este valor. |
| x-ms-date | Obligatorio | Date | La fecha de la solicitud por formato de fecha RFC 1123 expresada en hora universal coordinada, por ejemplo, Fri, 08 abr 2015 03:52:31 GMT. |
| x-ms-max-item-count | Opcionales | Number | Entero que indica el número máximo de elementos que se van a devolver por página. Se puede especificar un recuento de elementos x-ms-max-item-count de -1 para permitir que el servicio determine el recuento óptimo de elementos. Este es el valor de configuración recomendado para x-ms-max-item-count |
| x-ms-documentdb-partitionkey | Opcionales | Array | Valor de clave de partición para la operación de documento o datos adjuntos solicitados. Se requiere para las operaciones en documentos y datos adjuntos cuando la definición de la colección incluye una definición de clave de partición. Este valor se usa para limitar el ámbito de la consulta a los documentos que coinciden con los criterios de clave de partición. Por diseño, es una consulta de partición única. Compatible con las versiones de API 2015-12-16 y versiones posteriores. Actualmente, la API de SQL admite una sola clave de partición, por lo que se trata de una matriz que contiene solo un valor. |
| x-ms-documentdb-query-enablecrosspartition | Opcionales | Boolean | Cuando este encabezado se establece en true y si la consulta no tiene una clave de partición, Azure Cosmos DB distribuye la consulta entre particiones. La diseminación se realiza mediante la emisión de consultas individuales para todas las particiones. Para leer los resultados de consulta, las aplicaciones cliente deben consumir los resultados de FeedResponse y comprobar la propiedad ContinuationToken. Para leer todos los resultados, mantenga la iteración en los datos hasta que ContinuationToken sea null. |
| x-ms-session-token | Obligatorio (solo para la coherencia de la sesión) | String | Token de cadena usado con coherencia de nivel de sesión. Para obtener más información, vea Uso de niveles de coherencia en Cosmos DB |
| x-ms-version | Obligatorio | String | La versión del servicio REST de Cosmos DB. Para obtener una lista de las versiones de API compatibles, consulte Referencia de la API REST de Azure Cosmos DB. |
| A-IM | Opcionales | String | Indica una solicitud de fuente de cambios . Debe establecerse en "Fuente incremental" o en caso contrario. |
| x-ms-documentdb-partitionkeyrangeid | Opcionales | Number | Se usa en las solicitudes de fuente de cambios . Id. de intervalo de claves de partición para la lectura de datos. |
| x-ms-cosmos-allow-tentative-writes | Opcionales | Boolean | Cuando este encabezado se establece en true para las cuentas de Azure Cosmos configuradas con varias ubicaciones de escritura, Azure Cosmos DB permitirá escrituras en todas las ubicaciones. Las solicitudes de escritura con el valor de este encabezado establecido en false (o si el encabezado está ausente) producirán un error con el código de estado de respuesta 403 con el mensaje de error "No se permiten escrituras en la región". |
Consulte también