# 挂起工作流实例 - SuspendBPMInstance
#### 功能介绍
挂起/恢复/终止一个工作流实例。工作流实例被挂起后，不会在用户的待办任务列表中出现，流程SLA定时器停止，也不会进行任何跟催。恢复后，可继续进行操作。终止操作则强行结束一个工作流实例，可在历史任务中查看。
#### URI
PUT*华为云Astro轻应用域名* /u-route/baas/bp/v2.0/runtime/instances/*{instance_id}*
表1路径参数 
| 参数          | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|:---|:---|:---|:---|
| instance_id | 是    | String | **参数解释**： 对应一个具体工作流实例的标识，可通过调用[查询工作流实例 - QueryBPMInstance](https://support.huaweicloud.com/api-astrozero/astrozero_api_0070.html)接口查看（响应消息中的"id"）。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 |
   
#### 请求参数
表2请求参数 
| 参数     | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|:---|:---|:---|:---|
| action | 是    | String | **参数解释**： 对工作流实例操作的动作名。 **约束限制**： 不涉及。 **取值范围**： - suspend：挂起。  - resume：恢复。  - terminate：终止。   **默认取值**： 不涉及。 |
   
#### 响应参数
表3响应参数 
| 参数      | 参数类型   | 描述                                                                                                                                                                                                                                                |
|:---|:---|:---|
| resCode | String | **参数解释**： 返回码。 **取值范围**： 如果返回"0"代表请求成功，其他错误码说明请参考[错误码（数据面）](https://support.huaweicloud.com/api-astrozero/astrozero_api_0082.html)。 |
| resMsg  | String | **参数解释**： 返回消息。 **取值范围**： 成功返回"Success"，其他情况会返回具体的错误信息。                                                                           |
| result  | Object | **参数解释**： 在成功请求时会有内容，返回启动工作流后，工作流实例的运行信息。                                                                                                                                                                    |
   
#### 请求示例
对一个已启动运行的工作流实例进行暂停操作，被操作的工作流实例ID是"002N000000Q3QW4IMAOO"。
```
PUT https://华为云Astro轻应用域名/u-route/baas/bp/v2.0/runtime/instances/002N000000Q3QW4IMAOO
    
{
    "action": "suspend"
}
```
#### 响应示例
可以看到返回的报文中，工作流实例的suspended字段被置为了true。
```
{
    "resCode":"0",
    "resMsg":"Success",
    "result":{
        "name":"SimpleBP",
        "version":"1.0.1",
        "id":"002N000000Q3QW4IMAOO",
        "processDefID":"001L000000Peuw1Q318a",
        "interviewLabel":"SimpleBP 2019-05-10 15:14:09",
        "nextElem":"",
        "isTest":true,
        "state":"New",
        "bpStatus":"New",
        "urgency":0,
        "taskOutcome":"",
        "businessKey":"002N000000Q3QW4IMAOO",
        "startTime":"2019-05-10 15:14:09",
        "endTime":"",
        "Ext1":"",
        "Ext2":"",
        "Ext3":"",
        "Ext4":"",
        "Ext5":"",
        "Ext6":"",
        "Ext7":0,
        "Ext8":0,
        "suspended":true,
        "isClosed":false
    }
}
```
#### 状态码
状态码请参见[状态码](https://support.huaweicloud.com/api-astrozero/astrozero_api_0081.html)。
#### 错误码
错误码请参见[错误码（数据面）](https://support.huaweicloud.com/api-astrozero/astrozero_api_0082.html)。