Availability

Get database endpoint availability {#get-db-endpoint-availability}

GET /v1/local/bdbs/{uid}/endpoint/availability

Verifies the local database endpoint is available. This request does not redirect to the primary node.

Permissions

Request {#get-endpoint-request}

Example HTTP requests

To check database endpoint availability without any additional checks:

GET /v1/local/bdbs/1/endpoint/availability

To perform a lag-aware database endpoint availability check using the cluster's default lag tolerance threshold:

GET /v1/local/bdbs/1/endpoint/availability?extend_check=lag

To perform a lag-aware database endpoint availability check and override the cluster's default lag tolerance threshold:

GET /v1/local/bdbs/1/endpoint/availability?extend_check=lag&availability_lag_tolerance_ms=100

Headers

URL parameters

Query parameters

Response {#get-endpoint-response}

Returns the status code 200 OK if the local database endpoint is available.

If the local database endpoint is unavailable, returns an error status code and a JSON object that contains error_code and description fields.

Error codes {#get-endpoint-error-codes}

When errors are reported, the server may return a JSON object with error_code and description fields that provide additional information. The following are possible error_code values:

Status codes {#get-endpoint-status-codes}

Get database availability {#get-db-availability}

GET /v1/bdbs/{uid}/availability

Gets the availability status of a database.

• If the OSS Cluster API is enabled, verifies all endpoints for this database are available.

• Otherwise, verifies the database has at least one available endpoint.

Permissions

Request {#get-db-request}

Example HTTP requests

To check database availability without any additional checks:

GET /v1/bdbs/1/availability

To perform a lag-aware database availability check using the cluster's default lag tolerance threshold:

GET /v1/bdbs/1/availability?extend_check=lag

To perform a lag-aware database availability check and override the cluster's default lag tolerance threshold:

GET /v1/bdbs/1/availability?extend_check=lag&availability_lag_tolerance_ms=100

Headers

URL parameters

Query parameters

Response {#get-db-response}

Returns the status code 200 OK if the database is available.

If the database is unavailable, returns an error status code and a JSON object that contains error_code and description fields.

Error codes {#get-db-error-codes}

When errors are reported, the server may return a JSON object with error_code and description fields that provide additional information. The following are possible error_code values:

Status codes {#get-db-status-codes}