Updated on 2026-01-12 GMT+08:00

Moving Multiple Pipelines To a Group

Function

This API is used to move multiple pipelines to a group.

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/api/pipeline-group/pipeline/move

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Project ID. For details, see Obtaining a Project ID.

Constraints:

N/A

Value range:

The value consists of 32 characters, including digits and letters.

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API for .

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

group_id

Yes

String

Definition:

Group ID.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

pipelines

Yes

Array of pipelines objects

Definition:

Pipeline set.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Table 4 pipelines

Parameter

Mandatory

Type

Description

pipeline_id

Yes

String

Definition:

Pipeline ID. Obtain the ID by calling the API for querying pipelines. pipelines.pipelineId indicates the pipeline ID.

Constraints:

N/A

Value range:

The value consists of 32 characters, including only digits and letters.

Default value:

N/A

pipeline_name

Yes

String

Definition:

Pipeline name.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

[items]

Array of PipelineMoveToGroupResponseVo objects

Definition:

Response details.

Value range:

N/A

Table 6 PipelineMoveToGroupResponseVo

Parameter

Type

Description

code

String

Definition:

Response code.

Value range:

  • failed: failed.

  • success: succeeded.

pipeline_id

String

Definition:

Pipeline ID.

Value range:

The value consists of 32 characters, including digits and letters.

pipeline_name

String

Definition:

Pipeline name.

Value range:

N/A

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A

error_code

String

Parameter description:

Error code.

Value range:

N/A

Example Requests

POST https://{endpoint}/v5/d80a8a6530324b7bac972cbb8a9f28ec/api/pipeline-group/pipeline/move

{
  "group_id" : "2ca78947b25847a9ab68a07d8ef1347b",
  "pipelines" : [ {
    "pipeline_id" : "1ae88404911a4513bcdf8158ab6a0416",
    "pipeline_name" : "sdfgsdfgdfsg345345"
  }, {
    "pipeline_id" : "b99de7c698264251ac1fc3c053dc2b34",
    "pipeline_name" : "32131233131025122241"
  } ]
}

Example Responses

Status code: 200

OK

[ {
  "code" : "success",
  "pipeline_id" : "1ae88404911a4513bcdf8158ab6a0416",
  "pipeline_name" : "sdfgsdfgdfsg345345"
}, {
  "code" : "success",
  "pipeline_id" : "b99de7c698264251ac1fc3c053dc2b34",
  "pipeline_name" : "32131233131025122241"
} ]

Status Codes

Status Code

Description

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.