华为云用户手册

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 work_hour_category 否 String 工时类型唯一标识取值为value，页面展示取值为display_value work_date_begin 是 String 工时开始日期 work_date_end 是 String 工时结束日期 work_hours 是 String 工时数值 work_hour_type 是 String 工时类型：1：总数 2：每天 include_weekend 是 Boolean 是否包含周末 description 否 String 描述

响应示例 状态码：200 工时信息以及分页信息返回 { "status" : "success", "message" : null, "result" : [ { "workitem" : { "plan_pi" : null, "sum_workload_man_day" : "112.00", "convolution_actual_hours" : null, "id" : "976857692367659008", "plan_iteration" : null }, "work_date" : "1706803200000", "created_by" : { "id" : "a360371833bf4c558f796fd707b44daf", "name" : "devcloud_devcloud_s00404480_01", "nick_name" : "测试账号" }, "work_hour_category" : "研发设计", "work_hours" : 6 } ], "page" : { "page" : 1, "size" : 200, "count" : 1 } }

请求示例 根据工作项id查询项目下工时 POST https://{endpoint}/v1/ipdprojectservice/projects/05c7d8bcf3db4829bc841e4ba93aaea5/work-hour/query { "params" : { "plan_pi" : [ ], "plan_iteration" : [ ], "workitem_id" : [ "976857692367659008" ], "created_by" : [ ] }, "page_info" : { "offset" : 0, "limit" : 200 } }

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 status String 参数解释： 返回状态 取值范围： 不涉及 message String 参数解释： 返回体消息 取值范围： 不涉及 result Array of WorkHourInfoVO objects 参数解释： 返回数据 page PageVO object 参数解释： 分页信息 表6 WorkHourInfoVO 参数 参数类型 描述 workitem workitem object 参数解释： 工作项信息 work_date String 参数解释： 工时日期，unix时间戳，单位：毫秒 取值范围： 不涉及 created_by UserEntity object 参数解释： 创建人信息 work_hour_category String 参数解释： 工时类型唯一标识取值为value，页面展示取值为display_value 取值范围： 不涉及 work_hours String 参数解释： 工时 取值范围： 不涉及 表7 workitem 参数 参数类型 描述 plan_pi String 参数解释： 发布计划ID 取值范围： 不涉及 sum_workload_man_day String 参数解释： 实际工时 取值范围： 不涉及 workload_man_day String 参数解释： 计划工时 取值范围： 不涉及 convolution_plan_hours String 参数解释： 卷积计划工时 取值范围： 不涉及 convolution_actual_hours String 参数解释： 卷积实际工时 取值范围： 不涉及 id String 参数解释： 工作项id 取值范围： 不涉及 plan_iteration String 参数解释： 迭代id 取值范围： 不涉及 表8 UserEntity 参数 参数类型 描述 id String 参数解释： 用户id，可通过[获取当前用户信息]接口获取，响应消息体中的id字段的值就是用户id。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 name String 参数解释： 用户名称。 约束限制： 最小长度：2，最大长度：64。 取值范围： 不涉及。 默认取值： 不涉及。 nick_name String 参数解释： 用户昵称。 约束限制： 最小长度：2，最大长度：30。 取值范围： 不涉及。 默认取值： 不涉及。 表9 PageVO 参数 参数类型 描述 page String 参数解释： 当前页 取值范围： 不涉及 size String 参数解释： 每页条数 取值范围： 不涉及 count String 参数解释： 数据总数 取值范围： 不涉及 状态码：400 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 params 是 WorkHourParamVO object 参数解释： 条件入参 page_info 是 RequestPageInfoVO object 参数解释： 分页参数 表3 WorkHourParamVO 参数 是否必选 参数类型 描述 plan_pi 否 Array of strings 参数解释： 发布计划ID数组，可以通过[发布/迭代计划详情查询]接口获取，响应消息体中的id字段的值就是发布计划ID 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 plan_iteration 否 Array of strings 参数解释： 迭代计划ID数组，可以通过[发布/迭代计划详情查询]接口获取，响应消息体中的id字段的值就是迭代计划ID 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 workitem_id 否 Array of strings 参数解释： 工作项ID数组，可以通过[查询工作项详情]接口获取，响应消息体中的id字段的值就是 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 created_by 否 Array of strings 参数解释： 创建人ID数组，可以通过[获取当前用户信息]接口获取，响应消息体中的user_id字段的值就是创建人ID 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 表4 RequestPageInfoVO 参数 是否必选 参数类型 描述 offset 是 String 参数解释： 偏移量 约束限制： 从0开始 取值范围： 最小值：0 默认取值： 缺省值：0 limit 是 String 参数解释： 每页显示数量,最大值200 约束限制： 不涉及 取值范围： 最小值：1，最大值：200 默认取值： 不涉及

URI POST /v1/ipdprojectservice/projects/{project_id}/work-hour/query 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 项目的32位uuid，项目唯一标识，通过查询项目列表接口获取，响应消息体中的project_id字段的值就是项目ID 约束限制： 正则表达式，[A-Za-z0-9]{32} 取值范围： 不涉及 默认取值： 不涉及

AK/SK认证 AK/SK签名认证方式仅支持请求body体大小12M以内，12M以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK(Secret Access Key)：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 GET https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ....

