From 788dd684abf6c201a750b20a37d83cf3139d2b7d Mon Sep 17 00:00:00 2001 From: pycook Date: Tue, 17 Oct 2023 12:06:37 +0800 Subject: [PATCH] docs: api doc --- docs/cmdb_api.md | 1 + docs/cmdb_query_api.md | 4 ++++ 2 files changed, 5 insertions(+) diff --git a/docs/cmdb_api.md b/docs/cmdb_api.md index 16a45e6..c7ad6f2 100644 --- a/docs/cmdb_api.md +++ b/docs/cmdb_api.md @@ -33,6 +33,7 @@ * **`IN`**查询: 例如: `hostname:(cmdb*;cmdb-web*)` 小括号, 分号分隔 * **`范围`**查询: 例如: `hostname:[cmdb* _TO_ cmdb-web*]` `_TO_`分隔 * **`比较`**查询: 例如: `cpu_count:>5` 支持`>, >=, <, <=` + * 多个条件可以用`小括号`进行组合 * 结果字段说明 diff --git a/docs/cmdb_query_api.md b/docs/cmdb_query_api.md index 18f999f..d98a2b7 100644 --- a/docs/cmdb_query_api.md +++ b/docs/cmdb_query_api.md @@ -25,6 +25,8 @@ - `IN`查询. eg. `hostname:(cmdb*;cmdb-web*)` 小括号, 分号分隔 - `RANGE`查询. eg. `hostname:[cmdb* _TO_ cmdb-web*]` `_TO_`分隔 - `COMPARISON`查询. eg. `cpu_count:>5` 支持`>, >=, <, <=` +- 多个条件可以用`小括号`进行组合 + - 返回结果 - 搜索表达式 `/api/v0.1/ci/s?q=_type:kvm,status:在线,idc:南汇,private_ip:10.1.1.1*&page=1&fl=hostname,private_ip&facet=private_ip&count=1` - 返回数据（默认 json） @@ -91,6 +93,8 @@ - `IN`查询. eg. `hostname:(cmdb*;cmdb-web*)` 小括号, 分号分隔 - `RANGE`查询. eg. `hostname:[cmdb* _TO_ cmdb-web*]` `_TO_`分隔 - `COMPARISON`查询. eg. `cpu_count:>5` 支持`>, >=, <, <=` +- 多个条件可以用`小括号`进行组合 + - 返回结果 - 搜索表达式 `/api/v0.1/ci_relations/s?root_id=53&level=3&q=_type:kvm,status:在线,idc:南汇,private_ip:10.1.1.1*&page=1&fl=hostname,private_ip&facet=private_ip&count=1` - 返回数据（默认 json）