2e5a91da72
Rather than our freeform way of listing response codes in our api-ref, we should be using the os-api-ref extension option to get nicely formatted response code listings. https://docs.openstack.org/os-api-ref/latest/usage.html#rest-status-code Change-Id: Iee21f54fe7cf0ea28258966e2d0f8fa2849c83f2
63 lines
1.0 KiB
ReStructuredText
63 lines
1.0 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
Workers (workers)
|
|
=================
|
|
|
|
|
|
Cleanup services
|
|
~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: POST v3/{project_id}/workers/cleanup
|
|
|
|
Request cleanup of services with optional filtering. This API is only
|
|
available with microversion 3.24 or later.
|
|
|
|
|
|
Response codes
|
|
~~~~~~~~~~~~~~
|
|
|
|
.. rest_status_code:: success ../status.yaml
|
|
|
|
- 202
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: project_id_path
|
|
- cluster_name: cluster_mutex
|
|
- service_id: service_id
|
|
- host: host_service
|
|
- binary: binary
|
|
- is-up: is_up
|
|
- disabled: disabled
|
|
- resource-id: resource_id
|
|
- resource-type: resource_type
|
|
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: ./samples/worker-cleanup-request.json
|
|
:language: javascript
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- host: host_service
|
|
- binary: binary
|
|
- id: service_id
|
|
- cluster_name: cluster_mutex
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ./samples/worker-cleanup-response.json
|
|
:language: javascript
|