파이프라인 실행 취소

Prev Next

Classic/VPC 환경에서 이용 가능합니다.

파이프라인의 실행을 취소합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
POST /api/v1/project/{projectId}/history/{historyId}/cancel

요청 헤더

SourcePipeline API에서 공통으로 사용하는 헤더에 대한 정보는 SourcePipeline 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
projectId String Required 파이프라인 아이디
historyId String Required 실행 작업 결과 아이디

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request POST 'https://vpcsourcepipeline.apigw.gov-ntruss.com/api/v1/project/2***/history/54***/cancel' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
result Object - 응답 결과
result.result Boolean - API 호출 성공 여부
  • 성공한 경우, true 표시
  • 실패한 경우, 필드가 표시되지 않음

응답 상태 코드

SourcePipeline API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 SourcePipeline 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "result": {
        "result": true
    }
}