批量删除流水线 - BatchDeletePipeline
功能介绍
批量删除流水线
调用方法
请参见如何调用API。
URI
POST /v5/{project_id}/api/pipelines/batch-delete
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方式请参见获取项目ID。 约束限制: 不涉及。 取值范围: 32位字符,由数字和字母组成。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| pipeline_ids | 是 | Array of strings | 参数解释: 流水线ID列表,可以通过查询流水线列表接口获取,其中pipelines.pipelineId即为流水线ID。 约束限制: 不涉及。 取值范围: 32位字符,由数字和字母组成。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| result | Array of result objects | 参数解释: 批量操作流水线响应体。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| pipeline_id | String | 参数解释: 流水线ID。 取值范围: 32位字符,仅由数字和字母组成。 |
| pipeline_name | String | 参数解释: 流水线名称。 取值范围: 仅包含中文、大小写英文字母、数字、'-'和'_',且长度为[1,128]个字符。 |
| status | String | 参数解释: 操作状态。DELETE_FAILED表示删除失败,DELETE_SUCCESS表示删除成功,SUCCESS表示操作成功,FAILED表示操作失败 取值范围: DELETE_FAILED,DELETE_SUCCESS,SUCCESS,FAILED。 |
| reason | String | 参数解释: 操作失败原因。 取值范围: 不涉及。 |
请求示例
POST https://{endpoint}}/v5/db8d07265e24426598b3eb03a7818972/api/pipelines/batch-delete
{
"pipeline_ids" : [ "d02cd56c8bfa406d96286454c87bd85a", "32d334890ff74d16b3f51df386f16407" ]
} 响应示例
状态码:200
OK
{
"result" : [ {
"pipeline_id" : "d02cd56c8bfa406d96286454c87bd85a",
"pipeline_name" : "删除2",
"status" : "DELETE_SUCCESS",
"reason" : null
}, {
"pipeline_id" : "32d334890ff74d16b3f51df386f16407",
"pipeline_name" : "删除111",
"status" : "DELETE_SUCCESS",
"reason" : null
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
错误码
请参见错误码。