Files
cloudkitty/doc/source/api-reference/v2/scope/scope.inc
Rafael Weingärtner 70114c829e Deprecate state field and propose last_processed_timestamp field
Changes the `state` field in `cloudkitty_storage_states` table.
The goal is to use a more descriptive and meaningful name.
The proposed new column name is `last_processed_timestamp`.

Depends-on: https://review.opendev.org/c/openstack/cloudkitty/+/793973
Depends-on: https://review.opendev.org/c/openstack/cloudkitty/+/797443

Change-Id: I9e29808dc5771a6455d3c564f080e8c2ec28dc72
Implements: https://review.opendev.org/c/openstack/cloudkitty-specs/+/771513
2021-06-23 10:57:00 -03:00

84 lines
1.5 KiB
HTML

====================
Scope state endpoint
====================
Get the status of several scopes
================================
Returns the status of several scopes.
.. rest_method:: GET /v2/scope
.. rest_parameters:: scope/scope_parameters.yml
- collector: collector
- fetcher: fetcher
- limit: limit
- offset: offset
- scope_id: scope_id
- scope_key: scope_key
Status codes
------------
.. rest_status_code:: success http_status.yml
- 200
.. rest_status_code:: error http_status.yml
- 400
- 403
- 404
- 405
Response
--------
.. rest_parameters:: scope/scope_parameters.yml
- collector: collector_resp
- fetcher: fetcher_resp
- state: state
- last_processed_timestamp: last_processed_timestamp
- scope_id: scope_id_resp
- scope_key: scope_key_resp
Response Example
----------------
.. literalinclude:: ./api_samples/scope/scope_get.json
:language: javascript
Reset the status of several scopes
==================================
Reset the status of several scopes.
.. rest_method:: PUT /v2/scope
.. rest_parameters:: scope/scope_parameters.yml
- state: state
- last_processed_timestamp: last_processed_timestamp
- collector: collector_body
- fetcher: fetcher_body
- scope_id: scope_id_body
- scope_key: scope_key_body
- all_scopes: all_scopes
Status codes
------------
.. rest_status_code:: success http_status.yml
- 202
.. rest_status_code:: error http_status.yml
- 400
- 403
- 404
- 405