From 390a59d052d8890d7a165f13445b22191dc6b361 Mon Sep 17 00:00:00 2001 From: inspurericzhang Date: Thu, 23 Feb 2023 02:49:17 +0000 Subject: [PATCH] adjust api document structure Change-Id: I5046262e8cc2223ae70693ef43dd7c500a5ca049 --- api-ref/source/v1/index.rst | 8 +- api-ref/source/v1/search.inc | 291 +++++++++++++++++++++++++++++++++++ 2 files changed, 292 insertions(+), 7 deletions(-) create mode 100644 api-ref/source/v1/search.inc diff --git a/api-ref/source/v1/index.rst b/api-ref/source/v1/index.rst index f576fb0..af57c9b 100644 --- a/api-ref/source/v1/index.rst +++ b/api-ref/source/v1/index.rst @@ -13,10 +13,4 @@ OpenStack Log API V1 (CURRENT) .. include:: custom-config.inc .. search log document. -.. include:: search-params.inc -.. include:: search-logs.inc -.. include:: search-logs-download.inc -.. include:: search-analyse-logs.inc -.. include:: search-typical-logs.inc -.. include:: search-instance-requestids.inc -.. include:: search-instance-callchain.inc +.. include:: search.inc diff --git a/api-ref/source/v1/search.inc b/api-ref/source/v1/search.inc new file mode 100644 index 0000000..ac018be --- /dev/null +++ b/api-ref/source/v1/search.inc @@ -0,0 +1,291 @@ +.. -*- rst -*- + +Search API +============= + +Get Search Params +~~~~~~~~~~~~~~~~~ + +.. rest_method:: GET /v1/search/params + +Get the value list of one search parameter. + +Response codes +-------------- + +.. rest_status_code:: success ../status.yaml + + - 0 + +.. rest_status_code:: error ../status.yaml + + - -1 + +Request +------- + +.. rest_parameters:: parameters.yaml + + - type: param_type + - module_name: module_name + - index_type: index_type + +Response +-------- + +**Example: JSON response** + + +.. literalinclude:: ./samples/search-log/search-params-show-response.json + :language: javascript +.. -*- rst -*- + + +Search logs of all modules +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. rest_method:: GET /v1/search/logs + +Search logs. + +Request +------- + +.. rest_parameters:: parameters.yaml + + - host_name: host_name + - module_name: module_name + - program_name: program_name + - level: level + - user_id: user_id + - project_id: project_id + - query: query + - start_time: start_time + - end_time: end_time + - page_num: page_num + - page_size: page_size + - index_type: index_type + +Response codes +-------------- + +.. rest_status_code:: success ../status.yaml + + - 1 + +.. rest_status_code:: error ../status.yaml + + - 0 + - -1 + +Response +-------- + +**Example: JSON response** + + +.. literalinclude:: ./samples/search-log/search-logs-show-response.json + :language: javascript +.. -*- rst -*- + + +Search logs download of all modules +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. rest_method:: GET /v1/search/logs/download + +Download the search logs of all Venus modules. + +Response codes +-------------- + +.. rest_status_code:: success ../status.yaml + + - 1 + +.. rest_status_code:: error ../status.yaml + + - 0 + - -1 + +Request +------- + +.. rest_parameters:: parameters.yaml + + - host_name: host_name + - module_name: module_name + - program_name: program_name + - level: level + - user_id: user_id + - project_id: project_id + - query: query + - start_time: start_time + - page_size: page_size + - index_type: index_type + +Response +-------- + +**Example: JSON response** + + +.. literalinclude:: ./samples/search-log/search-logs-download-show-response.json + :language: javascript +.. -*- rst -*- + + +Search analyse logs of all modules +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. rest_method:: GET v1/search/analyse/logs + +Search host_name, module_name,program_name,level more informations for all Venus modules analyse logs. + +Response codes +-------------- + +.. rest_status_code:: success ../status.yaml + + - 1 + +.. rest_status_code:: error ../status.yaml + + - 0 + - -1 + +Request +------- + +.. rest_parameters:: parameters.yaml + + - group_name: group_name + - host_name: host_name + - module_name: module_name + - program_name: program_name + - level: level + - start_time: start_time + - end_time: end_time + +Response +-------- + +**Example: JSON response** + + +.. literalinclude:: ./samples/search-log/search-analyse-logs-show-response.json + :language: javascript +.. -*- rst -*- + + +Search typical error logs of all modules +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. rest_method:: GET v1/search/typical/logs + +Search host_name, module_name,program_name,level more informations for all Venus modules typical error logs. + +Response codes +-------------- + +.. rest_status_code:: success ../status.yaml + + - 1 + +.. rest_status_code:: error ../status.yaml + + - 0 + - -1 + +Request +------- + +.. rest_parameters:: parameters.yaml + + - type: typical_log_type + - start_time: start_time + - end_time: end_time + +Response +-------- + +**Example: JSON response** + + +.. literalinclude:: ./samples/search-log/search-typical-logs-show-response.json + :language: javascript +.. -*- rst -*- + + +Search the list of instance request id +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. rest_method:: GET v1/search/instance/request_ids + +Search instance request id from a start time to end time + +Response codes +-------------- + +.. rest_status_code:: success ../status.yaml + + - 1 + +.. rest_status_code:: error ../status.yaml + + - 0 + - -1 + +Request +------- + +.. rest_parameters:: parameters.yaml + + - start_time: start_time + - end_time: end_time + +Response +-------- + +**Example: JSON response** + + +.. literalinclude:: ./samples/search-log/search-instance-request-ids-show-response.json + :language: javascript +.. -*- rst -*- + + +Search instance callchain of all modules +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. rest_method:: GET /v1/search/instance/callchain + +Search nova-api, nova-conductor, nova-scheduler and nova-compute informations for all Venus modules instance callchain + +Response codes +-------------- + +.. rest_status_code:: success ../status.yaml + + - 1 + +.. rest_status_code:: error ../status.yaml + + - 0 + - -1 + +Request +------- + +.. rest_parameters:: parameters.yaml + + - request_id: request_id + +Response +-------- + +**Example: JSON response** + + +.. literalinclude:: ./samples/search-log/search-instance-callchain-show-response.json + :language: javascript