更新任务
功能介绍
更新定时任务的启停状态,可启动定时任务或停止定时任务,返回操作任务结果。
调用方法
请参见如何调用API。
URI
PUT /v1/{project_id}/cms/workflow/{workflow_id}/trigger/action
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户从IAM申请到的projectid,一般为32位字符串。 最小长度:32 最大长度:32 |
workflow_id |
是 |
String |
任务id,待修改任务的id。 最小长度:1 最大长度:64 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
action |
是 |
String |
启动或暂停任务的定时执行。enable为开启定时任务,disable为关闭定时任务 最小长度:1 最大长度:10 枚举值:
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。 最小长度:1 最大长度:40960 |
Content-Type |
是 |
String |
指定类型为application/json。 最小长度:1 最大长度:32 |
响应参数
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
响应码。 最小长度:1 最大长度:64 |
error_msg |
String |
调用失败响应信息描述。 最小长度:1 最大长度:1024 |
http_code |
Integer |
http返回码 最小值:0 最大值:999 |
状态码: 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 |
请求示例
enable为开启定时任务
disable为关闭定时任务
https://{Endpoint}/v1/{project_id}/cms/workflow/{workflow_id}/trigger/action?action=enable
响应示例
状态码: 200
任务启停操作成功
{"success"}
状态码: 400
BadRequest。非法请求。建议直接修改该请求,不要重试该请求。
{ "error_code" : "AOM.31001302", "error_msg" : "Invalid param", "http_code" : 400 }
状态码: 401
Unauthorized。在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。
{ "error_code" : "AOM.31009003", "error_msg" : "auth failed.", "http_code" : 401 }
状态码: 500
InternalServerError
表明服务端能被请求访问到,但是不能理解用户的请求。
{ "error_code" : "AOM.31001305", "error_msg" : "workflow 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 48 |
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 UpdateWorkflowTriggerStatusSolution { 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); AomClient client = AomClient.newBuilder() .withCredential(auth) .withRegion(AomRegion.valueOf("<YOUR REGION>")) .build(); UpdateWorkflowTriggerStatusRequest request = new UpdateWorkflowTriggerStatusRequest(); request.withWorkflowId("{workflow_id}"); try { UpdateWorkflowTriggerStatusResponse response = client.updateWorkflowTriggerStatus(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"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = AomClient.new_builder() \ .with_credentials(credentials) \ .with_region(AomRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateWorkflowTriggerStatusRequest() request.workflow_id = "{workflow_id}" response = client.update_workflow_trigger_status(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 38 |
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") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := aom.NewAomClient( aom.AomClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateWorkflowTriggerStatusRequest{} request.WorkflowId = "{workflow_id}" response, err := client.UpdateWorkflowTriggerStatus(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
任务启停操作成功 |
400 |
BadRequest。非法请求。建议直接修改该请求,不要重试该请求。 |
401 |
Unauthorized。在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 |
500 |
InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。 |
错误码
请参见错误码。