Querying the Project List
Function
This API is used to query the project list.
Calling Method
For details, see Calling APIs.
Authorization Information
No identity policy-based permission required for calling this API.
URI
GET /v4/projects
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| offset | Yes | Integer | Definition Start page number. The value starts from 0 and is an integer multiple of limit. The default value is 0. Constraints N/A Range 0–10000 Default Value 0 |
| limit | Yes | Integer | Definition Page size. Constraints N/A Range 1–1000 Default Value 10 |
| search | No | String | Definition: Project name or description for fuzzy query. Constraints: Advanced query methods like wildcard characters are not supported. Options: N/A Default value: N/A |
| project_type | No | String | Definition Project type. Constraints N/A Range scrum: Scrum project normal: normal project xboard: Kanban project Default Value N/A |
| sort | No | String | Definition Sorting criteria. Constraints Sorting parameter. The format is field name + colon + sorting direction. A maximum of four groups are supported, which are separated by commas (,). Range ((name|author_name|created_on|memcount)(:|%3A|%253A)(asc|desc|ASC|DESC)(,)?){0,4}. Default Value Creation time in descending order |
| archive | No | String | Definition Archived or not. Constraints N/A (The allowed values are defined in the range below.) Range true (not archived and currently in use) false (already archived and cannot be used) Default Value N/A |
| query_type | No | String | Definition By default, the projects that the current user participates in are returned. Constraints N/A (The allowed values are defined in the range below.) Range Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Definition User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints N/A Range The value contains 10 to 32,768 characters. Default Value N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| projects | Array of projects objects | Definition: Project information. |
| total | Integer | Definition Total number of projects. Range 0–10000 |
| 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. Range N/A |
| project_name | String | Definition: Project name. Options: N/A |
| description | String | Definition: Project description. Options: N/A |
| created_time | Long | Definition: Time when a project was created. Options: N/A |
| updated_time | Long | Definition: Project update time. Options: N/A |
| project_type | String | Definition: Project type. Value range: scrum: Scrum project normal: normal project xboard: Kanban project |
| creator | creator object | Definition: Creator information. Options: N/A |
| Parameter | Type | Description |
|---|---|---|
| user_num_id | Integer | Definition: Creator numId. Options: N/A |
| user_id | String | Definition Creator ID. Range N/A |
| user_name | String | Definition: Creator name. Options: N/A |
| domain_id | String | Definition Tenant ID of the creator. Range N/A |
| domain_name | String | Definition: Tenant name of the creator. Options: N/A |
| nick_name | String | Definition: Tenant nickname of the creator. Options: N/A |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition: Error code. Value range: N/A |
| error_msg | String | Definition: Error description. Value range: N/A |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition: Error code. Value range: N/A |
| error_msg | String | Definition: Error description. Value range: N/A |
| request_id | String | Definition Request ID, which is automatically generated by the system. Range N/A |
Status code: 403
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition: Error code. Value range: N/A |
| error_msg | String | Definition: Error description. Value range: N/A |
Example Requests
GET https://{endpoint}/v4/projects?limit=10&offset=0&project_type=scrum&sort=&search=aa&archive=true&query_type=domain_projects Example Responses
Status code: 200
{
"projects" : [ {
"project_num_id" : 3183801,
"project_id" : "41bd3eab86544863b8fc92ffcd35e3c8",
"project_name" : "demo_project",
"description" : "demo",
"created_time" : 1576114296000,
"updated_time" : 1576114296000,
"project_type" : "xboard",
"creator" : {
"user_num_id" : 4097,
"user_id" : "c4bd39f0573a436589714bedbcca8536",
"user_name" : "mobile_user",
"domain_id" : "2489d8cbba804db8bcd35384685ff3ac",
"domain_name" : "mobile_user",
"nick_name" : "Tom.M.Riddle"
}
} ],
"total" : 10
} 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 | 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 ListProjectsV4Solution { 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(); ListProjectsV4Request request = new ListProjectsV4Request(); try { ListProjectsV4Response response = client.listProjectsV4(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 | # 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 = ListProjectsV4Request() response = client.list_projects_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 37 38 39 40 41 42 43 44 45 46 47 | 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := projectman.ProjectManClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := projectman.NewProjectManClient(hcClient) request := &model.ListProjectsV4Request{} response, err := client.ListProjectsV4(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 | Response body parameters |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot