文档首页/ 数据治理中心 DataArts Studio/ API参考/ 数据开发API（V1）/ 脚本开发API/ 停止脚本实例的执行 - CancelScript
更新时间：2025-11-04 GMT+08:00
在线调试
CLI示例
查看PDF
分享

停止脚本实例的执行 - CancelScript

功能介绍

该接口用于停止脚本实例的执行。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

  • URI格式

    POST /v1/{project_id}/scripts/{script_name}/instances/{instance_id}/stop

  • 参数说明
    表1 URI参数说明

    参数名

    是否必选

    参数类型

    说明

    project_id

    是

    String

    项目编号，获取方法请参见项目ID和账号ID。

    script_name

    是

    String

    脚本名称。

    instance_id

    是

    String

    脚本实例id，获取方法请参见执行脚本 - ExecuteScript的响应参数。

请求参数

表2 请求Header参数

参数名

是否必选

参数类型

说明

workspace

否

String

工作空间id。

  • 如果不设置该参数，默认查询default工作空间下的数据。
  • 如果需要查询其他工作空间的数据，需要带上该消息头。
    说明：
    • 多个DataArts Studio实例需要指定工作空间。
    • 当工作空间里面没有default工作空间时，工作空间为必填参数，否则会报错。

响应参数

无

请求示例

POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/scripts/dwsscript/instances/a1ad-448a-9d56-4154193d49c5/stop

响应示例

  • 成功响应

    HTTP状态码 204

  • 失败响应

    HTTP状态码 400

    {
    "error_code":"DLF.6205",
    "error_msg":"The script running history does not exist."
}

状态码

状态码请参见状态码。

父主题： 脚本开发API

相关文档