diff options
author | Lingxian Kong <anlin.kong@gmail.com> | 2020-08-04 12:29:10 +1200 |
---|---|---|
committer | Lingxian Kong <anlin.kong@gmail.com> | 2020-08-06 20:38:11 +1200 |
commit | cf3e9a6e7459e8434172e03b0b046bcbe4b277d5 (patch) | |
tree | 3857cbd673ba3048e9afee0d9f69fba9b320f17a /api-ref | |
parent | 8e48d757e64d7f88058584bbf2c2898a7a94b619 (diff) | |
download | trove-cf3e9a6e7459e8434172e03b0b046bcbe4b277d5.tar.gz |
Support to rebuild instance by admin
Change-Id: I48f8c6f997daeb6d82ff62b3325277d86fee2147
Diffstat (limited to 'api-ref')
-rw-r--r-- | api-ref/source/instance-actions.inc | 30 | ||||
-rw-r--r-- | api-ref/source/samples/instance-mgmt-action-rebuild-instance-request.json | 5 |
2 files changed, 35 insertions, 0 deletions
diff --git a/api-ref/source/instance-actions.inc b/api-ref/source/instance-actions.inc index 15787b13..14715f20 100644 --- a/api-ref/source/instance-actions.inc +++ b/api-ref/source/instance-actions.inc @@ -311,4 +311,34 @@ Request Example --------------- .. literalinclude:: samples/instance-mgmt-action-reset-task-status-request.json + :language: javascript + + +Rebuild instance +~~~~~~~~~~~~~~~~ + +.. rest_method:: POST /v1.0/{project_id}/mgmt/instances/{instanceId}/action + +Admin only API. Rebuild the Nova server's operating system for the database +instance. The rebuild operation is mainly for Trove upgrade, especially when +the interface between Trove controller and guest agent changes. After Trove +controller is upgraded, the cloud administrator needs to send rebuild request +with the new guest image ID. Communication with the end users is needed as the +database service goes offline during the process. User's data in the database +is not affected. + +Normal response codes: 202 + +Request +------- + +.. rest_parameters:: parameters.yaml + + - project_id: project_id + - instanceId: instanceId + +Request Example +--------------- + +.. literalinclude:: samples/instance-mgmt-action-rebuild-instance-request.json :language: javascript
\ No newline at end of file diff --git a/api-ref/source/samples/instance-mgmt-action-rebuild-instance-request.json b/api-ref/source/samples/instance-mgmt-action-rebuild-instance-request.json new file mode 100644 index 00000000..99befd1f --- /dev/null +++ b/api-ref/source/samples/instance-mgmt-action-rebuild-instance-request.json @@ -0,0 +1,5 @@ +{ + "rebuild": { + "image_id": "3e50414a-8532-4646-982c-a66fe8f0411b" + } +}
\ No newline at end of file |