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

更新Scrum项目迭代

功能介绍

更新Scrum项目迭代。

调用方法

请参见如何调用API

URI

PUT /v4/projects/{project_id}/iterations/{iteration_id}

表1 路径参数

参数

是否必选

参数类型

描述

iteration_id

String

参数解释:

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

约束限制:

正则表达式,\d+。

取值范围:

最小值 0。

默认取值:

不涉及。

project_id

String

参数解释

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

约束限制

正则表达式,[A-Za-z0-9]{32}。

取值范围:

不涉及。

默认取值

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

begin_time

String

参数解释:

开始时间,年-月-日。

约束限制:

正则表达式:"[1-9]\d{3}-(0?[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])"。

取值范围:

不涉及。

默认取值:

不涉及。

description

String

参数解释:

描述。

约束限制:

最大支持50000字符。

取值范围:

不涉及。

默认取值:

不涉及。

end_time

String

参数解释:

结束时间,年-月-日。

约束限制:

正则表达式:"[1-9]\d{3}-(0?[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])"。

取值范围:

不涉及。

默认取值:

不涉及。

name

String

参数解释:

标题。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

over_type

String

参数解释:

迭代结束时,工作项的处理。

约束限制:

正则表达式:"empty|close"。status更新为2时需要填写over_type。

取值范围:

close(所有的工作项关闭);

empty(没有关闭的工作项 放在block里面)。

默认取值:

不涉及。

status

String

参数解释:

迭代的状态。

约束限制:

正则表达式:"0|1|2"。

0未开始<-->1进行中<-->2结束<-->1<-->0,状态不能跨状态更改。

取值范围:

0(未开始);

1(进行中);

2(结束)。

默认取值:

不涉及。

响应参数

状态码:204

No Content

状态码:400

表3 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

Put https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/iteration/11225793

{
  "end_time" : "2018-07-05",
  "name" : "sttes32s3",
  "begin_time" : "2018-1-31",
  "description" : ""
}

响应示例

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
47
48
49
50
51
52
53
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 UpdateIterationV4Solution {

    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();
        UpdateIterationV4Request request = new UpdateIterationV4Request();
        request.withProjectId("{project_id}");
        request.withIterationId({iteration_id});
        UpdateIterationRequestV4 body = new UpdateIterationRequestV4();
        body.withName("sttes32s3");
        body.withEndTime("2018-07-05");
        body.withDescription("");
        body.withBeginTime("2018-1-31");
        request.withBody(body);
        try {
            UpdateIterationV4Response response = client.updateIterationV4(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
32
33
34
35
36
37
38
# 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 = UpdateIterationV4Request()
        request.project_id = "{project_id}"
        request.iteration_id = {iteration_id}
        request.body = UpdateIterationRequestV4(
            name="sttes32s3",
            end_time="2018-07-05",
            description="",
            begin_time="2018-1-31"
        )
        response = client.update_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
37
38
39
40
41
42
43
44
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.UpdateIterationV4Request{}
	request.ProjectId = "{project_id}"
	request.IterationId = int32({iteration_id})
	descriptionUpdateIterationRequestV4:= ""
	request.Body = &model.UpdateIterationRequestV4{
		Name: "sttes32s3",
		EndTime: "2018-07-05",
		Description: &descriptionUpdateIterationRequestV4,
		BeginTime: "2018-1-31",
	}
	response, err := client.UpdateIterationV4(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

204

No Content

400

Bad Request

401

Unauthorized

错误码

请参见错误码

相关文档