调用StopInstance终止实例。
接口说明
实例终止机制与注意事项:
实例终止为异步操作。发起终止请求不代表实例已立即停止。请在请求后持续查询实例状态,确认终止结果;涉及外部计算资源时,还需核实远端作业的实际状态。
DataWorks 实例状态不一定与远端作业状态一致。对于依赖外部计算资源的任务(如 MaxCompute、EMR、SSH 等),DataWorks 通过客户端向远端发起终止请求。受网络异常、客户端兼容性等因素影响,可能出现 DataWorks 实例已标记为失败,但远端作业仍在运行的情况。因此,不能仅依据 DataWorks 实例状态判断远端作业已终止。请到对应计算平台核查,必要时手动终止,避免作业持续运行或产生额外资源消耗。
公共调度资源组下的 MaxCompute 任务需特别关注。DataWorks 公共调度资源组即将下线,受相关组件版本及兼容性限制,部分 MaxCompute 任务的终止指令可能无法在远端生效。遇到此类情况,请前往 MaxCompute 查询对应 Instance 的实际状态;若仍在运行,需在 MaxCompute 侧执行 Kill 操作,并再次确认其已终止。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
integer |
是 |
实例的 ID。您可以调用 ListInstances 获取。 |
1234 |
| ProjectEnv |
string |
是 |
工作空间的环境,包括 PROD 和 DEV。 枚举值:
|
PROD |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| HttpStatusCode |
integer |
HTTP 状态码。 |
200 |
| Data |
boolean |
调用停止实例接口后,返回的结果详情。 |
true |
| ErrorMessage |
string |
错误信息。 |
The connection does not exist. |
| RequestId |
string |
请求的 ID。用于定位日志,排查问题。 |
E6F0DBDD-5AD**** |
| ErrorCode |
string |
错误码。 |
Invalid.Tenant.ConnectionNotExists |
| Success |
boolean |
调用是否成功。 |
true |
示例
正常返回示例
JSON格式
{
"HttpStatusCode": 200,
"Data": true,
"ErrorMessage": "The connection does not exist.",
"RequestId": "E6F0DBDD-5AD****",
"ErrorCode": "Invalid.Tenant.ConnectionNotExists",
"Success": true
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。