华为云用户手册

  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 error CommonResponseErrorOfAPITest object 错误详情 reason String 错误原因 result DnsMapping object DNS配置结果集 status String 状态值,如success、error code String 错误码 表4 CommonResponseErrorOfAPITest 参数 参数类型 描述 code String 错误码 reason String 错误原因 表5 DnsMapping 参数 参数类型 描述 dns Array of DnsMappingNode objects DNS配置 表6 DnsMappingNode 参数 参数类型 描述 domain_name String 域名信息 ips Array of strings 域名对应的IP
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 code String 错误码 error CommonResponseErrorOfAPITest object 统一错误返回 reason String 失败原因 result Array of GetPublicLibAndAwsResp objects 公共aw信息 status String 状态 表4 CommonResponseErrorOfAPITest 参数 参数类型 描述 code String 错误码 reason String 错误原因 表5 GetPublicLibAndAwsResp 参数 参数类型 描述 aw_tag String 公共关键字分组信息 document_link String 公共关键字帮助文档链接 is_favorite Integer 保留字段 public_aw_description String 公共关键字描述 public_aw_id String 公共关键字唯一ID public_aw_lib_id String 公共关键库唯一ID public_aw_lib_name String 公共关键字库名称 public_aw_mark Integer 保留字段 public_aw_name String 公共关键字名称
  • 响应示例 状态码: 200 SUCCESS { "status" : "success", "result" : [ { "public_aw_id" : "dbc1256e4de44381bad5c426d9341b62", "public_aw_name" : "DubboClient", "public_aw_description" : "访问dubbo服务器。", "public_aw_mark" : null, "is_favorite" : 1, "public_aw_lib_id" : "2111fa8bc9724b999b2c1fea6bc1e8f2", "public_aw_lib_name" : "dubbo-operation-aw", "aw_tag" : "协议", "document_link" : "https://support.huaweicloud.com/usermanual-testman/cloudtest_01_1320.html" } ], "reason" : null, "error" : null, "code" : null }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 status String 对外时:success|error; result ResultValueListTestVersionVo object 请求的返回的数据对象 表4 ResultValueListTestVersionVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时, 值为0, 分页请求才有此值 value Array of TestVersionVo objects 实际的数据类型:单个对象,集合 或 NULL reason String 业务失败的提示内容,对内接口才有此值 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表5 TestVersionVo 参数 参数类型 描述 uri String 资源URI type String 资源类型 author String 创建人 name String 名称 rank Integer 级别 version String 待测版本 owner String 处理者ID creator String 创建人ID iterations String 关联迭代 description String 描述 region String 区域 last_modifier String 最后修改人 last_modified String 最后修改时间 last_modified_timestamp Long 修改时间时间戳 last_change_time String 最后变更时间 version_uri String 版本URI origin_uri String 源资源URI parent_uri String 父资源URI parent_path String 父资源路径 creation_version_uri String 创建版本URI creation_date String 创建时间 creation_date_timestamp Long 创建时间时间戳 author_name String 创建人名称 comment String 备注 number String 编号 is_master Integer 是否为Master分支 is_iterator Integer 是否为迭代 plan_start_date String 开始时间 plan_end_date String 结束时间 service_id String 微服务ID service_name String 微服务名 pbi_id String PBI ID pbi_name String PBI信息 plan_id String 计划ID metric_pbi_ids String 度量PBI ID metric_pbi_id_names String 度量PBI名称 last_syn_date String 最后同步时间 is_closed String 版本是否关闭 asyn_git String 是否同步git库 schema_no Integer schema编号 finish_date String 迭代实际完成时间 owner_name String 处理者名称 creator_name String 创建人名称 current_stage String 当前所处阶段 service_types String 服务类型 risk_rating Integer 风险等级 risk_des String 风险描述 project_uuid String 项目ID domain_id String 租户ID pi_id String pi的id 状态码: 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 业务失败的提示内容
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 page_no 是 Integer 页码 最小值:1 最大值:20000 page_size 是 Integer 每页数量 最小值:1 最大值:100
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 testcases Array of TestCaseVo objects 用例详情 total_count Integer 用例总数 page_no Integer 页码 page_size Integer 每页数量 表5 TestCaseVo 参数 参数类型 描述 uri String 用例ID number String 用例编号 name String 用例名称 rank String 用例等级 dr_relation_id String 工作项id status_code String 状态ID status_name String 状态名称 author String 创建人名称 author_id String 创建人ID owner String 处理人名称 project_uuid String 项目ID test_type String 测试类型 creation_date String 创建时间 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 status String 对外时:success|error; 对内时:ok|failed result ResultValueListTestItemVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入,建议使用UUID保证请求的唯一性。 server_address String 对内接口才有此属性 表5 ResultValueListTestItemVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时, 值为0, 分页请求才有此值 value Array of TestItemVo objects 实际的数据类型:单个对象,集合 或 NULL reason String 业务失败的提示内容,对内接口才有此值 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表6 TestItemVo 参数 参数类型 描述 uri String 资源URI type String 资源类型 author String 创建人 name String 名称 rank Integer 级别 owner String 责任人 frequence String frequence值 region String 区域 last_modifier String 最后修改人 last_modified String 最后修改时间 last_modified_timestamp Long 修改时间时间戳 last_change_time String 最后变更时间 version_uri String 版本URI origin_uri String 源资源URI parent_uri String 父资源URI parent_path String 父资源路径 creation_version_uri String 创建版本URI creation_date String 创建时间 creation_date_timestamp Long 创建时间时间戳 author_name String 创建人名称 comment String 备注 number String 编号 is_feature String 是否特性 relate_htsm String 是否关联特性 aw_unique_id String aw id test_mind_id String 脑图id test_mind_url String 脑图url project_uuid String 项目id case_total Integer 用例总数 execd_total Integer 执行总数 is_direct_relation Boolean is_direct_relation has_child Boolean 是否有子特性 表7 ApiError 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码: 400 表8 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码: 401 表9 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码: 404 表10 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码: 500 表11 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 表3 请求Body参数 参数 是否必选 参数类型 描述 owner 否 String 责任人 stage 否 String 阶段 activity 否 String 活动 version_uri 否 String 版本URI task_uri 否 String 任务uri service_type 否 String 用例服务类型 contain_total 否 Boolean 是否包含用例数 project_uuid 否 String 项目id sort_type 否 String 排序类型 page_number 否 Integer 页码 page_size 否 Integer 每页数量
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 value String testbird key 状态码: 400 表4 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码: 401 表5 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码: 404 表6 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码: 500 表7 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 value String testbird key 状态码: 400 表3 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码: 401 表4 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码: 404 表5 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码: 500 表6 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 uri String 进度uri name String 异步进度名称 total Integer 资源总数 completed Boolean 异步操作是否完成 cancelled Boolean 异步操作是否取消 informations Array of strings 提示信息列表 code String 错误编码 reason String 错误信息 submitted_time String 提交时间 begin_time String 开始时间 end_time String 结束时间 server_ip String 服务ip last_modified_time Long 最后修改时间 finished_count Integer 执行完成总数 return_value Object 异步操作返回值 exception_message String 异常信息 line_up_num Integer 行编号 asyn_operation_key String 异步操作的key is_ended Boolean 是否结束 finished_percent Integer 异步操作完成进度 状态码: 400 表5 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码: 401 表6 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码: 404 表7 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码: 500 表8 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 end_row Long 结束行 has_next_page Boolean 是否有下一页 has_previous_page Boolean 是否有上一页 is_first_page Boolean 是否是第一页 is_last_page Boolean 是否是最后一页 list Array of AlertTemplateVo objects 当前页面的模板 navigate_first_page Integer 导航第一页数字 navigate_last_page Integer 导航最后一页数字 navigate_pages Integer 导航页数 navigate_page_nums Array of integers 导航页数 next_page Integer 下一页 page_num Integer 多少页 page_size Integer 每页多少个 pages Integer 总页数 pre_page Integer 前面有多少页 size Integer 当前页告警模板数 start_row Long 开始行 total Long 总告警模板数 表5 AlertTemplateVo 参数 参数类型 描述 alert_levels Array of AlertLevel objects 告警级别列表 create_time String 创建时间 create_user String 创建人 id String 唯一ID,主键 name String 告警模板名称 remarks String 备注 test_service_id String 服务ID update_time String 修改时间 update_user String 更新人 表6 AlertLevel 参数 参数类型 描述 alert_channel Array of strings 告警渠道列表 alert_groups Array of AlertGroup objects 告警组列表 alert_template_id String 告警模板ID alert_times Integer 告警次数 表7 AlertGroup 参数 参数类型 描述 ding_talk_hook_url String 企业钉钉微信群聊机器人地址 group_name String 告警组名称 id String 告警组ID we_chat_work_hook_url String 企业微信群聊机器人地址 we_link_group_no String weLink群号 状态码: 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误编码 最小长度:1 最大长度:50 error_msg String 错误原因 最小长度:1 最大长度:256 状态码: 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误编码 最小长度:1 最大长度:50 error_msg String 错误原因 最小长度:1 最大长度:256 状态码: 404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误编码 最小长度:1 最大长度:50 error_msg String 错误原因 最小长度:1 最大长度:256
  • URI GET /v1/projects/{service_id}/alert-templates 表1 路径参数 参数 是否必选 参数类型 描述 service_id 是 String 服务id 最小长度:1 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 模板名称 最小长度:0 最大长度:64 page_num 否 Integer 当前页数 page_size 否 Integer 每页数量
  • 响应参数 状态码: 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 业务失败的提示内容
  • 请求参数 表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
  • URI GET /v1/projects/{service_id}/alert/user/name 表1 路径参数 参数 是否必选 参数类型 描述 service_id 是 String 服务id 最小长度:1 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 user_id 否 String 用户ID 最小长度:0 最大长度:200 user_name 是 String 用户名
  • 响应参数 状态码: 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误编码 最小长度:1 最大长度:50 error_msg String 错误原因 最小长度:1 最大长度:256 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误编码 最小长度:1 最大长度:50 error_msg String 错误原因 最小长度:1 最大长度:256 状态码: 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误编码 最小长度:1 最大长度:50 error_msg String 错误原因 最小长度:1 最大长度:256
  • 响应示例 状态码: 200 OK { "code" : "success", "data" : { "saveTemplate" : true, "deleteMindmapById" : true, "editMindmap" : true, "mindmapBackupBackUpMindmap" : true }, "message" : null }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息 状态码: 400 表4 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息 状态码: 401 表5 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息 状态码: 404 表6 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息 状态码: 500 表7 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 status String 对外时:success|error; result ResultValueStringForOk object 请求结果 表4 ResultValueStringForOk 参数 参数类型 描述 value String ok 状态码: 400 表5 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码: 401 表6 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码: 404 表7 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码: 500 表8 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 code String 错误码 error CommonResponseErrorOfAPITest object 统一错误返回 reason String 失败原因 result BasicAwRes object 结果 status String 状态 表4 CommonResponseErrorOfAPITest 参数 参数类型 描述 code String 错误码 reason String 错误原因 表5 BasicAwRes 参数 参数类型 描述 aw_code String 关键字代码, hascode字段为1是有效 aw_description String 模板描述 aw_mark Integer 关键字标记 aw_operationid String 关键字操作编号 aw_tags String 关键字tags aw_type Integer 关键字类型 aw_uniqueid String 关键字来源编号 by_order Integer 关键字顺序 create_time String 创建时间 create_time_stamp Long 创建时间戳 create_time_string String 创建时间戳 create_user String 创建人 create_user_id String 创建人ID delete_time String 更新时间 delete_user String 删除人 description String 描述 dft_check_point_list Array of objects 默认检查点列表 dft_custom_header Array of objects 默认请求头参数对象 dft_retry_interval String 重试间隔时间 (ms) 为空表示不等待 dft_retry_times String 重试次数 dft_variable_list Array of objects 默认变量信息 extra_info Object 补充信息 group_name String 分组名 has_code Integer 是否存在代码 id String 编号 import_package Array of strings 导入的包名 interface_label String 接口的x-extend字段说明 is_favorite Integer 是否收藏 method String 方法名 name String 关键字名 nameView String 在页面上显示的名字 origin_project String 源工程信息 param_type_and_dft_value Array of objects 参数类型和参数默认值 project_id String 工程编号 protocol_type String 协议类型 public_aw_lib Object 公共关键字信息 public_aw_lib_id String 公共关键字id region String region信息 return_type String 返回值类型 root_id String 根节点编号 source String 关键字依赖的类源 special_type Integer 特殊关键字类型 tmssCaseNumber String 关键字编号(来自测试管理服务) tmss_case_id String 测试用例id update_time String 更新时间 update_time_stamp Long 更新时间戳 update_time_string String 更新时间戳(字符串格式) update_user String 更新人 warningMsg String 警告信息 yamlName String yaml名称
  • URI GET /testreport/v4/{project_id}/versions/{version_id}/custom-reports 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID。 最小长度:32 最大长度:32 version_id 是 String 版本id 最小长度:11 最大长度:34 表2 Query参数 参数 是否必选 参数类型 描述 page_size 是 Long 每页显示的条目数量,最大支持200条 最小值:1 最大值:200 缺省值:200 offset 是 Long 页数,page_no大于等于1 最小值:0 最大值:20000 缺省值:0 type 是 Integer 报表类型 1:首页用例库, 2:质量报告 最小值:1 最大值:2
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 status String 对外时:success|error; 对内时:ok|failed result ResultValueListCustomReportListVo object 请求的返回的数据对象 表5 ResultValueListCustomReportListVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时, 值为0, 分页请求才有此值 value Array of CustomReportListVo objects 实际的数据类型:单个对象,集合 或 NULL reason String 业务失败的提示内容,对内接口才有此值 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表6 CustomReportListVo 参数 参数类型 描述 id String 报表id name String 报表名称 filter ReportFilter object 过滤条件 workpiece_type String 工件类型(用例:case,测试套:task) analysis_dimension String 分析维度 compare_dimension String 对比维度 chart_data Array of ReportChartDataVo objects 报表数据 表7 ReportFilter 参数 参数类型 描述 creatorIds String 创建人 ownerIds String 所属人 ranks String 级别 releaseIds String releaseId status String 状态 moduleIds String 级别 results String 结果 labelIds String 标签 startTime String 开始时间 endTime String 结束时间 isAssociateIssue String 是否关联需求 表8 ReportChartDataVo 参数 参数类型 描述 id String 报表id name String 报表名称 analyze_dim ReportDimVo object 对比维度数据 compare_dim Array of ReportDimVo objects 对比维度数据 表9 ReportDimVo 参数 参数类型 描述 id String id name String 名称 value Integer 值 状态码: 400 表10 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码: 401 表11 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码: 404 表12 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码: 500 表13 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 表3 请求Body参数 参数 是否必选 参数类型 描述 work_item_ids 否 Array of strings 需求/缺陷ID列表 project_uuid 否 String 项目id version_uri 否 String 版本uri relate_type 否 String 关联关系类型
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 status String 对外时:success|error; result ResultValueStringForOk object 请求结果 表5 ResultValueStringForOk 参数 参数类型 描述 value String ok 状态码: 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 业务失败的提示内容
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 value Boolean 实际的数据类型:单个对象,集合 或 NULL 状态码: 400 表3 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码: 401 表4 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码: 404 表5 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码: 500 表6 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容
  • 响应示例 状态码: 200 OK { "code" : "success", "data" : { "total" : 1, "list" : [ { "id" : "e0fd499609614f12b2fca889ada32162", "mindmap" : null, "name" : "思维导图", "privacy" : null, "app" : null, "create_time" : "2024/05/22 07:38:58 GMT+08:00", "creator_name" : "lwx1开发人员21", "creator_num" : "e8ad9e7478c94f4eaf90d5a379af9cb1", "updator_name" : "--", "updator_num" : null, "update_name" : "lwx1开发人员21", "update_num" : "e8ad9e7478c94f4eaf90d5a379af9cb1", "update_time" : "2024/05/22 07:39:39 GMT+08:00", "folder_id" : "feature_root_id", "project_id" : "fb07002bf4ae4317a855b590a86a52e0", "folder_root_id" : "feature_root_id", "branch_uri" : "v91j0000viceusv6", "iterator_uri" : "", "is_master" : 1, "max_depth" : null, "map_version" : null } ], "offset" : 1, "limit" : 10, "pages" : 1, "size" : 1 }, "message" : null }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 code String 接口调用状态码 data BasePageInfoMindmap object 脑图分页结果 message String 接口调用返回信息 表6 BasePageInfoMindmap 参数 参数类型 描述 total Long 总数 list Array of Mindmap objects 脑图列表 offset Integer 页码偏移量 limit Integer 每页记录数 pages Integer 总页数量 size Integer 列表个数 表7 Mindmap 参数 参数类型 描述 id String 脑图主键 mindmap String 脑图JSON name String 脑图名称 privacy String 是否私有 app String 所属app create_time String 创建时间 creator_name String 创建人名称 creator_num String 创建人编号 update_name String 更新人名称 update_num String 更新人编号 update_time String 更新时间 folder_id String 文件路径 project_id String 项目id folder_root_id String 根目录id branch_uri String 分支uri iterator_uri String 计划uri is_master Integer 是否为Master分支 max_depth Integer 脑图最大深度 map_version String 脑图版本 状态码: 400 表8 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息 状态码: 401 表9 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息 状态码: 404 表10 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息 状态码: 500 表11 响应Body参数 参数 参数类型 描述 code String 接口调用错误码 data String 接口调用返回体 message String 接口调用错误信息
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 表3 请求Body参数 参数 是否必选 参数类型 描述 params 是 MindmapPageParam object 脑图分页查询参数 表4 MindmapPageParam 参数 是否必选 参数类型 描述 offset 否 Integer 页码偏移量 limit 否 Integer 每页记录数 name 否 String 脑图名称 id_collection 否 Array of strings 主键集合id folder_id_collection 否 Array of strings 目录id project_id 是 String 项目id folder_root_id 否 String 根目录id branch_uri 否 String 分支uri iterator_uri 否 String 计划uri is_master 否 Integer 是否基线 creator_name_collection 否 Array of strings 创建者名称集合 updater_name_collection 否 Array of strings 更新人名称集合
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 value Array of IntegerIdAndNameVo objects 测试类型信息 表4 IntegerIdAndNameVo 参数 参数类型 描述 id Integer 数据库存储数字 name String 页面显示值 状态码: 400 表5 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码: 401 表6 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码: 404 表7 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码: 500 表8 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容
共100000条