华为云用户手册

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 uris 否 Array of strings 测试任务URI集合 keyword 否 String 关键字查询，任务名或编号 tags 否 Array of strings 标签集合 own 否 Boolean 是否是我的 service_type 否 Integer 服务类型 release_dev_list 否 Array of strings 发布版本号集合 result_codes 否 Array of strings 结果Code集合 status_codes 否 Array of strings 状态Code集合 owner_ids 否 Array of strings 责任人ID集合 executor_ids 否 Array of strings 执行者ID集合 creator_ids 否 Array of strings 创建者ID集合 sort_field 否 String 排序字段 sort_type 否 String 排序方式 page_no 否 Integer 当前页数 page_size 否 Integer 每页条数 is_polling_query 否 Boolean 是否轮询查询 is_query_associated_case_list 否 Boolean 是否获取关联用例列表 plan_start_start_timestamp 否 Long 计划开始时间过滤起始时间戳 plan_start_end_timestamp 否 Long 计划开始时间过滤结束时间戳 plan_end_start_timestamp 否 Long 计划结束时间过滤起始时间戳 plan_end_end_timestamp 否 Long 计划结束时间过滤结束时间戳 expiration_status_list 否 Array of integers 测试套超期状态过滤，超期状态值分别为：无状态(null)、未超期(0)、即将超期(1)、已超期(2)、延期完成(3)、按期完成(4)

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueListProjectFieldConfigVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入，建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址。 表4 ResultValueListProjectFieldConfigVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value Array of ProjectFieldConfigVo objects 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表5 ProjectFieldConfigVo 参数 参数类型 描述 uri String 字段配置URI标识 updator NameAndIdVo object 服务类型信息 description String 描述 customName String 项目用例自定义字段名称 table_field_name String 字段名（对应后端参数名） value_type String 字段类型(单行文本text、多行文本textArea、单选框radio、多选框checkbox、日期date、数字number、用户user)。 value_type_name String 字段类型国际化名称 is_system Integer 是否系统字段 is_display Integer 是否显示 is_required Integer 是否必填 sort_numb Integer 顺序数值 default_value String 默认值 custom_field_uri String 扩展字段uri(用于连表查扩展字段) resource_type String 资源类型 creator NameAndIdVo object 服务类型信息 create_time_stamp Long 创建时间时间戳 update_time_stamp Long 更新时间时间戳 project_uuid String 项目ID option_vos Array of ProjectFieldConfigOptionVo objects 可选项 custom_field_id Integer 项目用例自定义字段id（1-25数字） custom_field_name String 项目用例自定义字段名称 custom_field_param String 项目用例自定义字段入参或者返回参数名称 表6 ProjectFieldConfigOptionVo 参数 参数类型 描述 uri String 字段选项URI标识.新增不传，修改、删除使用必传 name String 可选项名称 code String 可选项code值 updator NameAndIdVo object 服务类型信息 description String 描述 flag Integer 修改标识，0：不可修改 1：可修改，用于结果和状态的选项值 sort_numb Integer 顺序数值 creator NameAndIdVo object 服务类型信息 create_time_stamp Long 创建时间时间戳 update_time_stamp Long 更新时间时间戳 表7 NameAndIdVo 参数 参数类型 描述 id String ID name String 名称 表8 ApiError 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 400 表9 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 401 表10 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 404 表11 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 500 表12 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容

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

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 stage 否 Integer 测试用例在任务中的阶段 owners 否 Array of strings 处理人过滤数组 page_no 否 Integer 页码 page_size 否 Integer 页数量 results 否 Array of strings 结果过滤 status 否 Array of strings 状态过滤 version_uri 否 String 分支/迭代uri release_dev 否 String 任务版本过滤条件，影响关联任务的结果查询，查询当前任务版本下的用例最新结果 sort_field 否 String 排序字段 sort_type 否 String 排序方法 feature_uri 否 String 特性目录URI task_result_uri 否 String 测试套结果uri rank_ids 否 Array of integers 用例等级ID集合 key_word 否 String 关键字 issue_id 否 String 需求id associated_issue 否 Boolean 是否关联需求（null：不限，false：未关联，true：已关联） select_all_pages 否 Boolean 是否全选所有页（null：不全选，false：不全选，true：全选），用于任务批量执行结果功能，只返回用例uri，不返回其他信息 is_available 否 Boolean 用例是否可用 is_script_exist 否 Boolean 用例脚本字段是否有值

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value Array of TaskAssignCaseDetailVo objects 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表5 TaskAssignCaseDetailVo 参数 参数类型 描述 uri String 关联关系uri sort Integer 排序顺序 owner String 责任人id stage Integer 测试阶段 project_uuid String 项目id task_uri String 任务uri update_time String 更新时间 updator_name String 更新人 updator String 更新人id case_uri String 用例uri is_available Integer 是否可用 test_case_name String 用例名称 feature_uri String 用例目录Uri test_case_number String 用例编号 svn_script_path String 脚本路径 status_code String 状态 status_name String 状态名称 result_code String 结果id result_name String 结果名称 owner_name String 责任人名称 execute_latest_time String 最新执行时间 execute_duration String 执行时长 is_keyword Integer 是否是关键用例 net_work_script_name String 脚本名称 rank_id Integer 用例等级 状态码： 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参数 参数 是否必选 参数类型 描述 aw_type 否 String AW类型1-普通aw,2-组合aw,3-导入aw cata_type 否 Integer 目录层级 current_project_id 否 String 工程ID is_positive_order 否 Boolean 是否按名称正序排序 page_no 否 Integer 当前页数 page_size 否 Integer 每页多少记录 parent_id 否 String aw目录父编号 search_type 否 String 过滤类型 search_value 否 String 过滤条件

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 error CommonResponseErrorOfobject object 统一错误返回 reason String 错误原因 result Object 结果 status String 状态值，如success、error 表5 CommonResponseErrorOfobject 参数 参数类型 描述 code String 错误码 reason String 错误原因

