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

查看迭代详情

功能介绍

查看迭代详情。

调用方法

请参见如何调用API

URI

GET /v4/iterations/{iteration_id}

表1 路径参数

参数

是否必选

参数类型

描述

iteration_id

String

参数解释:

迭代id,可通过获取指定项目的迭代列表接口获取指定项目对应迭代的ID。

约束限制:

正则表达式,\d+。

取值范围:

最小值 0。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

最小长度:10,最大长度:32768。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

begin_time

String

参数解释:

迭代开始时间,年-月-日

取值范围:

不涉及

charts

Array of Chart objects

参数解释:

燃尽图

closed_total

Integer

参数解释:

已关闭的工单数

取值范围:

不涉及

created_time

String

参数解释:

迭代创建时间

取值范围:

不涉及

end_time

String

参数解释:

迭代结束时间,年-月-日

取值范围:

不涉及

have_task

Boolean

参数解释:

是否有task

取值范围:

true(有)

false(无)

iteration_id

Integer

参数解释:

迭代id

取值范围:

不涉及

name

String

参数解释:

迭代标题

取值范围:

不涉及

opened_total

Integer

参数解释:

开启的工单数

取值范围:

不涉及

progress

String

参数解释:

工作进展

取值范围:

不涉及

status

String

参数解释:

迭代的状态

取值范围:

0(未开始)

1(进行中)

2(结束)

total

Integer

参数解释:

工单总数

取值范围:

不涉及

updated_time

String

参数解释:

迭代更新时间

取值范围:

不涉及

表4 Chart

参数

参数类型

描述

date

String

参数解释:

统计时间

取值范围:

不涉及

finished_num

Integer

参数解释:

完成story工单

取值范围:

不涉及

iteration_id

Integer

参数解释:

迭代id

取值范围:

不涉及

project_num_id

Integer

参数解释:

项目id

取值范围:

不涉及

remaining_num

Integer

参数解释:

未完成story数

取值范围:

不涉及

total

Integer

参数解释:

总story数

取值范围:

不涉及

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

Get https://{endpoint}/v4/iterations/11225793

响应示例

状态码:200

OK

{
  "begin_time" : "2020-07-12",
  "charts" : [ {
    "date" : "2020-09-12",
    "finished_num" : 1,
    "iteration_id" : 3789,
    "project_num_id" : 36587463,
    "remaining_num" : 3,
    "total" : 4
  } ],
  "closed_total" : 1,
  "created_time" : "2020-06-30 09:10:03",
  "end_time" : "2020-07-19",
  "have_task" : false,
  "iteration_id" : 35789,
  "name" : "迭代1",
  "opened_total" : 3,
  "progress" : "25%",
  "total" : 4,
  "updated_time" : "2020-06-30 09:10:03",
  "status" : "0"
}

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

    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();
        ShowIterationV4Request request = new ShowIterationV4Request();
        request.withIterationId({iteration_id});
        try {
            ShowIterationV4Response response = client.showIterationV4(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 = ShowIterationV4Request()
        request.iteration_id = {iteration_id}
        response = client.show_iteration_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.ShowIterationV4Request{}
	request.IterationId = int32({iteration_id})
	response, err := client.ShowIterationV4(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

错误码

请参见错误码

相关文档