Help Center/ DataArts Studio/ More Documents/ API Reference (Kuala Lumpur Region)/ DataArts Factory APIs/ Script Development APIs/ Stopping Executing a Script Instance
Updated on 2022-08-17 GMT+08:00
Share

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
    Table 1 URI parameters

    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

    ID of the script instance.

Request

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

workspace

No

String

Workspace ID.

  • If this parameter is not set, data in the default workspace is queried by default.
  • To query data in other workspaces, this header must be carried.

Response

None.

Example

  • Request 
    POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/scripts/dwsscript/instances/a1ad-448a-9d56-4154193d49c5/stop
  • 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.

Parent topic: Script Development APIs