diff --git a/api-ref/source/api-ref-dcmanager-v1.rst b/api-ref/source/api-ref-dcmanager-v1.rst index c5bee8a2b..fc300bdaa 100644 --- a/api-ref/source/api-ref-dcmanager-v1.rst +++ b/api-ref/source/api-ref-dcmanager-v1.rst @@ -184,9 +184,9 @@ internalServerError (500), serviceUnavailable (503) This operation does not accept a request body. -****************** +******************** Creates a subcloud -****************** +******************** .. rest_method:: POST /v1.0/subclouds @@ -269,9 +269,9 @@ serviceUnavailable (503) "name": "subcloud7" } -****************************************************** +********************************************* Shows information about a specific subcloud -****************************************************** +********************************************* .. rest_method:: GET /v1.0/subclouds/​{subcloud}​ @@ -359,9 +359,9 @@ internalServerError (500), serviceUnavailable (503) This operation does not accept a request body. -****************************************************** +******************************************************** Shows additional information about a specific subcloud -****************************************************** +******************************************************** .. rest_method:: GET /v1.0/subclouds/​{subcloud}​/detail @@ -378,7 +378,7 @@ internalServerError (500), serviceUnavailable (503) **Request parameters** .. csv-table:: - :header: "Parameter", "Style", "Type", "Description" + :header: "Parameter", "Style", "Type", "Description" :widths: 20, 20, 20, 60 "subcloud", "URI", "xsd:string", "The subcloud reference, name or id." @@ -386,7 +386,7 @@ internalServerError (500), serviceUnavailable (503) **Response parameters** .. csv-table:: - :header: "Parameter", "Style", "Type", "Description" + :header: "Parameter", "Style", "Type", "Description" :widths: 20, 20, 20, 60 "id (Optional)", "plain", "xsd:int", "The unique identifier for this object." @@ -544,7 +544,7 @@ serviceUnavailable (503) Reconfigures a specific subcloud ********************************** -.. rest_method:: PATCH /v1.0/subclouds/<200b>{subcloud}<200b>/reconfigure +.. rest_method:: PATCH /v1.0/subclouds/{subcloud}/reconfigure The attributes of a subcloud which are modifiable: @@ -563,7 +563,7 @@ serviceUnavailable (503) **Request parameters** .. csv-table:: - :header: "Parameter", "Style", "Type", "Description" + :header: "Parameter", "Style", "Type", "Description" :widths: 20, 20, 20, 60 "subcloud", "URI", "xsd:string", "The subcloud reference, name or id." @@ -573,7 +573,7 @@ serviceUnavailable (503) **Response parameters** .. csv-table:: - :header: "Parameter", "Style", "Type", "Description" + :header: "Parameter", "Style", "Type", "Description" :widths: 20, 20, 20, 60 "id", "plain", "xsd:int", "The unique identifier for this object." @@ -616,9 +616,9 @@ Accepts Content-Type multipart/form-data "name": "subcloud6" } -********************************** +******************************** Reinstalls a specific subcloud -********************************** +******************************** .. rest_method:: PATCH /v1.0/subclouds/{subcloud}/reinstall @@ -638,7 +638,7 @@ serviceUnavailable (503) **Request parameters** .. csv-table:: - :header: "Parameter", "Style", "Type", "Description" + :header: "Parameter", "Style", "Type", "Description" :widths: 20, 20, 20, 60 "subcloud", "URI", "xsd:string", "The subcloud reference, name or id." @@ -693,6 +693,86 @@ serviceUnavailable (503) "deploy_status": "pre-deploy" } +******************************************************** +Restores a specific subcloud from platform backup data +******************************************************** + +.. rest_method:: PATCH /v1.0/subclouds/{subcloud}/restore + +Accepts Content-Type multipart/form-data. + + +**Normal response codes** + +200 + +**Error response codes** + +badRequest (400), unauthorized (401), forbidden (403), badMethod (405), +HTTPUnprocessableEntity (422), internalServerError (500), +serviceUnavailable (503) + +**Request parameters** + +.. csv-table:: + :header: "Parameter", "Style", "Type", "Description" + :widths: 20, 20, 20, 60 + + "subcloud", "URI", "xsd:string", "The subcloud reference, name or id." + "restore_values", "plain", "xsd:string", "The content of a file containing restore parameters (e.g. backup_filename)." + "sysadmin_password", "plain", "xsd:string", "The sysadmin password of the subcloud. Must be base64 encoded." + "with_install", "plain", "xsd:string", "The flag which indicates whether remote install is required or not (e.g. true)." + +**Response parameters** + +.. csv-table:: + :header: "Parameter", "Style", "Type", "Description" + :widths: 20, 20, 20, 60 + + "id", "plain", "xsd:int", "The unique identifier for this object." + "created_at", "plain", "xsd:dateTime", "The time when the object was created." + "updated_at", "plain", "xsd:dateTime", "The time when the object was last updated." + "name", "plain", "xsd:string", "The name provisioned for the subcloud." + "description(Optional)", "plain", "xsd:string", "The description of the subcloud." + "location(Optional)", "plain", "xsd:string", "The location of the subcloud." + "software-version", "plain", "xsd:string", "The software version of the subcloud." + "deploy_status", "plain", "xsd:string", "The deployment status of the subcloud." + "management-state", "plain", "xsd:string", "Management state of the subcloud." + "availability-status (Optional)", "plain", "xsd:string", "Availability status of the subcloud." + "management-subnet", "plain", "xsd:string", "Management subnet for subcloud in CIDR format." + "management-start-ip", "plain", "xsd:string", "Start of management IP address range for subcloud." + "management-end-ip", "plain", "xsd:string", "End of management IP address range for subcloud." + "systemcontroller-gateway-ip", "plain", "xsd:string", "Systemcontroller gateway IP Address." + "openstack-installed (Optional)", "plain", "xsd:boolean", "Whether openstack is installed on the subcloud." + "group_id (Optional)", "plain", "xsd:int", "Id of the subcloud group." + "data_install", "plain", "xsd:string", "The values of the subcloud installation." + "data_upgrade (Optional)", "plain", "xsd:string", "The values of the subcloud upgrade." + +:: + + { + "description": "subcloud description", + "management-start-ip": "192.168.204.50", + "created-at": "2018-02-25T19:06:35.208505", + "updated-at": "2018-02-25T23:01:17.490090", + "software-version": "20.06", + "management-state": "unmanaged", + "availability-status": "offline", + "openstack-installed": false, + "deploy-status": "pre-install", + "systemcontroller-gateway-ip": "192.168.204.101", + "location": "location", + "management-subnet": "192.168.204.0/24", + "management-gateway-ip": "192.168.204.1", + "management-end-ip": "192.168.204.100", + "group_id": 1, + "id": 1, + "name": "subcloud1", + "data_install": "{"bootstrap_interface": "eno1", "bootstrap_address": ...}", + "data_upgrade": null, + "deploy_status": "pre-restore" + } + ***************************** Deletes a specific subcloud ***************************** @@ -721,9 +801,9 @@ Subcloud Groups are a logical grouping managed by a central System Controller. Subclouds in a group can be updated in parallel when applying patches or software upgrades. -************************** +*************************** Lists all subcloud groups -************************** +*************************** .. rest_method:: GET /v1.0/subcloud-groups @@ -770,9 +850,9 @@ internalServerError (500), serviceUnavailable (503) This operation does not accept a request body. -************************* +************************** Creates a subcloud group -************************* +************************** .. rest_method:: POST /v1.0/subcloud-groups @@ -830,9 +910,9 @@ serviceUnavailable (503) "created-at": "2020-04-08 15:15:10.750592", } -****************************************************** +*************************************************** Shows information about a specific subcloud group -****************************************************** +*************************************************** .. rest_method:: GET /v1.0/subcloud-groups/​{subcloud-group}​ @@ -882,9 +962,9 @@ internalServerError (500), serviceUnavailable (503) This operation does not accept a request body. -****************************************************** +*************************************************** Shows subclouds that are part of a subcloud group -****************************************************** +*************************************************** .. rest_method:: GET /v1.0/subcloud-groups/​{subcloud-group}​/subclouds @@ -958,9 +1038,9 @@ internalServerError (500), serviceUnavailable (503) This operation does not accept a request body. -*********************************** +************************************ Modifies a specific subcloud group -*********************************** +************************************ .. rest_method:: PATCH /v1.0/subcloud-groups/​{subcloud-group}​ @@ -999,7 +1079,7 @@ serviceUnavailable (503) **Response parameters** .. csv-table:: - :header: "Parameter", "Style", "Type", "Description" + :header: "Parameter", "Style", "Type", "Description" :widths: 20, 20, 20, 60 "id (Optional)", "plain", "xsd:int", "The unique identifier for this object." @@ -1028,9 +1108,9 @@ serviceUnavailable (503) "updated-at": "2020-04-08 15:21:01.527101" } -********************************** +*********************************** Deletes a specific subcloud group -********************************** +*********************************** .. rest_method:: DELETE /v1.0/subcloud-groups/​{subcloud-group}​ @@ -1658,9 +1738,9 @@ These APIs allow for the display and upload of the deployment manager common files which include deploy playbook, deploy overrides, and deploy helm charts. -************************** +**************************** Show Subcloud Deploy Files -************************** +**************************** .. rest_method:: GET /v1.0/subcloud-deploy @@ -1699,9 +1779,9 @@ internalServerError (500), serviceUnavailable (503) This operation does not accept a request body. -**************************** +****************************** Upload Subcloud Deploy Files -**************************** +****************************** .. rest_method:: POST /v1.0/subcloud-deploy