响应示例 状态码： 200 SUC CES S { "status" : "success", "result" : { "page_no" : 1, "page_size" : 0, "total_page" : 0, "total_size" : 0, "page_list" : [ ] }, "reason" : null, "error" : null}

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

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String token 表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 表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 String 告警时间 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 测试套类型 状态码： 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 错误原因

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 value Array of AttachmentVo objects 实际的数据类型：单个对象，集合 或 NULL 表5 AttachmentVo 参数 参数类型 描述 uri String 附件Uri creator String 创建人 updator String 更新人 region String 逻辑region doc_id String 文档id parent_uri String 父节点Uri parent_type String 父节点类型 file_name String 文件名 store_file_name String 保存文件名 file_path String 文件路径 file_size Integer 文件大小 file_type String 文件类型 system_type String 系统区分：docman或testman create_time String 创建时间 create_time_timestamp Long 创建时间时间戳 update_time String 更新时间 update_time_timestamp Long 更新时间时间戳 project_uuid String 项目id related_type String 附件类型 0 本地上传 other 关联文档 状态码： 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 GET /GT3KServer/v4/{project_id}/resources/{resource_uri}/attachments 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值: 不涉及 resource_uri 是 String 资源Uri 表2 Query参数 参数 是否必选 参数类型 描述 resource_type 是 String 资源类型

