TerminateInstance - 终止工作流实例-企业 Agent 应用平台(AgentOne)-阿里云帮助中心

接口说明

终止当前工作流实例

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

winnexo:TerminateInstance

none

*全部资源

*

无

请求语法

POST /openapi/terminateInstance HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
tenantId	string	否	租户 ID，缺省使用调用方默认租户	10000
collaborationGroupId	string	是	协作空间 ID	group_example
instanceId	string	是	物理工作流实例 ID（planId）	plan_example
reason	string	是	终止原因	用户终止

返回参数

名称	类型	描述	示例值
	object
code	string	业务状态码；成功为 200	200
message	string	错误描述	请求的资源不存在
requestId	string	请求追踪 ID	019FF406-1B10-0065-A97D-2D1920C2A03D
instanceId	string	物理实例 ID	plan_example
instanceStatus	string	终止后状态	Terminated
stateVersion	integer	状态版本	2
terminated	boolean	终止成功为 true；失败通过 Code 和 Message 返回	true

示例

正常返回示例

JSON格式

{
  "code": "200",
  "message": "请求的资源不存在",
  "requestId": "019FF406-1B10-0065-A97D-2D1920C2A03D",
  "instanceId": "plan_example",
  "instanceStatus": "Terminated",
  "stateVersion": 2,
  "terminated": true
}

错误码

访问错误中心错误中心查看更多错误码。

变更历史

更多信息，参考变更详情变更详情。