响应示例 状态码：200 OK { "status" : "success", "message" : null, "result" : { "total" : 1, "issues" : [ { "promised" : null, "type" : "raw requirement", "src_domain" : { "id" : "965714701520515072", "name" : "IPD-系统设备类-0217", "title" : "IPD-系统设备类-0217", "project_id" : "e4b0424709934bd1a54753e70336564d", "parent_id" : null, "category" : "Project", "created_by" : "a360371833bf4c558f796fd707b44daf", "model_id" : "10001" }, "domain_id" : { "id" : "965714701520515072", "name" : "IPD-系统设备类-0217", "title" : "IPD-系统设备类-0217", "project_id" : "e4b0424709934bd1a54753e70336564d", "parent_id" : null, "category" : "Project", "created_by" : "a360371833bf4c558f796fd707b44daf", "model_id" : "10001" }, "send_from" : "", "number" : "RR20240402742063", "send_to" : "", "convolution_actual_hours" : null, "workload_man_day" : null, "id" : "981935538274476033", "state" : "正在工作", "stay_days" : 1, "assigned_cc" : null, "submit_time" : "1712041275000", "workitem2label" : null, "close_time" : null, "priority" : { "id" : "965714705672876036", "display_value" : "中", "value" : "中", "code" : "中", "value_py" : "2", "sequence" : 2, "level" : 1, "domain_id" : "965714701520515072", "belong_definition_type" : "5" }, "modified_date" : "1712041276000", "created_by" : { "watcher" : null, "user_id" : "a360371833bf4c558f796fd707b44daf", "user_num_id" : 4091, "user_name" : "devcloud_devcloud_s00404480_01", "domain_id" : "4e919d73499648e3b0292cd3cbef806a", "domain_name" : "devcloud_devcloud_s00404480_01", "nick_name" : "测试账号", "role_id" : "8dc2cd191a104148a77f937681f9a5d6,6af50476ba89492698d237fb6fa456d6", "role_name" : "项目管理员,项目经理", "role_code" : "project_admin,Project manager", "image_id" : null, "region" : null, "has_removed" : null }, "break_status" : { "id" : "965714705672876041", "display_value" : "未分解", "value" : "undecomposed", "code" : "undecomposed", "value_py" : "undecomposed", "sequence" : 2, "level" : 1, "domain_id" : "965714701520515072", "belong_definition_type" : "5" }, "status_modified_date" : "1712041276000", "canceled" : null, "expect_delivery_time" : null, "parent_id" : null, "assignee" : { "watcher" : null, "user_id" : "a360371833bf4c558f796fd707b44daf", "user_num_id" : 4091, "user_name" : "devcloud_devcloud_s00404480_01", "domain_id" : "4e919d73499648e3b0292cd3cbef806a", "domain_name" : "devcloud_devcloud_s00404480_01", "nick_name" : "测试账号", "role_id" : "8dc2cd191a104148a77f937681f9a5d6,6af50476ba89492698d237fb6fa456d6", "role_name" : "项目管理员,项目经理", "role_code" : "project_admin,Project manager", "image_id" : null, "region" : null, "has_removed" : null }, "region" : "region01", "status" : { "id" : "965714705815482388", "belonging" : "START", "space_id" : "965714701520515072", "name" : "分析", "status_category" : null, "code" : "Analyse", "definition_type" : "5", "belong_definition_type" : 3, "belong_scope" : null, "display_value" : "分析", "position" : 2, "displayable" : 1, "editable" : 1, "deletable" : 1, "mutable" : 1, "title_py" : "fx", "builtin" : null, "label" : null, "description" : null, "created_by" : "a360371833bf4c558f796fd707b44daf", "created_userinfo" : null, "created_on" : null, "created_date" : 1708202727000, "modified_date" : 1708202727000, "modified_by" : "a360371833bf4c558f796fd707b44daf", "category_code" : null, "editing_fields" : null, "associate" : null, "linkage_node_fields" : false }, "tenant_id" : "4e919d73499648e3b0292cd3cbef806a", "link" : "", "is_suspended" : null, "change_status" : null, "title" : "RR-01", "sum_workload_man_day" : null, "plan_end_date" : null, "rr2ir" : "", "convolution_plan_hours" : null, "submitted_by" : [ { "watcher" : null, "user_id" : "a360371833bf4c558f796fd707b44daf", "user_num_id" : 4091, "user_name" : "devcloud_devcloud_s00404480_01", "domain_id" : "4e919d73499648e3b0292cd3cbef806a", "domain_name" : "devcloud_devcloud_s00404480_01", "nick_name" : "测试账号", "role_id" : "8dc2cd191a104148a77f937681f9a5d6,6af50476ba89492698d237fb6fa456d6", "role_name" : "项目管理员,项目经理", "role_code" : "project_admin,Project manager", "image_id" : null, "region" : null, "has_removed" : null } ], "rr2us" : "", "cascade_delete" : "none", "recipient" : [ { "watcher" : null, "user_id" : "a360371833bf4c558f796fd707b44daf", "user_num_id" : 4091, "user_name" : "devcloud_devcloud_s00404480_01", "domain_id" : "4e919d73499648e3b0292cd3cbef806a", "domain_name" : "devcloud_devcloud_s00404480_01", "nick_name" : "测试账号", "role_id" : "8dc2cd191a104148a77f937681f9a5d6,6af50476ba89492698d237fb6fa456d6", "role_name" : "项目管理员,项目经理", "role_code" : "project_admin,Project manager", "image_id" : null, "region" : null, "has_removed" : null } ], "modified_by" : { "watcher" : null, "user_id" : "a360371833bf4c558f796fd707b44daf", "user_num_id" : 4091, "user_name" : "devcloud_devcloud_s00404480_01", "domain_id" : "4e919d73499648e3b0292cd3cbef806a", "domain_name" : "devcloud_devcloud_s00404480_01", "nick_name" : "测试账号", "role_id" : "8dc2cd191a104148a77f937681f9a5d6,6af50476ba89492698d237fb6fa456d6", "role_name" : "项目管理员,项目经理", "role_code" : "project_admin,Project manager", "image_id" : null, "region" : null, "has_removed" : null }, "created_date" : "1712041275000", "closed_flag" : null, "category" : "RR", "collaborative_status" : [ ], "setup" : true, "parent_status" : "no" } ] } }

请求示例 Post https://{endpoint}/v1/ipdprojectservice/projects/{project_id}/issues/query?issue_type=IR,US { "filter" : [ { "descendants.plan_pi" : { "values" : [ "956200745322848257" ], "operator" : "||" }, "descendants.plan_iteration" : { "values" : [ "956200745322848257-child" ], "operator" : "||" } }, { "descendants.priority" : { "values" : [ "中" ], "operator" : "||" } }, { "descendants.assignee" : { "values" : [ "a360371833bf4c558f796fd707b44daf" ], "operator" : "||" } }, { "descendants.status" : { "values" : [ "Start" ], "operator" : "||" } }, { "parent_id" : { "values" : [ "" ], "operator" : "||" } } ], "page" : { "page_no" : 1, "page_size" : 20 } }

URI POST /v1/ipdprojectservice/projects/{project_id}/issues/query 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 项目的32位uuid，项目唯一标识，通过查询项目列表接口获取，响应消息体中的project_id字段的值就是项目ID 约束限制： 正则表达式，[A-Za-z0-9]{32} 取值范围： 不涉及 默认取值： 不涉及 表2 Query参数 参数 是否必选 参数类型 描述 issue_type 是 String 参数解释： 工作项类型，区分大小写，传入错误的工作项类型时不返回数据，系统设备类和独立软件类型的项目当issue_type传入没有父子关系的工作项时，仅返回第一个工作项类型数据 约束限制： 支持多种工作项类型，使用英文逗号分隔 取值范围： RR/SF/IR/SR/AR/Task/Bug（系统设备类项目可选值） RR/SF/IR/US/Task/Bug（独立软件类项目可选值） RR/Epic/FE/US/Task/Bug（云服务类项目可选值） 默认取值： 不涉及

响应示例 状态码：200 OK { "status" : "success", "message" : null, "result" : { "issues" : [ { "category" : "IR", "id" : "961308804339843073", "title" : "IR-16-分解", "type" : "requirement", "number" : "IR20240205000401", "project_id" : "8e70d806a8f04d018ea6af6b6ffe7b96", "status" : "Start", "state" : "正在工作", "assignee" : { "id" : "a360371833bf4c558f796fd707b44daf", "name" : "devcloud_devcloud_s00404480_01", "nick_name" : "测试账号" }, "assigned_cc" : [ { "id" : "a360371833bf4c558f796fd707b44daf", "name" : "devcloud_devcloud_s00404480_01", "nick_name" : "测试账号" } ], "created_by" : { "id" : "a360371833bf4c558f796fd707b44daf", "name" : "devcloud_devcloud_s00404480_01", "nick_name" : "测试账号" }, "created_time" : "1707123479000", "modified_by" : { "id" : "a360371833bf4c558f796fd707b44daf", "name" : "devcloud_devcloud_s00404480_01", "nick_name" : "测试账号" }, "modified_time" : "1707123480000", "workload" : "20.00", "tenant_id" : "4e919d73499648e3b0292cd3cbef806a", "link" : "", "status_modified_time" : "1707123480000", "custom_fields" : [ { "code" : "c7073388365101674496", "value" : "881467547473321986" }, { "code" : "c7148512434669625344", "value" : "956591616891461634" } ], "children" : [ ], "ir2feature" : "", "need_break" : "yes", "break_status" : "undecomposed", "priority" : "中", "related_network_security" : "no", "business_domain" : "software", "submitted_by" : [ { "id" : "a360371833bf4c558f796fd707b44daf", "name" : "devcloud_devcloud_s00404480_01", "nick_name" : "测试账号" } ], "ir2rr" : "956559072707911681" } ], "total" : 1 } } 状态码：400 错误信息 { "error_code" : "PM.02175000", "error_msg" : "系统繁忙，请稍后再试" }

