활성화/비활성화¶
POST /api/v1/pipeline/batch_set_disable
개요¶
Pipeline 및 해당 소스 연결을 일괄 활성화 또는 비활성화합니다.
호출 전 및 사용 단계¶
먼저 이 워크스페이스 목록에서 삭제되지 않은 Pipeline UUID를 항목별로 확인해야 하며, 다른 워크스페이스, 시스템 템플릿 또는 일치하지 않는 식별자를 혼합해서는 안 됩니다. 기본 구성 조회는 워크스페이스로 필터링되지만, 연결된 소스 상태 업데이트에는 전체 입력 집합이 사용됩니다. 기본 구성이 매칭되지 않았거나 HTTP 200이 반환되었다고 해서 다른 연결이 영향을 받지 않았다고 해석해서는 안 됩니다. true만 반환하며, 빈 배열이거나 기본 구성이 매칭되지 않아도 성공할 수 있고, 항목별 결과는 제공되지 않습니다. 활성화는 과거 데이터 리플레이를 트리거하지 않으며, 비활성화는 진행 중인 처리를 취소하지 않습니다. 이 작업은 구성 버전을 아카이빙하지 않습니다. 완료 후 목록을 다시 읽어 각 객체의 상태를 확인하십시오.
요청 헤더¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 획득합니다. |
Body 요청 파라미터¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| plUUIDs[*] | string | 이름 또는 과거 UUID가 아닙니다. 예: pl_example획득 또는 입력 방법: 단일 Pipeline UUID입니다. |
|
| isDisable | boolean | Y | 필수 불리언이며, 각각 status=2/0을 설정하고 연결된 소스 상태를 업데이트합니다. 삭제된 항목은 복구하지 않습니다. null 허용: False 예: true획득 또는 입력 방법: true는 일시 중지, false는 활성화입니다. |
| plUUIDs | array | Y | 필수 배열이며 비어 있지 않은 값을 권장합니다. 시스템 템플릿은 조작하지 않습니다. null 허용: False 예: ["pl_example"]획득 또는 입력 방법: 이 워크스페이스의 UUID 집합은 Pipeline 목록에서 가져옵니다. |
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/pipeline/batch_set_disable' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"plUUIDs":["pl_example"],"isDisable":true}'
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 타입 | 설명 |
|---|---|---|
| content | boolean | 성공 시 true이며, 모든 입력 UUID가 매칭되었음을 의미하지 않습니다. |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반했습니다. | 파라미터 구문 분석 실패 | 파라미터 위치, 필드명, 타입 및 값을 확인하십시오. |
| 400 | ft.RequestJsonFormatError | 요청 JSON 구문이 유효하지 않습니다. | 요청 JSON 형식 오류 | content.reason, line, column에 따라 JSON을 수정하십시오. |
| 500 | ft.InternalServerError | 동기 컴파일 서비스 사용 불가/시간 초과/형식 이상(내부 PipelineValidationUnavailable이 최종적으로 통합 래핑됨), 데이터베이스, 구조 오류 또는 제출 후 포맷 실패 | 내부 오류 | 잠시 후 다시 시도하기 전에 현재 구성과 버전을 먼저 읽어 저장되었는지 확인하십시오. 지속적으로 실패하면 traceId를 제공하십시오. |