# 租户侧获取检索数据（待下线） - ListSearchLogsForTenant
#### 功能介绍
获取检索数据
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-secmaster/secmaster_03_0008.html)。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-secmaster/secmaster_03_0023.html)。
#### URI
POST /v1/{project_id}/workspaces/{workspace_id}/siem/log/search
表1路径参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|:---|:---|:---|:---|
| project_id   | 是    | String | **参数解释：** 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。[获取项目ID](https://support.huaweicloud.com/api-secmaster/secmaster_03_0014.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
| workspace_id | 是    | String | **参数解释：** 工作空间ID **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                                                                                                                              |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释：** 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。[获取用户Token](https://support.huaweicloud.com/api-secmaster/secmaster_03_0010.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
   
表3请求Body参数 
| 参数           | 是否必选 | 参数类型    | 描述                                      |
|:---|:---|:---|:---|
| dataspace_id | 是    | String  | 数据空间ID                                  |
| from         | 是    | Long    | 查询开始时间点                                 |
| limit        | 是    | Integer | 查询返回的原始日志条数，最大值为500                     |
| offset       | 是    | Integer | 查询偏移值                                   |
| pipe_id      | 是    | String  | 数据管道ID                                  |
| query        | 是    | String  | 查询语句                                    |
| sort         | 是    | String  | 是否按时间排序返回；可选值：asc(升序)、desc(降序)，默认为 desc |
| to           | 是    | Long    | 查询结束时间点                                 |
   
#### 响应参数
**状态码：200**
表4响应Body参数 
| 参数               | 参数类型                                                                             | 描述      |
|:---|:---|:---|
| analysis_results | [AnalysisResults] object     | 分析结果    |
| count            | Long                                                                             | 查询结果的条数 |
| results          | Array of [SearchResult] objects | 返回的查询结果 |
   
 表5AnalysisResults 
| 参数       | 参数类型                                                                               | 描述          |
|:---|:---|:---|
| datarows | Array\<Array\<\>\>                                                                 | 统计分析结果数据    |
| schema   | Array of [AnalysisField] objects | 统计分析结果字段类型  |
| size     | Integer                                                                            | 返回的统计分析结果条数 |
| total    | Integer                                                                            | 统计分析结果总数    |
   
 表6AnalysisField 
| 参数    | 参数类型   | 描述                                                                                                                      |
|:---|:---|:---|
| alias | String | 字段别名                                                                                                                    |
| name  | String | 字段名称                                                                                                                    |
| type  | String | 字段类型；可选值：boolean、byte、short、integer、long、float、half_float、scaled_float、double、keyword、text、date、ip、binary、object、nested |
   
 表7SearchResult 
| 参数          | 参数类型   | 描述     |
|:---|:---|:---|
| data_source | Object | 原始日志内容 |
| timestamp   | Long   | 数据接收时间 |
   
**状态码：400**
表8响应Body参数 
| 参数         | 参数类型   | 描述   |
|:---|:---|:---|
| error_code | String | 错误码  |
| error_msg  | String | 错误描述 |
   
#### 请求示例
```
{
  "dataspace_id" : "a00106ba-bede-453c-8488-b60c70bd6aed",
  "from" : 1584883694354,
  "limit" : 50,
  "offset" : 0,
  "pipe_id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx",
  "query" : "xxx",
  "sort" : "desc",
  "to" : 1584883694654
}
```
#### 响应示例
**状态码：200**
成功
```
{
  "analysis_results" : {
    "datarows" : [ [ 1, null ], [ 2, "value" ] ],
    "schema" : [ {
      "alias" : "key_alias1",
      "name" : "key1",
      "type" : "long"
    }, {
      "name" : "key2",
      "type" : "string"
    } ],
    "size" : 10,
    "total" : 100
  },
  "count" : 1,
  "results" : [ {
    "data_source" : {
      "key1" : -1,
      "key2" : 1.2,
      "key3" : {
        "key4" : true,
        "key5" : "value5"
      }
    },
    "timestamp" : 1584883694354
  } ]
}
```
#### 状态码
| 状态码 | 描述   |
|:---|:---|
| 200 | 成功   |
| 400 | 错误响应 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-secmaster/ErrorCode.html)。