华为云用户手册

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 参数解释 测试用例总数 取值范围 0-2147483647 project_id String 参数解释 测试服务id 取值范围 32个字符组成的字符串 testcase_id String 参数解释 测试用例id 取值范围 32个字符组成的字符串 testcase_name String 参数解释 测试用例名称 取值范围 3-128个字符组成的字符串 testcase_results Array of TestcaseResult objects 参数解释 测试用例结果 表5 TestcaseResult 参数 参数类型 描述 execute_result_id String 参数解释 用例结果标识 取值范围 0-3个字符组成的字符串 execute_status String 参数解释 测试用例状态 取值范围 0-128个字符组成的字符串 failure_cause String 参数解释 失败原因 取值范围 0-10000个字符组成的字符串 task_id String 参数解释 任务id 取值范围 32个字符组成的字符串 plan_id String 参数解释 测试计划id 取值范围 32个字符组成的字符串 start_time String 参数解释 用例执行开始时间 取值范围 0-128个字符组成的字符串 end_time String 参数解释 用例执行结束时间 取值范围 0-128个字符组成的字符串 executor_id String 参数解释 执行测试用例的用户id 取值范围 1-32个字符组成的字符串 executor_name String 参数解释 执行测试用例的用户名 取值范围 1-32个字符组成的字符串 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 12-18个字符组成的字符串 error_msg String 参数解释 接口调用失败错误信息 取值范围 3-1000个字符组成的字符串 状态码：401 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 12-18个字符组成的字符串 error_msg String 参数解释 接口调用失败错误信息 取值范围 3-1000个字符组成的字符串 状态码：403 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 12-18个字符组成的字符串 error_msg String 参数解释 接口调用失败错误信息 取值范围 3-1000个字符组成的字符串 状态码：404 表9 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 12-18个字符组成的字符串 error_msg String 参数解释 接口调用失败错误信息 取值范围 3-1000个字符组成的字符串 状态码：500 表10 响应Body参数 参数 参数类型 描述 error_code String 参数解释 接口调用失败错误码 取值范围 12-18个字符组成的字符串 error_msg String 参数解释 接口调用失败错误信息 取值范围 3-1000个字符组成的字符串

URI GET /v1/{project_id}/api-testcases/{testcase_id}/execute-histories 表1 路径参数 参数 是否必选 参数类型 描述 testcase_id 是 String 参数解释 测试用例id 约束限制 不涉及 取值范围 32个字符组成的字符串 默认取值 不涉及 project_id 是 String 参数解释 CodeArts的项目ID 约束限制 不涉及 取值范围 32个字符组成的字符串 默认取值 不涉及 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 参数解释 起始偏移量，表示从此偏移量开始查询， offset大于等于1 约束限制 不涉及 取值范围 1-2147483647 默认取值 1 limit 否 Integer 参数解释 每页显示的条目数量,最大支持200条 约束限制 不涉及 取值范围 1-200 默认取值 1 plan_id 否 String 参数解释 测试计划id 约束限制 不涉及 取值范围 32个字符组成的字符串 默认取值 不涉及

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 alert_success_rate Integer 告警成功比率，恒为1 running_tasks Integer 正在运行的任务个数 total_alerts Integer 总告警数 total_days Integer 总运行天数 total_runs Long 总运行个数 total_tasks Integer 总任务个数 work_item_count Integer 工作项个数 状态码：401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因 状态码：403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因 状态码：404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 list Array of MsgInfoVo objects 返回结果 page_num Integer 页码 page_size Integer 分页大小 total_page Integer 总页数 total_size Long 总条数 表5 MsgInfoVo 参数 参数类型 描述 alert_channels String 告警渠道 alert_groups String 告警分组 alert_level Integer 告警级别 alert_num Integer 总告警次数 alert_time Integer 告警时间 alert_type String 告警类型 content String 告警内容 id String MsgInfo的id link String 链接 location_names String 执行机区域 send_alert_type String 发送告警类型 sub_task_case_id String 子任务用例id sub_task_case_start_time String 子任务用例开始时间 sub_task_id String 子任务id sub_task_start_time String 子任务开始时间 task_id String 任务id task_name String 任务名 test_case_id String 用例id test_case_name String 用例名称 test_suite_type Integer 测试套类型 状态码：201 Created 状态码：401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因 状态码：403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因 状态码：404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因

