venus/api-ref/source/v1/custom-config.inc
inspurericzhang 320518ab99 fix detail of api inc and json files
Change-Id: I81d1cd1d6d39c5fc9d2352735ad7c1e4c39a94b8
2022-09-14 09:02:20 +00:00

35 lines
623 B
ReStructuredText

.. -*- rst -*-
Custom Config
=============
Users can customize some important configurations, such as the retention days of ElasticSearch index.
However, only these configurations can be read now, implement modification later.
Get Custom Config
~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v1/custom_config
Get all custom config.
Response codes
--------------
.. rest_status_code:: success ../status.yaml
- 1
.. rest_status_code:: error ../status.yaml
- -1
Response
--------
**Example: JSON response**
.. literalinclude:: ./samples/custom-config/custom-config-show-response.json
:language: javascript