# 获取项目测试用例自定义字段列表 - ListProjectTestCaseFields #### 功能介绍 此接口用于获取自定义字段列表,同页面 设置 -\> 测试设置 -\> 右侧用例字段设置 -\> 见右侧列表 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-testman/cloudtest_03_2000.html)。 #### URI GET /GT3KServer/v4/{project_id}/testcase/field/batch-query 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**: 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-testman/cloudtest_03_4003.html) **约束限制**: 字符串类型，长度32位字符 **取值范围**: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 **默认取值**: 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 必传。 **取值范围：** 字符串长度不少于1，不超过10万。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | value | Array of [ProjectTestCaseFieldVo] objects | **参数解释** 本次查询的记录结果 **取值范围** 不涉及 | 表4ProjectTestCaseFieldVo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | uri | String | **参数解释** 项目用例自定义字段主键 **取值范围** 不涉及 | | name | String | **参数解释** 项目用例自定义字段名称 **取值范围** 不涉及 | | type | String | **参数解释**: 项目用例自定义字段类型 **取值范围**: - richText，富文本。 - text，单行文本。 - textArea，多行文本。 - radio，单选框。 - checkBox，多选框。 - date，日期时间。 - onlyDate，日期。 - date，日期时间。 - number，数字（整数）。 - double，数字（小数）。 - checkBoxUser，多选用户。 - user，单选用户。 | | options | String | **参数解释** 项目用例自定义字段选项 **取值范围** 数字类型时，数组两个值，第一个是最小值，第二个是最大值 | | description | String | **参数解释** 项目用例自定义字段描述 **取值范围** 不涉及 | | creator | String | **参数解释** 项目用例自定义字段创建人 **取值范围** 不涉及 | | updater | String | **参数解释** 项目用例自定义字段更新人 **取值范围** 不涉及 | | custom_field_id | Integer | **参数解释** 项目用例自定义字段id **取值范围** 1-25数字 | | custom_field_name | String | **参数解释** 项目用例自定义字段名称 **取值范围** 不涉及 | | custom_field_param | String | **参数解释** 项目用例自定义字段入参或者返回参数名称 **取值范围** 不涉及 | | type_name | String | **参数解释** 项目用例自定义字段类型国际化名称 **取值范围** 不涉及 | | create_time | String | **参数解释** 项目用例自定义字段创建时间 **取值范围** 不涉及 | | create_time_timestamp | Long | **参数解释** 项目用例自定义字段创建时间时间戳 **取值范围** 不涉及 | | update_time | String | **参数解释** 项目用例自定义字段更新时间 **取值范围** 不涉及 | | update_time_timestamp | Long | **参数解释** 项目用例自定义字段更新时间时间戳 **取值范围** 不涉及 | | project_uuid | String | **参数解释** 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-testman/cloudtest_03_4003.html) **取值范围** 长度等于32位，包含大小写字母、数字 | **状态码：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 | **参数解释**: 业务失败的提示内容 **取值范围**: 不涉及 | #### 请求示例 ``` GET https://{endpoint}/GT3KServer/v4/90f8dc52eb7b4c47b853c661152ca62d/testcase/field/batch-query ``` #### 响应示例 **状态码：200** OK ``` { "value" : [ { "uri" : "v90b000109n4ldea", "name" : "用例别名", "type" : "text", "description" : "", "creator" : "dfc5347b9b16491e942ce55ce7f79dbc", "custom_field_id" : 3, "custom_field_name" : "customField3", "custom_field_param" : "custom_field_3", "type_name" : "单行文本", "create_time" : "2025-03-03 15:59:12", "create_time_timestamp" : 1740988752000, "project_uuid" : "90f8dc52eb7b4c47b853c661152ca62d" } ] } ``` #### 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 ListProjectTestCaseFieldsSolution { 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(); ListProjectTestCaseFieldsRequest request = new ListProjectTestCaseFieldsRequest(); request.withProjectId("{project_id}"); try { ListProjectTestCaseFieldsResponse response = client.listProjectTestCaseFields(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 = ListProjectTestCaseFieldsRequest() request.project_id = "{project_id}" response = client.list_project_test_case_fields(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.ListProjectTestCaseFieldsRequest{} request.ProjectId = "{project_id}" response, err := client.ListProjectTestCaseFields(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=ListProjectTestCaseFields)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | | 401 | Unauthorized | | 404 | Not Found | | 500 | Internal Server Error | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-testman/ErrorCode.html)。