更新时间:2025-06-26 GMT+08:00
分享

查询项目字段配置

功能介绍

查询项目字段配置

调用方法

请参见如何调用API

URI

GET /GT3KServer/v4/projects/{project_id}/field-configs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

项目uuid应符合如下规则:长度等于32位,包含大小写字母、数字

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

必传。

取值范围:

字符串长度不少于1,不超过10万。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

status

String

参数解释

本次请求的处理状态

取值范围

success|error

result

ResultValueListProjectFieldConfigVo object

请求返回的数据

error

ApiError object

错误信息

request_id

String

参数解释

请求的唯一id,由接口调用方传入,建议使用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

参数解释

项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目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

参数解释:

业务失败的提示内容

取值范围:

不涉及

请求示例

get https://{endpoint}/GT3KServer/v4/projects/efdb403066474ab08836b9eeaaa23bca/field-configs

响应示例

状态码:200

OK

{
  "result" : {
    "value" : [ {
      "uri" : "v901106fd4f7tosm",
      "updator" : {
        "id" : "85f7cd3cd8784307a5bb194321bef3c1",
        "name" : "wtt_apitest"
      },
      "table_field_name" : "name",
      "value_type" : "text",
      "value_type_name" : "单行文本",
      "is_system" : 1,
      "is_display" : 1,
      "is_required" : 1,
      "sort_numb" : 1,
      "resource_type" : "TestCase",
      "creator" : {
        "id" : "85f7cd3cd8784307a5bb194321bef3c1",
        "name" : "wtt_apitest"
      },
      "update_time_stamp" : 1737507973000,
      "project_uuid" : "761e569574894180b3ecadc9d9df52b6"
    } ]
  }
}

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
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 ListProjectFieldConfigsSolution {

    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();
        ListProjectFieldConfigsRequest request = new ListProjectFieldConfigsRequest();
        request.withProjectId("{project_id}");
        try {
            ListProjectFieldConfigsResponse response = client.listProjectFieldConfigs(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
# 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 = ListProjectFieldConfigsRequest()
        request.project_id = "{project_id}"
        response = client.list_project_field_configs(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
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.ListProjectFieldConfigsRequest{}
	request.ProjectId = "{project_id}"
	response, err := client.ListProjectFieldConfigs(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档