Describe Project
Updated at：2025-11-03
Description
Get detailed information about a specified project.
Request
- Request syntax
Text
1GET /v1/project/{uuid}? 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 |
|---|---|---|---|---|
| uuid | String | Yes | Path | Project UUID |
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:
| Field | Types | Description |
|---|---|---|
| project | Project | Project object |
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 |
| 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
Apart from standard error codes, the following codes may be returned:
| Error code | Error message | Description | HTTP status code |
|---|---|---|---|
| ProjectNotFound | Project not exists | Project not exists | 404 |
Example
- Request example
Text
1GET /v1/project/276c6cce-0350-4719-856d-ba675fa52c06 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 "success": true,
5 "code": "success",
6 "message": ""
7 "result": {
8 "project": {
9 "uuid": "276c6cce-0350-4719-856d-ba675fa52c06",
10 "name": "test",
11 "description": "For test only",
12 "top": true,
13 "createdTime": "2023-01-29T03:32:58Z",
14 "updatedTime": "2023-01-29T03:32:58Z"
15 }
16 }
17}