Stopping a Job Instance

Function

This API is used to stop a specific job instance. A job instance can be stopped only when it is in the running state.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

• If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
• If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

• URI format

  POST /v1/{project_id}/jobs/{job_name}/instances/{instance_id}/stop

• Parameter description

  Table 1 URI parameters

  Parameter	Mandatory	Type	Description
  project_id	Yes	String	Project ID. For details about how to obtain a project ID, see Project ID and Account ID.
  job_name	Yes	String	Job name
  instance_id	Yes	Long	Job instance ID. For details about how to obtain it, see Viewing a Job Instance List.

Request Parameters

Response Parameters

None.

Example Request

POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/job_batch/instances/34765/stop

Example Response

• Success response

  HTTP status code 204

• Failure response

  HTTP status code 400

  {
      "error_code":"DLF.0137",
      "error_msg":"Job instance does not exist."
  }