List Project
Updated at：2025-11-03
Description
Retrieve the current user's project list.
Request
- Request syntax
Text
1POST /v1/project/list HTTP/1.1
2Host: <Endpoint>
3Authorization: <Authorization String>- Request headers
No additional headers are required beyond the standard request headers.
- Request parameters
| Parameter name | Types | Required or not | Parameter location | Description |
|---|---|---|---|---|
| name | String | No | RequestBody | Specify the keywords for project name filtering |
| description | String | No | RequestBody | Specify the keywords for project description filtering |
| orderBy | String | No | RequestBody | Sorting field, defaulting to creation time, supporting createdAt: Creation time, updatedAt: Update time, name: Name |
| order | String | No | RequestBody | Sort order, desc: descending; asc: ascending; default: desc |
| pageNo | Int | No | RequestBody | Start page, default: 1 |
| pageSize | Int | No | RequestBody | Data volume shown on each page, default: 10 |
Response
- Response headers
No additional headers are required beyond the standard response headers.
- Response parameters
| Field | Types | Description |
|---|---|---|
| success | Boolean | Whether the request succeeded |
| code | String | Request code, OK for success, or a specific error code for failure |
| message | String | Empty for request success, or a specific error message for request failure |
| result | Object | Result object |
The element structure of result object in the above table is as follows:
| Parameter name | Types | Description |
|---|---|---|
| order | String | Sort rule, desc: descending; asc: ascending |
| orderBy | String | Sorting field |
| pageNo | Int | Start page |
| pageSize | Int | Data volume shown on each page |
| total | Int | Total entries |
| default | Project | Default project |
| projects | List<Project> | Project list |
The element structure of project object in the above table is as follows:
| Parameter name | Types | Description |
|---|---|---|
| uuid | String | Project UUID |
| name | String | Project name |
| logStoreCount | Int | Number of logstores in project |
| description | String | Project description |
| top | Boolean | Whether the project is put at the top |
| createdTime | DateTime | Project creation datetime |
| updatedTime | DateTime | Last modification datetime of project |
Error code
No special error codes are returned beyond standard error codes.
Example
- Request example
Text
1GET /v1/project/list?name=test&order=asc&orderBy=createdTime&pageNo=1&pageSize=10 HTTP/1.1
2Host: bls-log.bj.baidubce.com
3Authorization:bce-auth-v1/18717522d39411e9b721df098b0b908c/2019-09-10T07:00:20Z/1800/content-type;host;x-bce-date;x-bce-request-id/6a7cb6c9ac7ec156c805e55e7d0bcfc443b47feee97cf099c1c0d93a0b4c8304- Response example
Text
1HTTP/1.1 200 OK
2Content-Type: application/json; charset=utf-8
3
4{
5 "code": "OK",
6 "success": true,
7 "result": {
8 "default": {
9 "uuid": "",
10 "name": "default",
11 "description": "default",
12 "top": true,
13 "LogStoreCount": 217,
14 "createdTime": "2024-09-11T09:46:40Z",
15 "updatedTime": "2024-09-11T09:46:40Z"
16 },
17 "projects": [
18 {
19 "uuid": "67ea8b0c-7d11-6661-78fe-01cbe33a1ac7",
20 "name": "test",
21 "description": "test",
22 "top": true,
23 "LogStoreCount": 10,
24 "createdTime": "2024-06-04T06:57:41Z",
25 "updatedTime": "2024-07-10T08:16:15Z"
26 }
27 ],
28 "order": "desc",
29 "orderBy": "updated_time",
30 "pageNo": 1,
31 "pageSize": 10,
32 "totalCount": 8
33 }
34}