Updated on 2024-09-30 GMT+08:00

Terminating a Job

Function

This API is used to terminate a specified job in an MRS cluster.

Constraints

None

Debugging

You can debug this API in API Explorer. Automatic authentication is supported. API Explorer can automatically generate sample SDK code and provide the sample SDK code debugging.

URI

  • Format

    POST /v2/{project_id}/clusters/{cluster_id}/job-executions/{job_execution_id}/kill

  • Parameter description
    Table 1 URI parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Explanation

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

    Constraints

    N/A

    Value range

    The value must consist of 1 to 64 characters. Only letters and digits are allowed.

    Default value

    N/A

    cluster_id

    Yes

    String

    Explanation

    Cluster ID. If this parameter is specified, the latest metadata of the cluster that has been patched will be obtained. For details about how to obtain the cluster ID, see Obtaining a Cluster ID.

    Constraints

    N/A

    Value range

    The value can contain 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-).

    Default value

    N/A

    job_execution_id

    Yes

    String

    Explanation

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

    Constraints

    N/A

    Value range

    N/A

    Default value

    N/A

Request Parameters

None

Response Parameters

None

Example Request

Terminate a job.

POST https://{endpoint}/v2/{project_id}/clusters/{cluster_id}/job-executions/{job_execution_id}/kill

Example Response

Status code: 400

Failed to terminate a specified job in an MRS cluster.

{
  "error_msg" : "Failed to terminate the job."
  "error_code" : "0175"
}

Status Codes

See Status Codes.

Error Codes

See Error Codes.