文档首页/ 需求管理 CodeArts Req/ API参考/ API/ Scrum项目的工作项/ 查询项目的工作项 - ListIssuesSfV4
更新时间:2026-09-15 GMT+08:00
分享

查询项目的工作项 - ListIssuesSfV4

功能介绍

工作项类型id,分页参数,创建时间查询项目的工作项。

调用方法

请参见如何调用API

授权信息

账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

codeartsreq:workitem:list

List

-

  • codeartsreq:Model

  • codeartsreq:ProjectId

-

-

URI

GET /v4/projects/{project_id}/issues

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目的32位UUID,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。

约束限制

32个字符,由英文字母和数字组成。

取值范围:

不涉及。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

参数解释:

分页起始,从0开始,为limit整数倍 从0开始

约束限制:

0~11个字符的数字字符串,首位为0时仅0,首位为1~9时最多11个字符。

取值范围:

最小值:0

默认取值:

0

limit

Integer

参数解释:

分页大小 最小1,最大100

约束限制:

不涉及

取值范围:

最小值:1 最大值:100

默认取值:

100

tracker_id

Integer

参数解释:

工作项类型

约束限制:

工作项类型枚举:

2(任务/Task)

3(缺陷/Bug)

5(Epic)

6(Feature)

7(Story)

取值范围:

最小值 2 最大值 7

默认取值:

不涉及

created_time_interval

String

参数解释:

创建工作项的时间(查询的起始时间,查询的结束时间)

约束限制:

两个13位时间戳使用英文逗号分割,时间戳精确到毫秒。

取值范围:

不涉及

默认取值:

不涉及

updated_time_interval

String

参数解释:

更新工作项的时间(查询的起始时间,查询的结束时间)

约束限制:

1~13个字符的数字字符串,首位为1~9,多个值以英文逗号分隔。

取值范围:

不涉及

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及。

取值范围:

长度为10~32768个字符。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

issues

Array of IssueItemSfV4 objects

参数解释:

工作项列表信息

total

Integer

参数解释:

工作项总数

取值范围:

不涉及

表5 IssueItemSfV4

参数

参数类型

描述

id

Integer

参数解释:

工作项ID。

取值范围:

不涉及

actual_work_hours

Double

参数解释:

实际工时

取值范围:

不涉及

assigned_user

IssueUser object

参数解释:

处理人

取值范围:

不涉及

author

IssueUser object

参数解释:

作者

begin_time

Long

参数解释:

工作项开始时间

取值范围:

不涉及

closed_time

Long

参数解释:

关闭工作项的时间

取值范围:

不涉及

created_time

Long

参数解释:

创建时间

取值范围:

不涉及

custom_feilds

Array of CustomFeildRecord objects

参数解释:

自定义属性

developer

IssueUser object

参数解释:

开发人员

discover_version

String

参数解释:

发现问题的版本

取值范围:

不涉及

domain

domain object

参数解释:

id, 领域

14(性能)

15(功能)

16(可靠性)

17(网络安全)

18(可维护性)

19(其他DFX)

20(可用性)

done_ratio

Integer

参数解释:

工作项进度值

取值范围:

不涉及

end_time

Long

参数解释:

工作项结束时间

取值范围:

不涉及

expected_work_hours

Double

参数解释:

预计工时

取值范围:

不涉及

iteration

iteration object

参数解释:

迭代

module

module object

参数解释:

模块

order

Integer

参数解释:

优先级顺序。

取值范围:

1~100。

parent_issue_id

Integer

参数解释:

父工作项的ID

取值范围:

不涉及

priority

priority object

参数解释:

工作项优先级

release_version

String

参数解释:

发布的版本

取值范围:

不涉及

root_issue_id

Integer

参数解释:

根工作项的ID

取值范围:

不涉及

severity

severity object

参数解释:

工作项重要程度

status

status object

参数解释:

工作项状态

story_point

story_point object

参数解释:

故事点id

1(0)

2(1/2)

3(1)

4(2)

5(3)

6(5)

7(8)

8(13)

9(21)

10(40)

11(80)

12(100)

13(∞)

14(?)

subject

String

参数解释:

工作项标题

取值范围:

不涉及

tracker

tracker object

参数解释:

工作项类型

2(任务/Task)

3(缺陷/Bug)

5(Epic)

6(Feature)

7(Story)

updated_time

Long

参数解释:

工作项更新时间

取值范围:

不涉及

env

IssueAttribute object

参数解释:

发现环境

取值范围:

不涉及

find_release_dev

String

参数解释:

发现版本号。

取值范围:

不涉及

release_dev

String

参数解释:

发布版本号。

取值范围:

不涉及

tag_list

Array of TagRelation objects

参数解释:

标签列表。

取值范围:

不涉及

表6 CustomFeildRecord

参数

参数类型

描述

key

String

参数解释:

自定义工作项属性

取值范围:

不涉及

name

String

参数解释:

自定义工作项名称

取值范围:

不涉及

value

String

参数解释:

自定义工作项值

取值范围:

不涉及

表7 IssueUser

参数

参数类型

描述

id

Integer