请求示例 POST https://{endpoint}/v1/ipdprojectservice/projects/8e70d806a8f04d018ea6af6b6ffe7b96/issues/tree?category=IR,US { "keyword" : "IR-", "plan" : [ { "plan_pi" : "966380919792246785", "plan_iteration" : [ "967014561020424192", "-2" ] } ], "number" : [ "IR20240218102026" ], "limit" : 10, "offset" : 0 }

响应参数 状态码：200 表7 响应Body参数 参数 参数类型 描述 result IssueEntityPageResult object 参数解释： 工作项树形列表接口。 status String 参数解释： 查询状态。 取值范围： 不涉及。 message String 参数解释： 查询失败的原因。 取值范围： 不涉及。 表8 IssueEntityPageResult 参数 参数类型 描述 issues Array of IssueEntity objects 参数解释： 工作项列表。 total Integer 参数解释： 工作项总数。 取值范围： 不涉及。 表9 IssueEntity 参数 参数类型 描述 id String 参数解释： 需要更新的工作项id，可通过[查询树状工作项]接口获取，响应消息体中的id字段的值就是工作项id。 约束限制： 正则表达式，^([0-9]{18,19})$ 取值范围： 不涉及。 默认取值： 不涉及。 title String 参数解释： 工作项标题，可通过[查询树状工作项]接口获取，响应消息体中的title字段的值就是工作项标题。 约束限制： 最小长度：1，最大长度：256。 取值范围： 不涉及。 默认取值： 不涉及。 description String 参数解释： 工作项描述字段，可通过[查询树状工作项]接口获取，响应消息体中的description字段的值就是工作项描述字段。 约束限制： 最小长度：1，最大长度：50000。 取值范围： 不涉及。 默认取值： 不涉及。 type String 参数解释： 工作项大分类定义，工作项创建、编辑无此字段，仅作展示用 requirement(研发需求)、bug(缺陷)、task(任务)、feature(特性)、raw_requirement(原始需求)，可通过[查询树状工作项]接口获取，响应消息体中的type字段的值就是工作项大分类定义。 约束限制： 最小长度：0，最大长度：128。 取值范围： 不涉及。 默认取值： 不涉及。 number String 参数解释： 工作项编号，可通过[查询树状工作项]接口获取，响应消息体中的number字段的值就是工作项编号 约束限制： 最小长度：0，最大长度：128。 取值范围： 不涉及。 默认取值： 不涉及。 category String 参数解释： 工作项类型，系统设备类项目可选值为:RR/SF/IR/SR/AR/Task/Bug，独立软件类项目可选值为:RR/SF/IR/US/Task/Bug，云服务类项目可选值为:RR/Epic/FE/US/Task/Bug。编辑工作项时，此字段必填、值为当前工作项正确的工作项类型，但不会更新此字段，可通过[查询树状工作项]接口获取，响应消息体中的category字段的值就是工作项类型 约束限制： 不涉及。 取值范围： 系统设备类项目可选值为：RR/SF/IR/SR/AR/Task/Bug。 独立软件类项目可选值为：RR/SF/IR/US/Task/Bug。 云服务类项目可选值为：RR/Epic/FE/US/Task/Bug。 默认取值： 不涉及。 parent_id String 参数解释： 父工作项id，可通过[查询树状工作项]接口获取，响应消息体中的parent_id字段的值就是父工作项id 约束限制： 正则表达式，^([0-9]{18,19})$。 取值范围： 不涉及。 默认取值： 不涉及。 project_id String 参数解释： 项目的32位uuid，项目唯一标识，通过[查询项目列表]接口获取，响应消息体中的project_id字段的值就是项目ID。 约束限制： 正则表达式，[A-Za-z0-9]{32}。 取值范围： 不涉及 默认取值： 不涉及。 status String 参数解释： 工作项状态code，可通过[查询树状工作项]接口获取，响应消息体中的status字段的值就是工作项状态code。 约束限制： 最小长度：2，最大长度：32。 取值范围： 不涉及。 默认取值： 不涉及。 state String 参数解释： 工作项的生命周期，可选值为"正在工作"，"作废"，可通过[查询树状工作项]接口获取，响应消息体中的state字段的值就是工作项的生命周期。 约束限制： 最小长度：2，最大长度：8。 取值范围： 正在工作，作废。 默认取值： 不涉及。 assignee UserEntity object 参数解释： 工作项责任人。 assigned_cc Array of UserEntity objects 参数解释： 工作项抄送人，支持多个抄送人。同一工作项最多支持50个抄送人。 created_by UserEntity object 参数解释： 工作项创建人。 created_time String 参数解释： 工作项创建时间，unix时间戳，单位：毫秒。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 modified_by UserEntity object 参数解释： 工作项最近更新人。 modified_time String 参数解释： 工作项最近更新时间，unix时间戳，单位：毫秒。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 plan_end_date String 参数解释： 工作项计划结束日期，unix时间戳，单位：毫秒。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 close_time String 参数解释： 工作项关闭时间，unix时间戳，单位：毫秒。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 workload String 参数解释： 工作项计划工时，保留一位小数，取值范围为0~999999999.9。 约束限制： 不涉及。 取值范围： 0~999999999.9。 默认取值： 不涉及。 workload_sum String 参数解释： 工作项计划工时，保留一位小数，取值范围为0~999999999.9，不可编辑。 约束限制： 最小长度：0，最大长度：11。 取值范围： 0~999999999.9。 默认取值： 不涉及。 tenant_id String 参数解释： 工作项所属租户id，可通过[查询树状工作项]接口获取，响应消息体中的tenant_id字段的值就是工作项所属租户id。 约束限制： 最小长度：32，最大长度：32。 取值范围： 不涉及。 默认取值： 不涉及。 link String 参数解释： 工作项关联项id，多个关联项用英文逗号分隔，同一工作项最多支持50个关联项，可通过[查询树状工作项]接口获取，响应消息体中的link字段的值就是工作项关联项id。 约束限制： 最小长度：0，最大长度：2048。 取值范围： 不涉及。 默认取值： 不涉及。 suspended Boolean 参数解释： 工作项是否已挂起。 约束限制： 不涉及。 取值范围： true，false。 默认取值： 不涉及。 status_modified_time String 参数解释： 工作项状态改变时间，可用于计算工作项在当前状态停留天数，unix时间戳，单位：毫秒。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 labels Array of LabelEntity objects 参数解释： 工作项标签。 custom_fields Array of FieldCodeValuePair objects 参数解释： 工作项自定义字段映射，用户添加的系统字段也在此列 { "code":"字段code", "value":"字段值" }。 children Array of IssueEntity objects 参数解释： 工作项的子工作项集合。 path String 参数解释： 子工作项的路径。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 ir2feature String 参数解释： IR和FE的关联字段，工作项类型为IR时，有此字段。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 need_break String 参数解释： 工作项是否需要分解,仅可以分解的工作项类型有此字段。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 break_status String 参数解释： 分解状态， 已分解（decomposed） 未分解（undecomposed） 不涉及（ --）。 约束限制： 不涉及。 取值范围： decomposed，undecomposed，--。 默认取值： 不涉及。 baseline String 参数解释： 工作项基线状态， 未基线（null） 已基线（baselined） 基线评审中（baseline-reviewing）。 约束限制： 不涉及。 取值范围： null，baselined，baseline-reviewing。 默认取值： 不涉及。 priority String 参数解释： 工作项优先级，部分工作项有此字段。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 related_network_security String 参数解释： 是否涉及网络安全。预设字段中，仅研发需求有此字段。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 collaboratives String 参数解释： 研发需求协同信息，协同任务id，可通过[查询树状工作项]接口获取，响应消息体中的collaboratives字段的值就是研发需求协同信息，协同任务id。 约束限制： 最小长度：0，最大长度：256。 取值范围： 不涉及。 默认取值： 不涉及。 business_domain String 参数解释： 领域字段。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 plan_pi String 参数解释： 工作项发布计id，可通过[查询树状工作项]接口获取，响应消息体中的plan_pi字段的值就是工作项发布计id。 约束限制： 正则表达式，^([0-9]{18,19})$。 取值范围： 不涉及。 默认取值： 不涉及。 plan_iteration String 参数解释： 工作项完成的迭代计划id，在Bug中为修复迭代计划id，可通过[查询树状工作项]接口获取，响应消息体中的plan_iteration字段的值就是迭代计划id。 约束限制： 正则表达式，^([0-9]{18,19})$。 取值范围： 不涉及。 默认取值： 不涉及。 change_status String 参数解释： 工作项变更状态， 变更评审中（change-reviewing） 已变更（changed） 未变更（unchange或null）。 约束限制： 最小长度：0，最大长度：32。 取值范围： change-reviewing，changed，unchange，null。 默认取值： 不涉及。 no_break_reason String 参数解释： 无需分解原因，need_break=no时有此字段 约束限制： 最小长度：0，最大长度：512。 取值范围： 不涉及。 默认取值： 不涉及。 submitted_by Array of UserEntity objects 参数解释： 工作项提出人。 ir2rr String 参数解释： IR关联的RR id，多选时用英文逗号分隔。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 feature_set String 参数解释： 特性集id，可通过[查询树状工作项]接口获取，响应消息体中的feature_set字段的值就是特性集id。 约束限制： 正则表达式，^([0-9]{18,19})$。 取值范围： 不涉及。 默认取值： 不涉及。 expected_repair_date String 参数解释： 期望修复时间。预设字段中，仅Bug有此字段，unix时间戳，单位：毫秒。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 found_pi String 参数解释： 缺陷发现发布计划id，预设字段中，仅Bug有此字段，可通过[查询树状工作项]接口获取，响应消息体中的found_pi字段的值就是缺陷发现发布计划id。 约束限制： 正则表达式，^([0-9]{18,19})$。 取值范围： 不涉及。 默认取值： 不涉及。 found_iteration String 参数解释： 缺陷发现迭代计划id，预设字段中，仅Bug有此字段，可通过[查询树状工作项]接口获取，响应消息体中的found_iteration字段的值就是缺陷发现迭代计划id。 约束限制： 正则表达式，^([0-9]{18,19})$。 取值范围： 不涉及。 默认取值： 不涉及。 reason_analysis String 参数解释： 分析原因。预设字段中，仅Bug有此字段。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 repair_solution String 参数解释： 修复方案。预设字段中，仅Bug有此字段。 约束限制： 最小长度：0，最大长度：50000。 取值范围： 不涉及。 默认取值： 不涉及。 test_report String 参数解释： 测试报告。预设字段中，仅Bug有此字段。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 sys_no_repair_reason String 参数解释： 无需修复原因。预设字段中，仅Bug有此字段。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 sys_activation_reason String 参数解释： 激活原因。预设字段中，仅Bug有此字段。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 sys_return_reason String 参数解释： 退回原因。预设字段中，仅Bug有此字段。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 test_failures_times Integer 参数解释： 回归不通过次数。预设字段中，仅Bug有此字段。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 close_type String 参数解释： 关闭类型。预设字段中，仅Bug有此字段，可选值为problem_solved，problem_to_requirement，duplicate_problem，not_a_problem。分别对应问题解决关闭，问题转需求关闭，重复问题关闭，非问题关闭。 约束限制： 不涉及。 取值范围： problem_solved，problem_to_requirement，duplicate_problem，not_a_problem。 默认取值： 不涉及。 表10 UserEntity 参数 参数类型 描述 id String 参数解释： 用户id，可通过[获取当前用户信息]接口获取，响应消息体中的id字段的值就是用户id。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 name String 参数解释： 用户名称。 约束限制： 最小长度：2，最大长度：64。 取值范围： 不涉及。 默认取值： 不涉及。 nick_name String 参数解释： 用户昵称。 约束限制： 最小长度：2，最大长度：30。 取值范围： 不涉及。 默认取值： 不涉及。 表11 LabelEntity 参数 参数类型 描述 id String 参数解释： 标签id，可通过[查询标签列表]接口获取，响应消息体中的id字段的值就是标签id。 约束限制： 正则表达式，^([0-9]{18,19})$。 取值范围： 不涉及。 默认取值： 不涉及。 label_type String 参数解释： 标签所属工作项类型，对应工作项的type字段。 约束限制： 最小长度：0，最大长度：32。 取值范围： 不涉及。 默认取值： 不涉及。 color String 参数解释： 标签颜色RGB。 约束限制： 最小长度：0，最大长度：16。 取值范围： 不涉及。 默认取值： 不涉及。 title String 参数解释： 标签标题。 约束限制： 最小长度：2，最大长度：256。 取值范围： 不涉及。 默认取值： 不涉及。 表12 FieldCodeValuePair 参数 参数类型 描述 code String 参数解释： 工作项字段code值。 约束限制： 最小长度：0，最大长度：32。 取值范围： 不涉及。 默认取值： 不涉及。 value String 参数解释： 工作项自定义字段值，为多选时用英文逗号分隔。 约束限制： 最小长度：0，最大长度：10000。 取值范围： 不涉及。 默认取值： 不涉及。 状态码：400 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

