Get a Database
To retrieve a database resource, perform a GET on the database resource.
Note
These API reference articles shows how to create resources using the Azure Cosmos DB data plane API. With the data plane API you can configure basic options such as indexing policy, partition keys much like you can with Cosmos DB SDKs. If you require complete feature support for all Azure Cosmos DB resources, we recommend using the Cosmos DB Resource Provider.
Request
| Method | Request URI | Description |
|---|---|---|
| GET | https://{databaseaccount}.documents.azure.com/dbs/{db-id} |
Note that {databaseaccount} is the name of the Azure Cosmos DB account you created under your subscription. The {db-id} value is the user generated name/ID of the database, not the system generated ID (rid). |
Headers
See Common Azure Cosmos DB REST request headers for headers that are used by all Cosmos DB requests.
Body
None.
Response
Headers
See Common Azure Cosmos DB REST response headers for headers that are returned by all Cosmos DB responses.
Status codes
The following table lists common status codes returned by this operation. For a full list of status codes, see HTTP Status Codes.
| HTTP status code | Description |
|---|---|
| 200 Ok | The operation was successful. |
| 404 Not Found | The database is no longer a resource, i.e. the resource was deleted. |
Body
| Property | Description |
|---|---|
| id | The unique user generated name for the database. |
| _rid | It is a system generated property. The resource id (_rid) is a unique identifier that is also hierarchical per the resource stack on the resource model. It is used internally for placement of and navigation to the database resource. |
| _ts | It is a system generated property. It denotes the last updated timestamp of the resource. The value is a timestamp. |
| _self | It is a system generated property. It is the unique addressable URI for the resource. |
| _etag | It is a system generated property representing the resource etag required for optimistic concurrency control. |
| _colls | It is a system generated property that specifies the addressable path of the collections resource. |
| _users | It is a system generated property that specifies the addressable path of the users resource. |
{
"id": "volcanodb",
"_rid": "Sl8fAA==",
"_ts": 1448049502,
"_self": "dbs\/Sl8fAA==\/",
"_etag": "\"00000100-0000-0000-0000-564f7b5e0000\"",
"_colls": "colls\/",
"_users": "users\/"
}
Example
GET https://contosomarketing.documents.azure.com/dbs/volcanodb HTTP/1.1
x-ms-date: Tue, 08 Dec 2015 19:41:22 GMT
authorization: type%3dmaster%26ver%3d1.0%26sig%3d0kZDPXylaMLpTI%2bxJYe7Xk5HiSv%2bX%2bpUGPKBMtY3My8%3d
Cache-Control: no-cache
User-Agent: contoso/1.0
x-ms-version: 2015-08-06
Accept: application/json
Host: contosomarketing.documents.azure.com
HTTP/1.1 200 Ok
Cache-Control: no-store, no-cache
Pragma: no-cache
Content-Type: application/json
Content-Location: https://contosomarketing.documents.azure.com/dbs/volcanodb
Server: Microsoft-HTTPAPI/2.0
Strict-Transport-Security: max-age=31536000
x-ms-last-state-change-utc: Sun, 29 Nov 2015 02:25:34.442 GMT
etag: "00000100-0000-0000-0000-564f7b5e0000"
x-ms-resource-quota: databases=100;
x-ms-resource-usage: databases=15;
x-ms-schemaversion: 1.1
x-ms-session-token: 860
x-ms-request-charge: 2
x-ms-serviceversion: version=1.5.57.3
x-ms-activity-id: d319e186-8e5f-4861-bcd0-59fb249769f3
x-ms-gatewayversion: version=1.5.57.3
Date: Tue, 08 Dec 2015 19:41:21 GMT
Content-Length: 168
{
"id": "volcanodb",
"_rid": "Sl8fAA==",
"_ts": 1448049502,
"_self": "dbs\/Sl8fAA==\/",
"_etag": "\"00000100-0000-0000-0000-564f7b5e0000\"",
"_colls": "colls\/",
"_users": "users\/"
}