Help Center/ ModelArts/ API Reference/ Historical APIs/ Training Management (Old Version)/ Visualization Jobs/ Stopping a Visualization Job
Updated on 2024-05-30 GMT+08:00
View PDF
Share

Stopping a Visualization Job

Function

This API is used to stop a visualization job. Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Querying a Visualization Job List and Querying the Details About a Visualization Job.

URI

POST /v1/{project_id}/visualization-jobs/{job_id}/stop

Table 1 describes the required parameters.
Table 1 Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

job_id

Yes

String

ID of a visualization job

Request Body

None

Response Body

Table 2 describes the response parameters.
Table 2 Parameters

Parameter

Type

Description

is_success

Boolean

Whether the request is successful

error_code

String

Error code of a failed API call. For details, see Error Codes.

This parameter is not included when the API call succeeds.

error_message

String

Error message of a failed API call.

This parameter is not included when the API call succeeds.

Sample Request

The following shows how to stop the visualization job whose ID is 10.

POST    https://endpoint/v1/{project_id}/visualization-jobs/10/stop

Sample Response

  • Successful response 
    {
    "is_success": true
}
  • Failed response 
    {
    "is_success": false,
    "error_message": "This job can't be stop. job status: 10",
    "error_code": "ModelArts.0105"
}

Status Code

For details about the status code, see Table 1.

Parent topic: Visualization Jobs