文档首页/ 需求管理 CodeArts Req/ API参考/ API/ IPD工作项快照/ 批量创建工作项快照 - BatchCreateIssueSnapitems
更新时间:2026-09-01 GMT+08:00
分享

批量创建工作项快照 - BatchCreateIssueSnapitems

功能介绍

为IPD工作项批量创建快照时,可调用此接口。

调用方法

请参见如何调用API

授权信息

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

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

codeartsreq:workitem:create

Write

-

  • codeartsreq:Model

  • codeartsreq:ProjectId

-

-

URI

POST /v1/ipdprojectservice/projects/{project_id}/baseline-snapshots/create/batch

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

约束限制

不涉及。

取值范围

10~32768个字符。

默认取值

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

issues

Array of issues objects

参数解释

需要创建快照的工作项数组。

约束限制

每次最多支持对50个工作项创建快照。

表4 issues

参数

是否必选

参数类型

描述

id

String

参数解释

工作项ID。可以通过查询工作项列表或者查询树状工作项接口获取,响应消息体中的id字段的值就是工作项ID。

约束限制

18~19个字符的数字字符串。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

result

result object

参数解释

批量创建快照的结果。

status

String

参数解释

返回状态。

取值范围

  • success:响应成功

  • error:响应失败

message

String

参数解释

失败原因。

取值范围

不涉及。

表6 result

参数

参数类型

描述

success

Array of CreateSnapshotResult objects

参数解释

创建成功的快照列表。

failed

Array of CreateSnapshotResult objects

参数解释

创建失败的快照列表。

表7 CreateSnapshotResult

参数

参数类型

描述

id

String

参数解释

快照ID。

取值范围

18或19个字符的数字字符串。

title

String

参数解释

快照名称。创建时自动生成,工作项快照名称生成规则为:“工作项类型”+“ v” + “年”+“.”+“月”+“.”+“日”+“.”+“当日生成版本次数”。例如工作项类型为IR的工作项在2026年3月25日第一次打快照系统生成的快照名称为:IR v26.03.25.1。

取值范围

不涉及。

category

String

参数解释

快照类型。工作项快照固定为:issue_snap_item。

取值范围

不涉及。

issue_id

String

参数解释

快照的工作项ID。

取值范围

不涉及。

created_by

String

参数解释

快照的创建人ID。

取值范围

不涉及。

deletable

Boolean

参数解释

快照是否可被删除。

取值范围

  • true:可删除。

  • false:不可删除。

errormsg

String

参数解释

创建快照失败的原因。

取值范围

不涉及。

状态码:400

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

取值范围

不涉及。

error_msg

String

参数解释

错误描述,对error_code的补充解释。

取值范围

不涉及。

请求示例

POST https://{endpoint}/v1/ipdprojectservice/projects/{project_id}/baseline-snapshots/create/batch

{
  "issues" : [ {
    "id" : "1221849688798175233"
  }, {
    "id" : "1222557368042950656"
  } ]
}

响应示例

状态码:200

批量创建快照成功的响应。

{
  "result" : {
    "success" : [ {
      "id" : "1243589930093629441",
      "title" : "IR v26.03.25.1",
      "category" : "issue_snap_item",
      "issue_id" : "1221849688798175233",
      "created_by" : "c533da3e53244b589e7175bb766859ac",
      "deletable" : true
    }, {
      "id" : "1243589930102018048",
      "title" : "SR v26.03.25.1",
      "category" : "issue_snap_item",
      "issue_id" : "1222557368042950656",
      "created_by" : "c533da3e53244b589e7175bb766859ac",
      "deletable" : true
    } ],
    "failed" : [ ]
  }
}

状态码:400

请求失败的响应。例如无操作权限、项目不存在。

{
  "error_code" : "PM.02174103",
  "error_msg" : "无操作权限"
}

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
54
55
56
57
58
59
60
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.*;

import java.util.List;
import java.util.ArrayList;

public class BatchCreateIssueSnapitemsSolution {

    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();
        BatchCreateIssueSnapitemsRequest request = new BatchCreateIssueSnapitemsRequest();
        request.withProjectId("{project_id}");
        BatchCreateSnapshotRequest body = new BatchCreateSnapshotRequest();
        List<BatchCreateSnapshotRequestIssues> listbodyIssues = new ArrayList<>();
        listbodyIssues.add(
            new BatchCreateSnapshotRequestIssues()
                .withId("1221849688798175233")
        );
        listbodyIssues.add(
            new BatchCreateSnapshotRequestIssues()
                .withId("1222557368042950656")
        );
        body.withIssues(listbodyIssues);
        request.withBody(body);
        try {
            BatchCreateIssueSnapitemsResponse response = client.batchCreateIssueSnapitems(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
39
40
41
42
# 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 = BatchCreateIssueSnapitemsRequest()
        request.project_id = "{project_id}"
        listIssuesbody = [
            BatchCreateSnapshotRequestIssues(
                id="1221849688798175233"
            ),
            BatchCreateSnapshotRequestIssues(
                id="1222557368042950656"
            )
        ]
        request.body = BatchCreateSnapshotRequest(
            issues=listIssuesbody
        )
        response = client.batch_create_issue_snapitems(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
49
50
51
52
53
54
55
56
57
58
59
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.BatchCreateIssueSnapitemsRequest{}
	request.ProjectId = "{project_id}"
	var listIssuesbody = []model.BatchCreateSnapshotRequestIssues{
        {
            Id: "1221849688798175233",
        },
        {
            Id: "1222557368042950656",
        },
    }
	request.Body = &model.BatchCreateSnapshotRequest{
		Issues: listIssuesbody,
	}
	response, err := client.BatchCreateIssueSnapitems(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

批量创建快照成功的响应。

400

请求失败的响应。例如无操作权限、项目不存在。

错误码

请参见错误码

相关文档