データベースの作成
この操作により Create Database
、データベース アカウントに新しいデータベースが作成されます。
注意
これらの API リファレンス記事では、Azure Cosmos DB データ プレーン API を使用してリソースを作成する方法について説明します。 データ プレーン API を使用すると、Cosmos DB SDK と同様に、インデックス作成ポリシー、パーティション キーなどの基本的なオプションを構成できます。 すべての Azure Cosmos DB リソースの完全な機能サポートが必要な場合は、 Cosmos DB リソース プロバイダーを使用することをお勧めします。
Request
Method | 要求 URI | 説明 |
---|---|---|
POST | https://{databaseaccount}.documents.azure.com/dbs |
{databaseaccount} は、サブスクリプションで作成した Azure Cosmos DB アカウントの名前です。 |
ヘッダー
すべての Azure Cosmos DB 要求 で使用されるヘッダーについては、「共通の Azure Cosmos DB REST 要求ヘッダー」を参照してください。
プロパティ | 必須 | Type | 説明 |
---|---|---|---|
x-ms-offer-throughput | 省略可能 | Number | ユーザーは、1 秒あたり 100 要求ユニット単位で表されたデータベースに対して手動スループット (RU/秒) を指定しました。 最小値は 400 から 1,000,000 までです (制限の引き上げを要求することで以上)。 または x-ms-cosmos-offer-autopilot-settings の x-ms-offer-throughput 1 つだけを指定する必要があります。 これらのヘッダーを一緒に指定することはできません。 |
x-ms-cosmos-offer-autopilot-settings | 省略可能 | JSON | ユーザーが指定したデータベースの最大 RU/秒の自動スケーリング。 値は、 プロパティを持つ JSON です maxThroughput 。 たとえば、{"maxThroughput": 4000} のように指定します。または x-ms-cosmos-offer-autopilot-settings の x-ms-offer-throughput 1 つだけを指定する必要があります。 これらのヘッダーを一緒に指定することはできません。 |
注意
データベースにスループットを設定すると、 共有スループット データベース が作成され、その中のすべてのコレクションがプロビジョニングされたスループットを共有します。 共有スループット データベースには、25 個のコンテナーの制限があります。 共有スループット データベースを使用する予定がない場合は、上記のスループット ヘッダーを設定せずにデータベースを作成します。 詳細については、こちらを参照してください。
Body
プロパティ | 必須 | Type | 説明 |
---|---|---|---|
id | 必須 | String | データベースのユーザーが生成した一意の名前。 255 文字以内の文字列です。 |
{
"id": "volcanodb2"
}
[応答]
ヘッダー
すべての Azure Cosmos DB 応答 によって返されるヘッダーについては、「共通の Azure Cosmos DB REST 応答ヘッダー」を参照してください。
状態コード
次の表に、この操作で返される一般的なステータス コードを示します。 状態コードの完全な一覧については、「 HTTP 状態コード」を参照してください。
HTTP 状態コード | 説明 |
---|---|
201 Created | 操作が成功したときに返されます。 |
400 Bad Request | JSON 本文が有効でない場合に返されます。 中かっこや引用符の不足がないか確認してください。 |
409 競合 | 新しいデータベースに指定された ID が既存のデータベースによって取得されたときに返されます。 |
Body
プロパティ | 説明 |
---|---|
id | データベースのユーザーが生成した一意の名前。 |
_解消 | これは、システムによって生成されるプロパティです。 リソース ID (_rid) は、リソース モデル上のリソース スタックごとに階層化された一意識別子です。 データベース リソースの配置およびナビゲーションのために内部的に使用されます。 |
_Ts | システムによって生成されるプロパティです。 リソースの最終更新タイムスタンプを示します。 値は、タイムスタンプです。 |
_自己 | システムによって生成されるプロパティです。 リソースの一意のアドレス指定が可能な URI です。 |
_Etag | これは、オプティミスティック コンカレンシー制御に必要なリソース etag を指定するシステム生成のプロパティです。 |
_colls | これは、コレクション リソースのアドレス指定可能パスを指定するシステム生成のプロパティです。 |
_ユーザー | ユーザー リソースのアドレス指定可能パスを指定するシステム生成のプロパティです。 |
{
"id": "volcanodb2",
"_rid": "CqNBAA==",
"_ts": 1449602962,
"_self": "dbs\/CqNBAA==\/",
"_etag": "\"00000a00-0000-0000-0000-56672f920000\"",
"_colls": "colls\/",
"_users": "users\/"
}
例 1
次の例では、データベースを作成します。
POST https://contosomarketing.documents.azure.com/dbs HTTP/1.1
x-ms.date: 04/20/2021
authorization: type%3dmaster%26ver%3d1.0%26sig%3dsc0%2fu25RB8wSqbY1%2bUZqTGD0yCQC5KkGOAP%2bgnHFceQ%3d
Cache-Control: no-cache
User-Agent: contoso/1.0
x-ms-version: 2015-08-06
Accept: application/json
Host: contosomarketing.documents.azure.com
Content-Length: 19
Expect: 100-continue
{"id":"volcanodb2"}
HTTP/1.1 201 Created
Cache-Control: no-store, no-cache
Pragma: no-cache
Content-Type: application/json
Server: Microsoft-HTTPAPI/2.0
Strict-Transport-Security: max-age=31536000
x-ms-last-state-change-utc: Sun, 29 Nov 2015 02:25:35.212 GMT
etag: "00000a00-0000-0000-0000-56672f920000"
x-ms-resource-quota: databases=100;
x-ms-resource-usage: databases=15;
x-ms-schemaversion: 1.1
x-ms-quorum-acked-lsn: 859
x-ms-session-token: 860
x-ms-current-write-quorum: 3
x-ms-current-replica-set-size: 4
x-ms-request-charge: 4.95
x-ms-serviceversion: version=1.5.57.3
x-ms-activity-id: f171e571-994e-4dc2-b443-7c3d5fa4a293
x-ms-gatewayversion: version=1.5.57.3
Date: Tue, 08 Dec 2015 19:29:21 GMT
Content-Length: 169
{
"id": "volcanodb2",
"_rid": "CqNBAA==",
"_ts": 1449602962,
"_self": "dbs\/CqNBAA==\/",
"_etag": "\"00000a00-0000-0000-0000-56672f920000\"",
"_colls": "colls\/",
"_users": "users\/"
}
例 2
次の例では、手動スループットが 400 RU/秒の 共有スループット データベース を作成します。
x-ms-offer-throughput
ヘッダーは、スループット (RU/秒) の値を設定するために使用されます。 最小 400 の数値を受け取り、100 単位ずつインクリメントします。
POST https://contosomarketing.documents.azure.com/dbs HTTP/1.1
x-ms-date: Tue, 08 Dec 2015 19:29:22 GMT
authorization: type%3dmaster%26ver%3d1.0%26sig%3dsc0%2fu25RB8wSqbY1%2bUZqTGD0yCQC5KkGOAP%2bgnHFceQ%3d
Cache-Control: no-cache
User-Agent: contoso/1.0
x-ms-version: 2015-08-06
Accept: application/json
x-ms-offer-throughput = 400
Host: contosomarketing.documents.azure.com
Content-Length: 19
Expect: 100-continue
{"id":"volcanodb2"}
例 3
次の例では、自動スケーリングの最大スループットが 4,000 RU/秒 (400 ~ 4000 RU/秒) の共有スループット データベースを作成します。
x-ms-cosmos-offer-autopilot-settings
ヘッダーは、 を設定するために使用されます maxThroughput
。これは、自動スケーリングの最大 RU/秒の値です。 最小 4000 の数値を受け取り、1000 単位ずつインクリメントします。
注意
既存のデータベースまたはコンテナーで自動スケーリングを有効にするか、自動スケーリングから手動スループットに切り替えるには、 オファーの置換に関する記事を参照してください。
POST https://contosomarketing.documents.azure.com:443/dbs HTTP/1.1
x-ms-version: 2018-12-31
x-ms-date: Wed, 22 Jul 2020 20:09:50 GMT
authorization: type%3dmaster%26ver%3d1.0%26sig%3dsc0%2fu25RB8wSqbY1%2bUZqTGD0yCQC5KkGOAP%2bgnHFceQ%3d
Accept: application/json
x-ms-cosmos-offer-autopilot-settings: {"maxThroughput": 4000}
Content-Type: application/json
User-Agent: contoso/1.0
Postman-Token: 81c0a4ac-4b7c-4f98-8d46-8c662969bc7e
Host: contosomarketing.documents.azure.com:443
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Content-Length: 27
{"id":"volcanodb3"}