All Products
Search
Document Center

PolarDB:CheckHealth

Last Updated:Sep 10, 2026

Performs a service health check.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element

Type

Description

Example

object

Status

string

Indicates whether the component is healthy. A return value of UP indicates healthy. Any other value or an empty value indicates an exception.

UP

RequestId

string

The request ID.

173CA69A-3513-591D-8A09-C1EA37CBE2D9

Examples

Success response

JSON format

{
  "Status": "UP",
  "RequestId": "173CA69A-3513-591D-8A09-C1EA37CBE2D9"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.