查询任务列表
功能介绍
该接口可返回已经创建的任务列表，可按任务名称，任务状态，任务类型，执行人，更新时间为查询条件分页查询任务。
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/cms/workflow-list
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户从IAM申请到的projectid，一般为32位字符串。 最小长度：32 最大长度：32 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。 最小长度：1 最大长度：40960 |
|
Content-Type |
是 |
String |
指定类型为application/json。 最小长度：1 最大长度：32 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
search |
否 |
String |
搜索内容，可以针对工作流名称和描述内容进行搜索。 最小长度：1 最大长度：64 |
|
type |
否 |
String |
工作流分类，可以取值["cron","event","manual"]。 最小长度：1 最大长度：16 |
|
tags |
否 |
Map<String,String> |
工作流标签，最多支持10个。 |
|
page |
否 |
Integer |
查询当前的页数，默认值为0。 最小值：1 最大值：9999999 |
|
size |
否 |
Integer |
查询当前页的大小，默认值为10。 最小值：1 最大值：100 |
|
enterprise_project_id |
否 |
String |
企业项目id。 最小长度：1 最大长度：64 |
|
create_by |
否 |
String |
工作流创建人。 最小长度：1 最大长度：64 |
|
sort_field |
是 |
String |
排序字段，取值["create_time"，"last_execution_start_time"，"update_time"]。 最小长度：1 最大长度：64 |
|
sort_type |
是 |
String |
排序类型，取值["ASC"，"DESC"]。 最小长度：1 最大长度：16 |
|
search_time_start |
否 |
Long |
时间范围查询的开始时间。 最小值：0 最大值：9999999999999 |
|
search_time_end |
否 |
Long |
时间范围查询的结束时间。 最小值：0 最大值：9999999999999 |
|
status |
否 |
String |
任务的状态 ["success","fail","executing","cancel","waitExecute","waitApproval","approvalFailed","pausing","canceling"] 最小长度：1 最大长度：16 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
elements |
Array of Workflow objects |
工作流详情集合。 数组长度：0 - 9999999 |
|
total_elements |
Long |
总数 最小值：0 最大值：99999999 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
工作流id，唯一标识，根据project_id和workflow_name生成。 最小长度：1 最大长度：64 |
|
name |
String |
工作流名称。 最小长度：1 最大长度：64 |
|
type |
String |
工作流类型，可以为cron、manual 最小长度：1 最大长度：16 |
|
description |
String |
工作流描述信息。 最小长度：1 最大长度：128 |
|
tags |
Map<String,String> |
标签键和值列表，标签键值对数量范围是0至20。 |
|
create_time |
Long |
工作流创建时间，为utc时间毫秒数。 最小值：0 最大值：9999999999999 |
|
create_by |
String |
工作流创人，从接口调用传入的token中获取。 最小长度：1 最大长度：64 |
|
update_time |
Long |
工作流更新时间，为utc时间毫秒数。 最小值：0 最大值：9999999999999 |
|
update_by |
String |
工作流更新人，从接口调用传入的token中获取。 最小长度：1 最大长度：64 |
|
template_name |
String |
模板名称。 最小长度：1 最大长度：64 |
|
template_id |
String |
模板id 最小长度：1 最大长度：64 |
|
input |
Map<String,Object> |
任务执行时需要的参数列表。 |
|
last_execution_id |
String |
最近一次执行id，也是工作流id 最小长度：1 最大长度：64 |
|
status |
String |
任务状态，包含success，fail,executing 最小长度：1 最大长度：16 |
|
citation_urns |
Array of strings |
工作流的引用。 最小长度：1 最大长度：256 数组长度：0 - 200 |
|
last_execution_end_time |
Long |
最近一次执行结束时间，为utc时间毫秒数 最小值：0 最大值：9999999999999 |
|
last_execution_start_time |
Long |
最近一次执行开始时间，为utc时间毫秒数 最小值：0 最大值：9999999999999 |
|
quote |
Array of strings |
引用，参数引用 最小长度：1 最大长度：256 数组长度：1 - 999 |
|
job_name |
String |
作业名称 最小长度：1 最大长度：64 |
|
job_id |
String |
作业id 最小长度：1 最大长度：64 |
|
service_scenario |
String |
服务场景分类 最小长度：1 最大长度：64 |
|
service_name |
String |
服务名称 最小长度：1 最大长度：64 |
|
task_type |
String |
任务类型 最小长度：1 最大长度：16 |
|
project_id |
String |
functiongraph返回的PROJECT_ID 最小长度：1 最大长度：32 |
|
workflow_id |
String |
functiongraph返回的WORKFLOW_ID 最小长度：1 最大长度：64 |
|
task_status |
String |
任务状态 最小长度：1 最大长度：32 |
|
nodes |
Array of Node objects |
任务节点 数组长度：1 - 20 |
|
edit_time |
Long |
编辑时间 最小值：0 最大值：9999999999999 |
|
execution_action_rules |
Array of strings |
执行动作细粒度权限 最小长度：1 最大长度：128 数组长度：0 - 200 |
|
execution_permission |
Array of strings |
云服务权限 最小长度：1 最大长度：128 数组长度：1 - 32 |
|
global_parameters |
Array of Parameter objects |
全局参数 数组长度：0 - 20 |
|
is_delete |
Boolean |
逻辑删除 |
|
steps |
Array of Step objects |
任务步骤 数组长度：1 - 10 |
|
output |
String |
任务输出 最小长度：1 最大长度：40960 |
|
trigger_id |
String |
触发器id 最小长度：1 最大长度：64 |
|
trigger_status |
String |
触发器状态 最小长度：1 最大长度：64 |
|
approve_id |
String |
审批id 最小长度：1 最大长度：64 |
|
template_i18n |
WorkFlowModel object |
任务国际化字段，包含中英文描述 |
|
enterprise_project_id |
String |
任务所属的企业项目 最小长度：1 最大长度：64 |
|
last_execute_by |
String |
任务最后一次执行人 最小长度：1 最大长度：64 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
parent_node |
String |
父亲节点的名称。 最小长度：1 最大长度：64 |
|
category |
String |
节点类型。 最小长度：1 最大长度：32 |
|
description |
String |
节点描述。 最小长度：1 最大长度：1024 |
|
id |
String |
节点id 最小长度：1 最大长度：64 |
|
ignore_error |
Boolean |
是否忽略错误 |
|
metadata |
Metadata object |
元数据。 |
|
name |
String |
节点名称,比如是Node。 最小长度：1 最大长度：64 |
|
task_name |
String |
任务名称，节点上任务的名称。 最小长度：1 最大长度：64 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
param_name |
String |
参数名称。 |
|
param_type |
String |
参数类型。 最小长度：1 最大长度：16 |
|
param_group |
String |
参数分组。 最小长度：1 最大长度：32 |
|
default_value |
String |
参数初始值。 最小长度：1 最大长度：40960 |
|
id |
String |
参数id。 最小长度：1 最大长度：64 |
|
encryption |
Boolean |
是否加密。 |
|
hint |
String |
参数提示。 最小长度：1 最大长度：1000 |
|
quote_param |
Boolean |
是否从参数库选择。 |
|
required |
Boolean |
是否为必填参数。 |
|
description |
String |
参数描述。 最小长度：1 最大长度：1000 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
步骤id。 最小长度：1 最大长度：64 |
|
name |
String |
步骤名称。 最小长度：1 最大长度：32 |
|
type |
String |
步骤类型。 最小长度：1 最大长度：16 |
|
input |
Map<String,String> |
步骤参数。 |
|
ignore_error |
Boolean |
是否自动忽略错误。 |
|
description |
String |
步骤说明。 最小长度：1 最大长度：1000 |
状态码： 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 |
请求示例
可指定name为xxx、last_execute_by为xxx、status为xxx、task_type为xxx、search_time_start为1600060125000的查询参数用于查询任务列表。
https://{Endpoint}/v1/{project_id}/cms/workflow-list
{
"search" : "",
"tags" : { },
"page" : 0,
"size" : 10,
"enterprise_project_id" : "0",
"create_by" : "xxx",
"sort_field" : "update_time",
"sort_type" : "DESC",
"status" : "xxx",
"type" : "manual",
"search_time_start" : 160000000000,
"search_time_end" : 160000000000
}响应示例
状态码： 200
请求响应成功，返回任务列表。
{
"elements" : [ {
"citation_urns" : [ ],
"create_by" : "xxxx",
"create_time" : 16000000000,
"description" : "",
"edit_time" : 0,
"enterprise_project_id" : "0",
"execution_action_rules" : [ "xxxxxxx", "xxxxxxx" ],
"execution_permission" : [ "xxxxxxx", "xxxxxx" ],
"id" : "xxxxxx",
"input" : {
"package" : {
"cmd_user" : "xxxxx",
"software_list" : "[xxxxxxx]",
"pre_install_script" : "",
"operate_type" : "install",
"un_install_script" : "",
"version_number" : "1",
"time_out" : "7200",
"install_script" : "xxxx",
"package_version_id" : "xxxxxx",
"package_basic_id" : "xxxxxx",
"package_name" : "xxxxx",
"install_file_dir" : "xxxxx",
"plat_form" : "Linux",
"group" : "package"
},
"project_id" : "xxxxxxx",
"approve" : {
"need_approve" : "false",
"group" : "approve"
},
"region_id" : "cn-north-7",
"get_instances" : {
"frontend_info" : "{xxxxxx}",
"ecs_id_list" : "[xxxxxxx]",
"type" : "cmdb_manual",
"group" : "ecs_instance"
},
"rate_control" : {
"max" : "0",
"timeDelay" : "0",
"group" : "rate_control"
}
},
"is_delete" : false,
"last_execute_by" : "xxxxxx",
"last_execution_end_time" : 1600000000,
"last_execution_id" : "xxxxxx",
"last_execution_start_time" : 1600000000,
"name" : "xxxxxx",
"nodes" : [ {
"category" : "service",
"description" : "download obs plug and install plug",
"id" : "xxxxxx",
"ignore_error" : true,
"metadata" : {
"configuration" : {
"func_urn" : "xxxxxxx",
"dataOutputPath" : "",
"func_app" : "CMS",
"dataInputPath" : "",
"validator" : true,
"func_version" : "latest",
"dataResultsPath" : "",
"parameters" : [ {
"default" : "",
"showFormat" : false,
"format" : "",
"value" : "root",
"isEditor" : false,
"key" : "properties.cmd_user"
}, {
"default" : "",
"showFormat" : false,
"format" : "",
"value" : "[xxxxxx]",
"isEditor" : false,
"key" : "properties.software_list"
}, {
"default" : "",
"showFormat" : false,
"format" : "",
"value" : "",
"isEditor" : false,
"key" : "properties.pre_install_script"
}, {
"default" : "",
"showFormat" : false,
"format" : "",
"value" : "install",
"isEditor" : false,
"key" : "properties.operate_type"
}, {
"default" : "",
"showFormat" : false,
"format" : "",
"value" : "",
"isEditor" : false,
"key" : "properties.un_install_script"
}, {
"default" : "",
"showFormat" : false,
"format" : "",
"value" : "1",
"isEditor" : false,
"key" : "properties.version_number"
}, {
"default" : "",
"showFormat" : false,
"format" : "",
"value" : "7200",
"isEditor" : false,
"key" : "properties.time_out"
}, {
"default" : "",
"showFormat" : false,
"format" : "",
"value" : "xxxx",
"isEditor" : false,
"key" : "properties.install_script"
}, {
"default" : "",
"showFormat" : false,
"format" : "",
"value" : "xxxxxx",
"isEditor" : false,
"key" : "properties.package_version_id"
}, {
"default" : "",
"showFormat" : false,
"format" : "",
"value" : "xxxxxx",
"isEditor" : false,
"key" : "properties.package_basic_id"
}, {
"default" : "",
"showFormat" : false,
"format" : "",
"value" : "xxxxx",
"isEditor" : false,
"key" : "properties.package_name"
}, {
"default" : "",
"showFormat" : false,
"format" : "",
"value" : "xxxx",
"isEditor" : false,
"key" : "properties.install_file_dir"
}, {
"default" : "",
"showFormat" : false,
"format" : "",
"value" : "Linux",
"isEditor" : false,
"key" : "properties.plat_form"
}, {
"default" : "",
"showFormat" : false,
"format" : "",
"value" : "package",
"isEditor" : false,
"key" : "properties.group"
}, {
"default" : "",
"showFormat" : false,
"format" : "",
"value" : "xxxxxx",
"isEditor" : false,
"key" : "properties.project_id"
}, {
"default" : "",
"showFormat" : false,
"format" : "",
"value" : "cn-north-4",
"isEditor" : false,
"key" : "properties.region_id"
}, {
"default" : "",
"showFormat" : false,
"format" : "",
"value" : "{xxxxxx}",
"isEditor" : false,
"key" : "properties.frontend_info"
}, {
"default" : "",
"showFormat" : false,
"format" : "",
"value" : "[xxxxxx]",
"isEditor" : false,
"key" : "properties.ecs_id_list"
}, {
"default" : "",
"showFormat" : false,
"format" : "",
"value" : "cmdb_manual",
"isEditor" : false,
"key" : "properties.type"
}, {
"default" : "",
"showFormat" : false,
"format" : "",
"value" : "ecs_instance",
"isEditor" : false,
"key" : "properties.group"
}, {
"default" : "",
"showFormat" : false,
"format" : "",
"value" : "0",
"isEditor" : false,
"key" : "properties.max"
}, {
"default" : "",
"showFormat" : false,
"format" : "",
"value" : "0",
"isEditor" : false,
"key" : "properties.timeDelay"
}, {
"default" : "",
"showFormat" : false,
"format" : "",
"value" : "rate_control",
"isEditor" : false,
"key" : "properties.group"
}, {
"default" : "",
"showFormat" : false,
"format" : "",
"value" : "$.executionId",
"isEditor" : false,
"key" : "properties.executionId"
}, {
"default" : "",
"showFormat" : false,
"format" : "",
"value" : "xxxxxxx",
"isEditor" : false,
"key" : "properties.workflowId"
}, {
"default" : "",
"showFormat" : false,
"format" : "",
"value" : "CMS::ECS::Package",
"isEditor" : false,
"key" : "properties.cmsTaskName2Distribute"
}, {
"default" : "",
"showFormat" : false,
"format" : "",
"value" : "xxxxxx",
"isEditor" : false,
"key" : "properties.cmsAccessPodLb"
}, {
"default" : "",
"showFormat" : false,
"format" : "",
"value" : "manual",
"isEditor" : false,
"key" : "properties.workflowType"
}, {
"default" : "",
"showFormat" : false,
"format" : "",
"value" : "package-manipulation",
"isEditor" : false,
"key" : "properties.nodeId"
} ]
},
"type" : "operation"
},
"name" : "package",
"task_name" : "CMS::ECS::Package"
} ],
"project_id" : "xxxxxx",
"quote" : [ ],
"status" : "fail",
"steps" : [ ],
"tags" : { },
"task_type" : "package",
"template_i18n" : {
"en-us" : {
"name" : "Package",
"description" : "download install plug or uninstall plug"
},
"zh-cn" : {
"name" : "文件管理",
"description" : " "
}
},
"template_id" : "CMS::ECS::Package",
"template_name" : "CMS::ECS::Package",
"type" : "manual",
"update_time" : 1600000000
} ],
"total_elements" : 1
}状态码： 400
BadRequest。非法请求。建议直接修改该请求，不要重试该请求。
{
"error_code" : "AOM.31001302",
"error_msg" : "Invalid input parameter.",
"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代码示例如下。
可指定name为xxx、last_execute_by为xxx、status为xxx、task_type为xxx、search_time_start为1600060125000的查询参数用于查询任务列表。
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 49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
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.*; import java.util.Map; import java.util.HashMap; public class ListWorkflowSolution { 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(); ListWorkflowRequest request = new ListWorkflowRequest(); WorkflowQueryParam body = new WorkflowQueryParam(); body.withStatus("xxx"); body.withSearchTimeEnd(160000000000L); body.withSearchTimeStart(160000000000L); body.withSortType("DESC"); body.withSortField("update_time"); body.withCreateBy("xxx"); body.withEnterpriseProjectId("0"); body.withSize(10); body.withPage(0); body.withType("manual"); body.withSearch(""); request.withBody(body); try { ListWorkflowResponse response = client.listWorkflow(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()); } } } |
可指定name为xxx、last_execute_by为xxx、status为xxx、task_type为xxx、search_time_start为1600060125000的查询参数用于查询任务列表。
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 |
# 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 = ListWorkflowRequest() request.body = WorkflowQueryParam( status="xxx", search_time_end=160000000000, search_time_start=160000000000, sort_type="DESC", sort_field="update_time", create_by="xxx", enterprise_project_id="0", size=10, page=0, type="manual", search="" ) response = client.list_workflow(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
可指定name为xxx、last_execute_by为xxx、status为xxx、task_type为xxx、search_time_start为1600060125000的查询参数用于查询任务列表。
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 49 50 51 52 53 54 55 56 57 58 59 |
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.ListWorkflowRequest{} statusWorkflowQueryParam:= "xxx" searchTimeEndWorkflowQueryParam:= int64(160000000000) searchTimeStartWorkflowQueryParam:= int64(160000000000) createByWorkflowQueryParam:= "xxx" enterpriseProjectIdWorkflowQueryParam:= "0" sizeWorkflowQueryParam:= int32(10) pageWorkflowQueryParam:= int32(0) typeWorkflowQueryParam:= "manual" searchWorkflowQueryParam:= "" request.Body = &model.WorkflowQueryParam{ Status: &statusWorkflowQueryParam, SearchTimeEnd: &searchTimeEndWorkflowQueryParam, SearchTimeStart: &searchTimeStartWorkflowQueryParam, SortType: "DESC", SortField: "update_time", CreateBy: &createByWorkflowQueryParam, EnterpriseProjectId: &enterpriseProjectIdWorkflowQueryParam, Size: &sizeWorkflowQueryParam, Page: &pageWorkflowQueryParam, Type: &typeWorkflowQueryParam, Search: &searchWorkflowQueryParam, } response, err := client.ListWorkflow(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。
可指定name为xxx、last_execute_by为xxx、status为xxx、task_type为xxx、search_time_start为1600060125000的查询参数用于查询任务列表。
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 49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
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.*; import java.util.Map; import java.util.HashMap; public class ListWorkflowSolution { 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(); ListWorkflowRequest request = new ListWorkflowRequest(); WorkflowQueryParam body = new WorkflowQueryParam(); body.withStatus("xxx"); body.withSearchTimeEnd(160000000000L); body.withSearchTimeStart(160000000000L); body.withSortType("DESC"); body.withSortField("update_time"); body.withCreateBy("xxx"); body.withEnterpriseProjectId("0"); body.withSize(10); body.withPage(0); body.withType("manual"); body.withSearch(""); request.withBody(body); try { ListWorkflowResponse response = client.listWorkflow(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()); } } } |
可指定name为xxx、last_execute_by为xxx、status为xxx、task_type为xxx、search_time_start为1600060125000的查询参数用于查询任务列表。
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 |
# 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 = ListWorkflowRequest() request.body = WorkflowQueryParam( status="xxx", search_time_end=160000000000, search_time_start=160000000000, sort_type="DESC", sort_field="update_time", create_by="xxx", enterprise_project_id="0", size=10, page=0, type="manual", search="" ) response = client.list_workflow(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
可指定name为xxx、last_execute_by为xxx、status为xxx、task_type为xxx、search_time_start为1600060125000的查询参数用于查询任务列表。
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 49 50 51 52 53 54 55 56 57 58 59 |
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.ListWorkflowRequest{} statusWorkflowQueryParam:= "xxx" searchTimeEndWorkflowQueryParam:= int64(160000000000) searchTimeStartWorkflowQueryParam:= int64(160000000000) createByWorkflowQueryParam:= "xxx" enterpriseProjectIdWorkflowQueryParam:= "0" sizeWorkflowQueryParam:= int32(10) pageWorkflowQueryParam:= int32(0) typeWorkflowQueryParam:= "manual" searchWorkflowQueryParam:= "" request.Body = &model.WorkflowQueryParam{ Status: &statusWorkflowQueryParam, SearchTimeEnd: &searchTimeEndWorkflowQueryParam, SearchTimeStart: &searchTimeStartWorkflowQueryParam, SortType: "DESC", SortField: "update_time", CreateBy: &createByWorkflowQueryParam, EnterpriseProjectId: &enterpriseProjectIdWorkflowQueryParam, Size: &sizeWorkflowQueryParam, Page: &pageWorkflowQueryParam, Type: &typeWorkflowQueryParam, Search: &searchWorkflowQueryParam, } response, err := client.ListWorkflow(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求响应成功，返回任务列表。 |
|
400 |
BadRequest。非法请求。建议直接修改该请求，不要重试该请求。 |
|
401 |
Unauthorized。在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 |
|
500 |
InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 |
错误码
请参见错误码。