参数解释:

用户ID。

取值范围:

不涉及。

name

String

参数解释:

用户名。

取值范围:

不涉及。

nick_name

String

参数解释:

昵称。

取值范围:

不涉及。

user_id

String

参数解释:

用户UUID。

取值范围:

不涉及。

user_num_id

Integer

参数解释:

用户数字ID。

取值范围:

不涉及。

first_name

String

参数解释:

用户名。

取值范围:

不涉及。

表8 domain

参数

参数类型

描述

id

Integer

参数解释:

领域id

取值范围:

不涉及

name

String

参数解释:

领域

取值范围:

不涉及

表9 iteration

参数

参数类型

描述

id

Integer

参数解释:

迭代ID

取值范围:

不涉及

name

String

参数解释:

迭代名

取值范围:

不涉及

表10 module

参数

参数类型

描述

id

Integer

参数解释:

模块ID

取值范围:

不涉及

name

String

参数解释:

模块

取值范围:

不涉及

表11 priority

参数

参数类型

描述

id

Integer

参数解释:

优先级id

取值范围:

不涉及

name

String

参数解释:

优先级

取值范围:

不涉及

表12 severity

参数

参数类型

描述

id

Integer

参数解释:

重要程度id

取值范围:

不涉及

name

String

参数解释:

重要程度

取值范围:

不涉及

表13 status

参数

参数类型

描述

id

Integer

参数解释:

状态id

取值范围:

不涉及

name

String

参数解释:

状态名称

取值范围:

不涉及

表14 story_point

参数

参数类型

描述

id

Integer

参数解释:

故事点id

取值范围:

不涉及

name

String

参数解释:

故事点

取值范围:

不涉及

表15 tracker

参数

参数类型

描述

id

Integer

参数解释:

类型id

取值范围:

不涉及

name

String

参数解释:

类型名称

取值范围:

不涉及

表16 IssueAttribute

参数

参数类型

描述

id

Integer

参数解释:

发现环境ID。

取值范围:

不涉及

name

String

参数解释:

发现环境名称。

取值范围:

不涉及

表17 TagRelation

参数

参数类型

描述

relationId

Integer

参数解释:

关联ID。

取值范围:

不涉及

tagId

Integer

参数解释:

标签ID。

取值范围:

不涉及

region

String

参数解释:

区域。

取值范围:

不涉及

name

String

参数解释:

标签名称。

取值范围:

不涉及

状态码:400

表18 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

取值范围

不涉及。

error_msg

String

参数解释

错误描述。

取值范围

不涉及。

状态码:401

表19 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

取值范围

不涉及。

error_msg

String

参数解释

错误描述。

取值范围

不涉及。

request_id

String

参数解释

请求的ID,系统自动生成。

取值范围

不涉及。

请求示例

GET https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/issues

响应示例

状态码:200

{
  "total" : 1,
  "issues" : [ {
    "id" : 1377841,
    "subject" : "testAPI",
    "security_level" : null,
    "release_version" : "",
    "developer" : {
      "user_id" : "d3775f2d201f423f9eeaa0b06f8f1b8f",
      "user_num_id" : 83,
      "nick_name" : "creq_chm1",
      "name" : "creq_chm1"
    },
    "assigned_user" : {
      "user_id" : "d3775f2d201f423f9eeaa0b06f8f1b8f",
      "user_num_id" : 83,
      "nick_name" : "creq_chm1",
      "name" : "creq_chm1"
    },
    "author" : {
      "user_id" : "d3775f2d201f423f9eeaa0b06f8f1b8f",
      "user_num_id" : 83,
      "nick_name" : "creq_chm1",
      "name" : "creq_chm1"
    },
    "discover_version" : "",
    "iteration" : null,
    "story_point" : null,
    "status" : {
      "id" : 1,
      "name" : "新建"
    },
    "module" : null,
    "priority" : {
      "id" : 2,
      "name" : "中"
    },
    "severity" : {
      "id" : 12,
      "name" : "一般"
    },
    "domain" : null,
    "tracker" : {
      "id" : 3,
      "name" : "Bug"
    },
    "updated_time" : 1782809865000,
    "created_time" : 1782809865000,
    "begin_time" : 1765900800000,
    "end_time" : 1767110400000,
    "closed_time" : null,
    "order" : 1,
    "parent_issue_id" : 1377839,
    "root_issue_id" : 1377837,
    "expected_work_hours" : 0,
    "actual_work_hours" : 0,
    "done_ratio" : 0,
    "env" : null,
    "custom_feilds" : [ ]
  } ]
}

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
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 ListIssuesSfV4Solution {

    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();
        ListIssuesSfV4Request request = new ListIssuesSfV4Request();
        request.withProjectId("{project_id}");
        try {
            ListIssuesSfV4Response response = client.listIssuesSfV4(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 = ListIssuesSfV4Request()
        request.project_id = "{project_id}"
        response = client.list_issues_sf_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
48
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.ListIssuesSfV4Request{}
	request.ProjectId = "{project_id}"
	response, err := client.ListIssuesSfV4(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

错误码

请参见错误码

相关文档