Checks the health status of PolarDB-X instances in a specified region.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CheckHealth

The operation that you want to perform. Set the value to CheckHealth.

Response parameters

Parameter Type Example Description
Status String UP

Indicates whether the instances in the specified region are healthy. The value UP indicates that the instances in the specified region are healthy. Other values indicate that exceptions occur on one or more instances in the specified region.

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

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CheckHealth
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<CheckHealthResponse>
    <Status>UP</Status>
    <RequestId>173CA69A-3513-591D-8A09-C1EA37CBE2D9</RequestId>
</CheckHealthResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, visit the API Error Center.