请求示例 post https://{endpoint}/v1/projects/1234567abc/dashboards/alarm/msgs { "alert_types" : [ "7" ], "page_num" : 1, "page_size" : 5, "start_time" : 1745824494068, "end_time" : 1745828094068 }

响应示例 状态码：200 OK { "list" : [ { "id" : "d0c909aeee594422bb4f0f74bd786557", "task_id" : "taskConfigOperationNoticeTaskId", "alert_channels" : "EMAIL", "alert_type" : 7, "send_alert_type" : "OPERATION_NOTICE", "test_suite_type" : 1, "alert_time" : 1745827846000, "location_names" : "cn-north-7", "content" : "[操作通知]服务名称:xxx 操作内容:用户xxx在2025-xx-xx xx:xx:xx GMT+08:00修改了任务配置,任务最长执行时间由长期运行更改为长期运行", "link" : "https://{hosturl}/echotest/project/1234567890/echotest/configurations/clearTask", "alert_num" : 1, "alert_level" : 0 } ], "page_num" : 1, "page_size" : 5, "total_page" : 1, "total_size" : 2 } 状态码：401 Unauthorized { "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 alert_types 否 Array of strings 告警类型 case_id 否 String 用例id case_name 否 String 用例名 end_time 否 Long 结束时间 page_num 否 Integer 页码 page_size 否 Integer 分页大小 send_alert_type 否 String 发送类型 start_time 否 Long 开始时间 task_id 否 String 任务id task_name 否 String 任务名

响应示例 状态码：200 OK { "related_case_uris" : [ "v92s00010db20aj6" ], "not_related_case_uris" : [ ], "case_task_info" : [ { "test_case_num" : "120", "test_case_name" : "推送误报信息处理", "test_case_uri" : "v92s00010db20aj6", "task_uri" : "v92s00010db20ank", "task_name" : "第一批次执行", "task_num" : "108", "task_creator" : "paas_testplan_g30030845_01" } ] }

请求示例 post https://{endpoint}/GT3KServer/v4/dc3f9aa646ad4707831080d3fcce474d/testcases/tasks/batch-query { "page_no" : 1, "page_size" : 10, "key_word" : "", "test_case_uris" : [ "v92s00010db20aj6" ], "iterator_uri" : "" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 page_no 否 Integer 页码 page_size 否 Integer 每页数量 start_index 否 Integer 起始位 end_index 否 Integer 结束位 key_word 否 String 关键字 test_case_uris 否 Array of strings 用例uri列表 iterator_uri 否 String 测试计划uri

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 related_case_uris Array of strings 关联的用例uris not_related_case_uris Array of strings 未关联的用例uris case_task_info Array of RelateTaskTestCasesVo objects 用例及任务信息 表5 RelateTaskTestCasesVo 参数 参数类型 描述 test_case_num String 用例编号 test_case_name String 用例名 test_case_uri String 用例uri task_uri String 任务uri task_name String 任务名 task_num String 任务编号 task_creator String 任务创建人 状态码：400 表6 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：401 表7 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：404 表8 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：500 表9 响应Body参数 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及

URI POST /GT3KServer/v4/{project_id}/testcases/tasks/batch-query 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值: 不涉及

响应示例 状态码：200 OK { "code" : "success", "data" : { "total" : 1, "list" : [ { "id" : "66053737cb7d4cedb1b848f2dfa37f0c", "description" : "", "mindmap" : null, "name" : "1", "editPermission" : true, "deletePermission" : true, "is_default" : null, "create_time" : "2025/01/10 10:43:56 GMT+08:00", "creator_name" : "user", "creator_num" : "efdb403066474ab08836b9eeaaa23bca", "update_time" : null } ], "offset" : 1, "limit" : 9, "pages" : 1, "size" : 1 }, "message" : null } 状态码：400 Bad Request { "error_code" : "TESTMIND.00021882", "error_msg" : "分支、计划id长度不合法，请稍后重试" } 状态码：401 Unauthorized { "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 code String 参数解释： 错误码 data BasePageInfoTemplateV2 object 返回体 message String 参数解释： 错误信息 表6 BasePageInfoTemplateV2 参数 参数类型 描述 limit Integer 参数解释： 每页显示的条目数量，最大支持200条 list Array of TemplateV2 objects 返回体 offset Integer 参数解释： 起始偏移量，表示从此偏移量开始查询，offset大于等于0，小于等于100000 pages Integer 参数解释： 总页数量 size Integer 参数解释： 列表个数 total Long 总数 表7 TemplateV2 参数 参数类型 描述 create_time String 参数解释： 创建时间 creator_name String 参数解释： 创建人名称。 取值范围： 大小写字母、数字、符号、中文。 creator_num String 参数解释： 创建者，用户在IAM中的ID。 取值范围： 大小写字母、数字。 长度限制固定32位 description String 描述 id String id 主键 is_default String 是否默认 mindmap String 脑图json name String 名称 update_time String 参数解释： 更新时间 editPermission Boolean 编辑权限 deletePermission Boolean 删除权限 状态码：400 表8 响应Body参数 参数 参数类型 描述 code String 参数解释： 接口调用错误码 data String 接口调用返回体 message String 参数解释： 接口调用错误信息 状态码：401 表9 响应Body参数 参数 参数类型 描述 code String 参数解释： 接口调用错误码 data String 接口调用返回体 message String 参数解释： 接口调用错误信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制： 必传。 取值范围： 字符串长度不少于1，不超过10万。 默认取值： 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 params 否 TemplatePageParam object 模板分页参数 表4 TemplatePageParam 参数 是否必选 参数类型 描述 creator_num 否 String 参数解释： 创建者，用户在IAM中的ID。 取值范围： 大小写字母、数字。 长度限制固定32位 offset 否 Integer 参数解释： 起始偏移量，表示从此偏移量开始查询，offset大于等于0，小于等于100000 limit 否 Integer 参数解释： 每页显示的条目数量，最大支持200条 name 否 String 参数解释： 脑图名称。 取值范围： 大小写字母、数字、符号、中文。 长度限制128位

响应示例 状态码：200 OK { "code" : "success", "data" : { "id" : "FD690D59571A4AA6AA110F6552793F55", "prerequisite" : "", "url" : null, "uri" : null, "deleted" : "no", "create_time" : "2024/08/20 10:56:59 GMT+08:00", "creator_name" : "user", "creator_num" : "efdb403066474ab08836b9eeaaa23bca", "update_name" : "user", "update_num" : "efdb403066474ab08836b9eeaaa23bca", "update_time" : "2024/08/20 10:56:59 GMT+08:00", "case_name" : "子主题", "test_procedure" : "", "expected_results" : "", "operation_and_expected_result" : null, "case_design_desc" : null, "case_num" : null, "auto_type" : "true", "test_case_level" : "2", "node_id" : "C35F88E19FC443928C11E5DFB634C4FC", "mindmap_id" : "6878af2466484f2eaf8b1095be7f0387", "is_archive" : null, "extra_param" : null, "project_id" : "0edf40e28ce64bc7936b79896e8ec630", "factor_combination_json" : null, "batch_id" : null, "service_id" : null, "branch_id" : null, "plan_id" : null }, "message" : null } 状态码：400 Bad Request { "error_code" : "TESTMIND.00021882", "error_msg" : "分支、计划id长度不合法，请稍后重试" } 状态码：401 Unauthorized { "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 code String 参数解释： 错误码 data TestCase object 请求体 message String 参数解释： 错误信息 表4 TestCase 参数 参数类型 描述 auto_type String 自动化类型 case_design_desc String 用例设计描述 case_name String 参数解释： 用例名称 取值范围： 大小写字母、数字、符号、中文。 长度限制1-10000位 case_num String 用例编号 create_time String 参数解释： 创建时间 creator_name String 创建人名字 creator_num String 参数解释： 创建者，用户在IAM中的ID。 取值范围： 大小写字母、数字。 长度限制固定32位 deleted String 删除状态 expected_results String 预期结果 extra_param String 额外模板字段：以json形式存储，前台解析 factor_combination_json String 因子组合json operation_and_expected_result String 操作及预期结果 id String id 主键 is_archive Boolean 参数解释： 是否归档 取值范围： 0，表示未归档。 1，表示已归档。 mindmap_id String 参数解释： 脑图ID 取值范围： 大小写字母、数字。 长度限制固定32位 node_id String 参数解释： 节点ID 取值范围： 大小写字母、数字。 长度限制固定32位 batch_id String 批次id branch_id String 分支ID plan_id String 计划ID prerequisite String 用例前置步骤 test_case_level String 测试用例级别 test_procedure String 测试步骤 update_name String 更新人名字 update_num String 更新人工号 update_time String 参数解释： 更新时间 url String url uri String uri project_id String 参数解释： 项目ID 取值范围： 大小写字母、数字。 长度限制固定32位 service_id String 服务id 状态码：400 表5 响应Body参数 参数 参数类型 描述 code String 参数解释： 接口调用错误码 data String 接口调用返回体 message String 参数解释： 接口调用错误信息 状态码：401 表6 响应Body参数 参数 参数类型 描述 code String 参数解释： 接口调用错误码 data String 接口调用返回体 message String 参数解释： 接口调用错误信息

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 status String success|error; ok|failed result ResultValueStepImageVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表5 ResultValueStepImageVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value StepImageVo object 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表6 StepImageVo 参数 参数类型 描述 img_id String 测试步骤图片id img_url String 测试步骤图片路径 表7 ApiError 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：400 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：401 表9 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：404 表10 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：500 表11 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及

响应示例 状态码：200 OK { "status" : "success", "result" : { "value" : "[{\"file_type\":\"xlsx\",\"docsize\":\"10094\",\"path\":\"/ffecfceca51d419cbfc2a28e90c93761/testman/\",\"doc_name\":\"数据安全风险排查上报记录-TMSS\",\"store_name\":\"5acf110e-c4a9-4be6-904b-6b3ae5204994.xlsx\",\"doc_id\":4593831}]" } }

URI GET /v1/projects/{service_id}/alert/user/name 表1 路径参数 参数 是否必选 参数类型 描述 service_id 是 String 参数解释 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID。 约束限制 不涉及 取值范围 32个字符组成的字符串 默认取值 不涉及 表2 Query参数 参数 是否必选 参数类型 描述 user_id 否 String 用户ID user_name 是 String 用户名

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 status String 返回状态码，OK表示名称校验通过，任务名不重复 result String 告警组用户名是否重复结果返回 状态码：401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因 状态码：403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因 状态码：404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误编码 error_msg String 错误原因

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 status String success|error; result ResultValueDisplayIssueDynamicVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表5 ResultValueDisplayIssueDynamicVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value DisplayIssueDynamicVo object 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表6 DisplayIssueDynamicVo 参数 参数类型 描述 is_display_issue_dynamic String 需求更新自定开关 表7 ApiError 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码：400 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：401 表9 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：404 表10 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码：500 表11 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及

URI GET /v4/projects/{project_id}/issue-update-notification 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值: 不涉及 表2 Query参数 参数 是否必选 参数类型 描述 owner_id 是 String 用户id

响应示例 状态码：200 OK { "code" : "success", "data" : { "mindmap_ids" : [ "b6940ab1deda47b29ebcae3cd07166da", "639b843066d449ca8e0c4ac8aed14929" ], "delete_mindmap_ids" : [ { "id" : "639b843066d449ca8e0c4ac8aed14929", "name" : "思维导图", "creator_num" : "e8ad9e7478c94f4eaf90d5a379af9cb1" }, { "id" : "b6940ab1deda47b29ebcae3cd07166da", "name" : "思维导图", "creator_num" : "e8ad9e7478c94f4eaf90d5a379af9cb1" } ], "no_permission_mindmap_ids" : [ ], "operation_uri" : null }, "message" : null } 状态码：400 Bad Request { "error_code" : "TESTMIND.00021882", "error_msg" : "分支、计划id长度不合法，请稍后重试" } 状态码：401 Unauthorized { "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }

响应参数 状态码：200 表7 响应Body参数 参数 参数类型 描述 code String 参数解释： 接口调用错误码 data Object 批量删除脑图参数对象 message String 参数解释： 接口调用错误信息 表8 BatchDeleteMindmapParam 参数 参数类型 描述 mindmap_ids Array of strings 脑图id列表 delete_mindmap_ids Array of MindmapDto objects 脑图已删除列表 no_permission_mindmap_ids Array of MindmapDto objects 脑图无权限删除列表 operation_uri String 进度id 表9 MindmapDto 参数 参数类型 描述 id String 脑图id name String 脑图名称 creator_num String 参数解释： 创建者，用户在IAM中的ID。 取值范围： 大小写字母、数字。 长度限制固定32位 状态码：400 表10 响应Body参数 参数 参数类型 描述 code String 参数解释： 接口调用错误码 data String 接口调用返回体 message String 参数解释： 接口调用错误信息 状态码：401 表11 响应Body参数 参数 参数类型 描述 code String 参数解释： 接口调用错误码 data String 接口调用返回体 message String 参数解释： 接口调用错误信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制： 必传。 取值范围： 字符串长度不少于1，不超过10万。 默认取值： 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 - 否 Object { "type": "object", "properties": { "mindmap_ids": { "description": "脑图id集合", "type": "array", "items": { "type": "string" } } } } 表4 CommRequestBatchDeleteMindmapParam 参数 是否必选 参数类型 描述 params 否 Object 批量删除脑图参数对象 表5 BatchDeleteMindmapParam 参数 是否必选 参数类型 描述 mindmap_ids 否 Array of strings 脑图id列表 delete_mindmap_ids 否 Array of MindmapDto objects 脑图已删除列表 no_permission_mindmap_ids 否 Array of MindmapDto objects 脑图无权限删除列表 operation_uri 否 String 进度id 表6 MindmapDto 参数 是否必选 参数类型 描述 id 否 String 脑图id name 否 String 脑图名称 creator_num 否 String 参数解释： 创建者，用户在IAM中的ID。 取值范围： 大小写字母、数字。 长度限制固定32位

响应示例 状态码：200 OK { "code" : "success", "data" : null, "message" : null } 状态码：400 Bad Request { "error_code" : "TESTMIND.00021882", "error_msg" : "分支、计划id长度不合法，请稍后重试" } 状态码：401 Unauthorized { "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 code String 错误码 data Object 返回体 message String 错误信息 状态码：400 表4 响应Body参数 参数 参数类型 描述 code String 参数解释： 接口调用错误码 data String 接口调用返回体 message String 参数解释： 接口调用错误信息 状态码：401 表5 响应Body参数 参数 参数类型 描述 code String 参数解释： 接口调用错误码 data String 接口调用返回体 message String 参数解释： 接口调用错误信息

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 code String 参数解释 错误码 error CommonResponseErrorString object 参数解释 统一错误返回 reason String 参数解释 失败原因 result String 参数解释 结果 status String 参数解释 响应状态 表4 CommonResponseErrorString 参数 参数类型 描述 code String 参数解释 错误码 reason String 参数解释 错误原因 状态码：204 No Content 状态码：401 Unauthorized 状态码：403 Forbidden

URI GET /v3/{project_id}/basic-aw/{aw_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID。 约束限制 不涉及 取值范围 32个字符组成的字符串 默认取值 不涉及 aw_id 是 String 参数解释 关键字id 约束限制 不涉及 取值范围 32个字符组成的字符串 默认取值 不涉及