You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/operate/rs/databases/durability-ha/db-availability.md
+26Lines changed: 26 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,6 +14,32 @@ weight: 30
14
14
15
15
You can use the [database availability API]({{<relref "/operate/rs/references/rest-api/requests/bdbs/availability">}}) to verify whether a Redis Software database is available to perform read and write operations and can respond to queries from client applications. Load balancers and automated monitoring tools can use this API to monitor database availability.
16
16
17
+
## Check database availability
18
+
19
+
To check the availability status of a database:
20
+
21
+
```sh
22
+
GET /v1/bdbs/<database_id>/availability
23
+
```
24
+
25
+
If the OSS Cluster API is enabled, this request verifies all endpoints for this database are available. Otherwise, it verifies the database has at least one available endpoint.
26
+
27
+
Returns the status code 200 OK if the database is available.
28
+
29
+
If the database is unavailable, returns an error status code and a JSON object that contains [`error_code` and `description` fields]({{<relref "/operate/rs/references/rest-api/requests/bdbs/availability#get-db-error-codes">}}).
30
+
31
+
## Check local database endpoint availability
32
+
33
+
To check the availability of a local database endpoint:
34
+
35
+
```sh
36
+
GET /v1/local/bdbs/<database_id>/endpoint/availability
37
+
```
38
+
39
+
Returns the status code 200 OK if the local database endpoint is available.
40
+
41
+
If the local database endpoint is unavailable, returns an error status code and a JSON object that contains [`error_code` and `description` fields]({{<relref "/operate/rs/references/rest-api/requests/bdbs/availability#get-endpoint-error-codes">}}).
0 commit comments