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

批量基线或取消基线

功能介绍

批量基线或取消基线

调用方法

请参见如何调用API

URI

PUT /v1/planservice/projects/{project_id}/plans/batch-baseline

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

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

取值范围

不涉及。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

x-auth-token

String

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

约束限制:不涉及

取值范围:最小长度10,最大长度:32768

默认取值:不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

ids

Array of strings

发布/迭代计划ids

attribute

BaseLineVO object

基线信息

表4 BaseLineVO

参数

是否必选

参数类型

描述

baseline

String

基线或取消基线

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

result

BatchResultVO object

批量删除返回结果

表6 BatchResultVO

参数

参数类型

描述

success_num

Number

成功数量

fail_num

Number

失败数量

success

Array of BatchOperateInfo objects

成功的结果

failed

Array of BatchOperateInfo objects

失败的结果

表7 BatchOperateInfo

参数

参数类型

描述

id

String

发布/迭代计划的id

modified_by

String

更新者

状态码:400

表8 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

请求示例

PUT https://{endpoint}/v1/planservice/projects/b54914d464d1498a97d683ef198ec448/plans/batch-baseline

{
  "ids" : [ "6614174000", "6614174000" ],
  "attribute" : {
    "baseline" : "基线"
  }
}

响应示例

状态码:200

OK

{
  "result" : {
    "success_num" : 3,
    "fail_num" : 1,
    "success" : [ {
      "id" : "123e4567e89b12d3a456426614174000",
      "modified_by" : "user1"
    }, {
      "id" : "123e4567e89b12d3a456426614174001",
      "modified_by" : "user2"
    }, {
      "id" : "123e4567e89b12d3a456426614174002",
      "modified_by" : "user3"
    } ],
    "failed" : [ {
      "id" : "123e4567e89b12d3a456426614174003",
      "modified_by" : "user4"
    } ]
  }
}

状态码:400

Bad Request

{
  "error_msg" : "Invalid project_id or other parameters",
  "error_code" : "AS.0001"
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码

相关文档