934675eca7
Update API document for API 'workers/cleanup', also remove 'until' from allowed clean keys as its value is always assigned in code. Change-Id: Iea940d7c7e52718b8e5e8dcf706aa5d1126860ef
59 lines
1006 B
ReStructuredText
59 lines
1006 B
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.
|
|
|
|
|
|
|
|
Normal response codes: 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
|