Stopping Executing a Script Instance¶
Function¶
This API is used to stop executing a script instance.
URI¶
URI format
POST /v1/{project_id}/scripts/{script_name}/instances/{instance_id}/stop
Parameter description
¶ Parameter
Mandatory
Type
Description
project_id
Yes
String
Project ID. For details about how to obtain a project ID, see Project ID and Account ID.
script_name
Yes
String
Script name.
instance_id
Yes
String
Script instance ID. For details about how to obtain the ID, see the response parameters in Executing a Script.
Request Parameters¶
Parameter | Mandatory | Type | Description |
---|---|---|---|
workspace | No | String | Workspace ID.
|
Response Parameters¶
None.
Example Request¶
POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/scripts/dwsscript/instances/a1ad-448a-9d56-4154193d49c5/stop
Example Response¶
Success response
HTTP status code 204
Failure response
HTTP status code 400
{ "error_code":"DLF.6205", "error_msg":"The script running history does not exist." }
Status Codes¶
See Status Codes.