对暂停中的任务进行操作
功能介绍
该接口可对任务进行失败重试、失败跳过、暂停继续操作,返回操作结果。
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/cms/workflow/{workflow_id}/executions/{execution_id}/operation
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户从IAM申请到的projectid,一般为32位字符串。 最小长度:32 最大长度:32 |
workflow_id |
是 |
String |
工作流ID,唯一标识,根据project_id和workflow_name生成。 最小长度:1 最大长度:64 |
execution_id |
是 |
String |
工作流执行ID。 最小长度:1 最大长度:64 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
action |
是 |
String |
对当前节点的操作:失败重试,失败跳过,暂停继续。 restart可重新执行失败的节点,skip可跳过失败的节点进入下个节点的执行,continue可通过暂停节点进入下一个节点。 最小长度:1 最大长度:10 枚举值:
|
node_id |
是 |
String |
当前节点的id。 最小长度:1 最大长度:64 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。 最小长度:1 最大长度:40960 |
Content-Type |
是 |
String |
指定类型为application/json。 最小长度:1 最大长度:32 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
result |
Object |
结果返回体 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
响应码。 最小长度:1 最大长度:64 |
error_msg |
String |
调用失败响应信息描述。 最小长度:1 最大长度:1024 |
http_code |
Integer |
http返回码 最小值:0 最大值:999 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
响应码。 最小长度:1 最大长度:64 |
error_msg |
String |
调用失败响应信息描述。 最小长度:1 最大长度:1024 |
http_code |
Integer |
http返回码 最小值:0 最大值:999 |
请求示例
可指定参数action为skip来对任务进行跳过操作。 skip:跳过,restart:重新执行,continue:暂停继续。
https://{Endpoint}/v1/{project_id}/cms/workflow/{workflow_id}/executions/{execution_id}/operation?action=skip&node_id=xxxxxxx
响应示例
状态码: 200
请求响应成功,任务状态已改变。
{ "result" : "success" }
状态码: 401
Unauthorized。在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。
{ "error_code" : "AOM.31009004", "error_msg" : "auth failed.", "http_code" : "401" }
状态码: 500
InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。
{ "error_code" : "AOM.31001405", "error_msg" : "internal server error.", "http_code" : "500" }
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.aom.v1.region.AomRegion; import com.huaweicloud.sdk.aom.v1.*; import com.huaweicloud.sdk.aom.v1.model.*; public class StartPausingWorkflowExecutionsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); AomClient client = AomClient.newBuilder() .withCredential(auth) .withRegion(AomRegion.valueOf("<YOUR REGION>")) .build(); StartPausingWorkflowExecutionsRequest request = new StartPausingWorkflowExecutionsRequest(); request.withAction(StartPausingWorkflowExecutionsRequest.ActionEnum.fromValue("<action>")); request.withNodeId("<node_id>"); try { StartPausingWorkflowExecutionsResponse response = client.startPausingWorkflowExecutions(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkaom.v1.region.aom_region import AomRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkaom.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = AomClient.new_builder() \ .with_credentials(credentials) \ .with_region(AomRegion.value_of("<YOUR REGION>")) \ .build() try: request = StartPausingWorkflowExecutionsRequest() request.action = "<action>" request.node_id = "<node_id>" response = client.start_pausing_workflow_executions(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" aom "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := aom.NewAomClient( aom.AomClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.StartPausingWorkflowExecutionsRequest{} request.Action = model.GetStartPausingWorkflowExecutionsRequestActionEnum().<ACTION> request.NodeId = "<node_id>" response, err := client.StartPausingWorkflowExecutions(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求响应成功,任务状态已改变。 |
401 |
Unauthorized。在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 |
500 |
InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。 |
错误码
请参见错误码。