1. REST API for Oracle Transaction Manager for Microservices
  2. Tasks
  3. Maintenance

Start Maintenance Mode with the Specified Duration

put

/admin/v1/maintenance/start/{duration}

Starts the maintenance mode. If you have deployed multiple replicas of the MicroTx coordinator, run this API on each replica. Specify the time buffer, in minutes, for the ongoing transactions to complete. Before you begin, ensure that you run the `/admin/v1/maintenance/clear` REST call to clear any existing cached maintenance data in the data store. When you start the maintenance mode, the transaction logs for all the new requests in each replica of the MicroTx transaction coordinator are saved in both the cache and data store

Request

Supported Media Types
Path Parameters
Back to Top

Response

Supported Media Types

200 Response

Ok, in maintenance mode

202 Response

Accepted, maintenance process started

500 Response

InternalServerError
Back to Top

Examples

cURL Command

The following example shows how to start the maintenance mode, with the specified time buffer for the ongoing transactions to complete, by submitting a PUT 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 PUT 
     -H "Authorization:Bearer $OTMM_COOKIE"
     https://192.0.2.1:8080/admin/v1/maintenance/start/7

  • 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.

  • 7 is the time buffer, in minutes, for the ongoing transactions to complete. You can specify an integer that is greater than 5. If you enter a value less than 5 minutes, the value is set to 5 minutes by default.

Example of the Response Body

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

{
     "message": "maintenance process started"
}
Back to Top