Updated on 2022-02-22 GMT+08:00

Stopping Scheduling a Job

Function

This API is used to stop scheduling a job.

URI

POST /v1.0/{project_id}/pipelines/stop-pipeline

Table 1 lists the parameters.

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request

Example request:

POST https://{Endpoint}:{port}/v1.0/{project_id}/pipelines/stop-pipeline
  {
    "jobId": 54022
  }

Table 2 lists the parameters.

Table 2 Parameter description

Parameter

Mandatory

Type

Description

jobId

Yes

Int

Unique identifier of the job. For details about how to obtain the job ID, see Obtaining a Job ID.

Response

None.

Status Code

  • If the operation is successful, status code 200 is returned. For details about status codes, see Status Codes.
  • If the operation failed, identify the failure cause according to the response body and the instructions in Error Codes.