URI POST /v1/ipdprojectservice/projects/{project_id}/issues/tree 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 项目的32位uuid，项目唯一标识，通过查询项目列表接口获取，响应消息体中的project_id字段的值就是项目ID 约束限制： 正则表达式，[A-Za-z0-9]{32} 取值范围： 不涉及 默认取值： 不涉及 表2 Query参数 参数 是否必选 参数类型 描述 category 是 String 参数解释： 工作项类型。 约束限制： 正则表达式：([A-Za-z_,]{2,32})。 取值范围： 系统设备类项目可选值为:RR/SF/IR/SR/AR/Task/Bug，独立软件类项目可选值为:RR/SF/IR/US/Task/Bug，云服务类项目可选值为:RR/Epic/FE/US/Task/Bug。支持多种工作项类型，使用英文逗号分隔，如category=IR,SR,AR。 默认取值： 不涉及。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数解释： 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制： 必传。 取值范围： 最小长度：10，最大长度：32768。 默认取值： 不涉及。 表4 请求Body参数 参数 是否必选 参数类型 描述 keyword 否 String 参数解释： 关键字。支持标题模糊搜索，编号精确搜索 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 number 否 Array of strings 参数解释： 按编号批量搜索，number参数有值时，keyword参数不生效。 约束限制： 不涉及。 plan 否 Array of PlanFilterVO objects 参数解释： 按发布计划、迭代计划条件过滤。参数为发布计划、迭代计划id，迭代计划id和发布计划id有从属关系，-2表示未设置内容 约束限制： 不涉及。 offset 否 Integer 参数解释： 分页参数—偏移量，从0开始，值为limit的整数倍。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 limit 否 Integer 参数解释： 分页参数—每页大小。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 默认20。 modified_date 否 DateFilterVO object 参数解释： 工作项最后修改时间。 约束限制： 不涉及。 表5 PlanFilterVO 参数 是否必选 参数类型 描述 plan_pi 否 String 参数解释： 发布计划id，-2表示未设置内容。 约束限制： 正则表达式：([0-9]{18,19})|(-2)。 取值范围： 不涉及。 默认取值： 不涉及。 plan_iteration 否 Array of strings 参数解释： 发布计划下的迭代计划id，-2表示未设置迭代。 约束限制： 不涉及。 表6 DateFilterVO 参数 是否必选 参数类型 描述 start_date 否 String 参数解释： 时间过滤器开始时间戳，-2表示未设置内容。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 end_date 否 String 参数解释： 时间过滤器结束时间戳，-2表示未设置内容。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

