停止一個正在執行的流程。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| fnf:StopExecution | update |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| FlowName | string | 是 | 需要停止的流程名稱，可以通過 ListFlows 的返回值獲取。 | my_flow_name |
| ExecutionName | string | 是 | 需要停止的執行名稱，可以通過 ListExecutions 的返回值獲取。 | my_exec_name |
| Cause | string | 否 | 停止錯誤原因。長度為 1~4096 個字符。 | for test |
| Error | string | 否 | 停止錯誤代碼。長度為 1~128 個字符。 | InvalidArgument |
返回參數
示例
正常返回示例
JSON格式
{
"Status": "Running",
"StoppedTime": "2019-01-01T01:01:01.001Z",
"RequestId": "testRequestId",
"StartedTime": "2019-01-01T01:01:01.001Z",
"FlowDefinition": "舊版：\n\"type: flow\\nversion: v1\\nname: my_flow_name\\nsteps:\\n - type: pass\\n name: mypass\"\n\n新版：\n\"Type: StateMachine\\nSpecVersion: v1\\nName: my_flow_name\\nStartAt: my_state\\nStates:\\n - Type: Pass\\n Name: my_state\\n End: true\"",
"Output": "{\"key\":\"value\"}",
"FlowName": "my_flow_name",
"Name": "my_exec_name",
"Input": "{\"key\":\"value\"}",
"RoleArn": "acs:ram:${region}:${accountID}:${role}"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | ActionNotSupported | The requested API operation '%s' is incorrect. Please check. | - |
| 400 | APIVersionNotSupported | The requested API version '%s' is not supported yet. Please check. | - |
| 400 | EntityTooLarge | The payload size exceeds maximum allowed size (%s bytes). | 請求消息體過大。 |
| 400 | ExecutionAlreadyCompleted | Execution '%s' for flow '%s' has already completed. | - |
| 400 | InvalidArgument | Parameter error. | 請求參數錯誤。具體內容請參考實際錯誤信息。 |
| 400 | MissingRequiredHeader | The HTTP header '%s' must be specified. | 請求所需參數缺失。具體內容請參考實際錯誤信息。 |
| 400 | MissingRequiredParams | The HTTP query '%s' must be specified. | 請求所需參數缺失。具體內容請參考實際錯誤信息。 |
| 403 | AccessDenied | The resources doesn't belong to you. | - |
| 403 | InvalidAccessKeyID | The AccessKey ID %s is invalid. | AccessKey ID無效。 |
| 403 | RequestTimeTooSkewed | The difference between the request time %s and the current time %s is too large. | 您的請求時間不正確，該請求已被識別為無效。請參考通用參數一節。 |
| 403 | SignatureNotMatch | The request signature we calculated does not match the signature you provided. Check your access key and signing method. | 您發起請求的簽名與我們計算不一致，請檢查您的簽名算法及AccessKey Secret。 |
| 404 | ExecutionNotExists | Execution %s for flow %s does not exist. | 所請求資源不存在，請確保流程已創建并存在待查詢的執行。 |
| 404 | FlowNotExists | Flow %s does not exist. | 所請求資源不存在，請確保流程已創建。 |
| 409 | ConcurrentUpdateError | Update conflict, please retry. | 所請求資源存在并發寫操作。請等待一段時間后再次操作。 |
| 415 | UnsupportedMediaType | The content type must be "application/json". | 請求消息體類型錯誤。 |
| 429 | ResourceThrottled | The request is throttled. Please try again later. | 因某些原因系統流量已達瓶頸。請稍后重試。 |
| 500 | InternalServerError | An internal error has occurred. Please retry. | 服務器內部錯誤。請稍后重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-08-06 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2024-03-21 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |