Stopping a Job¶
Function¶
This API is used to stop a job.
URI¶
PUT /v1.1/{project_id}/clusters/{cluster_id}/cdm/job/{job_name}/stop
Parameter | Mandatory | Type | Description |
|---|---|---|---|
project_id | Yes | String | Project ID |
cluster_id | Yes | String | Cluster ID |
job_name | Yes | String | Job name |
Request Parameters¶
Parameter | Mandatory | Type | Description |
|---|---|---|---|
X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
Response Parameters¶
Status code: 200
Parameter | Type | Description |
|---|---|---|
validation-result | Array of JobValidationResult objects | Validation result. If the job fails to be stopped, the failure cause is returned. For details, see the validation-result parameter. If the job is stopped, an empty list is returned. |
Parameter | Type | Description |
|---|---|---|
message | String | Error message |
status | String | ERROR,WARNING Enumeration values:
|
Example Requests¶
PUT /v1.1/1551c7f6c808414d8e9f3c514a170f2e/clusters/6ec9a0a4-76be-4262-8697-e7af1fac7920/cdm/job/jdbc2hive/stop
Example Responses¶
Status code: 200
ok
{ }
Status Codes¶
Status Code | Description |
|---|---|
200 | ok |
Error Codes¶
See Error Codes.