Skip to content

Commit 0fc6e3c

Browse files
authored
Merge pull request #1051 from redis/DOC-4661
RC API: Minor fixes to least-viewed example pages
2 parents 1a2dcca + 44b60ba commit 0fc6e3c

File tree

3 files changed

+12
-34
lines changed

3 files changed

+12
-34
lines changed

content/operate/rc/api/examples/audit-system-logs.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,9 @@ To view the log, sign in to the [Redis Cloud console](https://cloud.redis.io/) a
1616

1717
To learn more, see [System logs]({{< relref "/operate/rc/logs-reports/system-logs" >}}).
1818

19+
## Get system logs via REST API
1920

20-
### System log REST API
21-
22-
The REST API operation for querying the system service log is `GET /logs`.
23-
24-
For example, the following request returns the latest 100 system log entries, in descending order:
25-
26-
```shell
27-
GET "https://[host]/v1/logs?limit=100&offset=0"
28-
```
21+
The REST API operation for querying the system service log is [`GET /logs`]({{< relref "/operate/rc/api/api-reference#tag/Account/operation/getAccountSystemLogs" >}}).
2922

3023
The `/logs` API operation accepts the following parameters:
3124

content/operate/rc/api/examples/back-up-and-import-data.md

Lines changed: 8 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -21,22 +21,19 @@ This parameter enables periodic and on-demand backup operations for the specifie
2121
The number of database backups that can run simultaneously on a cluster is limited to 4 by default.
2222
{{</note>}}
2323

24-
The API operation for on-demand backups is `POST /subscriptions/{subscriptionId}/databases/{databaseId}/backup`.
24+
For Redis Cloud Pro databases, back up a database with [`POST /subscriptions/{subscriptionId}/databases/{databaseId}/backup`]({{< relref "/operate/rc/api/api-reference#tag/Databases-Pro/operation/backupDatabase" >}}). For Redis Cloud Essentials databases, use [`POST /fixed/subscriptions/{subscriptionId}/databases/{databaseId}/backup`]({{< relref "/operate/rc/api/api-reference#tag/Databases-Essentials/operation/backupDatabase_1" >}}).
2525
On-demand database backup is an [asynchronous operation]({{< relref "/operate/rc/api/get-started/process-lifecycle" >}}).
2626

27-
```shell
28-
POST "https://[host]/v1/subscriptions/<subscriptionId>/databases/<databaseId>/backup"
29-
```
27+
The backup database API does not require a body. Instead, the `periodicBackupPath` must be set to a valid path with available storage capacity to store the backup files for the specific database. You can set an `adhocBackupPath` in the body to specify a different backup location for this backup.
3028

31-
The backup database API does not require a body.
32-
Instead, the `periodicBackupPath` must be set to a valid path with available storage capacity to store the backup files for the specific database.
29+
See [Set up backup storage locations]({{< relref "/operate/rc/databases/back-up-data#set-up-backup-storage-locations" >}}) to learn how to configure your backup storage locations.
3330

34-
## Import a database
31+
## Import data to a database
3532

3633
You can import data into an existing database from multiple storage sources, including AWS S3, Redis, and FTP.
3734
Database import is an [asynchronous operation]({{< relref "/operate/rc/api/get-started/process-lifecycle" >}}).
3835

39-
The API operation for performing on-demand backup is `POST /v1/subscriptions/{subscriptionId}/databases/{databaseId}/import`.
36+
Use [`POST /v1/subscriptions/{subscriptionId}/databases/{databaseId}/import`]({{< relref "/operate/rc/api/api-reference#tag/Databases-Pro/operation/importDatabase" >}}) to import data to an existing Redis Cloud Pro database. For Redis Cloud Essentials databases, use [`POST /fixed/subscriptions/{subscriptionId}/databases/{databaseId}/backup`]({{< relref "/operate/rc/api/api-reference#tag/Databases-Essentials/operation/importDatabase_1" >}})
4037

4138
The requirements for data import are:
4239

@@ -51,27 +48,15 @@ The duration of the import process depends on the amount of data imported and th
5148
Data imported into an existing database overwrites any existing data.
5249
{{< /warning >}}
5350

54-
To import the data, run:
55-
56-
```shell
57-
POST "https://[host]/v1/subscriptions/<subscriptionId>/databases/{databaseId}/import" \
58-
{
59-
"sourceType": "aws-s3",
60-
"importFromUri": [
61-
"s3://bucketname/filename-dbForAWSBackup-1_of_3.rdb.gz",
62-
"s3://bucketname/filename-dbForAWSBackup-2_of_3.rdb.gz",
63-
"s3://bucketname/filename-dbForAWSBackup-3_of_3.rdb.gz"
64-
]
65-
}
66-
```
67-
6851
You can specify the backup location with the `sourceType` and `importFromUri` values for these sources:
6952

70-
|Data location|sourceType|importFromUri|
53+
|Data location|`sourceType`|`importFromUri`|
7154
|---|---|---|
7255
|Amazon AWS S3|aws-s3|s3://bucketname/[path/]filename.rdb[.gz]|
7356
|FTP|ftp|ftp://[username][:password]@[:port]/[path/]filename.rdb[.gz]|
7457
|Google Blob Storage|google-blob-storage|gs://bucketname/[path/]filename.rdb[.gz]|
7558
|Microsoft Azure Blob Storage|azure-blob-storage|abs://:storage_account_access_key@storage_account_name/[container/]filename.rdb[.gz]|
7659
|Redis server|redis|redis://[db_password]@[host]:[port]|
7760
|Web server|HTTP|HTTP://[username][:password]@[:port]/[path/]filename.rdb[.gz]|
61+
62+
See [Import data]({{< relref "/operate/rc/databases/import-data" >}}) to learn how to set up your storage locations for data import.

content/operate/rc/api/examples/dryrun-cost-estimates.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ With a **dry-run request**, you can evaluate the impact and obtain a new cost es
2020

2121
API operations that support dry-run requests accept the `dryRun` boolean parameter in the JSON request body.
2222

23-
For example, the JSON body of a create subscription request body can include the `dryRun=true` parameter:
23+
For example, the JSON body of a create subscription request body can include `"dryRun": true`:
2424

2525

2626
```json
@@ -55,7 +55,7 @@ For example, the JSON body of a create subscription request body can include the
5555
Dry-run requests behave like regular requests except that no changes are made to existing resources.
5656
A dry-run request produces a cost evaluation report for the subscription.
5757

58-
| API Operation | `dryRun=false` (default) | `dryRun=true` |
58+
| API Operation | `"dryRun": false` (default) | `"dryRun": true` |
5959
|---|---|---|
6060
| **Create subscription** | Create a subscription | Returns a cost evaluation report of the planned subscription |
6161
| **Create database** | Creates a new database in the subscription | Returns a cost evaluation report for the relevant subscription |

0 commit comments

Comments
 (0)