响应参数 状态码：200 表7 响应Body参数 参数 参数类型 描述 result Array of IssueBatchOperateEntitiesResult objects 参数解释： 批量编辑的结果 status String 参数解释： 操作状态 取值范围： 不涉及 message String 参数解释： 操作失败原因 取值范围： 不涉及 表8 IssueBatchOperateEntitiesResult 参数 参数类型 描述 success Array of IssueOperateResult objects 参数解释： 成功的结果 failed Array of IssueOperateResult objects 参数解释： 失败的结果 表9 IssueOperateResult 参数 参数类型 描述 id String 参数解释： 变更的工作项id 取值范围： 不涉及 operator String 参数解释： 工作项变更人id 取值范围： 不涉及 state String 参数解释： 工作项变更后生命周期状态 取值范围： 不涉及 operate_time String 参数解释： 工作项变更时间 取值范围： 不涉及 状态码：400 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求示例 批量更新研发需求 PUT https://{endpoint}/v1/ipdprojectservice/projects/8e70d806a8f04d018ea6af6b6ffe7b96/issues/batch { "id" : [ "957294446158852096", "957315051394478080" ], "attribute" : { "category" : "IR", "priority" : "低", "submitted_by" : [ { "id" : "a360371833bf4c558f796fd707b44daf" } ], "labels" : [ { "id" : "956308025419804673" }, { "id" : "956308025419804673" } ], "custom_fields" : [ { "code" : "c7073388365101674496", "value" : "881467547473321986,881467547473321987" }, { "code" : "c7148504958125613056", "value" : "我是一个项目自定义字段" }, { "code" : "module", "value" : "956584293264568320" }, { "code" : "c7148512434669625344", "value" : "956591616891461634" } ] } }

