Obter uma oferta
Para recuperar um recurso de oferta, execute um GET no recurso Oferta .
Solicitação
| Método | URI da solicitação | Descrição |
|---|---|---|
| GET | https://{databaseaccount}.documents.azure.com/offers/{_rid-offer} |
Observe que {databaseaccount} é o nome da conta do Azure Cosmos DB que você criou em sua assinatura. O valor {_rid-offer} é a ID de recurso gerada pelo sistema da oferta. |
Cabeçalhos
Confira Cabeçalhos comuns de solicitação REST do Azure Cosmos DB para cabeçalhos usados por todas as solicitações do Cosmos DB.
Ao construir a assinatura hash para o token de chave master, o ResourceType deve ser "ofertas". O ResourceLink deve ser apenas o _rid da oferta que você deseja recuperar. O valor deve ser minúsculo. Por exemplo, ao executar um GET no https://querydemo.documents.azure.com/offers/uT2L, o ResourceLink no token de chave master deve ser "ut2l".
Corpo
Nenhum.
Resposta
Retorna o recurso de oferta solicitado.
Cabeçalhos
Consulte Cabeçalhos comuns de resposta REST do Azure Cosmos DB para obter cabeçalhos retornados por todas as respostas do Cosmos DB.
Códigos de status
A tabela a seguir lista os códigos de status comuns retornados por esta operação. Para obter uma lista completa de códigos de status, consulte Códigos de status HTTP.
| Código de status HTTP | Descrição |
|---|---|
| 200 Ok | A operação foi bem-sucedida. |
| 404 Não Encontrado | A oferta não é mais um recurso, ou seja, o recurso de coleção pai foi excluído. |
Corpo
| Propriedade | Descrição |
|---|---|
| offerVersion | Esse valor pode ser V1 para níveis de taxa de transferência predefinidos e V2 para níveis de taxa de transferência definidos pelo usuário. |
| offerType | Esse valor indica o nível de desempenho para a versão da oferta V1, os valores permitidos para a oferta V1 são S1, S2 ou S3. Essa propriedade é definida como Inválida para a versão da oferta V2. |
| content | Ele contém informações sobre a oferta. Para ofertas V2, ela contém a taxa de transferência da coleção. |
| recurso | Ao criar uma nova coleção, essa propriedade é definida como o auto-link da coleção, por exemplo, dbs/pLJdAA==/colls/pLJdAOlEdgA=/. |
| offerResourceId | Durante a criação de uma coleção, essa propriedade é automaticamente associada à ID do recurso, ou seja, _rid da coleção. No exemplo acima, o _rid da coleção é pLJdAOlEdgA=. |
| id | É uma propriedade gerada pelo sistema. A ID do recurso de oferta é gerada automaticamente quando ele é criado. Ele tem o mesmo valor que o _rid para a oferta. |
| _Livrar | É uma propriedade gerada pelo sistema. A ID do recurso (_rid) é um identificador exclusivo que também é hierárquico de acordo com a pilha de recursos no modelo de recurso. Ela é usada internamente para posicionamento 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. |
| _Auto | É uma propriedade gerada pelo sistema. É o URI endereçável exclusivo do recurso. |
| _Etag | É uma propriedade gerada pelo sistema que especifica a etag de recurso necessária para o controle 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
}
Comentários
Para saber mais sobre a taxa de transferência provisionada máxima e mínima que pode ser definida em um contêiner ou um banco de dados, consulte o artigo Provisionar taxa de transferência em contêineres e bancos de dados .
Execute GET no recurso de oferta para recuperar a taxa de transferência mínima que pode ser definida para um determinado contêiner ou um banco de dados. O cabeçalho x-ms-cosmos-min-throughput de resposta indica a taxa de transferência mínima determinada pelo sistema.