URI GET /testreport/v4/{project_id}/versions/{version_id}/custom-reports 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值: 不涉及 version_id 是 String 版本id 表2 Query参数 参数 是否必选 参数类型 描述 page_size 是 Long 每页显示的条目数量,最大支持200条 offset 是 Long 页数，page_no大于等于1 type 是 Integer 报表类型 1：首页用例库， 2：质量报告

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 status String success|error 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 业务失败的提示内容

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value Array of TestCaseVo objects 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表4 TestCaseVo 参数 参数类型 描述 uri String 资源URI type String 资源类型 author String 创建人 name String 名称 rank Integer 级别 preparation String 前置条件 remark String 备注 stage String 测试阶段 activity String 测试类型 keywords String 关键词 market String apitest标记是否代码已提交 designer String 设计者 tags String 标签 execute_parameter String 执行参数 region String 逻辑region owner String 处理人id，IteratorTestCase字段 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 编号 case_type Integer 用例类型 platform_type Integer 执行平台类型 service_type Integer 服务类型 service_type_name String 服务类型名称 test_type Integer 测试类型 test_type_name String 测试类型名称 design_note String 设计描述 test_step String 测试步骤 expect_output String 期望结果 env_type String 测试环境类型 exe_platform String 执行平台 testcase_project String 测试工程 svn_script_path String 脚本路径 map_restrict String 约束条件 network_script_name String 网络脚本名 auto_type Integer 自动化类型，非自动化:0, 是自动化:1 to_be_auto_exec Integer 被自动化执行 last_result String 最后一次结果 last_result_uri String 最后一次结果Uri feature_uri String 目录Uri feature_name String 目录名称 interface_name String 测试接口名 snp_no String 网络问题ID dr_relation_id String 关联需求编号 issue_name String 需求名称 test_base_num String 测试基数 automatically_executed Integer 是否被自动化执行 first_execute_time String 第一次执行时间 detect_type String 检测类型 execute_param String 执行参数 test_feature String 分析领域 is_contract_testcase Integer 是否是契约用例，0:表示非契约用例, 1：表示契约用例 time_cost Double 总共耗时 be_auto_type_time String 记录用例由非自动化变为自动化类型的时间 compare_number String 配对用例编号 scene_flag String 场景标识 base_flag String 场景标识 para_validator String 区别是否从yaml中生成的用例，默认false knet_node_id String knet节点id last_exe_author String 最后一次执行用户 cloud_carrier String 运营商 market_place String 应用市场 test_mind_id String 脑图id test_mind_url String 脑图url commit_url String git提交url test_pattern_number String 测试模式编号 test_factor_number String 测试因子编号 status_code String 状态Code result_code String 结果Code release_id String 迭代ID label_id String 标签ID labels String 用例标签名称列表 module_id String 模块ID module_name String 模块名称 module_path String 模块path module_path_name String 模块路径名称 execute_latest_time String 最后执行时间 execute_duration String 执行时长 execute_times Integer 执行次数 is_keyword Integer 是否关键用例 release_dev String 测试版本号 new_created String 是否用户新增用例 project_uuid String 项目ID creation_version_name String 创建版本名称，原逻辑marshall添加字段 feature_path String 特性路径，原逻辑marshall添加字段 testcase_uri String 实体用例Uri，IteratorTestCase字段 owner_name String 处理人名称 iterator_case_uri String 迭代用例Uri，IteratorTestCase字段 script_link String 脚本链接scriptLink custom_field_1 String 自定义字段1 custom_field_2 String 自定义字段2 custom_field_3 String 自定义字段3 custom_field_4 String 自定义字段4 custom_field_5 String 自定义字段5 custom_field_6 String 自定义字段6 custom_field_7 String 自定义字段7 custom_field_8 String 自定义字段8 custom_field_9 String 自定义字段9 custom_field_10 String 自定义字段10 custom_field_11 String 自定义字段11 custom_field_12 String 自定义字段12 custom_field_13 String 自定义字段13 custom_field_14 String 自定义字段14 custom_field_15 String 自定义字段15 custom_field_16 String 自定义字段16 custom_field_17 String 自定义字段17 custom_field_18 String 自定义字段18 custom_field_19 String 自定义字段19 custom_field_20 String 自定义字段20 custom_field_21 String 自定义字段21 custom_field_22 String 自定义字段22 custom_field_23 String 自定义字段23 custom_field_24 String 自定义字段24 custom_field_25 String 自定义字段25 状态码： 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 业务失败的提示内容

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 value Array of TestCaseCommentVo objects 实际的数据类型：单个对象，集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表5 TestCaseCommentVo 参数 参数类型 描述 uri String URI creator String 创建者 comment String 评论内容 notifier Array of strings 评论通知人 test_case_uri String 测试用例URI create_time String 创建时间 create_time_timestamp Long 创建时间时间戳 update_time String 更新时间 update_time_timestamp Long 更新时间时间戳 project_uuid String 项目UUID version_uri String 版本/测试计划URI display_name 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 业务失败的提示内容

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 project_id String 项目ID values Array of ExternalBranchInfoVo objects 实际的数据类型：单个对象，集合 或 NULL 表5 ExternalBranchInfoVo 参数 参数类型 描述 id String 分支ID type String 类型 author String 创建人 name String 名称 region String 区域 last_modifier String 最后修改人 last_modified String 最后修改时间 last_modified_timestamp Long 修改时间时间戳 creation_date String 创建时间 creation_date_timestamp Long 创建时间时间戳 author_name String 创建人名称 is_base_branch Integer 是否为基线分支。0表示不是基线分支，1表示是基线分支。 状态码： 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 OK { "total" : 1, "project_id" : "1f22e3511dd348e38131b4066afbd0b4", "values" : [ { "id" : "001s16gt6q5", "type" : "TestVersion", "author" : "efdb403066474ab08836b9eeaaa23bca", "name" : "名称", "region" : "cn-north-7", "last_modifier" : "张三", "last_modified" : "2023-07-20 02:17:01", "last_modified_timestamp" : 1660617231016, "creation_date" : "2023-07-20 02:17:01", "creation_date_timestamp" : 1660617231016, "author_name" : "tester", "is_base_branch" : 0 } ]}

