142 lines
3.8 KiB
YAML
142 lines
3.8 KiB
YAML
200:
|
|
default: |
|
|
Request was successful.
|
|
image-data-200: |
|
|
The service lists the image data in the response body.
|
|
create-maintenance-session-post: |
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- session_id: uuid
|
|
|
|
.. literalinclude:: samples/create-maintenance-session-post-200.json
|
|
:language: javascript
|
|
|
|
maintenance-session-put: |
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- session_id: uuid
|
|
|
|
.. literalinclude:: samples/maintenance-session-put-200.json
|
|
:language: javascript
|
|
|
|
maintenance-sessions-get: |
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- session_id: uuid-list
|
|
|
|
.. literalinclude:: samples/maintenance-sessions-get-200.json
|
|
:language: javascript
|
|
|
|
maintenance-session-get: |
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- state: workflow-state
|
|
|
|
.. literalinclude:: samples/maintenance-session-get-200.json
|
|
:language: javascript
|
|
|
|
maintenance-session-detail-get: |
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- action: migration-type
|
|
- action_done: boolean
|
|
- created_at: datetime-string
|
|
- details: details
|
|
- disabled: boolean
|
|
- host: hostname
|
|
- hostname: hostname
|
|
- id: uuid
|
|
- instance_id: uuid
|
|
- instance_name: instance-name
|
|
- maintained: boolean
|
|
- maintenance_at: datetime-string
|
|
- meta: metadata
|
|
- percent_done: percent_done
|
|
- plugin: plugin
|
|
- prev_state: workflow-state
|
|
- project_id: uuid
|
|
- project_state: workflow-state-reply
|
|
- session_id: uuid
|
|
- state(action_plugin_instances): action-plugin-state
|
|
- state(instances): instance-state
|
|
- state: workflow-state
|
|
- type: host-type
|
|
- updated_at: datetime-string
|
|
- workflow: workflow-name
|
|
|
|
.. literalinclude:: samples/maintenance-session-detail-get-200.json
|
|
:language: javascript
|
|
|
|
project-maintenance-session-post: |
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- instance_ids: instance-ids
|
|
|
|
.. literalinclude:: samples/project-maintenance-session-post-200.json
|
|
:language: javascript
|
|
|
|
201:
|
|
default: |
|
|
Request has been fulfilled and new resource created.
|
|
202:
|
|
default: |
|
|
Request is accepted, but processing may take some time.
|
|
203:
|
|
default: |
|
|
Returned information is not full set, but a subset.
|
|
204:
|
|
default: |
|
|
Request fulfilled but service does not return anything.
|
|
300:
|
|
default: |
|
|
The resource corresponds to more than one representation.
|
|
400:
|
|
default: |
|
|
Some content in the request was invalid.
|
|
401:
|
|
default: |
|
|
User must authenticate before making a request.
|
|
403:
|
|
default: |
|
|
Policy does not allow current user to do this operation.
|
|
404:
|
|
default: |
|
|
The requested resource could not be found.
|
|
405:
|
|
default: |
|
|
Method is not valid for this endpoint and resource.
|
|
409:
|
|
default: |
|
|
This resource has an action in progress that would conflict with this request.
|
|
413:
|
|
default: |
|
|
This operation cannot be completed.
|
|
image-data-413: |
|
|
The payload cannot be accepted. Possible causes include:
|
|
* The backend storage is full.
|
|
* This request added to your existing image data exceeds your total
|
|
storage quota for images.
|
|
* The image payload submitted with this request exceeds the maximum
|
|
allowable image size.
|
|
415:
|
|
default: |
|
|
The entity of the request is in a format not supported by the requested
|
|
resource for the method.
|
|
422:
|
|
default: |
|
|
The entity of the request is not inline with resource schema
|
|
500:
|
|
default: |
|
|
Something went wrong with the service which prevents it from fulfilling
|
|
the request.
|
|
501:
|
|
default: |
|
|
The service does not have the functionality required to fulfill this
|
|
request.
|
|
503:
|
|
default: |
|
|
The service cannot handle the request right now.
|
|
509:
|
|
default: |
|
|
There is too many parallel sessions.
|