Compartir a través de

Encabezados comunes de solicitud REST de Azure Cosmos DB

  • Artículo

Los siguientes encabezados de solicitud son comunes a todas las tareas que puede realizar con la API de SQL:

Encabezado Obligatorio Tipo Descripción
de autorización Obligatorio Cuerda Token de autorización para la solicitud. Para obtener más información sobre cómo generar un token de autorización válido, consulte Control de acceso en recursos de Cosmos DB
de tipo de contenido de Obligatorio (en PUT, PATCH y POST) Cuerda Para POST en las operaciones de consulta, debe ser aplicación/consulta+json.

Para las operaciones PATCH, debe ser aplicación/json_patch+json.

Para datos adjuntos, debe establecerse en el tipo Mime de los datos adjuntos. Para obtener más información sobre los tipos mime, consulte Crear datos adjuntos

Para todas las demás tareas, debe ser application/json.
If-Match Opcional (aplicable solo en PUT y DELETE) Cuerda 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) Cuerda 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
de agente de usuario de Opcional Cuerda Cadena que especifica el agente de usuario 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 Opcional Cuerda Identificador proporcionado por el cliente para la operación, que se repite en la respuesta del servidor. El valor recomendado es un identificador único.
de nivel x-ms-consistency Opcional Cuerda Invalidación de 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 más fuerte a débil). La invalidación debe ser la misma o más débil que el nivel de coherencia configurado de la cuenta.
x-ms-continuation Opcional Cuerda 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 mediante la reenvío de la solicitud con el encabezado de solicitud x-ms-continuation establecido en este valor.
x-ms-date Obligatorio Fecha 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 Opcional Número 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 Opcional Arreglo Valor de clave de partición para la operación de documento o datos adjuntos solicitados. Necesario 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 definir el ámbito de la consulta a los documentos que coinciden con los criterios de clave de partición. Por diseño, se trata de una sola consulta de partición. 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 Opcional Booleano Cuando este encabezado se establece en true y si la consulta no tiene una clave de partición, Azure Cosmos DB agrupa la consulta entre particiones. La distribución ramificada se realiza mediante la emisión de consultas individuales a todas las particiones. Para leer los resultados de la consulta, las aplicaciones cliente deben consumir los resultados de FeedResponse y comprobar la propiedad ContinuationToken. Para leer todos los resultados, siga iterando en los datos hasta que ContinuationToken sea NULL.
x-ms-session-token Obligatorio (solo para la coherencia de la sesión) Cuerda Token de cadena usado con coherencia de nivel de sesión. Para obtener más información, consulte
Uso de niveles de coherencia en cosmos DB
x-ms-version Obligatorio Cuerda Versión del servicio REST de Cosmos DB.
Para obtener una lista de las versiones de API admitidas, consulte referencia de la API REST de Azure Cosmos DB
A-IM Opcional Cuerda Indica una solicitud de fuente de cambios. Debe establecerse en "Fuente incremental" o omitirse de lo contrario.
x-ms-documentdb-partitionkeyrangeid Opcional Número Se usa en solicitudes de fuente de cambios. Identificador del intervalo de claves de partición para leer datos.
x-ms-cosmos-allow-tentative-writes Opcional Booleano 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