オファーの取得
オファー リソースを取得するには、 オファー リソースに対して GET を実行します。
Request
| Method | 要求 URI | 説明 |
|---|---|---|
| GET | https://{databaseaccount}.documents.azure.com/offers/{_rid-offer} |
{databaseaccount} は、サブスクリプションで作成した Azure Cosmos DB アカウントの名前であることに注意してください。 {_rid-offer} の値は、オファーのシステムによって生成されるリソース ID です。 |
ヘッダー
すべての Cosmos DB 要求 で使用されるヘッダーについては、「共通の Azure Cosmos DB REST 要求ヘッダー」を参照してください。
マスター キー トークンのハッシュ署名を構築する場合、ResourceType は "オファー" である必要があります。
ResourceLink は、取得するオファーの_ridのみにする必要があります。 値は小文字にする必要があります。 たとえば、 で https://querydemo.documents.azure.com/offers/uT2LGET を実行する場合、マスター キー トークンの ResourceLink は "ut2l" である必要があります。
本文
なし。
[応答]
要求されたオファー リソースを返します。
ヘッダー
すべての Cosmos DB 応答によって返されるヘッダーについては、「 共通の Azure Cosmos DB REST 応答ヘッダー 」を参照してください。
状態コード
次の表に、この操作で返される一般的なステータス コードを示します。 状態コードの完全な一覧については、「 HTTP 状態コード」を参照してください。
| HTTP 状態コード | 説明 |
|---|---|
| 200 Ok | 操作に成功しました。 |
| 404 見つかりません | オファーはリソースではなく、つまり親コレクション リソースが削除されました。 |
Body
| プロパティ | 説明 |
|---|---|
| offerVersion | この値は、定義済みのスループット レベルの場合は V1、ユーザー定義のスループット レベルの場合は V2 にすることができます。 |
| offerType | この値は、V1 オファーのバージョンのパフォーマンス レベル、V1 オファーの許容値が S1、S2、または S3 であることを示します。 このプロパティは、V2 オファーのバージョンに対して無効に設定されています。 |
| content | オファーに関する情報が含まれています。 V2 オファーの場合は、コレクションのスループットが含まれます。 |
| resource | 新しいコレクションを作成する場合、このプロパティはコレクションのセルフリンクに設定されます (例: dbs/pLJdAA==/colls/pLJdAOlEdgA=/)。 |
| offerResourceId | コレクションの作成時に、このプロパティはリソース ID (つまりコレクションの _rid ) に自動的に関連付けられます。 上記の例では、コレクションの _rid は pLJdAOlEdgA= です。 |
| id | これは、システムによって生成されるプロパティです。 オファー リソースの ID は、作成時に自動的に生成されます。 オファーの _rid と同じ値を持ちます。 |
| _解消 | これは、システムによって生成されるプロパティです。 リソース ID (_rid) は、リソース モデルのリソース スタックごとに階層化される一意識別子です。 プランの配置とナビゲーションのために内部的に使用されます。 |
| _Ts | これは、システムによって生成されるプロパティです。 リソースの最終更新タイムスタンプを示します。 値は、タイムスタンプです。 |
| _自己 | これは、システムによって生成されるプロパティです。 リソースの一意のアドレス指定が可能な URI です。 |
| _Etag | これは、オプティミスティック コンカレンシー制御に必要なリソース etag を指定するシステム生成プロパティです。 |
{
"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
}
例
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
}
注釈
コンテナーまたはデータベースで設定できるプロビジョニング済みの最大スループットと最小スループットの詳細については、「コンテナー とデータベースでのスループットのプロビジョニング 」の記事を参照してください。
オファー リソースに対して GET を実行して、特定のコンテナーまたはデータベースに設定できる最小スループットを取得します。 応答ヘッダーは、システムによって決定された最小スループットを示します x-ms-cosmos-min-throughput 。