Help Center/ DataArts Studio/ API Reference/ DataArts Quality APIs/ Job Instances/ Stopping Instances
Updated on 2025-05-09 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Stopping Instances

Function

This API is used to stop instances.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/quality/instances/batch-stop

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain it, see Project ID and Account ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

workspace

Yes

String

DataArts Studio workspace ID. For details about how to obtain it, see Instance ID and Workspace ID.

X-Auth-Token

Yes

String

IAM token. For details about how to obtain it, see Authentication.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

[items]

Yes

Array of integers

IDs of the instances to be stopped

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DQC.0000 which indicates that the request was successfully processed

error_msg

String

Error message

data

Object

Returned data

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DQC.0000 which indicates that the request was successfully processed

error_msg

String

Error message

data

Object

Returned data

Status code: 406

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DQC.0000 which indicates that the request was successfully processed

error_msg

String

Error message

data

Object

Returned data

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DQC.0000 which indicates that the request was successfully processed

error_msg

String

Error message

data

Object

Returned data

Example Requests

Stop instances whose IDs are 1317151269261262848 and 1317151258234322945.

POST https://{endpoint}/v2/{project_id}/quality/instances/batch-stop

[ 1317151269261262848, 1317151258234322945 ]

Example Responses

Status code: 200

The API call is successful. InstanceVO is returned.

{
  "error_code" : "DLG.2700",
  "error_msg" : "Successful."
}

Status Codes

Status Code

Description

200

The API call is successful. InstanceVO is returned.

400

BadRequest

406

NOT ACCEPTABLE

500

INTERNAL SERVER ERROR
Parent Topic: Job Instances