ListProject
更新时间：2024-09-11
描述
获取当前用户的日志组列表内容。
请求
- 请求语法
POST /v1/project/list HTTP/1.1
Host: <Endpoint>
Authorization: <Authorization String>- 请求头域
除公共请求头域外，无其它特殊头域。
- 请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| name | String | No | RequestBody | 指定筛选日志组名称的关键字 |
| description | String | No | RequestBody | 指定筛选日志组描述的关键字 |
| orderBy | String | No | RequestBody | 排序字段，默认为创建时间，支持createdAt: 创建时间，updatedAt: 修改时间, name: 名称 |
| order | String | No | RequestBody | 排序顺序，desc为降序，asc为升序，默认为 desc |
| pageNo | Int | No | RequestBody | 起始页码，默认为 1 |
| pageSize | Int | No | RequestBody | 每页显示数据大小，默认为 10 |
响应
- 响应头域
除公共响应头域外，无其它特殊头域。
- 响应参数
| 字段 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 请求是否成功 |
| code | String | 请求码，成功为OK，错误为具体的错误码 |
| message | String | 请求成功为空，失败为具体的错误信息 |
| result | Object | 结果对象 |
上表中的 result 对象的元素结构如下：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| order | String | 排序规则，desc为降序，asc为升序 |
| orderBy | String | 排序字段 |
| pageNo | Int | 起始页码 |
| pageSize | Int | 每页显示数据大小 |
| total | Int | 总数目 |
| default | Project | 默认日志组 |
| projects | List<Project> | 日志组列表 |
上表中的 project 对象元素结构如下：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| uuid | String | 日志组UUID |
| name | String | 日志组名称 |
| logStoreCount | Int | 日志组中日志集的个数 |
| description | String | 日志组描述 |
| top | Boolean | 日志组是否置顶 |
| createdTime | DateTime | 日志组创建的日期时间 |
| updatedTime | DateTime | 日志组最后修改的日期时间 |
错误码
除了通用的错误码，无其他特殊错误码返回。
示例
- 请求示例
GET /v1/project/list?name=test&order=asc&orderBy=createdTime&pageNo=1&pageSize=10 HTTP/1.1
Host: bls-log.bj.baidubce.com
Authorization:bce-auth-v1/18717522d39411e9b721df098b0b908c/2019-09-10T07:00:20Z/1800/content-type;host;x-bce-date;x-bce-request-id/6a7cb6c9ac7ec156c805e55e7d0bcfc443b47feee97cf099c1c0d93a0b4c8304- 响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"code": "OK",
"success": true,
"result": {
"default": {
"uuid": "",
"name": "default",
"description": "default",
"top": true,
"LogStoreCount": 217,
"createdTime": "2024-09-11T09:46:40Z",
"updatedTime": "2024-09-11T09:46:40Z"
},
"projects": [
{
"uuid": "67ea8b0c-7d11-6661-78fe-01cbe33a1ac7",
"name": "test",
"description": "test",
"top": true,
"LogStoreCount": 10,
"createdTime": "2024-06-04T06:57:41Z",
"updatedTime": "2024-07-10T08:16:15Z"
}
],
"order": "desc",
"orderBy": "updated_time",
"pageNo": 1,
"pageSize": 10,
"totalCount": 8
}
}