新增用例评论
功能介绍
新增用例评论
调用方法
请参见如何调用API。
URI
POST /GT3KServer/v4/{project_id}/testcases/{testcase_id}/comments
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则:长度等于32位,包含大小写字母、数字 默认取值: 不涉及 |
testcase_id |
是 |
String |
参数解释 用例uri 约束限制 不涉及 取值范围 11-34位字母/数字 默认取值 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
comment |
是 |
String |
参数解释: 评论 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
notifier |
否 |
Array of strings |
参数解释: 通知人列表 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
version_uri |
否 |
String |
参数解释: 分支uri/测试计划uri 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
参数解释 状态码 取值范围 success|error |
result |
ResultValueTestCaseCommentVo object |
参数解释 请求返回的数据 取值范围 不涉及 |
error |
ApiError object |
参数解释 错误信息 取值范围 不涉及 |
request_id |
String |
参数解释 由接口调用方传入,建议使用UUID保证请求的唯一性。 取值范围 不涉及 |
server_address |
String |
参数解释 本次请求的受理的服务地址 取值范围 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
total |
Integer |
参数解释 数据总数 取值范围 起始记录数 大于 实际总条数时, 值为0, 分页请求才有此值 |
value |
TestCaseCommentVo object |
参数解释 请求返回的数据 取值范围 不涉及 |
reason |
String |
参数解释 业务失败的提示内容 取值范围 不涉及 |
page_size |
Integer |
参数解释 分页大小 取值范围 不涉及 |
page_no |
Integer |
参数解释 分页编码 取值范围 不涉及 |
has_more |
Boolean |
参数解释 是否有更多 取值范围 true:是 false:否 |
参数 |
参数类型 |
描述 |
---|---|---|
uri |
String |
参数解释 用例评论id 取值范围 不涉及 |
creator |
String |
参数解释 创建者id 取值范围 不涉及 |
comment |
String |
参数解释 评论内容 取值范围 不涉及 |
notifier |
Array of strings |
参数解释 评论通知人 取值范围 不涉及 |
test_case_uri |
String |
参数解释 用例di 取值范围 不涉及 |
create_time |
String |
参数解释 创建时间 取值范围 不涉及 |
create_time_timestamp |
Long |
参数解释 创建时间时间戳 取值范围 不涉及 |
update_time |
String |
参数解释 更新时间 取值范围 不涉及 |
update_time_timestamp |
Long |
参数解释 更新时间时间戳 取值范围 不涉及 |
project_uuid |
String |
参数解释 项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID 取值范围 不涉及 |
version_uri |
String |
参数解释 迭代,分支uri 取值范围 不涉及 |
display_name |
String |
参数解释 是否显示通知人 取值范围 不涉及 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 业务失败的错误码 取值范围: 不涉及 |
reason |
String |
参数解释: 业务失败的提示内容 取值范围: 不涉及 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 业务失败的错误码 取值范围: 不涉及 |
reason |
String |
参数解释: 业务失败的提示内容 取值范围: 不涉及 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 业务失败的错误码 取值范围: 不涉及 |
reason |
String |
参数解释: 业务失败的提示内容 取值范围: 不涉及 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 业务失败的错误码 取值范围: 不涉及 |
reason |
String |
参数解释: 业务失败的提示内容 取值范围: 不涉及 |
请求示例
post https://{endpoint}/GT3KServer/v4/dc3f9aa646ad4707831080d3fcce474d/testcases/v92u00010e58tdun/comments { "version_uri" : "v92s00010db209le", "comment" : "<p>这是一个评论</p>", "notifier" : [ ] }
响应示例
状态码:200
参数解释
新增用例评论返回体
约束限制
不涉及
取值范围
不涉及
默认取值
不涉及
{ "status" : "success", "result" : { "value" : { "uri" : "v92s00010e7dgk3p", "creator" : "f3b807a0d249424fa36a0d804110c4ed", "comment" : "<p>这是一个评论</p>", "notifier" : [ ], "test_case_uri" : "v92u00010e58tdun", "create_time" : "2025-04-28 16:44:30", "update_time" : "2025-04-28 16:44:30", "project_uuid" : "dc3f9aa646ad4707831080d3fcce474d", "version_uri" : "v92s00010db209le" } } }
SDK代码示例
SDK代码示例如下。
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 |
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.*; import java.util.List; import java.util.ArrayList; public class AddTestCaseCommentSolution { 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("<YOUR REGION>")) .build(); AddTestCaseCommentRequest request = new AddTestCaseCommentRequest(); request.withTestcaseId("{testcase_id}"); request.withProjectId("{project_id}"); TestCaseCommentInfo body = new TestCaseCommentInfo(); body.withVersionUri("v92s00010db209le"); body.withComment("<p>这是一个评论</p>"); request.withBody(body); try { AddTestCaseCommentResponse response = client.addTestCaseComment(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
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
# 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("<YOUR REGION>")) \ .build() try: request = AddTestCaseCommentRequest() request.testcase_id = "{testcase_id}" request.project_id = "{project_id}" request.body = TestCaseCommentInfo( version_uri="v92s00010db209le", comment="<p>这是一个评论</p>" ) response = client.add_test_case_comment(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
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 |
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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := cloudtest.NewCloudtestClient( cloudtest.CloudtestClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.AddTestCaseCommentRequest{} request.TestcaseId = "{testcase_id}" request.ProjectId = "{project_id}" versionUriTestCaseCommentInfo:= "v92s00010db209le" request.Body = &model.TestCaseCommentInfo{ VersionUri: &versionUriTestCaseCommentInfo, Comment: "<p>这是一个评论</p>", } response, err := client.AddTestCaseComment(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
参数解释 新增用例评论返回体 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 |
400 |
Bad Request |
401 |
Unauthorized |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。