# 创建或执行任务组 - ExecuteTaskGroup #### 功能介绍 根据taskPolicy，创建功能自动化任务组，或者直接提交执行自动化任务组 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-testman/cloudtest_03_2000.html)。 #### URI POST /v3/task-group/execution #### 请求参数 表1请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 必传。 **取值范围：** 字符串长度不少于1，不超过10万。 **默认取值：** 不涉及。 | | x-auth-groups | 否 | String | **参数解释** 项目id **约束限制** 不涉及 **取值范围** 字符串长度不少于1，不超过100000 **默认取值** 不涉及 **获取方式** 从 GET /rest/me 的返回结果中对应的id字段获取。 | 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | branchId | 否 | String | 分支ID **获取方式** 从 POST /v3/task/list 返回结果中对应的 id 字段获取。 | | branchName | 否 | String | 分支名称 | | versionId | 否 | String | 版本ID **获取方式** 从 POST /v3/task/list 返回结果中对应的 id 字段获取。 | | versionName | 否 | String | 版本名称 | | id | 否 | String | 唯一ID **获取方式** 从 POST /v3/task/list 返回结果中对应的 id 字段获取。 | | author | 否 | String | 作者ID **获取方式** 从 GET /rest/me 返回结果中的 userId 字段获取。 | | analyser | 否 | String | 分析者ID **获取方式** 从 GET /rest/me 返回结果中的 userId 字段获取。 | | testServiceId | 否 | String | **参数解释** 测试服务id **约束限制** 不涉及 **取值范围** 字符串长度不少于1，不超过100000 **默认取值** 不涉及 **获取方式** 从 GET /rest/me 的返回结果中 projectId 字段获取。 | | userName | 否 | String | 用户ID **获取方式** 从 GET /rest/me 返回结果中的 userId 字段获取。 | | taskGroupName | 否 | String | 任务组名称 | | scheduledTime | 否 | String | 定时调度时间 | | intervalTime | 否 | String | 调度间隔时间 | | intervalTimeUnit | 否 | String | 调度间隔时间单位 | | taskPolicy | 否 | Integer | 任务策略 | | taskGroupExeParam | 否 | [taskGroupExeParam] object | 任务组执行参数 | | taskStrategy | 否 | [taskStrategy] object | 任务策略 | | circle | 否 | [circle] object | 循环执行参数 | | overTimeParam | 否 | [overTimeParam] object | 超时参数 | | tmssInfo | 否 | [tmssInfo] object | 测试用例信息 | | tasks | 否 | Array of [tasks] objects | 任务列表 | 表3taskGroupExeParam | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | exeParam | 否 | String | 执行参数 | | exeParamTemplateId | 否 | String | 参数模板ID **获取方式** 从 POST /v3/task/list 返回结果中对应的 id 字段获取。 | 表4taskStrategy | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | extendParam | 否 | String | 扩展参数 | 表5circle | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | distance | 否 | Integer | 循环间隔 | | beginTime | 否 | Integer | 循环起始时间 | | concludingTime | 否 | Integer | 循环结束时间 | 表6overTimeParam | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | maxExecuteTime | 否 | Integer | 最大执行时间 | 表7tmssInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 否 | String | 类型："CloudTMSS" - CloudTMSS | | url | 否 | String | 访问地址 | | urlvpc | 否 | String | VPC地址 | 表8tasks | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 否 | String | 任务ID **获取方式** 从 POST /v3/task/list 返回结果中对应的 id 字段获取。 | | parentId | 否 | String | 父任务组ID **获取方式** 从 POST /v3/task/list 返回结果中对应的 id 字段获取。 | | taskName | 否 | String | 任务名称 | | ticcTaskType | 否 | String | 功能自动化任务类型：serial - 串行，parallel - 并行，executing - 执行中 | | maxTepNum | 否 | String | 最大执行器数量 | | testServiceId | 否 | String | **参数解释** 测试服务id **约束限制** 不涉及 **取值范围** 字符串长度不少于1，不超过100000 **默认取值** 不涉及 **获取方式** 从 GET /rest/me 返回结果中的 projectId 字段获取。 | | strategyId | 否 | String | 策略ID | | executeType | 否 | String | 执行类型 | | testType | 否 | String | 测试类型：regression - 回归 | | startTime | 否 | String | 启动时间 | | endTime | 否 | String | 结束时间 | | intervalTime | 否 | String | 间隔时间 | | Mail | 否 | String | 邮箱 | | exeParam | 否 | String | 执行参数 | | exeParamTemplateId | 否 | String | 参数模板ID **获取方式** 从 POST /v3/task/list 返回结果中对应的 id 字段获取。 | | envSystem | 否 | String | 环境系统 | | envDetails | 否 | String | 环境详情 | | resourceType | 否 | String | 资源类型："TestVersion" - 测试版本，"TestItem" - 测试项，"TaskFolder" - 任务目录，"TestCase" - 测试用例，"Task" - 任务，"UserDefined" - 用户定义 | | uris | 否 | Array of strings | 用例uri列表 | | ip | 否 | String | IP地址 | | port | 否 | String | 端口号 | | taskPolicy | 否 | String | 任务策略 | | isPersonConfig | 否 | Boolean | 是否个人配置 | | sutRepoUrl | 否 | String | SUT代码仓地址 | | gitUsername | 否 | String | git用户名 | | ignoreEnv | 否 | Boolean | 忽略环境 | | needEnvVersion | 否 | Boolean | 需要环境版本 | | rgId | 否 | String | 区域 **获取方式** 从 POST /v3/task/list 返回结果中对应的 id 字段获取。 | | testbeds | 否 | Array of strings | 测试床 | | location | 否 | String | 位置 | | inputHost | 否 | String | 输入主机 | | env | 否 | Array of strings | 环境变量 | | teps | 否 | Array of [teps] objects | 执行器数组 | | taskDesc | 否 | String | 任务描述 | | selectedTeps | 否 | Array of strings | 选中的执行器 | | pSelect | 否 | Array of strings | 选择执行器 | | caseUris | 否 | Array of strings | 用例URIs | | taskUris | 否 | Array of strings | 任务URIs | | isGroupExeParam | 否 | Boolean | 是否组执行参数 | | showPreCondition | 否 | String | 展示前置条件 | | showTermination | 否 | String | 展示终止条件 | | jenkinsUrl | 否 | String | Jenkins地址 | | jenkinsUsername | 否 | String | Jenkins用户名 | | jenkinsPassword | 否 | String | Jenkins密码 | | userextendParam | 否 | [userextendParam] object | 用户扩展参数 | | exe_param_overridable | 否 | Boolean | 执行参数可覆盖 | | user_init_sh | 否 | String | 用户初始化脚本 | | user_finalized_sh | 否 | String | 用户最终处理脚本 | | cpts_kpi_monitor | 否 | String | cpts kpi监控 | | serial_execution | 否 | Boolean | 串行执行 | | taskStrategy | 否 | [taskStrategy] object | 任务策略 | | author | 否 | String | 任务创建人 | | analyser | 否 | String | 任务分析人 | | jenkinsId | 否 | String | Jenkins任务ID **获取方式** 从 POST /v3/task/list 返回结果中对应的 id 字段获取。 | | stageId | 否 | Integer | 阶段ID | | git_branch | 否 | String | git分支 | | circle | 否 | Object | 循环信息 | | scene | 否 | String | 场景 | | coverageServer | 否 | String | 覆盖服务器 | | taskMode | 否 | String | 任务模式 | | isSelectAllTeps | 否 | Boolean | 是否全选执行器 | | downloadScriptUrl | 否 | String | 下载脚本url | | serviceName | 否 | String | 服务名称 | | branchId | 否 | String | 分支ID **获取方式** 从 POST /v3/task/list 返回结果中对应的 id 字段获取。 | | branchName | 否 | String | 分支名称 | | versionId | 否 | String | 版本ID **获取方式** 从 POST /v3/task/list 返回结果中对应的 id 字段获取。 | | versionName | 否 | String | 版本名称 | 表9teps | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 否 | String | 执行器id **获取方式** 从 POST /attask/v1/ticc/tepsByGroup/{serviceId} 返回结果中对应的 id 字段获取。 | | groupId | 否 | String | 执行器组id **获取方式** 从 POST /attask/v1/ticc/tepsByGroup/{serviceId} 返回结果中对应的 id 字段获取。 | 表10userextendParam | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | platFromErrStrategy | 否 | String | 平台异常策略 | 表11taskStrategy | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | blockSize | 否 | String | 块大小 | | extendParam | 否 | String | 扩展参数 | #### 响应参数 **状态码：200** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | result | [result] object | 任务结果 | | requestId | String | 请求唯一标识 | | serverIp | String | 服务端IP | | status | String | 状态：ok - 成功 | 表13result | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 任务ID | **状态码：201** Created **状态码：401** 表14响应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** 表15响应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** 表16响应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-group/execution { "branchId" : "bawedsad21312312412434534", "branchName" : "测试用", "versionId" : "V1.0", "versionName" : "版本1.0", "id" : "sadasgfh312312412", "author" : "test123", "analyser" : "hgfh", "testServiceId" : "string", "userName" : "string", "taskGroupName" : "string", "scheduledTime" : "string", "intervalTime" : "string", "intervalTimeUnit" : "string", "taskPolicy" : 0, "taskGroupExeParam" : { "exeParam" : "string", "exeParamTemplateId" : "string" }, "taskStrategy" : { "extendParam" : "string" }, "circle" : { "distance" : 0, "beginTime" : 0, "concludingTime" : 0 }, "overTimeParam" : { "maxExecuteTime" : 0 }, "tmssInfo" : { "type" : "string", "url" : "string", "urlvpc" : "string" }, "tasks" : [ { "id" : "string", "parentId" : "string", "taskName" : "string", "ticcTaskType" : "string", "maxTepNum" : "string", "testServiceId" : "string", "strategyId" : "string", "executeType" : "string", "testType" : "string", "startTime" : "string", "endTime" : "string", "intervalTime" : "string", "Mail" : "string", "exeParam" : "string", "exeParamTemplateId" : "string", "envSystem" : "string", "envDetails" : "string", "resourceType" : "string", "uris" : [ "string" ], "ip" : "string", "port" : "string", "taskPolicy" : "string", "isPersonConfig" : true, "sutRepoUrl" : "string", "gitUsername" : "string", "ignoreEnv" : true, "needEnvVersion" : true, "rgId" : "string", "testbeds" : [ "string" ], "location" : "string", "inputHost" : "string", "env" : [ "string" ], "teps" : [ { "id" : "string", "groupId" : "string" } ], "taskDesc" : "string", "selectedTeps" : [ "string" ], "pSelect" : [ "string" ], "caseUris" : [ "string" ], "taskUris" : [ "string" ], "isGroupExeParam" : true, "showPreCondition" : "string", "showTermination" : "string", "jenkinsUrl" : "string", "jenkinsUsername" : "string", "jenkinsPassword" : "string", "userextendParam" : { "platFromErrStrategy" : "string" }, "exe_param_overridable" : true, "user_init_sh" : "string", "user_finalized_sh" : "string", "cpts_kpi_monitor" : "string", "serial_execution" : true, "taskStrategy" : { "blockSize" : "string", "extendParam" : "string" }, "author" : "string", "analyser" : "string", "jenkinsId" : "string", "stageId" : 0, "git_branch" : "string", "circle" : { }, "scene" : "string", "coverageServer" : "string", "taskMode" : "string", "isSelectAllTeps" : true, "downloadScriptUrl" : "string", "serviceName" : "string", "branchId" : "string", "branchName" : "string", "versionId" : "string", "versionName" : "string" } ] } ``` #### 响应示例 **状态码：200** OK ``` { "result" : { "id" : "2549123529622683648" }, "requestId" : "", "serverIp" : "", "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)。