更新时间:2025-07-21 GMT+08:00
分享

查询项目列表

功能介绍

查询项目列表。

调用方法

请参见如何调用API

URI

GET /v4/projects

表1 Query参数

参数

是否必选

参数类型

描述

offset

Integer

参数解释:

分页索引,偏移量,offset是limit的整数倍数。

约束限制:

从0开始。

取值范围:

最小值:0,最大值:10000。

默认取值:

缺省值:0

limit

Integer

参数解释:

条数,每页显示查询的数量。

约束限制:

不涉及。

取值范围:

最小值:1,最大值:1000。

默认取值:

10

search

String

参数解释:

模糊查询项目名称或描述。

约束限制:

不支持通配符等高级查询。

取值范围:

不涉及。

默认取值:

不涉及。

project_type

String

参数解释:

项目类型。

约束限制:

正则表达式:"scrum|normal|xboard"。

取值范围:

scrum,normal,xboard

默认取值:

不涉及。

sort

String

参数解释:

排序条件。

约束限制:

正则表达式:"((name|author_name|created_on|memcount)(:|%3A|%253A)(asc|desc|ASC|DESC)(,)?){0,4}"。

取值范围:

((name|author_name|created_on|memcount)(:|%3A|%253A)(asc|desc|ASC|DESC)(,)?){0,4}。

默认取值:

默认创建时间降序。

archive

String

参数解释:

是否归档。

约束限制:

正则表达式:"false|true"。

取值范围:

true(未归档,在使用的)

false(已经归档,不能使用)

默认取值:

不涉及。

query_type

String

参数解释:

默认返回当前用户参与的项目列表。

约束限制:

正则表达式:"absent|domain_projects"。

取值范围:

domain_projects(租户下的所有项目列表),

absent(当前用户未参与的租户项目列表)。

默认取值:

不涉及。

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

projects

Array of projects objects

参数解释:

项目信息列表。

total

Integer

参数解释:

项目总数。

取值范围:

最小值:0,最大值:10000。

表3 projects

参数

参数类型

描述

project_num_id

Integer

参数解释:

项目numId,删除项目场景下的非必传字段,删除项目时也可以通过project_num_id确定唯一的项目。

取值范围:

不涉及。

project_id

String

参数解释:

项目uuid。

取值范围:

不涉及。

project_name

String

参数解释:

项目名称。

取值范围:

不涉及。

description

String

参数解释:

项目描述。

取值范围:

不涉及。

created_time

Long

参数解释:

项目创建时间。

取值范围:

不涉及。

updated_time

Long

参数解释:

项目更新时间。

取值范围:

不涉及。

project_type

String

参数解释:

项目类型。

取值范围:

scrum,normal,xboard。

creator

creator object

参数解释:

创建者信息。

取值范围:

不涉及。

表4 creator

参数

参数类型

描述

user_num_id

Integer

参数解释:

创建人numId。

取值范围:

不涉及。

user_id

String

参数解释:

创建人id。

取值范围:

不涉及。

user_name

String

参数解释:

创建人姓名。

取值范围:

不涉及。

domain_id

String

参数解释:

创建人租户id。

取值范围:

不涉及。

domain_name

String

参数解释:

创建人租户名称。

取值范围:

不涉及。

nick_name

String

参数解释:

创建人租户昵称。

取值范围:

不涉及。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET https://{endpoint}/v4/projects?limit=10&offset=0&project_type=scrum&sort=&search=aa&archive=true&query_type=domain_projects

响应示例

状态码:200

响应Body参数

{
  "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" : "modile_user",
      "domain_id" : "2489d8cbba804db8bcd35384685ff3ac",
      "domain_name" : "modile_user",
      "nick_name" : "Tom.M.Riddle"
    }
  } ],
  "total" : 10
}

SDK代码示例

SDK代码示例如下。

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
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.ListProjectsV4Request{}
	response, err := client.ListProjectsV4(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

响应Body参数

400

Bad Request

401

Unauthorized

403

Forbidden

错误码

请参见错误码

相关文档