Skip to content

Commit 9b13dab

Browse files
cmilesbcmilesb
authored
Merge pull request #1000 from redis/DOC-4657
CAPI: Consolidate database examples and add Essentials information
2 parents 7175e4d + 5ef79af commit 9b13dab

File tree

4 files changed

+58
-111
lines changed

4 files changed

+58
-111
lines changed

‎content/operate/rc/api/_index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,7 @@ You can use the API to:
3333

3434
1. [Manage subscriptions]({{< relref "/operate/rc/api/examples/manage-subscriptions.md" >}})
3535
1. Database examples
36-
- [Create database]({{< relref "/operate/rc/api/examples/create-database" >}})
37-
- [Update database]({{< relref "/operate/rc/api/examples/update-database.md" >}})
36+
- [Create and manage databases]({{< relref "/operate/rc/api/examples/create-database" >}})
3837
- [Back up and import data]({{< relref "/operate/rc/api/examples/back-up-and-import-data.md" >}})
3938
1. [Estimate costs]({{< relref "/operate/rc/api/examples/dryrun-cost-estimates.md" >}})
4039

‎content/operate/rc/api/examples/create-database.md

Lines changed: 56 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,45 +5,79 @@ categories:
55
- docs
66
- operate
77
- rc
8-
description: This article describes how to create and manage a database using `cURL`
9-
commands.
10-
linkTitle: Create databases
8+
description: This article describes how to create and manage a database using the Redis Cloud API.
9+
linkTitle: Create and manage databases
1110
weight: 20
1211
---
1312

14-
You can use the Redis Cloud REST API to create databases.
13+
You can use the Redis Cloud REST API to create and manage databases.
1514

16-
These examples use the [`cURL` utility]({{< relref "/operate/rc/api/get-started/use-rest-api#use-the-curl-http-client" >}}). You can use any REST client to work with the Redis Cloud REST API. The examples in this article refer to Redis Cloud Pro databases.
15+
## Redis Cloud Essentials
1716

18-
## Create a database
17+
### Create an Essentials database
1918

20-
To create a database, use `POST /subscriptions/{subscription-id}/databases`
19+
To create a Redis Cloud Essentials database, use [`POST /fixed/subscriptions/{subscriptionId}/databases`]({{< relref "/operate/rc/api/api-reference#tag/Databases-Essentials/operation/createFixedDatabase" >}}).
2120

22-
The database is created in an existing or a newly created subscription.
21+
This call creates a database in the specified subscription. Use [`GET /fixed/subscriptions`]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Essentials/operation/getAllSubscriptions_1" >}}) to get a list of Essentials subscriptions and their IDs.
2322

24-
When a subscription is created, it is created with at least one database.
23+
```shell
24+
POST "https://[host]/v1/fixed/subscriptions/{subscriptionId}/databases"
25+
{
26+
"name": "Basic-essentials-database-example"
27+
}
28+
```
29+
30+
This example JSON body contains only the most basic, required parameters to create a database:
31+
32+
- `name`: The database name. A unique name per subscription that can contain only alphanumeric characters and hyphens
33+
34+
There are other additional parameters and settings that can be defined on database creation. Review the database parameters and options in the [full API reference]({{< relref "/operate/rc/api/api-reference#tag/Databases-Essentials/operation/createFixedDatabase" >}}).
35+
36+
Some options may not be compatible with your selected plan. Use [`GET /fixed/subscriptions/{subscriptionId}`]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Essentials/operation/getFixedSubscriptionsPlansBySubscriptionId" >}}) to view the plan you have selected and what options it supports.
37+
38+
The response body contains the `taskId` for the task that creates the database. You can use [`GET /v1/tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}) to track the task's status.
39+
40+
### Update an Essentials database
2541

26-
You can add databases to the subscription; you can also update or delete existing databases.
42+
To update a Redis Cloud Essentials database, use [`PUT /fixed/subscriptions/{subscriptionId}/databases/{databaseId}`]({{< relref "/operate/rc/api/api-reference#tag/Databases-Essentials/operation/deleteFixedDatabaseByID" >}}).
2743

28-
Creating a database is an [asynchronous operation]({{< relref "/operate/rc/api/get-started/process-lifecycle" >}}).
44+
The primary component of a database update request is the JSON request body that contains the details of the requested database changes. You can see the full set of changes you can make in the [full API reference]({{< relref "/operate/rc/api/api-reference#tag/Databases-Essentials/operation/deleteFixedDatabaseByID" >}}).
2945

30-
The following API call creates a database.
46+
Some options may not be compatible with your selected plan. Use [`GET /fixed/subscriptions/{subscriptionId}`]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Essentials/operation/getFixedSubscriptionsPlansBySubscriptionId" >}}) to view the plan you have selected and what options it supports.
47+
48+
The response body contains the `taskId` for the task that updates the database. You can use [`GET /v1/tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}) to track the task's status.
49+
50+
## Redis Cloud Pro
51+
52+
### Create a Pro database
53+
54+
If you want to create a Pro database in a new subscription, see [Create a Pro subscription]({{< relref "/operate/rc/api/examples/manage-subscriptions#create-a-pro-subscription" >}}).
55+
56+
To create a Redis Cloud Pro database in an existing subscription, use [`POST /subscriptions/{subscriptionId}/databases`]({{< relref "/operate/rc/api/api-reference#tag/Databases-Pro/operation/createDatabase" >}}).
57+
58+
This call creates a database in the specified subscription. Use [`GET /subscriptions`]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Pro/operation/getAllSubscriptions" >}}) to get a list of subscriptions and their IDs.
3159

3260
```shell
33-
POST "https://[host]/v1/subscriptions/$SUBSCRIPTION_ID/databases"
61+
POST "https://[host]/v1/subscriptions/{subscriptionId}/databases"
3462
{
35-
"name": "Database-example-basic",
36-
"memoryLimitInGb": 10,
37-
"password": "P@ssw0rd"
63+
"name": "Basic-database-example",
64+
"datasetSizeInGb": 1
3865
}
3966
```
4067

41-
The JSON body contains only the most basic, required parameters in order to create a database:
68+
This example JSON body contains only the most basic, required parameters to create a database:
69+
70+
- `name`: The database name. A unique name per subscription that can contain only alphanumeric characters and hyphens
71+
- `datasetSizeInGb`: Maximum dataset size in GB
72+
73+
There are many additional parameters and settings that can be defined on database creation. Review the database parameters and options in the [full API reference]({{< relref "/operate/rc/api/api-reference#tag/Databases-Pro/operation/createDatabase" >}}).
74+
75+
The response body contains the `taskId` for the task that creates the database. You can use [`GET /v1/tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}) to track the task's status.
76+
77+
### Update a Redis Cloud Pro database
4278

43-
- Database name - A unique name per subscription that can contain only alphanumeric characters and hyphens
44-
- Maximum database size in GB
45-
- Database password
79+
To update a Redis Cloud Pro database, use [`PUT /subscriptions/{subscriptionId}/databases/{databaseId}`]({{< relref "/operate/rc/api/api-reference#tag/Databases-Pro/operation/updateDatabase" >}}).
4680

47-
### Additional database parameters
81+
The primary component of a database update request is the JSON request body that contains the details of the requested database changes. You can see the full set of changes you can make in the [full API reference]({{< relref "/operate/rc/api/api-reference#tag/Databases-Pro/operation/updateDatabase" >}}).
4882

49-
There are many additional parameters and settings that can be defined on database creation. Review the database parameters and options in the [Full API documentation]({{< relref "/operate/rc/api/api-reference#tag/Databases-Pro/operation/createDatabase" >}}).
83+
The response body contains the `taskId` for the task that updates the database. You can use [`GET /v1/tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}) to track the task's status.

‎content/operate/rc/api/examples/manage-subscriptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Modify the following parameters in the sample JSON document to create a subscrip
3838

3939
Use [`GET /v1/fixed/plans`]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Essentials/operation/getAllFixedSubscriptionsPlans" >}}) to get a list of plan IDs.
4040

41-
After you create an Essentials subscription, you must use the [`POST /v1/fixed/subscriptions/{subscriptionId}/databases`]({{< relref "/operate/rc/api/api-reference#tag/Databases-Essentials/operation/createFixedDatabase" >}}) endpoint to create the database.
41+
After you create an Essentials subscription, you must use the [`POST /v1/fixed/subscriptions/{subscriptionId}/databases`]({{< relref "/operate/rc/api/api-reference#tag/Databases-Essentials/operation/createFixedDatabase" >}}) endpoint to [create the database]({{< relref "/operate/rc/api/examples/create-database#redis-cloud-essentials" >}}).
4242

4343
You can include the contents of the JSON document in the `POST /v1/fixed/subscriptions` operation in the [Swagger UI](https://api.redislabs.com/v1/swagger-ui.html). See [Swagger user interface]({{< relref "/operate/rc/api/get-started/use-rest-api#swagger-user-interface" >}}) for more details.
4444

‎content/operate/rc/api/examples/update-database.md

Lines changed: 0 additions & 86 deletions
This file was deleted.

0 commit comments

Comments
 (0)