响应示例 状态码：200 OK { "status" : "success", "result" : [ { "success" : [ { "id" : "957294446158852096", "operator" : "a360371833bf4c558f796fd707b44daf", "operate_time" : "2024-01-29T21:26:11Z" }, { "id" : "957315051394478080", "operator" : "a360371833bf4c558f796fd707b44daf", "operate_time" : "2024-01-29T21:26:11Z" } ], "failed" : [ ] } ] } 状态码：400 错误原因 { "error_code" : "PM.02175000", "error_msg" : "系统繁忙，请稍后再试" }

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 id 是 Array of strings 参数解释： 需要更新的工作项id数组，可通过[高级查询工作项]接口获取，响应消息体中的id字段的值就是工作项id 约束限制： 正则表达式，^([0-9]{18,19})$ 取值范围： 最小长度：18，最大长度：19 默认取值： 不涉及 attribute 否 IssueEntity object 参数解释： 更新的工作项内容 表3 IssueEntity 参数 是否必选 参数类型 描述 id 否 String 参数解释： 需要更新的工作项id，可通过[查询树状工作项]接口获取，响应消息体中的id字段的值就是工作项id。 约束限制： 正则表达式，^([0-9]{18,19})$ 取值范围： 不涉及。 默认取值： 不涉及。 title 否 String 参数解释： 工作项标题，可通过[查询树状工作项]接口获取，响应消息体中的title字段的值就是工作项标题。 约束限制： 最小长度：1，最大长度：256。 取值范围： 不涉及。 默认取值： 不涉及。 description 否 String 参数解释： 工作项描述字段，可通过[查询树状工作项]接口获取，响应消息体中的description字段的值就是工作项描述字段。 约束限制： 最小长度：1，最大长度：50000。 取值范围： 不涉及。 默认取值： 不涉及。 type 否 String 参数解释： 工作项大分类定义，工作项创建、编辑无此字段，仅作展示用 requirement(研发需求)、bug(缺陷)、task(任务)、feature(特性)、raw_requirement(原始需求)，可通过[查询树状工作项]接口获取，响应消息体中的type字段的值就是工作项大分类定义。 约束限制： 最小长度：0，最大长度：128。 取值范围： 不涉及。 默认取值： 不涉及。 number 否 String 参数解释： 工作项编号，可通过[查询树状工作项]接口获取，响应消息体中的number字段的值就是工作项编号 约束限制： 最小长度：0，最大长度：128。 取值范围： 不涉及。 默认取值： 不涉及。 category 否 String 参数解释： 工作项类型，系统设备类项目可选值为:RR/SF/IR/SR/AR/Task/Bug，独立软件类项目可选值为:RR/SF/IR/US/Task/Bug，云服务类项目可选值为:RR/Epic/FE/US/Task/Bug。编辑工作项时，此字段必填、值为当前工作项正确的工作项类型，但不会更新此字段，可通过[查询树状工作项]接口获取，响应消息体中的category字段的值就是工作项类型 约束限制： 不涉及。 取值范围： 系统设备类项目可选值为：RR/SF/IR/SR/AR/Task/Bug。 独立软件类项目可选值为：RR/SF/IR/US/Task/Bug。 云服务类项目可选值为：RR/Epic/FE/US/Task/Bug。 默认取值： 不涉及。 parent_id 否 String 参数解释： 父工作项id，可通过[查询树状工作项]接口获取，响应消息体中的parent_id字段的值就是父工作项id 约束限制： 正则表达式，^([0-9]{18,19})$。 取值范围： 不涉及。 默认取值： 不涉及。 project_id 否 String 参数解释： 项目的32位uuid，项目唯一标识，通过[查询项目列表]接口获取，响应消息体中的project_id字段的值就是项目ID。 约束限制： 正则表达式，[A-Za-z0-9]{32}。 取值范围： 不涉及 默认取值： 不涉及。 status 否 String 参数解释： 工作项状态code，可通过[查询树状工作项]接口获取，响应消息体中的status字段的值就是工作项状态code。 约束限制： 最小长度：2，最大长度：32。 取值范围： 不涉及。 默认取值： 不涉及。 assignee 否 UserEntity object 参数解释： 工作项责任人。 assigned_cc 否 Array of UserEntity objects 参数解释： 工作项抄送人，支持多个抄送人。同一工作项最多支持50个抄送人。 created_by 否 UserEntity object 参数解释： 工作项创建人。 created_time 否 String 参数解释： 工作项创建时间，unix时间戳，单位：毫秒。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 modified_by 否 UserEntity object 参数解释： 工作项最近更新人。 modified_time 否 String 参数解释： 工作项最近更新时间，unix时间戳，单位：毫秒。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 plan_end_date 否 String 参数解释： 工作项计划结束日期，unix时间戳，单位：毫秒。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 close_time 否 String 参数解释： 工作项关闭时间，unix时间戳，单位：毫秒。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 workload 否 String 参数解释： 工作项计划工时，保留一位小数，取值范围为0~999999999.9。 约束限制： 不涉及。 取值范围： 0~999999999.9。 默认取值： 不涉及。 link 否 String 参数解释： 工作项关联项id，多个关联项用英文逗号分隔，同一工作项最多支持50个关联项，可通过[查询树状工作项]接口获取，响应消息体中的link字段的值就是工作项关联项id。 约束限制： 最小长度：0，最大长度：2048。 取值范围： 不涉及。 默认取值： 不涉及。 suspended 否 Boolean 参数解释： 工作项是否已挂起。 约束限制： 不涉及。 取值范围： true，false。 默认取值： 不涉及。 status_modified_time 否 String 参数解释： 工作项状态改变时间，可用于计算工作项在当前状态停留天数，unix时间戳，单位：毫秒。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 labels 否 Array of LabelEntity objects 参数解释： 工作项标签。 custom_fields 否 Array of FieldCodeValuePair objects 参数解释： 工作项自定义字段映射，用户添加的系统字段也在此列 { "code":"字段code", "value":"字段值" }。 children 否 Array of IssueEntity objects 参数解释： 工作项的子工作项集合。 ir2feature 否 String 参数解释： IR和FE的关联字段，工作项类型为IR时，有此字段。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 need_break 否 String 参数解释： 工作项是否需要分解,仅可以分解的工作项类型有此字段。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 break_status 否 String 参数解释： 分解状态， 已分解（decomposed） 未分解（undecomposed） 不涉及（ --）。 约束限制： 不涉及。 取值范围： decomposed，undecomposed，--。 默认取值： 不涉及。 baseline 否 String 参数解释： 工作项基线状态， 未基线（null） 已基线（baselined） 基线评审中（baseline-reviewing）。 约束限制： 不涉及。 取值范围： null，baselined，baseline-reviewing。 默认取值： 不涉及。 priority 否 String 参数解释： 工作项优先级，部分工作项有此字段。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 related_network_security 否 String 参数解释： 是否涉及网络安全。预设字段中，仅研发需求有此字段。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 collaboratives 否 String 参数解释： 研发需求协同信息，协同任务id，可通过[查询树状工作项]接口获取，响应消息体中的collaboratives字段的值就是研发需求协同信息，协同任务id。 约束限制： 最小长度：0，最大长度：256。 取值范围： 不涉及。 默认取值： 不涉及。 business_domain 否 String 参数解释： 领域字段。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 plan_pi 否 String 参数解释： 工作项发布计id，可通过[查询树状工作项]接口获取，响应消息体中的plan_pi字段的值就是工作项发布计id。 约束限制： 正则表达式，^([0-9]{18,19})$。 取值范围： 不涉及。 默认取值： 不涉及。 plan_iteration 否 String 参数解释： 工作项完成的迭代计划id，在Bug中为修复迭代计划id，可通过[查询树状工作项]接口获取，响应消息体中的plan_iteration字段的值就是迭代计划id。 约束限制： 正则表达式，^([0-9]{18,19})$。 取值范围： 不涉及。 默认取值： 不涉及。 change_status 否 String 参数解释： 工作项变更状态， 变更评审中（change-reviewing） 已变更（changed） 未变更（unchange或null）。 约束限制： 最小长度：0，最大长度：32。 取值范围： change-reviewing，changed，unchange，null。 默认取值： 不涉及。 no_break_reason 否 String 参数解释： 无需分解原因，need_break=no时有此字段 约束限制： 最小长度：0，最大长度：512。 取值范围： 不涉及。 默认取值： 不涉及。 submitted_by 否 Array of UserEntity objects 参数解释： 工作项提出人。 ir2rr 否 String 参数解释： IR关联的RR id，多选时用英文逗号分隔。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 feature_set 否 String 参数解释： 特性集id，可通过[查询树状工作项]接口获取，响应消息体中的feature_set字段的值就是特性集id。 约束限制： 正则表达式，^([0-9]{18,19})$。 取值范围： 不涉及。 默认取值： 不涉及。 expected_repair_date 否 String 参数解释： 期望修复时间。预设字段中，仅Bug有此字段，unix时间戳，单位：毫秒。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 found_pi 否 String 参数解释： 缺陷发现发布计划id，预设字段中，仅Bug有此字段，可通过[查询树状工作项]接口获取，响应消息体中的found_pi字段的值就是缺陷发现发布计划id。 约束限制： 正则表达式，^([0-9]{18,19})$。 取值范围： 不涉及。 默认取值： 不涉及。 found_iteration 否 String 参数解释： 缺陷发现迭代计划id，预设字段中，仅Bug有此字段，可通过[查询树状工作项]接口获取，响应消息体中的found_iteration字段的值就是缺陷发现迭代计划id。 约束限制： 正则表达式，^([0-9]{18,19})$。 取值范围： 不涉及。 默认取值： 不涉及。 reason_analysis 否 String 参数解释： 分析原因。预设字段中，仅Bug有此字段。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 repair_solution 否 String 参数解释： 修复方案。预设字段中，仅Bug有此字段。 约束限制： 最小长度：0，最大长度：50000。 取值范围： 不涉及。 默认取值： 不涉及。 test_report 否 String 参数解释： 测试报告。预设字段中，仅Bug有此字段。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 sys_no_repair_reason 否 String 参数解释： 无需修复原因。预设字段中，仅Bug有此字段。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 sys_activation_reason 否 String 参数解释： 激活原因。预设字段中，仅Bug有此字段。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 sys_return_reason 否 String 参数解释： 退回原因。预设字段中，仅Bug有此字段。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 test_failures_times 否 Integer 参数解释： 回归不通过次数。预设字段中，仅Bug有此字段。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 close_type 否 String 参数解释： 关闭类型。预设字段中，仅Bug有此字段，可选值为problem_solved，problem_to_requirement，duplicate_problem，not_a_problem。分别对应问题解决关闭，问题转需求关闭，重复问题关闭，非问题关闭。 约束限制： 不涉及。 取值范围： problem_solved，problem_to_requirement，duplicate_problem，not_a_problem。 默认取值： 不涉及。 表4 UserEntity 参数 是否必选 参数类型 描述 id 否 String 参数解释： 用户id，可通过[获取当前用户信息]接口获取，响应消息体中的id字段的值就是用户id。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 name 否 String 参数解释： 用户名称。 约束限制： 最小长度：2，最大长度：64。 取值范围： 不涉及。 默认取值： 不涉及。 nick_name 否 String 参数解释： 用户昵称。 约束限制： 最小长度：2，最大长度：30。 取值范围： 不涉及。 默认取值： 不涉及。 表5 LabelEntity 参数 是否必选 参数类型 描述 id 否 String 参数解释： 标签id，可通过[查询标签列表]接口获取，响应消息体中的id字段的值就是标签id。 约束限制： 正则表达式，^([0-9]{18,19})$。 取值范围： 不涉及。 默认取值： 不涉及。 label_type 否 String 参数解释： 标签所属工作项类型，对应工作项的type字段。 约束限制： 最小长度：0，最大长度：32。 取值范围： 不涉及。 默认取值： 不涉及。 color 否 String 参数解释： 标签颜色RGB。 约束限制： 最小长度：0，最大长度：16。 取值范围： 不涉及。 默认取值： 不涉及。 title 否 String 参数解释： 标签标题。 约束限制： 最小长度：2，最大长度：256。 取值范围： 不涉及。 默认取值： 不涉及。 表6 FieldCodeValuePair 参数 是否必选 参数类型 描述 code 否 String 参数解释： 工作项字段code值。 约束限制： 最小长度：0，最大长度：32。 取值范围： 不涉及。 默认取值： 不涉及。 value 否 String 参数解释： 工作项自定义字段值，为多选时用英文逗号分隔。 约束限制： 最小长度：0，最大长度：10000。 取值范围： 不涉及。 默认取值： 不涉及。

