# 查询任务列表或任务模板列表 - ListTask #### 功能介绍 根据项目ID，租户ID等条件查询功能自动化任务列表或任务模板列表 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-testman/cloudtest_03_2000.html)。 #### URI POST /v3/task/list #### 请求参数 表1请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | x-auth-tenantid | 是 | String | **参数解释** 租户id **约束限制** 不涉及 **取值范围** 字符串长度不少于1，不超过100000 **默认取值** 不涉及 **获取方式** 从 GET /rest/me 的返回结果中对应的id字段获取。 | | x-auth-groups | 是 | String | **参数解释** 项目id **约束限制** 不涉及 **取值范围** 字符串长度不少于1，不超过100000 **默认取值** 不涉及 **获取方式** 从 GET /rest/me 的返回结果中对应的id字段获取。 | | x-user-name | 是 | String | **参数解释** 用户id **约束限制** 不涉及 **取值范围** 字符串长度不少于1，不超过100000 **默认取值** 不涉及 **获取方式** 从 GET /rest/me 的返回结果中对应的id字段获取。 | | x-auth-token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 必传。 **取值范围：** 字符串长度不少于1，不超过10万。 **默认取值：** 不涉及。 | | requestId | 是 | String | **参数解释** 请求id **约束限制** 不涉及 **取值范围** 字符串长度不少于1，不超过100000 **默认取值** 不涉及 **获取方式** 任意字母加数字组成的字符串，长度不超过32位。 | 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | userName | 否 | String | 用户名 | | testServiceId | 是 | String | **参数解释** 测试服务id **约束限制** 不涉及 **取值范围** 字符串长度不少于1，不超过100000 **默认取值** 不涉及 **获取方式** 从 GET /rest/me 的返回结果中 projectId 字段获取。 | | flag | 否 | String | 标识 | | searchType | 否 | String | 查询类型："CloudTest" - 云测试 | | coldDataFlag | 否 | Boolean | 冷数据开关，默认关闭 | | where | 否 | Array of objects | 查询条件 | | option | 否 | Object | 排序 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | result | [result] object | 任务结果集合 | | server_ip | String | 服务端IP | | request_id | String | 请求唯一标识 | | status | String | 请求状态："ok" - 成功 | 表4result | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data | Array of [data] objects | 任务详情列表 | | resultSize | [resultSize] object | 结果总数 | | taskStateCount | [taskStateCount] object | 任务状态统计 | 表5data | 参数 | 参数类型 | 描述 | |:---|:---|:---| | isSetResultToTMSS | Boolean | 是否将结果同步到用例管理服务 | | tmssInfo | Object | 用例管理服务信息 | | productId | String | 产品ID | | author | String | 创建人唯一标识 | | testType | String | 测试类型：regression - 回归 | | testServiceId | String | 测试服务ID | | simple | Boolean | 是否为简单类型 | | verName | String | 版本名称 | | updateTime | Long | 更新时间，毫秒时间戳 | | type | String | 任务类型：executing - 测试任务，ticctaskproject - 任务组 | | versionName | String | 版本名称 | | userExtendContent | [userExtendContent] object | 扩展参数 | | analyser | String | 分析者ID | | versionId | String | 版本ID | | excuteType | String | 执行类型 | | createTime | Long | 创建时间，毫秒时间戳 | | envInfo | Object | 环境信息 | | name | String | 任务名称 | | progress | Integer | 进度百分比 | | state | Integer | 任务状态：1 - 初始化，2 - 运行中，3 - 已暂停，4 - 暂停中，5 - 停止，6 - 完成，7 - 错误，8 - 停止中，10 - 等待中，12 - 提交 | | id | String | 任务ID | | maillist | String | 邮件列表 | | projectId | String | 项目ID | 表6userExtendContent | 参数 | 参数类型 | 描述 | |:---|:---|:---| | serviceType | String | 服务类型 | | platFromErrStrategy | String | 平台错误处理策略 | | pbiName | String | PBI名称 | | ignoreEnv | Boolean | 是否忽略环境 | | Env_Network_Area | String | 网络区域 | | productName | String | 产品名 | | testActivityType | String | 测试活动类型 | | serial_execution | Boolean | 是否串行执行 | | intervalTimeUnit | String | 间隔时间单位 | | git_url | String | Git仓库地址 | | envSystem | String | 环境系统 | | downloadScriptUrl | [downloadScriptUrl] object | 脚本下载地址 | | branchId | String | 分支ID | | rgid | String | RGID | | ip | String | IP地址 | | branchName | String | 分支名称 | | pbiId | String | PBI编号 | | env | Array of strings | 环境变量集合 | | taskDesc | String | 任务描述 | | isSelectAllTeps | Boolean | 是否全选执行器 | | iteratorId | String | 迭代器ID | | iteratorName | String | 迭代器名称 | | exe_param_overridable | Boolean | 执行参数是否可覆盖 | | excuteType | String | 执行类型 | | port | String | 端口 | | jenkinsIds | Array of strings | Jenkins任务ID集合 | | isPersonConfig | String | 是否为个人配置 | | git_username | String | Git用户名 | 表7downloadScriptUrl | 参数 | 参数类型 | 描述 | |:---|:---|:---| | api_host | String | API主机地址 | 表8resultSize | 参数 | 参数类型 | 描述 | |:---|:---|:---| | size | Integer | 数据条数 | 表9taskStateCount | 参数 | 参数类型 | 描述 | |:---|:---|:---| | pauseTaskCount | Integer | 已暂停任务数 | | stoppingTaskCount | Integer | 停止中任务数 | | waitingTaskCount | Integer | 待执行任务数 | | runningTaskCount | Integer | 运行中任务数 | | pausingTaskCount | Integer | 暂停中任务数 | | initTaskCount | Integer | 初始化任务数 | **状态码：201** Created **状态码：401** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | status | String | 请求状态："failed" - 失败 | | request_id | String | 请求id | | server_ip | String | 服务节点IP | | error_msg | String | 错误信息 | | error_code | String | 错误码 | | error_cause | String | 错误原因 | | faq | String | faq内容 | **状态码：403** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | status | String | 请求状态："failed" - 失败 | | request_id | String | 请求id | | server_ip | String | 服务节点IP | | error_msg | String | 错误信息 | | error_code | String | 错误码 | | error_cause | String | 错误原因 | | faq | String | faq内容 | **状态码：404** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | status | String | 请求状态："failed" - 失败 | | request_id | String | 请求id | | server_ip | String | 服务节点IP | | error_msg | String | 错误信息 | | error_code | String | 错误码 | | error_cause | String | 错误原因 | | faq | String | faq内容 | #### 请求示例 ``` post https://{endpoint}/v3/task/list { "searchType" : "CloudTest", "flag" : "cardTask", "where" : [ { "value" : "c2d63f9d3af34177ab62545d841c78d7", "type" : "=", "key" : "productId" }, { "value" : [ "v9050000tqu3e7e2", "v92t00010dqad7nt" ], "type" : "in", "key" : "versionUri" }, { "value" : 0, "type" : "=", "key" : "state" } ], "option" : { "order" : "desc", "by" : "update_time", "limit" : 15, "start" : 0 }, "testServiceId" : "xxx", "userName" : "xxx" } ``` #### 响应示例 **状态码：200** OK ``` { "result" : { "data" : [ { "isSetResultToTMSS" : false, "tmssInfo" : { }, "productId" : "7b90e408636344328e44bf70bbae8351", "author" : "efdb403066474ab08836b9eeaaa23bca", "testType" : "regression", "testServiceId" : "", "simple" : true, "verName" : "用例库", "updateTime" : 1748403551661, "type" : "executing", "versionName" : "用例库", "userExtendContent" : { "serviceType" : "Single", "platFromErrStrategy" : "no", "pbiName" : "", "ignoreEnv" : false, "Env_Network_Area" : "NetworkArea", "productName" : "productName", "testActivityType" : "", "serial_execution" : false, "intervalTimeUnit" : "h", "git_url" : "", "envSystem" : "", "downloadScriptUrl" : { "api_host" : "apigw.huawei.com" }, "branchId" : "v9050000tqu3e7e2", "rgid" : "", "ip" : "", "branchName" : "基线", "pbiId" : "", "env" : [ ], "taskDesc" : "", "isSelectAllTeps" : false, "iteratorId" : "v9050000tqu3e7e2", "iteratorName" : "用例库", "exe_param_overridable" : false, "excuteType" : "6", "port" : "", "jenkinsIds" : [ ], "isPersonConfig" : "false", "git_username" : "" }, "analyser" : "efdb403066474ab08836b9eeaaa23bca", "versionId" : "v9050000tqu3e7e2", "excuteType" : "6", "createTime" : 1748403551661, "envInfo" : { }, "name" : "213123213123", "progress" : 0, "state" : -1, "id" : "2607532507867906048", "maillist" : "", "projectId" : "2607532507867906048" } ], "resultSize" : { "size" : 1 }, "taskStateCount" : { "pauseTaskCount" : 0, "stoppingTaskCount" : 0, "waitingTaskCount" : 0, "runningTaskCount" : 0, "pausingTaskCount" : 0, "initTaskCount" : 0 } }, "server_ip" : "", "request_id" : "", "status" : "ok" } ``` **状态码：401** Unauthorized ``` { "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 201 | Created | | 401 | Unauthorized | | 403 | Forbidden | | 404 | Not Found | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-testman/ErrorCode.html)。