List Project

Last Updated：2025-11-14

Description

Retrieve the current user's project list.

Request

Request syntax

POST /v1/project/list HTTP/1.1
Host: <Endpoint>
Authorization: <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

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

Response example

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
    }
}

Describe Project

LogStore Related APIs

百度智能云

Log Service