URI PUT /v1/ipdprojectservice/projects/{project_id}/issues/batch 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 项目的32位uuid，项目唯一标识，通过查询项目列表接口获取，响应消息体中的project_id字段的值就是项目ID 约束限制： 正则表达式，[A-Za-z0-9]{32} 取值范围： 不涉及 默认取值： 不涉及

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 status String 参数解释： 请求状态。 取值范围： 不涉及。 message String 参数解释： 响应信息。 取值范围： 不涉及。 result Array of AttachmentEntity objects 参数解释： 附件列表。 表4 AttachmentEntity 参数 参数类型 描述 id String 参数解释： 附件Id。 取值范围： 不涉及。 issue_id String 参数解释： 附件所属工作项Id。 取值范围： 不涉及。 file_size Long 参数解释： 附件大小，单位为Byte，单个附件最大为50MB。 取值范围： 不涉及。 file_name String 参数解释： 附件原名称。 取值范围： 不涉及。 attachment_type String 参数解释： 附件类型，即文件扩展名。 取值范围： 不涉及。 modified_by UserEntity object 参数解释： 修改人。 created_by UserEntity object 参数解释： 创建人。 created_date String 参数解释： 附件上传时间的时间戳。 取值范围： 不涉及。 表5 UserEntity 参数 参数类型 描述 id String 参数解释： 用户id，可通过[获取当前用户信息]接口获取，响应消息体中的id字段的值就是用户id。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 name String 参数解释： 用户名称。 约束限制： 最小长度：2，最大长度：64。 取值范围： 不涉及。 默认取值： 不涉及。 nick_name String 参数解释： 用户昵称。 约束限制： 最小长度：2，最大长度：30。 取值范围： 不涉及。 默认取值： 不涉及。 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码：200 附件响应 { "status" : "success", "message" : null, "result" : [ { "id" : "984409429450334208", "issue_id" : "984407816014831616", "file_size" : "79234", "file_name" : "IPD系统设备-缺陷-导入模板.xlsx", "modified_by" : { "id" : "a360371833bf4c558f796fd707b44daf", "name" : "devcloud_devcloud_s00404480_01", "nick_name" : "测试账号" }, "created_by" : { "id" : "a360371833bf4c558f796fd707b44daf", "name" : "devcloud_devcloud_s00404480_01", "nick_name" : "测试账号" }, "attachment_type" : "xlsx", "created_date" : "1712631097000" } ] } 状态码：400 通用错误响应 { "error_code" : "PM.02174103", "error_msg" : "无操作权限" }

URI GET /v1/ipdprojectservice/projects/{project_id}/attachments 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 项目的32位uuid，项目唯一标识，通过查询项目列表接口获取，响应消息体中的project_id字段的值就是项目ID 约束限制： 正则表达式，[A-Za-z0-9]{32} 取值范围： 不涉及 默认取值： 不涉及 表2 Query参数 参数 是否必选 参数类型 描述 issue_id 是 String 参数解释：工作项唯一Id。可以通过[查询工作项列表]或者[查询树状工作]接口获取，响应消息体中的id字段的值就是工作项ID 约束限制：正则表达式，^([0-9]{18,19})$ 默认取值：不涉及 source_project_id 是 String 参数解释： 工作项归属项目Id。当工作项类型为RR或Bug时，在提出项目查询提给外部的工作项附件时，project_id为提出项目Id，source_project_id为工作项归属项目Id。其他场景非必填。 约束限制： 正则表达式：[A-Za-z0-9]{32}。 取值范围： 不涉及。 默认取值： 不涉及。

请求示例 修改工时 PUT https://{endpoint}/v1/projects/dbf92424384e46dd9829492abe533829/work-items/1038401818296492033/work-hour/1038556057203286016 { "work_hours" : "321", "work_hour_category" : "后端开发", "description" : "工作内容" }

响应示例 状态码：200 工时信息以及工时总数信息返回 { "status" : "success", "message" : null, "result" : { "data" : [ { "id" : "1038556057203286016", "description" : "1133", "workitem_id" : "1038401818296492033", "created_by" : { "id" : "a360371833bf4c558f796fd707b44daf", "name" : "devcloud_devcloud_s00404480_01", "nick_name" : "t" }, "modified_by" : { "id" : "a360371833bf4c558f796fd707b44daf", "name" : "devcloud_devcloud_s00404480_01", "nick_name" : "t" }, "work_hour_category" : "后端开发", "work_hours" : 321 } ], "work_hours_total" : 387.7 } }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 status String 状态 message String 消息 result WorkHourTotalVO object 工时信息及工时总数 表4 WorkHourTotalVO 参数 参数类型 描述 data Array of WorkHourVO objects 工时信息列表 work_hours_total String 实际工时总数 表5 WorkHourVO 参数 参数类型 描述 id String 工时id title String 工时名称 operation_id String 操作ID description String 描述 workitem_id String 工作项id work_date String 工时日期 created_by UserEntity object 创建人信息 modified_by UserEntity object 修改人信息 work_hour_category String 工时类型唯一标识取值为value，页面展示取值为display_value work_hours String 花费工时(人天) 表6 UserEntity 参数 参数类型 描述 id String 参数解释： 用户id，可通过[获取当前用户信息]接口获取，响应消息体中的id字段的值就是用户id。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 name String 参数解释： 用户名称。 约束限制： 最小长度：2，最大长度：64。 取值范围： 不涉及。 默认取值： 不涉及。 nick_name String 参数解释： 用户昵称。 约束限制： 最小长度：2，最大长度：30。 取值范围： 不涉及。 默认取值： 不涉及。

