Obtention d'une offre

Pour récupérer une ressource d’offre, effectuez une opération GET sur la ressource Offre .

Requête

Méthode URI de demande Description
GET https://{databaseaccount}.documents.azure.com/offers/{_rid-offer} Notez que {databaseaccount} est le nom du compte Azure Cosmos DB que vous avez créé sous votre abonnement. La valeur {_rid-offer} est l’ID de ressource généré par le système de l’offre.

En-têtes

Consultez En-têtes de requête REST Azure Cosmos DB courants pour les en-têtes utilisés par toutes les requêtes Cosmos DB.

Lors de la construction de la signature hachée pour le jeton de clé master, le ResourceType doit être « offers ». ResourceLink ne doit être que le _rid de l’offre que vous souhaitez récupérer. La valeur doit être minuscule. Par exemple, lors de l’exécution d’un GET sur https://querydemo.documents.azure.com/offers/uT2L, le ResourceLink dans le jeton de clé master doit être « ut2l ».

Corps

Aucun.

response

Retourne la ressource d’offre demandée.

En-têtes

Consultez En-têtes de réponse REST Azure Cosmos DB courants pour les en-têtes retournés par toutes les réponses Cosmos DB.

Codes d’état

Le tableau suivant répertorie les codes d'état courants renvoyés par cette opération. Pour obtenir la liste complète des codes status, consultez Codes d’état HTTP.

Code d'état HTTP Description
200 Ok L'opération a réussi.
404 Introuvable L’offre n’est plus une ressource, c’est-à-dire que la ressource de collection parente a été supprimée.

body

Propriété Description
offerVersion Cette valeur peut être V1 pour les niveaux de débit prédéfinis et V2 pour les niveaux de débit définis par l’utilisateur.
offerType Cette valeur indique le niveau de performances de la version de l’offre V1. Les valeurs autorisées pour l’offre V1 sont S1, S2 ou S3. Cette propriété est définie sur Non valide pour la version de l’offre V2.
content Il contient des informations sur l’offre. Pour les offres V2, il contient le débit de la collection.
resource Lors de la création d’une collection, cette propriété est définie sur l’auto-liaison de la collection, par exemple, dbs/pLJdAA==/colls/pLJdAOlEdgA=/.
offerResourceId Lors de la création d’une collection, cette propriété est automatiquement associée à l’ID de ressource, c’est-à-dire _rid de la collection. Dans l’exemple ci-dessus, le _rid de la collection est pLJdAOlEdgA=.
id Il s’agit d’une propriété générée par le système. L’ID de la ressource d’offre est généré automatiquement lors de sa création. Il a la même valeur que le _rid de l’offre.
_Débarrasser Il s’agit d’une propriété générée par le système. L’ID de ressource (_rid) est un identificateur unique qui est également hiérarchique en fonction de la pile de ressources sur le modèle de ressource. Il est utilisé en interne pour le positionnement et la navigation dans l'offre.
_Ts Il s’agit d’une propriété générée par le système. Elle spécifie l'horodateur de la dernière mise à jour de la ressource. La valeur est un horodateur.
_self Il s’agit d’une propriété générée par le système. Il s'agit de l'URI adressable unique pour la ressource.
_Etag Il s’agit d’une propriété générée par le système qui spécifie l’etag de ressources requis pour le contrôle d’accès concurrentiel optimiste.
{  
  "offerVersion": "V2",  
  "offerType": "Invalid",  
  "content": {  
    "offerThroughput": 4000  
  },  
  "resource": "dbs/rgkVAA==/colls/rgkVAMHcJww=/",  
  "offerResourceId": "rgkVAMHcJww=",  
  "id": "uT2L",  
  "_rid": "uT2L",  
  "_self": "offers/uT2L/",  
  "_etag": "\"0000a600-0000-0000-0000-56fac0570000\"",  
  "_ts": 1459273815  
}  
  

Exemple

GET https://querydemo.documents.azure.com/offers/uT2L HTTP/1.1  
x-ms-date: Tue, 29 Mar 2016 17:50:18 GMT  
authorization: type%3dmaster%26ver%3d1.0%26sig%3dA9Y9JAZylsBHG%2bM1Rdb3PpzO3Fw7kMJbRUJ8Llh2kpo%3d  
Cache-Control: no-cache  
User-Agent: Microsoft.Azure.Documents.Client/1.6.0.0 samples-net/3  
x-ms-version: 2015-12-16  
Accept: application/json  
Host: querydemo.documents.azure.com  
  
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/offers/uT2L  
Server: Microsoft-HTTPAPI/2.0  
Strict-Transport-Security: max-age=31536000  
x-ms-last-state-change-utc: Fri, 25 Mar 2016 21:27:20.035 GMT  
etag: "0000a600-0000-0000-0000-56fac0570000"  
x-ms-schemaversion: 1.1  
x-ms-request-charge: 2  
x-ms-serviceversion: version=1.6.52.5  
x-ms-activity-id: bfa5991d-46f5-4c40-b3f0-957fccd8df9e  
x-ms-session-token: M:8110  
x-ms-gatewayversion: version=1.6.52.5  
x-ms-cosmos-min-throughput: 400 
Date: Tue, 29 Mar 2016 17:50:18 GMT  
  
{  
  "offerVersion": "V2",  
  "offerType": "Invalid",  
  "content": {  
    "offerThroughput": 4000  
  },  
  "resource": "dbs/rgkVAA==/colls/rgkVAMHcJww=/",  
  "offerResourceId": "rgkVAMHcJww=",  
  "id": "uT2L",  
  "_rid": "uT2L",  
  "_self": "offers/uT2L/",  
  "_etag": "\"0000a600-0000-0000-0000-56fac0570000\"",  
  "_ts": 1459273815  
}  
  

Notes

Pour en savoir plus sur le débit provisionné maximal et minimal qui peut être défini sur un conteneur ou une base de données, consultez l’article Provisionner le débit sur les conteneurs et les bases de données .

Exécutez GET sur la ressource de l’offre pour récupérer le débit minimal qui peut être défini pour un conteneur ou une base de données donné. L’en-tête x-ms-cosmos-min-throughput de réponse indique le débit minimal déterminé par le système.

Voir aussi