Updated on 2024-12-10 GMT+08:00

Deleting Jobs in Batches

Function

This API is used to delete jobs in batches.

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

POST /v2/{project_id}/clusters/{cluster_id}/job-executions/batch-delete
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

Request Parameters

Table 2 Request parameter

Parameter

Mandatory

Type

Description

job_id_list

No

Array of strings

Explanation

The job ID list. 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

Response Parameters

None

Example Request

Delete jobs in batches.

POST https://{endpoint}/v2/{project_id}/clusters/{cluster_id}/job-executions/batch-delete

{
  "job_id_list" : [ "48c45725-b699-4aa9-9bfd-f7ff87eb6fe8", "af846665-dd32-4349-a8b5-561e109c383c" ]
}

Example Response

None

Status Codes

See Status Codes.

Error Codes

See Error Codes.