CancelApplicationInstance - 停止作业实例--流式计算 Flink版-火山引擎

文档中心

导航

CancelApplicationInstance - 停止作业实例

最近更新时间：2024.11.06 00:31:11首次发布时间：2024.10.31 11:30:33

停止指定作业实例

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	CancelApplicationInstance	要执行的操作，取值：CancelApplicationInstance。
Version	String	是	2025-01-01	API的版本，取值：2025-01-01。
InstanceId	String	是	181821991364353871361	作业实例id

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
InstanceId	String	1840648066264309761	作业实例ID
Success	Boolean	true	是否成功
Id	String	1669169289439948801	要停止的 instance 对应的 application id

请求示例

POST /?Action=CancelApplicationInstance&Version=2025-01-01&ProjectId=%22ahbf3mzf1iih%22 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241028T082201Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241028/cn-beijing/flink/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "InstanceId": "181821991364353871361"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2024102816220903102023411711648E",
    "Action": "CancelApplicationInstance",
    "Version": "2025-01-01",
    "Service": "flink",
    "Region": "cn-beijing"
  },
  "Result": {
    "InstanceId": "1840648066264309761",
    "Success": true,
    "Id": "1669169289439948801"
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
200	default system error	当前展示的错误信息指示当前传入的 app instance id 对应的实例已经停止. 实际使用中,请根据具体的错误信息进行判断,此处仅展示其中一个示例	当前展示的错误信息指示当前传入的 app instance id 对应的实例已经停止. 实际使用中,请根据具体的错误信息进行判断,此处仅展示其中一个示例