URI GET /v1/{project_id}/branches 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值: 不涉及 表2 Query参数 参数 是否必选 参数类型 描述 sort_field 否 String 排序字段 sort_type 否 String 排序方式 offset 是 Integer 起始偏移量，表示从此偏移量开始查询， offset大于等于0，小于等于20000 limit 是 Integer 每页显示的条目数量，最大支持200条

响应示例 状态码： 200 OK { "environments" : [ { "environment_id" : "ff4893796ee1a8aa009ff3a470de55d8", "environment_name" : "默认环境", "environment_description" : "默认环境", "is_default" : true } ], "offset" : 0, "limit" : 1, "total_count" : 50}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 environments Array of Environment objects 环境分组列表 offset Long 偏移量，表示从此偏移量开始查询，offset大于等于0 limit Long 每页显示的条目数量,最大支持200条 total_count Long 环境分组总条数 表5 Environment 参数 参数类型 描述 environment_id String 环境分组id environment_name String 环境分组名 environment_description String 环境分组描述 is_default Boolean 是否是默认环境 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 接口调用失败错误码 error_msg String 接口调用失败错误信息

URI GET /v1/projects/{project_id}/environments 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 是 Long 参数解释 起始偏移量，表示从此偏移量开始查询， offset大于等于0 约束限制 不涉及 取值范围 0-999 默认取值 不涉及 limit 是 Long 参数解释 每页显示的条目数量,最大支持200条 约束限制 不涉及 取值范围 1-200 默认取值 不涉及

