Obtention d'une offre

Pour récupérer une ressource d’offre, effectuez une récupération sur la ressource d' 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éé dans le cadre de 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 les en-têtes de demande REST Azure Cosmos DB courants pour les en-têtes utilisés par toutes les demandes Cosmos DB.

Lors de la construction de la signature hachée pour le jeton de clé principale, le resourceType doit être « offers ». Le ResourceLink doit être uniquement le _RID de l’offre que vous souhaitez récupérer. La valeur doit être en minuscules. Par exemple, lors de l’exécution d’une opération obtenir sur https://querydemo.documents.azure.com/offers/uT2L , le ResourceLink dans le jeton de clé principale doit être « ut2l ».

body

Aucun.

response

Retourne la ressource d’offre demandée.

En-têtes

Consultez les 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 d’État, 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, autrement dit, 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 performance pour 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 d’offre v2.
content Elle contient des informations sur l’offre. Pour les offres v2, elle contient le débit de la collection.
resource Lors de la création d’une nouvelle collection, cette propriété est définie sur le lien automatique 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, autrement dit, _RID de la collection. Dans l’exemple ci-dessus, le _RID pour 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. Elle a la même valeur que le _RID pour l’offre.
_rid 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 ressource 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 approvisionné maximal et minimal qui peut être défini sur un conteneur ou une base de données, consultez l’article approvisionner le débit sur les conteneurs et les bases de données .

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

Voir aussi