URI PUT /v1/projects/{project_id}/work-items/{issue_id}/work-hour/{workhour_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 项目的32位uuid，项目唯一标识，通过查询项目列表接口获取，响应消息体中的project_id字段的值就是项目ID 约束限制： 正则表达式，[A-Za-z0-9]{32} 取值范围： 不涉及 默认取值： 不涉及 issue_id 是 String 参数解释：工作项唯一Id。可以通过[查询工作项列表]或者[查询树状工作]接口获取，响应消息体中的id字段的值就是工作项ID 约束限制：正则表达式，^([0-9]{18,19})$ 默认取值：不涉及 workhour_id 是 String 工时id

步骤一：购买HBase集群 登录 表格存储服务 控制台。 在控制台左上角选择区域。 单击“集群管理”进入集群管理界面。 单击集群管理界面右上角的“购买集群”，进入购买集群页面配置相关参数（安全组规则配置端口请参见HBase安全规则组）。 单击“立即购买”，进入确认规格页面，确认无误，单击“完成”。 返回集群列表查看创建集群进度，当集群状态为“服务中”时，集群创建成功，详细参见创建HBase集群。 表2 HBase安全规则组 方向 协议 端口/范围 源地址/安全组 用途 出方向 全部 全部 0.0.0.0/0 出方向放行 入方向 TCP 16000 CloudTable HBase集群所在的安全组 HMaster RPC端口 TCP 16020 RegionServer RPC端口 TCP 2181 监听ZooKeeper客户端连接监听端口 TCP 2888 Follower连接监听端口 TCP 3888 ZooKeeper选举端口 TCP 2000 Hagent访问端口

资源监控使用限制 表2 资源监控使用限制 分类 限制项 说明 仪表盘 仪表盘数量 1个区域中最多可创建1000个仪表盘。 仪表盘中的图表数量 1个仪表盘中最多可添加50个图表。 仪表盘中图表可选资源、阈值规则、组件或主机数量 1个数字图最多可添加12个资源，只能展示1个资源，默认展示第一个资源。 1个阈值状态图表最多可添加10个阈值规则。 1个主机状态图表最多可添加10个主机。 1个组件状态图表最多可添加10个组件。 指标 指标数据存储时长 指标数据在数据库中默认最多保存30天。 通过ICAgent插件采集指标数据时，采集周期为1分钟，不支持修改。 关联指标项存储时长 资源（例如，集群、组件、主机等）被删除后，其关联的指标项在数据库中最多保存30天。 指标维度个数 每个指标的维度最多为20个。 通过指标查询接口查询指标数量 单次最大可同时查询20个指标。 统计周期 最大统计周期为1小时。 单次查询返回指标数据点数量 单个指标单次查询最大返回1440个数据点。 自定义指标 无限制。 上报自定义指标 单次请求数据最大不能超过40KB，上报指标所带时间戳不能超前于标准UTC时间10分钟，不接收乱序指标，即有新指标上报后，旧指标上报将会失败。 应用指标 每个主机的容器个数超过1000个时，ICAgent将停止采集该主机应用指标，并发送“ICAgent停止采集应用指标”告警（告警ID：34105）。 每个主机的容器个数缩减到1000个以内时，ICAgent将恢复该主机应用指标采集，并清除“ICAgent停止采集应用指标”告警 。 JOB指标 由于JOB在完成任务之后，会自动退出。如果您需要监控JOB指标，要保证存活时间大于90秒才能采集到指标数据。 采集器资源消耗 采集器在采集基础指标时的资源消耗情况和容器、进程数等因素有关，在未运行任何业务的VM上，采集器将消耗30M内存、1% CPU。为保证采集可靠性，单节点上运行的容器个数应小于1000。 指标维度格式 指标的维度标签必须符合 AOM 标准格式或普罗标准格式，才能将指标上报到AOM： AOM标准格式：可以包含大小写字母、数字、下划线，且必须以字母或下划线开头。 普罗标准格式：可以包含ASCII字母、数字以及下划线，且必须与正则表达式匹配[a-zA-Z_][a-zA-Z0-9_]*。 告警规则 告警规则数量 告警规则（包含指标告警规则和事件告警规则）最多可创建3000个。 告警模板数量 告警模板最多可创建150个。 日志 日志功能限制 日志功能限制请参考LTS日志限制。 日志文件 只支持采集文本类型日志文件，不支持采集其他类型日志文件（例如二进制文件）。 每个通过卷挂载日志的路径下，ICAgent最多采集20个日志文件。 每个ICAgent最多采集1000个容器标准输出日志文件，容器标准输出日志只支持json-file类型。 采集日志文件的资源消耗 日志文件采集时消耗的资源和日志量、文件个数及网络带宽、backend服务处理能力等多种因素强相关。 日志丢弃 当单行日志长度超过10240字节时，此行会被丢弃。 日志采集路径 Linux 采集路径支持递归路径，**表示递归5层目录。示例：/var/logs/**/a.log。 采集路径支持模糊匹配，匹配目录或文件名中的任何字符。示例：/var/logs/*/a.log、/var/logs/service/a*.log。 采集路径如果配置的是目录，示例：/var/logs/，则只采集目录下后缀为“.log”、“.trace”和“.out”的文件；如果配置的是文件名，则直接采集对应文件，只支持文本类型的文件。 采集路径不能重复配置，即同一主机下的同一路径，即使跨日志组和日志流，也只能配置一次。 Windows Windows环境日志采集路径支持递归路径，**表示递归5层目录。配置样例：C:\var\service\**\a.log。 Windows环境日志采集路径支持模糊匹配，匹配目录或文件名中的任何字符。配置样例：C:\var\service\*\a.log、C:\var\service\a*.log。 采集路径不能重复配置，即同一主机下的同一路径，即使跨日志组和日志流，也只能配置一次。 windows事件日志采集不能重复配置，即同一主机下，即使跨日志组和日志流，也只能配置一次。 日志重复 当采集器被重启后，重启时间点附近可能会产生一定的数据重复。 历史日志 日志数据存储时长与您选择的版本有关，且收费不同，详见价格详情。 告警列表 查询告警时间范围 可查询最近一年内，时间跨度不超过31天的告警。 查询事件时间范围 可查询最近一年内，时间跨度不超过31天的事件。 应用发现 应用发现规则数量 应用发现规则最多可创建100个。