Retrieve the Progress Status

get

/admin/v1/maintenance/status

Retrieves the progress status of the cached maintenance data backup. Before upgrading the MicroTx transaction coordinator, ensure that the back up of the cached maintenance data was completed successfully.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

200 Response

OK. You will receive one of the following messages: maintenance mode completed, maintenance mode is in progress, or maintenance mode has not started.

500 Response

InternalServerError
Back to Top

Examples

cURL Command

The following example shows how to check the progress and to confirm that the maintenance mode has completed successfully by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

Enter the command on a single line. Line breaks are used in this example for readability.

curl -X GET 
     -H "Authorization:Bearer $OTMM_COOKIE"
     --header 'Accept: application/json'
     https://192.0.2.1:8080/admin/v1/maintenance/status
  • OTMM_COOKIE is the name of the variable in which you stored the authentication cookie earlier. For information about retrieving the authentication cookie and storing it in a variable, see Authenticate.

  • 192.0.2.1:8080 is an example REST endpoint URL. Change this value to the REST endpoint URL to access the Istio ingress gateway in your environment. For information about finding out REST endpoint URL for your site, see Send Requests.

Example of the Response Body

The following example shows the contents of the response body in JSON format.

{
 "message": "maintenance mode completed"
}
Back to Top