Skip to content

Commit 4e1787d

Browse files
rrelledgerrelledge
authored
RS: Added missing job_scheduler info to REST API reference (#1394)
* DOC-5034 Added bdb_usage_report_job_settings to RS REST API reference * DOC-5034 Added job_scheduler REST API reference * DOC-5034 Added missing enabled field to job_scheduler REST API references
1 parent 8c5700f commit 4e1787d

File tree

8 files changed

+213
-4
lines changed

8 files changed

+213
-4
lines changed

‎content/operate/rs/references/rest-api/objects/job_scheduler/_index.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,9 @@ An API object that represents the job scheduler settings in the cluster.
1616
| Name | Type/Value | Description |
1717
|------|------------|-------------|
1818
| backup_job_settings | [backup_job_settings]({{< relref "/operate/rs/references/rest-api/objects/job_scheduler/backup_job_settings" >}}) object | Backup job settings |
19-
| cert_rotation_job_settings | [cert_rotation_job_settings]({{< relref "/operate/rs/references/rest-api/objects/job_scheduler/cert_rotation_job_settings" >}}) object | Job settings for internal certificate rotation |
20-
| log_rotation_job_settings | [log_rotation_job_settings]({{< relref "/operate/rs/references/rest-api/objects/job_scheduler/log_rotation_job_settings" >}}) object | Log rotation job settings |
21-
| node_checks_job_settings | [node_checks_job_settings]({{< relref "/operate/rs/references/rest-api/objects/job_scheduler/node_checks_job_settings" >}}) object | Node checks job settings |
22-
| redis_cleanup_job_settings | [redis_cleanup_job_settings]({{< relref "/operate/rs/references/rest-api/objects/job_scheduler/redis_cleanup_job_settings" >}}) object | Redis cleanup job settings (deprecated as of Redis Enterprise v6.4.2, replaced with persistence_cleanup_scan_interval) |
19+
| <span class="break-all">bdb_usage_report_job_settings</span> | <span class="break-all">[bdb_usage_report_job_settings]({{< relref "/operate/rs/references/rest-api/objects/job_scheduler/bdb_usage_report_job_settings" >}})</span> object | Job settings for database usage reports |
20+
| <span class="break-all">cert_rotation_job_settings</span> | <span class="break-all">[cert_rotation_job_settings]({{< relref "/operate/rs/references/rest-api/objects/job_scheduler/cert_rotation_job_settings" >}})</span> object | Job settings for internal certificate rotation |
21+
| <span class="break-all">log_rotation_job_settings</span> | <span class="break-all">[log_rotation_job_settings]({{< relref "/operate/rs/references/rest-api/objects/job_scheduler/log_rotation_job_settings" >}})</span> object | Log rotation job settings |
22+
| <span class="break-all">node_checks_job_settings</span> | <span class="break-all">[node_checks_job_settings]({{< relref "/operate/rs/references/rest-api/objects/job_scheduler/node_checks_job_settings" >}})</span> object | Node checks job settings |
23+
| <span class="break-all">redis_cleanup_job_settings</span> | <span class="break-all">[redis_cleanup_job_settings]({{< relref "/operate/rs/references/rest-api/objects/job_scheduler/redis_cleanup_job_settings" >}})</span> object | Redis cleanup job settings (deprecated as of Redis Enterprise v6.4.2, replaced with persistence_cleanup_scan_interval) |
2324
| rotate_ccs_job_settings | [rotate_ccs_job_settings]({{< relref "/operate/rs/references/rest-api/objects/job_scheduler/rotate_ccs_job_settings" >}}) object | Rotate CCS job settings |

‎content/operate/rs/references/rest-api/objects/job_scheduler/backup_job_settings.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,4 @@ weight: $weight
1414
| Name | Type/Value | Description |
1515
|------|------------|-------------|
1616
| cron_expression | string | [CRON expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that defines the backup schedule |
17+
| enabled | boolean (default: true) | Indicates whether this job is enabled |

‎content/operate/rs/references/rest-api/objects/job_scheduler/bdb_usage_report_job_settings.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
Title: BDB usage report job settings object
3+
alwaysopen: false
4+
categories:
5+
- docs
6+
- operate
7+
- rs
8+
description: Documents the bdb_usage_report_job_settings object used with Redis Enterprise Software REST API calls.
9+
linkTitle: bdb_usage_report_job_settings
10+
weight: $weight
11+
---
12+
13+
| Name | Type/Value | Description |
14+
|------|------------|-------------|
15+
| cron_expression | string | [CRON expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that defines the database usage report schedule |
16+
| enabled | boolean (default: true) | Indicates whether this job is enabled |
17+
| file_retention_days | integer, 1-1000 (default: 365) | Number of days after a file is closed before it is deleted |

‎content/operate/rs/references/rest-api/objects/job_scheduler/cert_rotation_job_settings.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,5 @@ weight: $weight
1414
| Name | Type/Value | Description |
1515
|------|------------|-------------|
1616
| cron_expression | string | [CRON expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that defines the certificate rotation schedule |
17+
| enabled | boolean (default: true) | Indicates whether this job is enabled |
1718
| expiry_days_before_rotation | integer, (range:&nbsp;1-90) (default:&nbsp;60) | Number of days before a certificate expires before rotation |

‎content/operate/rs/references/rest-api/objects/job_scheduler/log_rotation_job_settings.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,4 @@ weight: $weight
1414
| Name | Type/Value | Description |
1515
|------|------------|-------------|
1616
| cron_expression | string | [CRON expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that defines the log rotation schedule |
17+
| enabled | boolean (default: true) | Indicates whether this job is enabled |

‎content/operate/rs/references/rest-api/objects/job_scheduler/node_checks_job_settings.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,4 @@ weight: $weight
1414
| Name | Type/Value | Description |
1515
|------|------------|-------------|
1616
| cron_expression | string | [CRON expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that defines the node checks schedule |
17+
| enabled | boolean (default: true) | Indicates whether this job is enabled |

‎content/operate/rs/references/rest-api/objects/job_scheduler/rotate_ccs_job_settings.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,6 @@ weight: $weight
1414
| Name | Type/Value | Description |
1515
|------|------------|-------------|
1616
| cron_expression | string | [CRON expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that defines the CCS rotation schedule |
17+
| enabled | boolean (default: true) | Indicates whether this job is enabled |
1718
| file_suffix | string (default:&nbsp;5min) | String added to the end of the rotated RDB files |
1819
| rotate_max_num | integer, (range:&nbsp;1-100) (default:&nbsp;24) | The maximum number of saved RDB files |

‎content/operate/rs/references/rest-api/requests/job_scheduler/_index.md

Lines changed: 186 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,186 @@
1+
---
2+
Title: Job scheduler requests
3+
alwaysopen: false
4+
categories:
5+
- docs
6+
- operate
7+
- rs
8+
description: REST API requests for the job scheduler
9+
headerRange: '[1-2]'
10+
hideListLinks: true
11+
linkTitle: job_scheduler
12+
weight: $weight
13+
---
14+
15+
| Method | Path | Description |
16+
|--------|------|-------------|
17+
| [GET](#get-job-scheduler) | `/v1/job_scheduler` | Get job scheduler settings |
18+
| [PUT](#put-job-scheduler) | `/v1/job_scheduler` | Update job scheduler settings |
19+
20+
## Get job scheduler settings {#get-job-scheduler}
21+
22+
```sh
23+
GET /v1/job_scheduler
24+
```
25+
26+
Get job scheduler information.
27+
28+
### Permissions
29+
30+
| Permission name | Roles |
31+
|-----------------|-------|
32+
| [view_cluster_info]({{< relref "/operate/rs/references/rest-api/permissions#view_cluster_info" >}}) | admin<br />cluster_member<br />cluster_viewer<br />db_member<br />db_viewer<br />user_manager |
33+
34+
### Request {#get-request}
35+
36+
#### Example HTTP request
37+
38+
```sh
39+
GET /v1/job_scheduler
40+
```
41+
42+
#### Headers
43+
44+
| Key | Value | Description |
45+
|-----|-------|-------------|
46+
| Host | cnm.cluster.fqdn | Domain name |
47+
| Accept | application/json | Accepted media type |
48+
49+
### Response {#get-response}
50+
51+
Returns a [job_scheduler object]({{<relref "/operate/rs/references/rest-api/objects/job_scheduler">}}).
52+
53+
#### Example JSON body
54+
55+
```json
56+
{
57+
"backup_job_settings": {
58+
"cron_expression": "*/5 * * * *",
59+
"enabled": true
60+
},
61+
"bdb_usage_report_job_settings": {
62+
"cron_expression": "0 */1 * * *",
63+
"enabled": false,
64+
"file_retention_days": 365
65+
},
66+
"cert_rotation_job_settings": {
67+
"cron_expression": "0 * * * *",
68+
"enabled": true,
69+
"expiry_days_before_rotation": 60
70+
},
71+
"log_rotation_job_settings": {
72+
"cron_expression": "*/5 * * * *",
73+
"enabled": true
74+
},
75+
"node_checks_job_settings": {
76+
"cron_expression": "0 * * * *",
77+
"enabled": true
78+
},
79+
"redis_cleanup_job_settings": {
80+
"cron_expression": "0 * * * *"
81+
},
82+
"rotate_ccs_job_settings": {
83+
"cron_expression": "*/5 * * * *",
84+
"enabled": true,
85+
"file_suffix": "5min",
86+
"rotate_max_num": 24
87+
}
88+
}
89+
```
90+
91+
#### Status codes {#get-status-codes}
92+
93+
| Code | Description |
94+
|------|-------------|
95+
| [200 OK](https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok) | No error. |
96+
97+
## Update job scheduler settings {#put-job-scheduler}
98+
99+
```sh
100+
PUT /v1/job_scheduler
101+
```
102+
103+
Update job scheduler settings.
104+
105+
### Permissions
106+
107+
| Permission name | Roles |
108+
|-----------------|-------|
109+
| [update_cluster]({{< relref "/operate/rs/references/rest-api/permissions#update_cluster" >}}) | admin |
110+
111+
### Request {#put-request}
112+
113+
#### Example HTTP request
114+
115+
```sh
116+
PUT /v1/job_scheduler
117+
```
118+
119+
#### Example JSON body
120+
121+
```json
122+
{
123+
"backup_job_settings": {
124+
"cron_expression": "*/10 * * * *"
125+
}
126+
}
127+
```
128+
129+
#### Headers
130+
131+
| Key | Value | Description |
132+
|-----|-------|-------------|
133+
| Host | cnm.cluster.fqdn | Domain name |
134+
| Accept | application/json | Accepted media type |
135+
136+
137+
#### Body
138+
139+
Include a [job_scheduler object]({{<relref "/operate/rs/references/rest-api/objects/job_scheduler">}}) with updated fields in the request body.
140+
141+
### Response {#put-response}
142+
143+
Returns a [job_scheduler object]({{<relref "/operate/rs/references/rest-api/objects/job_scheduler">}}) with the updated fields.
144+
145+
#### Example JSON body
146+
147+
```json
148+
{
149+
"backup_job_settings": {
150+
"cron_expression": "*/10 * * * *",
151+
"enabled": true
152+
},
153+
"bdb_usage_report_job_settings": {
154+
"cron_expression": "0 */1 * * *",
155+
"enabled": false,
156+
"file_retention_days": 365
157+
},
158+
"cert_rotation_job_settings": {
159+
"cron_expression": "0 * * * *",
160+
"enabled": true,
161+
"expiry_days_before_rotation": 60
162+
},
163+
"log_rotation_job_settings": {
164+
"cron_expression": "*/5 * * * *",
165+
"enabled": true
166+
},
167+
"node_checks_job_settings": {
168+
"cron_expression": "0 * * * *",
169+
"enabled": true
170+
},
171+
"rotate_ccs_job_settings": {
172+
"cron_expression": "*/5 * * * *",
173+
"enabled": true,
174+
"file_suffix": "5min",
175+
"rotate_max_num": 24
176+
}
177+
}
178+
```
179+
180+
#### Status codes {#put-status-codes}
181+
182+
| Code | Description |
183+
|------|-------------|
184+
| [200 OK](https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok) | No error. |
185+
| [400 Bad Request](https://www.rfc-editor.org/rfc/rfc9110.html#name-400-bad-request) | Bad content provided. |
186+
| [409 Conflict](https://www.rfc-editor.org/rfc/rfc9110.html#name-409-conflict) | Attempting to configure the job_scheduler while it is busy with another configuration change. In this context, this is a temporary condition and the request should be re-attempted later. |

0 commit comments

Comments
 (0)