Obter uma Oferta

  • Artigo

Para obter um recurso de oferta, execute um GET no recurso Oferta .

Pedir

Método URI do pedido Descrição
GET https://{databaseaccount}.documents.azure.com/offers/{_rid-offer} Tenha em atenção que {databaseaccount} é o nome da conta do Azure Cosmos DB que criou na sua subscrição. O valor {_rid-offer} é o ID de recurso gerado pelo sistema da oferta.

Cabeçalhos

Veja Common Azure Cosmos DB REST request headers for headers that are used by all Cosmos DB requests (Cabeçalhos de pedido REST do Azure Cosmos DB comuns para cabeçalhos que são utilizados por todos os pedidos do Cosmos DB).

Ao construir a assinatura hash para o token de chave mestra, o ResourceType deve ser "ofertas". O ResourceLink deve ser apenas o _rid da oferta que pretende obter. O valor tem de estar em minúsculas. Por exemplo, ao executar um GET no https://querydemo.documents.azure.com/offers/uT2L, o ResourceLink no token de chave mestra deve ser "ut2l".

Corpo

Nenhum.

Resposta

Devolve o recurso de oferta pedido.

Cabeçalhos

Veja Common Azure Cosmos DB REST response headers for headers that are returned by all Cosmos DB responses (Cabeçalhos de resposta REST do Azure Cosmos DB comuns para cabeçalhos devolvidos por todas as respostas do Cosmos DB).

Códigos de estado

A tabela seguinte lista os códigos de estado comuns devolvidos por esta operação. Para obter uma lista completa dos códigos de estado, consulte Códigos de Estado HTTP.

Código de estado de HTTP Descrição
200 Ok A operação foi bem-sucedida.
404 Não Encontrado A oferta já não é um recurso, ou seja, o recurso da coleção principal foi eliminado.

Corpo

Propriedade Descrição
offerVersion Este valor pode ser V1 para níveis de débito predefinidos e V2 para níveis de débito definidos pelo utilizador.
offerType Este valor indica o nível de desempenho da versão da oferta V1, os valores permitidos para a oferta V1 são S1, S2 ou S3. Esta propriedade está definida como Inválida para a versão da oferta V2.
conteúdo Contém informações sobre a oferta. Para ofertas V2, contém o débito da coleção.
recurso Ao criar uma nova coleção, esta propriedade é definida como a auto-ligação da coleção, por exemplo, dbs/pLJdAA==/colls/pLJdAOlEdgA=/.
offerResourceId Durante a criação de uma coleção, esta propriedade é automaticamente associada ao ID do recurso, ou seja, _rid da coleção. No exemplo acima, o _rid da coleção é pLJdAOlEdgA=.
id É uma propriedade gerada pelo sistema. O ID do recurso de oferta é gerado automaticamente quando é criado. Tem o mesmo valor que o _rid para a oferta.
_rid É uma propriedade gerada pelo sistema. O ID do recurso (_rid) é um identificador exclusivo que também é hierárquico de acordo com a pilha de recursos no modelo de recursos. É utilizado internamente para colocação e navegação da oferta.
_ts É uma propriedade gerada pelo sistema. Especifica o último carimbo de data/hora atualizado do recurso. O valor é um carimbo de data/hora.
_self É uma propriedade gerada pelo sistema. É o URI endereçável exclusivo para o recurso.
_etag É uma propriedade gerada pelo sistema que especifica o etag de recursos necessário para o controlo de simultaneidade otimista. 
{  
  "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  
}

Exemplo

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  
}

Observações

Para saber mais sobre o débito máximo e mínimo aprovisionado que pode ser definido num contentor ou numa base de dados, veja o artigo Aprovisionar débito em contentores e bases de dados .

Execute GET no recurso de oferta para obter o débito mínimo que pode ser definido para um determinado contentor ou base de dados. O cabeçalho x-ms-cosmos-min-throughput de resposta indica o débito mínimo determinado pelo sistema.

Consulte também