名人识别示例 本章节对名人识别AK/SK方式使用SDK进行示例说明。 名人识别示例代码只需将AK/SK信息替换为实际AK/SK，代码中可以使用初始化CelebrityRecognitionReq中的Image或Url配置图像信息（image和url参数二选一），示例中以url为例，配置完成后运行即可。 endpoint是华为云各服务应用区域和各服务的终端节点，详情请查看地区和终端节点。 名人识别调用示例代码如下： 1 2 3 4 5 6 7 8 91011121314151617181920212223242526272829303132333435363738394041 package mainimport ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" image "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/image/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/image/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/image/v2/region")func main() { // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全； // 本示例以ak和sk保存在环境变量中来实现身份验证为例，运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。 ak := os.Getenv("HUAWEICLOUD_SDK_AK") sk := os.Getenv("HUAWEICLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := image.NewImageClient( image.ImageClientBuilder(). WithRegion(region.ValueOf("cn-north-1")). //此处替换为您开通服务的区域，详情请查看地区和终端节点. WithCredential(auth). Build()) request := &model.RunCelebrityRecognitionRequest{} thresholdCelebrityRecognitionReq:= float32(0.48) urlCelebrityRecognitionReq:= "https://XXX.jpg" //此处替换为公网可以访问的图片地址 request.Body = &model.CelebrityRecognitionReq{ Threshold: &thresholdCelebrityRecognitionReq, Url: &urlCelebrityRecognitionReq, } response, err := client.RunCelebrityRecognition(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) }} 识别结果输出到控制台表示执行成功。相关参数说明请参考名人识别API。 12 RunCelebrityRecognitionResponse {"result":[{"confidence":0.9990679,"face_detail":{"h":510,"w":357,"x":260,"y":201},"label":"迈克尔·杰克逊"}]}Process exiting with code: 0 父主题： 使用SDK（GO）

图像识别概述 图像识别（Image Recognition），是指利用计算机对图像进行分析和理解，以识别各种不同模式的目标和对象的技术，包括媒资图像标签，名人识别，主体识别，翻拍识别，图像标签等。 图像识别以开放API（Application Programming Interface，应用程序编程接口）的方式提供给用户，用户通过实时访问和调用API获取推理结果，帮助用户自动采集关键数据，打造智能化业务系统，提升业务效率。

主体识别示例 本章节对主体识别AK/SK方式使用SDK进行示例说明。 主体识别示例代码只需将AK/SK信息替换为实际AK/SK，代码中可以使用初始化ImageMainObjectDetectionReq中的Image或Url配置图像信息（image和url参数二选一），示例中以url为例，配置完成后运行即可。 endpoint是华为云各服务应用区域和各服务的终端节点，详情请查看地区和终端节点。 主体识别调用示例代码如下： 1 2 3 4 5 6 7 8 91011121314151617181920212223242526272829303132333435363738394041 package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" image "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/image/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/image/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/image/v2/region") func main() { // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全； // 本示例以ak和sk保存在环境变量中来实现身份验证为例，运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。 ak := os.Getenv("HUAWEICLOUD_SDK_AK") sk := os.Getenv("HUAWEICLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := image.NewImageClient( image.ImageClientBuilder(). WithRegion(region.ValueOf("cn-north-4")). //此处替换为您开通服务的区域，详情请查看地区和终端节点. WithCredential(auth). Build()) request := &model.RunImageMainObjectDetectionRequest{} thresholdImageMainObjectDetectionReq:= float32(30) urlImageMainObjectDetectionReq:= "https://XXX.jpg" //此处替换为公网可以访问的图片地址 request.Body = &model.ImageMainObjectDetectionReq{ Threshold: &thresholdImageMainObjectDetectionReq, Url: &urlImageMainObjectDetectionReq, } response, err := client.RunImageMainObjectDetection(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) }} 识别结果输出到控制台表示执行成功。相关参数说明请参考主体识别API。 1 RunImageMainObjectDetectionResponse {"result":[{"label":"bounding_box","location":{"height":327.77,"top_left_x":3.7,"top_left_y":1.72,"width":463.03},"confidence":"95.73"},{"label":"main_object_box","location":{"height":328.35,"top_left_x":3.22,"top_left_y":1.5,"width":456.63},"confidence":"88.35"}]} 父主题： 使用SDK（GO）