智能日志管理平台

  • 日志分析服务 API

    最近更新时间:2018-07-16 15:59:38

    API 接收地址

    https://nb-insight.qiniuapi.com

    API返回内容

    • 所有参数默认大小写敏感

    响应报文

    • 如果请求成功,返回HTTP状态码200:
    HTTP/1.1 200 OK
    
    • 如果请求失败,返回包含如下内容的JSON字符串(已格式化,便于阅读):
    {
        "error":   "<errMsg    string>"
    }
    
    • 如果请求包含数据获取,则返回相应数据的JSON字符串;

    创建日志仓库

    请求语法

    POST /v5/repos/<RepoName>
    Content-Type: application/json
    Authorization: Pandora <auth>
    {
      "region": <Region>,
      "retention": <Retention>,
      "fullText":{
        "enabled":true, 
        "analyzer":""  
      },
      "schema": [
        {
          "key": <Key>,
          "valtype": <ValueType>,
          "analyzer":<AnalyzerName>
        },
        "analyzers":[
            {
                "analyzerName":<AnalyzerName>,
                "options":{
                    <key>:<Value>,
                    ....
                }
            }
        ],
        "children":{
            <ChildName>:{
                "schema":[
                    ....
                ]
            }
        },
        "similarity":{
            "name":<Name>,
            "options":{
                "type":<Type>,
                <Key>:<Value>,
                ....
            }
        }
        ...
      ]
    }
    

    请求内容

    参数 类型 必填 说明
    RepoName string 日志仓库名称,用来标识该日志仓库的唯一性;
    命名规则: ^[a-z][a-z0-9_]{0,127}$
    region string 所属区域,计算与存储所使用的物理资源所在区域,目前支持华东区域(代号nb);
    此参数是为了降低用户传输数据的成本,应当尽量选择离自己数据源较近的区域
    retention string 数据存储时限,1天=1d,最大支持30天
    fullText.enabled bool 是否开启全文索引,默认为false,不开启全文索引
    fullText.analyzer string 全文索引使用的分词器,和schema.analyzer意义相同,见analyzers定义。
    schema json 字段信息
    key string 字段名称,用来标识该字段的唯一性;
    命名规则: ^[a-zA-Z_][a-zA-Z0-9_]{0,60}$
    valtype string 字段类型,目前支持stringfloatlongboolean,dateip,geo_pointobject共8种类型;
    其中date支持RFC3339NanoRFC3339Nano(Numeric time zone offsets format)
    例:2006-01-02T15:04:05.999999999Z07:002006-01-02T15:04:05.999999999+08:00;geo_point为经纬度坐标,如 [ -71.34, 41.12 ]
    schema.analyzer string 文本分词方式,支持standard,whitespace,index_ansj(中文分词),keyword,no5种内置分词方式;同时支持pattern类型的自定义分词器,见analyzers定义。
    analyzers json 高级用户自定义分词器,解释见详解。
    children json 定义子repo,详情见children详解。

    分词方式详解:

    分词器简单来说定义了两个方面:

    1. 如何将一段文档划分为多个词
    2. 如何对这些词做过滤和处理
    

    下面通过阐述一个简单的例子来对分词器如何工作做一个简单的说明。

    实例文档:

    The 2 QUICK Brown-Foxes jumped over the lazy dog's bone.
    

    简单来说文档在索引的过程中会有以下两个个步骤,了解这个步骤有助于用户理解如何更好的使用LOGDB进行搜索。

    1. 解析此document为多个token,token通常指以非字母数字结束的一个字符串(还有其他的区分方式,比如),比如'apple+orange'则为两个token 'apple' 'orange'
    2. 进入TokenFilter阶段,即是对每个Token根据所选择的分词器做过滤处理。比如下面几个常见的filter
    
            * lowercase filter,将所有字母变为小写
            * stopword filter, 过滤掉所有定义的stopword,一些常见的比如 'a','the'等
            * 其他特殊的filter。
    

    standard

    划分document时以unicode字符作为结束的标志,然后过滤掉大部分标点符号,将所有字母变为小写。如果不清楚选择哪个分词器,默认使用这个。
    
    unicode字符:详见http://unicode.org/reports/tr29/
    
    standard分词器处理后,实例文档变为:`the, 2, quick, brown, foxes, jumped, over, the, lazy, dog's, bone`几个词
    

    keyword

    document不划分,整体作为个token。如果字段为ID、国家等类似的时,强烈建议选择此分词器
    

    whitespace

    划分document时,碰到空格即认为一个token的结束
    
    whitespace分词器处理后,实例文档变为:  `The, 2, QUICK, Brown-Foxes, jumped, over, the, lazy, dog's, bone.`
    
    
    keyword分词器处理后,实例文档变为: `The 2 QUICK Brown-Foxes jumped over the lazy dog's bone.`。 注意:此时搜索单个单词无法匹配到该数据,只能输入全部的docuemtn才能成功匹配。
    

    no

    不分词不索引。 不能直接通过条件搜索到
    

    index_ansj

     根据中文语义分词,目前基于我们的系统词库来做分词依据
    

    ###高级用户自定义分词详解

    目前支持只支持 type="pattern"。

    下面定义一个type为pattern的例子。

    stopwords表示停词,会在索引时被过滤掉。在下面例子中,如果文本中有‘bug',那么搜索时则不会被搜索到。

    pattern使用正则表达如何划分document,比如 "[^\\w]+"表示按 非字母分词,那么text=type_1-type_4,会被分为:"type_1","type_4"两个词。

    定义好后,则可以在schema中的analyzer字段指明使用testAnalyzerName

    例子:

    {
                "analyzerName":"testAnalyzerName",
                "options":{
                     "type":"pattern",
                     "stopwords":["bug"],
                     "pattern":"[^\\w]+"
                }
    }
    

    children详解:

    一个repo中使用children对Docs做父子关联

    Docs父子关联是指在docs之间建立一个parent-child关系,用于相互关联表示一对多的关系。和嵌套类型相比较而言,有以下优势:

    1. 被指定为parent的docs可以直接更新,而不用更新所有的子doc。如果使用嵌套类型,则需要更新整个doc。

    2. children的docs可以做增删改查操作,而不用影响parent功能。当子doc的数量非常庞大并且需要经常性的增加或者修改时,这个特性非常关键。

      使用示例

    创建一个LogDB的RepotestRepo示例

    {
      "region": "nb",
      "retention": "-1",
      "children": {
        "myChildRepo": {
          "schema": [
            {
              "key": "k2",
              "valtype": "string",
              "primary": true
            }
          ]
        }
      },
      "schema": [
        {
          "key": "k1",
          "valtype": "geo_point"
        },
        {
          "key": "id",
          "valtype": "string",
          "primary": true
        }
      ]
    }
    
    
    
    • children 表示子Repo。(我们创建的testRepo默认为parent
    • myChildRepo 表示用户自定义的子repo名字,需要对child repo定义schema,schema中必须选择一个string字段作为主键primary:true

    打点示例

    • 打点分为两类,一类是直接打点给parent repo,第二类是给children下的repo打点。Parent repo打点时和普通打点一样。

    • 打点到parent repo

    {
         "k1":[1,2],
         "id":"mainRepoUuid
    }
    

    下面介绍children Repo打点时需要关联parent docs时的打点方式。

    • 打点到child repo
    {
        "k2":"testk2data",
        "__parent":"mainRepoUuid",
        "__type":"myChildRepo"
    }
    
    • __parent 字段指明需要关联的Doc ID,这里等于刚才主Repo中的数据中id=mainRepoUuid
    • __type 字段指明该Doc属于哪个children,这里使用的是创建repo时指定的myChildRepo

    关联查询示例

    比如现在想要查询 myChildRepo中关联了 id=mainRepoUuid的doc

    q=id:mainRepoUuid&scope=myChildRepo&has_parent=testRepo

    • q是关联条件,这里一般为 <指定的ID Key Name>:<ID Value>
    • scope是搜索的范围,比如这里我要搜索的是myChildRepo下的关联了mainRepoUuid的数据。

      ####反过来

      比如现在想要查询主repo中关联了myChildRepok2:testk2data的doc

      q=k2:testk2data&scope=testRepo&has_child=myChildRepo

    schema.valtype.object 类型:

    object是一个json对象,下面例子中的work字段即为object类型,其中keystring类型,value的类型会根据实际数据进行推断。凡是object类型的字段会被自动索引,被索引后,可以通过work.address作为key进行搜索。

       [
            {
                "name":"testName",
                "work":{
                    "address":"workAddress",
                    "name":"workName",
                    "salary":111.00
                },
                "timestamp":"2016-05-10T15:00:00+08:00"
            }
        ]   
    

    示例

    curl -X POST https://nb-insight.qiniuapi.com/v5/repos/test_repo \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Pandora 2J1e7iG13J66GA8vWBzZdF-UR_d1MF-kacOdUUS4:NTi3wH_WlGxYOnXsvgUrO4XMD6Y=' \
    -d '{
      "region": "nb",
      "retention": "1d"
      "schema": [
        {
          "key": "userName",
          "valtype": "string",
        },
        {
          "key": "createDate",
          "valtype": "date"
        }
      ]
    }'
    

    查询日志

    查询接口请求语法

    POST /v5/repos/<RepoName>/search
    Content-Type: application/json
    Authorization: Pandora <auth>
    {  
       "size":<size>,
       "query":"<QueryString>",
       "scroll":"3m",
       "sort":"userName:asc",
       "from":1,
       "fields":"<F1>,<F2>",
       "highlight":{  
          "pre_tags":[  
             "<tag1>"
          ],
          "post_tags":[  
             "</tag1>"
          ],
          "fields":{  
             "<高亮的字段>":{  
    
             }
          },
          "require_field_match":false,
          "fragment_size":100
       }
    }
    

    查询接口请求说明

    字段 类型 必填 说明
    RepoName string 日志仓库名称
    query string 查询表达式,参照查询语法
    sort string 排序,field1:asc,field2:desc, …。field 是实际字段名,asc代表升序,desc 代表降序。用逗号进行分隔。
    from int 日志开始的位置
    size int 返回数据数量
    scroll string scroll查询时ScrollID保存时间,如果不需要通过游标的方式拉取大量数据,可不填
    fields string 选择返回的数据中只展示部分字段。比如 fields=k1,k2,则返回的结果中只有k1,和k2字段
    highlight map 返回结果高亮配置
    highlight.pre_tags string数组 表示高亮元素的前置标签,通常为<em>
    highlight.post_tags string数组 表示高亮元素的后置标签,通常为</em>
    highlight.fields map 表示要高亮的字段,以及其高亮设置,比如设置高亮的窗口大小
    highlight.require_field_match bool 表示是否必须要强制匹配搜索符合的结果高亮,默认为false
    highlight.fragment_size int 高亮的最大字符窗口大小

    示例

    curl -X POST https://nb-insight.qiniuapi.com/v5/repos/test_Repo/search \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Pandora 2J1e7iG13J66GA8vWBzZdF-UR_d1MF-kacOdUUS4:NTi3wH_WlGxYOnXsvgUrO4XMD6Y=' \
    -d '{"size":1,"query":"content:test","sort":"userName:asc","from":1,"highlight":{"pre_tags":["<tag1>"],"post_tags":["</tag1>"],"fields":{"<高亮的字段>":{}},"require_field_match":false,"fragment_size":100}}'
    
    {
        "total": 10,
        "partialSuccess": false,
        "data": [
            {
                "content": "test",
                "highlight": {
                    "content": [
                        "<tag>test<tag/>"
                    ]
                }
            }
        ]
    }
    

    MSearch请求语法

    和elasticsearch msearch接口一样,可以对多个repo进行搜索、分析。细节移步https://www.elastic.co/guide/en/elasticsearch/reference/2.3/search-multi-search.html

    POST /v5/logdbkibana/msearch
    Authorization: Pandora <auth>
    Content-Type: text/plain
    {"index":["repo0"]}
    {"size":1,"sort":[{"timestamp":{"order":"desc"}}],"query":{"query_string":{"query":"*"}}}
    {"index":["repo1"]}
    {"size":1,"sort":[{"timestamp":{"order":"desc"}}],"query":{"query_string":{"query":"*"}}}
    

    MSearch请求说明

    字段 类型 必填 说明
    index string 日志仓库名称

    示例

    curl -X POST https://nb-insight.qiniuapi.com/v5/logdbkibana/msearch \
    -H 'Content-Type: text/plain' \
    -H 'Authorization: Pandora 2J1e7iG13J66GA8vWBzZdF-UR_d1MF-kacOdUUS4:NTi3wH_WlGxYOnXsvgUrO4XMD6Y=' \
    -d '{"index":["repo0"]}\n{"size":1,"sort":[{"timestamp":{"order":"desc"}}],"query":{"query_string":{"query":"*"}}}'
    
    {
        "responses": [
            {
                "took": 166,
                "hits": {
                    "total": 10,
                    "max_score": 1,
                    "hits": [
                        {
                            "_source": {
                                "content": "test"
                            }
                        }
                    ]
                }
            }
        ]
    }
    

    PartialSearch请求语法

    POST /v5/repos/<RepoName>/s
    Content-Type: text/plain
    Authorization: Pandora <auth>
    {
        "query_string": <query_string>,
        "sort": <timestamp>,
        "size": <size>,
        "startTime": <timestamp>,
        "endTime": <timestamp>,
        "searchType": <searchType>,
        "highlight": {
            "pre_tag": "<pre_tag>",
            "post_tag": "<post_tag>"
        }
    }
    

    PartialSearch请求说明

    适用于非永久存储的repo且具有时间字段的repo查询,该接口针对超大规模日志进行优化。

    字段 类型 必填 说明
    RepoName string 日志仓库名称
    query_string string 查询表达式,参照查询语法
    sort string 时间排序字段,比如sort:fieldName
    size int 返回数据数量
    pre_tags string 表示高亮元素的前置标签,通常为<em>
    post_tags string 表示高亮元素的后置标签,通常为</em>
    startTime int 开始时间,毫秒时间戳
    endTime int 结束时间,毫秒时间戳
    searchType int 搜索模式:混合模式:0,searching模式:1,直方图模式:2

    示例

    curl -X POST https://nb-insight.qiniuapi.com/v5/test_Repo/s \
    -H 'Content-Type: text/plain' \
    -H 'Authorization: Pandora 2J1e7iG13J66GA8vWBzZdF-UR_d1MF-kacOdUUS4:NTi3wH_WlGxYOnXsvgUrO4XMD6Y=' \
    -d '{"query_string":"*","sort":"time","size":10,"startTime":1483203661000,"endTime":1483203663000,"searchType":1}'
    
    {
            "process": 0.5,
            "total": 20,
            "took": 28,
            "partialSuccess": true,
            "hits": [
                {
                    "content": "test"
                }
            ],
            "buckets": [
                {
                    "key": 1498124340000,
                    "count": 2
                },
                {
                    "key": 1498124370000,
                    "count": 2
                }
            ]
    }
    
    curl -X POST https://nb-insight.qiniuapi.com/v5/test_Repo/s \
    -H 'Content-Type: text/plain' \
    -H 'Authorization: Pandora 2J1e7iG13J66GA8vWBzZdF-UR_d1MF-kacOdUUS4:NTi3wH_WlGxYOnXsvgUrO4XMD6Y=' \
    -d '{"query_string":"*","sort":"time","size":10,"startTime":1483203661000,"endTime":1483203663000,"searchType":1}'
    
    {
            "process": 1,
            "total": 20,
            "took": 28,
            "partialSuccess": false,
            "hits": [
                {
                    "content": "test"
                }
            ],
            "buckets": [
                {
                    "key": 1498124340000,
                    "count": 5
                },
                {
                    "key": 1498124370000,
                    "count": 5
                }
            ]
    }
    

    循环调用partialsearch直到partialSuccess=false停止.

    Scroll请求语法

    scroll接口用于拉取大规模数据,需要配合搜素日志查询接口来使用。

    POST /v5/repos/<RepoName>/scroll
    Content-Type: application/json
    Authorization: Pandora <auth>
    {
        "scroll_id": <scroll_id>,
        "scroll": <scroll>
    }
    

    Scroll请求说明

    字段 类型 必填 说明
    scroll_id string 使用上一次返回到的ID,用户抽取下一批结果
    scroll string 维护这个批量拉取上下文的时间,比如1m,1h等

    示例

    curl -X POST https://nb-insight.qiniuapi.com/v5/repos/test_Repo/search \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Pandora 2J1e7iG13J66GA8vWBzZdF-UR_d1MF-kacOdUUS4:NTi3wH_WlGxYOnXsvgUrO4XMD6Y=' \
    -d '{"size":1,"query":"content:test","scroll":"3m","sort":"userName:asc","from":1}'
    
    {
        "scroll_id":"scroll_id1",
        "total": 10,
        "partialSuccess": false,
        "data": [
            {
                "content": "test",
                "highlight": {
                    "content": [
                        "<tag>test<tag/>"
                    ]
                }
            }
        ]
    }
    
    curl -X POST https://nb-insight.qiniuapi.com/v5/scroll \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Pandora 2J1e7iG13J66GA8vWBzZdF-UR_d1MF-kacOdUUS4:NTi3wH_WlGxYOnXsvgUrO4XMD6Y=' \
    -d '{"scroll":"3m","scroll_id":"scroll_id1"}'
    
    {
        "scroll_id":"scroll_id2"
        "total": 10,
        "partialSuccess": false,
        "data": [
            {
                "content": "test",
                "highlight": {
                    "content": [
                        "<tag>test<tag/>"
                    ]
                }
            }
        ]
    }
    
    curl -X POST https://nb-insight.qiniuapi.com/v5/scroll \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Pandora 2J1e7iG13J66GA8vWBzZdF-UR_d1MF-kacOdUUS4:NTi3wH_WlGxYOnXsvgUrO4XMD6Y=' \
    -d '{"scroll":"3m","scroll_id":"scroll_id2"}'
    
    {
        "scroll_id":""
        "total": 10,
        "partialSuccess": false,
        "data": []
    }
    

    当scroll_id为空或者data为空的时候,表示数据批量拉取完成。

    查询语法

    关键字

    名称 语义
    AND query1 AND query2,查询交集
    OR query1 OR query2,查询并集
    NOT query1 NOT query2,表示符合query1,不符合query2的结果
    () 把一个或多个query合并成一个query,提升优先级
    [] 区间查询,包括边界
    {} 区间查询,不包括边界
    \ 转义字符
    >,=,<,<=,>= 区间查询

    查询举例

    • 字段field包括a的log:field:a
    • 字段field包括a,b的log:field:a OR field:b
    • 字段field包含a或者b,不包含c:(field:a OR field:b) AND (NOT field:c)
    • 字段field1包括a,b同时域field2包括c的log:(field1:a OR field1:b) AND (field2:c)
    • 2017-1-1 12:00到2016-1-2 12:00的数据:date:[2017-01-01T12:00:27.87+08:00 TO 2017-02-01T12:00:27.87+08:00]
    • 在数字1-5之间的log: count:[1 TO 5]
    • 大于5的log: count:>5
    • 包含hello,world,同时二者之间有5个单词相隔:field:"hello world"~5

    响应报文

    200 OK
    Content-Type: application/json
    {
        "total": <Total>,
        "partialSuccess": <partialSuccess>,
        "data": [
            {
               "id": "<ID>",
               "<Key>": "<Value>",
               ...
            },
            ...
        ]
    }
    

    响应内容

    参数 类型 必填 说明
    total int - 共有多少结果数据
    partialSuccess bool - true时,说明该次查询涉及的数据量比较大,需要较久的时间,我们将提前结束,并返回部分结果
    data json - 数据结果集
    id string - 系统自动生成,表示该条数据的唯一性
    key string - 字段名称,value为此条数据内容

    请求报文示例

    curl -G https://nb-insight.qiniuapi.com/v5/repos/search?q="count:>=10 AND <20"&sort="userName:asc"&from=1&size=100 \
    -H 'Authorization: Pandora 2J1e7iG13J66GA8vWBzZdF-UR_d1MF-kacOdUUS4:NTi3wH_WlGxYOnXsvgUrO4XMD6Y=' 
    

    响应报文示例

    200 OK
    Content-Type: application/json
    {
        "total": 100,
        "partialSuccess": true,
        "buckets": [
            {
               "id": "AVczSkfVrDpcIhsMRsgK",
               "userName": "xiaowang",
            },
            ...
        ]
    }
    

    搜索结果高亮示例

    Highlight是指用户可以在搜索中自定义高亮的标签。

    参数 highlight=true

    GET请求示例:

        curl -G https://nb-insight.qiniuapi.com/v5/repos/search?q="count:>=10 AND <20"&sort="userName:asc"&from=1&size=100&highlight=true \
        -H 'Authorization: Pandora 2J1e7iG13J66GA8vWBzZdF-UR_d1MF-kacOdUUS4:NTi3wH_WlGxYOnXsvgUrO4XMD6Y='  \
        -d    '{
              "pre_tags":[
                     "<em>"
              ],
              "post_tags":[
                     "</em>"
              ],
              "fields":{
                  "name":{}    # name表示字段名称,value为{}即可
              }
            }'
    

    POST请求示例:

        curl -XPOST https://nb-insight.qiniuapi.com/v5/repos/search \
          -H 'Authorization: Pandora 2J1e7iG13J66GA8vWBzZdF-UR_d1MF-kacOdUUS4:NTi3wH_WlGxYOnXsvgUrO4XMD6Y='  \
        -d '{  
          "size":2,
          "query":"count:>=10 AND <20",
          "scroll":"3m",
          "from":1,
          "sort":"userName:asc",
          "highlight":{  
              "pre_tags":[  
                "<em>"
              ],
              "post_tags":[  
                "</em>"
              ],
              "fields":{  
                "a":{  
    
                }
              },
              "require_field_match":false,
              "fragment_size":100
          }
        }'
    

    返回示例:

            '{
                "total":1,
                "partialSuccess":false,
                "data": [
                    {
                        "name":"exampleName",
                        "timestamp":"2006-01-02T15:04:05.999999999+08:00",
                        "work":"es3",
                        "highlight":{
                            "name": [
                                "<em> exampleName </em>"
                            ]
                        }
                    }
                ]
            }'
    

    必选字段解释:

    • fields 是指需要高亮的字段.

    可选字段解释:

    • pre\_tagspost\_tags 是指包着被高亮文本的标签。默认是 <em></em>

    根据时间聚合日志

    请求语法

    GET /v5/repos/<RepoName>/histogram?q=<QueryString>&from=<StartTimestamp>&to=<EndTimestamp>&field=<AggregationField>
    Authorization: Pandora <auth>
    

    请求内容

    参数 类型 必填 说明
    RepoName string 日志仓库名称
    q string 查询表达式,参照查询语法
    from long 聚合的开始时间戳,例如: 1470163291000
    to long 聚合的结束时间戳,例如: 1470336091000
    field string 聚合的字段,该字段必须为date

    !> 注意: 根据时间聚合日志返回的是用户选择的时间段内日志的分布情况。

    更新日志仓库

    请求语法

    PUT /v5/repos/<RepoName>
    Content-Type: application/json
    Authorization: Pandora <auth>
    {
      "retention": <Retention>
      "schema": [
        {
          "key": <Key>,
          "valtype": <ValueType>
        },
        ...
      ]
    }
    

    更新repo的注意事项:

    • 更新repo目前支持增加repo字段、修改字段分词
    • 更新repo不支持删减字段,不支持修改字段类型
    • 增加repo字段是立即生效的,更新repo的字段分词是延迟生效的,一般情况下,更新的repo字段的分词生效时间需要2天,即今天更新的repo schema,要后天凌晨才生效。
    • 在更新的repo 分词生效之前,数据依旧只能以原来的形式分词, 且新的分词更新生效后,也只对新数据生效。

    示例

    curl -X POST https://nb-insight.qiniuapi.com/v5/repos/test_repo \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Pandora 2J1e7iG13J66GA8vWBzZdF-UR_d1MF-kacOdUUS4:NTi3wH_WlGxYOnXsvgUrO4XMD6Y=' \
    -d '{
      "retention": "1d"
      "schema": [
        {
          "key": "userName",
          "valtype": "string"
        },
        {
          "key": "createDate",
          "valtype": "date"
        }
      ]
    }'
    

    删除日志仓库

    请求语法

    DELETE /v5/repos/<RepoName>
    Authorization: Pandora <auth>
    

    根据名称查询日志仓库

    请求语法

    GET /v5/repos/<RepoName>
    Authorization: Pandora <auth>
    

    请求内容

    参数 类型 必填 说明
    RepoName string 日志仓库名称

    响应报文

    200 OK
    {
      "region": <Region>,
      "retention": <Retention>
      "schema": [
        {
          "key": <Key>,
          "valtype": <ValueType>
        },
        ...
      ],
      "createTime": <CreateTime>,
      "updateTime": <UpdateTime>
    }
    

    响应内容

    参数 类型 必填 说明
    region string - 所属区域
    retention string - 存储时限
    schema json - 字段信息
    createTime string - 创建时间
    updateTime string - 更新时间

    查询所有日志仓库

    请求语法

    GET /v5/repos
    Authorization: Pandora <auth>
    

    响应报文

    200 OK
    Content-Type: application/json
    {
      repos: [
        {
          "name": <RepoName>,
          "region": <RegionName>,
          "retention": <Retention>
          "createTime": <CreateTime>,
          "updateTime": <UpdateTime>
        },
        ...
      ]
    }
    

    响应内容

    参数 类型 必填 说明
    name string - 日志仓库名称
    region string - 所属区域
    retention string - 存储时限
    createTime string - 创建时间
    updateTime string - 更新时间

    创建和更新的分词器生效时间同更新repo后

    创建 Analyzer

    请求语法

    POST /v5/repo/<RepoName>/analyzer
    Authorization: Pandora <auth>
    Content-Type: application/json
    [
        {
            "key":"<KEY>",
            "analyzer":{
                "analyzerName":"<AnalyzerName>",
                "options":{
                     "type":"<TYPE>",
                     "stopwords":["word1","word2"...],
                     "pattern":"PATTERN"
                }
    
            }
        }
    ]
    

    返回包:

    200 OK
    

    更新分词器

    请求包:

    PUT /v5/repo/<RepoName>/analyzer
    Authorization: Pandora <auth>
    Content-Type: application/json
    [
        {
            "key":"<KEY>",
            "analyzer":{
                "analyzerName":"<AnalyzerName>",
                "options":{
                     "type":"<TYPE>",
                     "stopwords":["word1","word2"...],
                     "pattern":"PATTERN"
                }
            }
        }
    ]
    

    返回包:

    200 OK
    

    查询分词器

    请求包:

    GET /v5/repo/<RepoName>/analyzer
    Authorization: Pandora <auth>
    

    返回包

    Content-Type: application/json
    [{
        "analyzerName":"<AnalyzerName>",
        "options":{
             "type":"<TYPE>",
             "stopwords":["word1","word2"...],
             "pattern":"PATTERN"
        }
    }]
    

    删除分词器

    请求包:

    DELETE /v5/repo/<RepoName>/analyzer/<AnalyzerName>
    Authorization: Pandora <auth>
    

    返回包:

    200 OK
    

    错误代码及相关说明

    通用错误

    http code error message 说明
    400 E8001: Invalid arguments 参数不合法
    500 E8004: Internal server error 服务器内部错误

    仓库(Repo)相关错误

    http code error message 说明
    400 E8101: Missing required Repo reponame为空
    400 E8102: Missing required Retention retention为空
    400 E8103: Missing required Region region为空
    400 E8104: The data you provided is not match with your repo schema 打点格式错误
    400 E8105: The Repo you provided is invalid 提供的reponame不合法
    400 E8106: The Retention you provided is invalid 提供的retention不合法
    400 E8107: The Region you provided is invalid 提供的region不合法
    400 E8108: The Schema you provided is invalid 提供的Schema不合法
    404 E8111: The specified repo does not exist under the provided appid repo不存在
    409 E8112: The specified repo already exists under the provided appid repo已存在
    400 E8113: The request frequency is beyond limit. Try later. 请求过于频繁,请稍候重试
    413 E8114: Request entity too large 请求体太大,请确认后重试
    400 E8115: Request entity empty 请求体为空,请确认后重试
    400 E8116: Request entity malformed 请求体不合法,请确认后重试

    Indice(索引)相关错误

    http code error message 说明
    400 E8202: The q you provided is invalid 请求参数q不合法
    400 E8203: The from you provided is invalid 请求参数from不合法
    400 E8204: The size you provided is invalid 请求参数size不合法
    400 E8205: The sort you provided is invalid 请求参数sort不合法
    400 E8206: The time range parameter value cannot be empty! 请求参数from,to不能为空
    400 E8207: The end time you provided is invalid 请求参数to不合法
    400 E8208: The end time you provided must be later than from time! 请求参数to必须小于from
    400 E8209: The aggregation field cannot be empty! 必须指定聚合的字段

    其它错误

    http code error message 说明
    400 E8301: The Params you provided is invalid 提供的参数不合法,请检查
    401 bad token 鉴权不通过 、token已过期、机器时间未同步
    以上内容是否对您有帮助?
  • Close