パイプライン実行のキャンセル

Classic/VPC環境で利用できます。

パイプラインの実行をキャンセルします。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
POST	/api/v1/project/{projectId}/history/{historyId}/cancel

リクエストヘッダ

SourcePipeline APIで共通して使用されるヘッダの詳細は、SourcePipelineのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`projectId`	String	Required	パイプライン ID パイプラインリストの照会を参照
`historyId`	String	Required	実行タスク結果 ID パイプラインの照会を参照

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://vpcsourcepipeline.apigw.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
    }
}