云服务器内容精选

  • 响应示例 状态码:201 OK [ { "end_date" : "2021-12-11 00:00:00", "iteration" : { "id" : "ID", "name" : "名称" }, "module" : { "id" : "ID", "name" : "名称" }, "name" : "工作项1", "owner" : { "id" : "ID", "name" : "名称" }, "parent_issue" : "4192352", "plan_id" : "c7c2ddf2ea914164ac6ee76bf11a30ea", "project_id" : "9b26f58ec29943f681804a6628779a23", "region_id" : "cn-north-7", "severity" : { "id" : "ID", "name" : "名称" }, "start_date" : "2021-12-10 00:00:00", "status" : { "id" : "ID", "name" : "名称" }, "tracker" : { "id" : "ID", "name" : "名称" }, "workitem_id" : "4192353" } ]
  • 响应参数 状态码:201 表4 响应Body参数 参数 参数类型 描述 [数组元素] Array of TestPlanIssueDetail objects 参数解释: 项目下某个测试计划关联的需求列表 取值范围: 不涉及 表5 TestPlanIssueDetail 参数 参数类型 描述 end_date String 参数解释: 预计结束日期 取值范围: 不涉及 iteration NameAndId object 参数解释: 测试计划迭代编号与迭代名称 取值范围: 不涉及 module NameAndId object 参数解释: 测试计划迭代编号与迭代名称 取值范围: 不涉及 name String 参数解释: 工作项名称 取值范围: 不涉及 owner NameAndId object 参数解释: 测试计划迭代编号与迭代名称 取值范围: 不涉及 parent_issue String 参数解释: 父工作项 取值范围: 不涉及 plan_id String 参数解释: 测试计划id 取值范围: 不涉及 project_id String 参数解释: 项目id,项目唯一标识,固定长度32位字符 取值范围: 不涉及 region_id String 参数解释: region信息 取值范围: 不涉及 severity NameAndId object 参数解释: 测试计划迭代编号与迭代名称 取值范围: 不涉及 start_date String 参数解释: 预计开始日期 取值范围: 不涉及 status NameAndId object 参数解释: 测试计划迭代编号与迭代名称 取值范围: 不涉及 tracker NameAndId object 参数解释: 测试计划迭代编号与迭代名称 取值范围: 不涉及 workitem_id String 参数解释: 工作项id 取值范围: 不涉及 表6 NameAndId 参数 参数类型 描述 id String 参数解释: 对象编号 取值范围: 不涉及 name String 参数解释: 对象名称 取值范围: 不涉及 状态码:400 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 接口调用失败错误码 取值范围: 不涉及 error_msg String 参数解释: 接口调用失败错误信息 取值范围: 不涉及 状态码:401 表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}/plans/{plan_id}/issues 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id,对应"需求管理 CodeArts Req"项目唯一标识,测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则:长度等于32位,包含大小写字母、数字 默认取值: 不涉及 plan_id 是 String 参数解释: 测试计划id,对应测试计划管理页面创建的测试计划对象以及版本管理中创建的版本对象,测试用例列表页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testcase?branch_id={branch_id}&testplan_id={testplan_id}中变量branch_id/testplan_id的值 约束限制: 不涉及 取值范围: 长度11-34位字符(字母和数字) 默认取值: 不涉及 表2 Query参数 参数 是否必选 参数类型 描述 offset 是 Long 参数解释: 起始偏移量,表示从此偏移量开始查询, 约束限制: 不涉及 取值范围: offset大于等于0,小于等于2000000。 默认取值: 不涉及 limit 是 Long 参数解释: 每页显示的条目数量,最大支持100条,表示从此偏移量开始查询, 约束限制: 不涉及 取值范围: 0-100 默认取值: 不涉及
  • 响应示例 状态码:200 OK { "result" : { "total" : 1, "value" : [ { "testcase_uri" : "sdsadasz1221", "testcase_number" : "sdsadasz1221" } ], "page_size" : 10, "page_no" : 1 } }
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueListTestcasePlanVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入,建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表5 ResultValueListTestcasePlanVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时, 值为0, 分页请求才有此值 value Array of TestcasePlanVo objects 实际的数据类型:单个对象,集合 或 NULL reason String 业务失败的提示内容 page_size Integer 分页大小 page_no Integer 分页编码 has_more Boolean 是否有更多 表6 TestcasePlanVo 参数 参数类型 描述 testcase_uri String 测试用例URI testcase_number String 测试用例用例编号 plans Array of TestPlanVo objects 测试计划信息 表7 TestPlanVo 参数 参数类型 描述 uri String 测试计划URI name String 测试计划名称 表8 ApiError 参数 参数类型 描述 code String 参数解释: 业务失败的错误码 取值范围: 不涉及 reason String 参数解释: 业务失败的提示内容 取值范围: 不涉及 状态码:400 Bad Resuest 状态码:401 Unauthorized 状态码:404 Not Found 状态码:500 Internal Server Error
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 case_uri_list 否 Array of strings 测试用例URI列表(测试用例URI和编号填其中一个即可) case_number_list 否 Array of strings 测试用例编号列表(测试用例URI和编号填其中一个即可
  • 请求示例 查询分支或迭代计划下缺陷列表 post https://{endpoint}/v4/26927372bbae40b184fe764e7a0d21f7/versions/v91k0000vgtfg1jk/defects/batch-query { "page_no" : 1, "page_size" : 15, "case_type" : "0", "fixed_version_id" : "991653560740388864,-2" }
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 status String success|error result ResultValueQueryIssueVo object 请求的返回的数据对象 error ApiError object 失败时的error信息 request_id String 由接口调用方传入,建议使用UUID保证请求的唯一性。 server_address String 本次请求的受理的服务地址 表4 ResultValueQueryIssueVo 参数 参数类型 描述 total Integer 起始记录数 大于 实际总条数时, 值为0, 分页请求才有此值 value QueryIssueVo object 实际的数据类型:单个对象,集合 或 NULL reason String 业务失败的提示内容 page_size Integer 每页展示条数 page_no Integer 页码 has_more Boolean 是否有更多 表5 QueryIssueVo 参数 参数类型 描述 total_count Integer 总数 issue_list Array of QueryIssueAssociatedResultBo objects 缺陷列表 表6 QueryIssueAssociatedResultBo 参数 参数类型 描述 workitem_id String 缺陷id name String 缺陷名称 tracker_name String 工作项名称 tracker_id String 工作项id status_name String 状态名 status_id String 状态id project_id String 项目id owner String 处理人 creator String 创建者id severity_name String 重要程度名称 severity_id String 重要程度id start_date String 预计开始日期 start_date_timestamp Long 预计开始日期时间戳 due_date String 预计结束日期 due_date_timestamp Long 预计结束日期时间戳 board_id String 板id board_name String 板名称 sequence_id String xBoard项目工作项序列号 表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 参数解释: 接口调用失败错误信息 取值范围: 不涉及
  • 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 own 否 Boolean 是否是我的 case_type 否 String 用例类型 keyword 否 String 关键字 owner_id 否 String 所属人 creator_id 否 String 创建人 status_id 否 String 状态id列表 serverity_id 否 String 服务性id page_size 否 Integer 每页数量 page_no 否 Integer 页码 sort_field 否 String 排序字段 sort_type 否 String 排序类型 module_id 否 String 模块id fixed_version_id 否 String 版本id