Updated on 2025-08-25 GMT+08:00

Obtaining Project Details

Function

This API is used to obtain project details.

Calling Method

For details, see Calling APIs.

URI

GET /v4/projects/{project_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

32-character UUID of a project, which uniquely identifies a project. Obtain the value of this parameter from the project_id field in the response body of the Querying the Project List API.

Constraints:

Regular expression: [A-Za-z0-9]{32}

Options:

N/A

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

User token. Obtain the token by calling theObtaining a User TokenIAM API. In the returned response header, X-Subject-Token is the desired user token.

Constraints:

Mandatory.

Range:

Minimum length: 10 character. Maximum length: 32,768 characters.

Default value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

project

project object

Definition:

Project information.

Table 4 project

Parameter

Type

Description

project_num_id

Integer

Definition:

Project number ID. This parameter is optional in the project deletion scenario. You can also use project_num_id to determine a unique project.

Options:

N/A

project_id

String

Definition:

Project UUID.

Options:

N/A

name

String

Definition:

Project name.

Options:

N/A

created_on

Long

Definition:

Time when a project was created.

Options:

N/A

updated_on

Long

Definition:

Project update time.

Options:

N/A

project_type

String

Definition:

Project type.

Options:

scrum, normal, and xboard

archive

Integer

Definition:

Archived or not.

Options:

true (not archived and currently in use)

false (already archived and cannot be used)

enterprise_id

String

Definition:

Enterprise project ID.

Options:

N/A

project_code

String

Definition:

Project code.

Options:

N/A

creator

creator object

Definition:

Creator information.

Table 5 creator

Parameter

Type

Description

domain_id

String

Definition:

Tenant ID of the creator.

Options:

N/A

domain_name

String

Definition:

Tenant name of the creator.

Options:

N/A

nick_name

String

Definition:

Creator alias.

Options:

N/A

user_id

String

Definition:

Creator UUID.

Options:

N/A

user_name

String

Definition:

Creator name.

Options:

N/A

user_num_id

Integer

Definition:

Creator num_id.

Options:

N/A

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Example Requests

Get https://{endpoint}/v4/projects/0792b7d26cb74bd799cbae80063dc74a

Example Responses

Status code: 200

OK

{
  "project" : {
    "project_num_id" : 3183801,
    "project_id" : "41bd3eab86544863b8fc92ffcd35e3c8",
    "name" : "demo_project",
    "created_on" : 1576114296000,
    "updated_on" : 1576114296000,
    "project_type" : "scrum",
    "archive" : 1,
    "enterprise_id" : "041bd3eab86544863b8f92ffcd35e218",
    "project_code" : "abc_123",
    "creator" : {
      "user_num_id" : 4097,
      "user_id" : "c4bd39f0573a436589714bedbcca8536",
      "user_name" : "modile_user",
      "domain_id" : "2489d8cbba804db8bcd35384685ff3ac",
      "domain_name" : "modile_user",
      "nick_name" : "Tom.M.Riddle"
    }
  }
}

SDK Sample Code

The SDK sample code is as follows.

Java

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.projectman.v4.region.ProjectManRegion;
import com.huaweicloud.sdk.projectman.v4.*;
import com.huaweicloud.sdk.projectman.v4.model.*;


public class ShowProjectInfoV4Solution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        ProjectManClient client = ProjectManClient.newBuilder()
                .withCredential(auth)
                .withRegion(ProjectManRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowProjectInfoV4Request request = new ShowProjectInfoV4Request();
        request.withProjectId("{project_id}");
        try {
            ShowProjectInfoV4Response response = client.showProjectInfoV4(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkprojectman.v4.region.projectman_region import ProjectManRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkprojectman.v4 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = ProjectManClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(ProjectManRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowProjectInfoV4Request()
        request.project_id = "{project_id}"
        response = client.show_project_info_v4(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    projectman "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := projectman.NewProjectManClient(
        projectman.ProjectManClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowProjectInfoV4Request{}
	request.ProjectId = "{project_id}"
	response, err := client.ShowProjectInfoV4(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.