# 查询某测试计划下的操作历史 - ShowPlanJournals #### 功能介绍 此接口用于查询指定测试计划下的操作历史,同页面 测试 -\> 测试计划 -\> 点击测试计划 -\> 点击上方操作历史页签 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-testman/cloudtest_03_2000.html)。 #### URI GET /v1/projects/{project_id}/plans/{plan_id}/journals 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**: 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-testman/cloudtest_03_4003.html) **约束限制**: 项目唯一标识，固定长度32位 **取值范围**: 字母、数字 **默认取值**: 不涉及 | | plan_id | 是 | String | **参数解释**: 测试计划id，测试计划的唯一标识，长度11-34位字符 **约束限制**: 测试计划唯一标识，长度11-34位 **取值范围**: 字母、数字 **默认取值**: 不涉及 **获取方法**： 从GET /v1/projects/{project_id}/plans的返回字段获取 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 是 | Long | **参数解释**: 起始偏移量，表示从此偏移量开始查询， offset大于等于0 **参数限制**: 大于等于0 **取值范围**: 0-2000000 **默认取值**: 不涉及 **获取方法**： 从GET /v1/projects/{project_id}/plans的返回字段获取 **默认取值：** 0 | | limit | 是 | Long | **参数解释**: 每页显示的条目数量,最大支持200条 **参数限制**: 大于等于0 **取值范围**: 1-200 **默认取值**: 不涉及 **默认取值：** 200 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | \[数组元素\] | Array of [TestPlanJournalList] objects | **参数解释**: 项目下查询测试计划操作历史返回结构 **取值范围**: 不涉及 | 表5TestPlanJournalList | 参数 | 参数类型 | 描述 | |:---|:---|:---| | detail | Array of [TestPlanJournalDetail] objects | **参数解释** 历史记录详情 **取值范围** 不涉及 | | operate_time | String | **参数解释** 变更时间 **取值范围** 不涉及 | | operator | [NameAndId] object | **参数解释** 操作信息 **取值范围** 不涉及 | | plan_id | String | **参数解释**: 测试计划id **取值范围**: 11-34位字符 | | project_id | String | **参数解释**: 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-testman/cloudtest_03_4003.html) **取值范围**: 32位固定长度字符 | 表6TestPlanJournalDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | added | Array of [NameAndId] objects | **参数解释** 测试计划资源的添加记录（工作项或者测试用例） **取值范围** 不涉及 | | deleted | Array of [NameAndId] objects | **参数解释** 测试计划资源的添加记录（工作项或者测试用例） **取值范围** 不涉及 | | journalized_type | String | **参数解释**: 表明该条变更记录的具体变更类型，例如测试用例（testCase），需求（issue） **取值范围**: 不涉及 | | type | String | **参数解释**: 表明该条变更记录属于基础信息变更还是资源（需求添加移除、用例添加移除）变更 **取值范围**: 不涉及 | | updated | Array of [AttributeChange] objects | **参数解释**: 测试计划基础信息变更，包括计划名称，测试类型，计划处理者、版本号、关联迭代、开始日期、截至日期、描述 **取值范围**: 不涉及 | 表7NameAndId | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**: 对象编号 **取值范围**: 11-34位的字母及数字（字符串） | | name | String | **参数解释**: 对象名称 **取值范围**: 不涉及 | 表8AttributeChange | 参数 | 参数类型 | 描述 | |:---|:---|:---| | attribute_type | String | **参数解释**: 发生变更的测试计划属性 **取值范围**: 不涉及 | | new_value | String | **参数解释**: 变更后的取值 **取值范围**: 不涉及 | | old_value | String | **参数解释**: 变更前的取值 **取值范围**: 不涉及 | **状态码：400** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**: 接口调用失败错误码 **取值范围**: 不涉及 | | error_msg | String | **参数解释**: 接口调用失败错误信息 **取值范围**: 不涉及 | **状态码：401** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**: 接口调用失败错误码 **取值范围**: 不涉及 | | error_msg | String | **参数解释**: 接口调用失败错误信息 **取值范围**: 不涉及 | **状态码：404** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**: 接口调用失败错误码 **取值范围**: 不涉及 | | error_msg | String | **参数解释**: 接口调用失败错误信息 **取值范围**: 不涉及 | **状态码：500** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**: 接口调用失败错误码 **取值范围**: 不涉及 | | error_msg | String | **参数解释**: 接口调用失败错误信息 **取值范围**: 不涉及 | #### 请求示例 ``` get https://{endpoint}/v1/projects/efdb403066474ab08836b9eeaaa23bca/plans/9b26f58ec29943f681804a6628779a23/journals?offset=1&limit=10 ``` #### 响应示例 **状态码：200** **参数解释** 查询某测试计划下的操作历史返回体 **取值范围** 不涉及 ``` [ { "detail" : [ { "added" : [ { "id" : "ID", "name" : "名称" } ], "deleted" : [ { "id" : "ID", "name" : "名称" } ], "journalized_type" : "plan", "type" : "resource/attribute", "updated" : [ { "attribute_type" : "name", "new_value" : "tester", "old_value" : "test" } ] } ], "operate_time" : "2021-07-10", "operator" : { "id" : "ID", "name" : "名称" }, "plan_id" : "c7c2ddf2ea914164ac6ee76bf11a30ea", "project_id" : "9b26f58ec29943f681804a6628779a23" } ] ``` #### SDK代码示例 SDK代码示例如下。 #### Java ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.cloudtest.v1.region.CloudtestRegion; import com.huaweicloud.sdk.cloudtest.v1.*; import com.huaweicloud.sdk.cloudtest.v1.model.*; public class ShowPlanJournalsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CloudtestClient client = CloudtestClient.newBuilder() .withCredential(auth) .withRegion(CloudtestRegion.valueOf("")) .build(); ShowPlanJournalsRequest request = new ShowPlanJournalsRequest(); request.withProjectId("{project_id}"); request.withPlanId("{plan_id}"); try { ShowPlanJournalsResponse response = client.showPlanJournals(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` #### Python ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcloudtest.v1.region.cloudtest_region import CloudtestRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcloudtest.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = CloudtestClient.new_builder() \ .with_credentials(credentials) \ .with_region(CloudtestRegion.value_of("")) \ .build() try: request = ShowPlanJournalsRequest() request.project_id = "{project_id}" request.plan_id = "{plan_id}" response = client.show_plan_journals(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` #### Go ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" cloudtest "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := cloudtest.CloudtestClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := cloudtest.NewCloudtestClient(hcClient) request := &model.ShowPlanJournalsRequest{} request.ProjectId = "{project_id}" request.PlanId = "{plan_id}" response, err := client.ShowPlanJournals(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` #### 更多 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CloudTest/sdk?api=ShowPlanJournals)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | **参数解释** 查询某测试计划下的操作历史返回体 **取值范围** 不涉及 | | 400 | Bad Request | | 401 | Unauthorized | | 404 | Not Found | | 500 | Internal Server Error | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-testman/ErrorCode.html)。