文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 接口测试管理/ 根据id获取工程信息 - ShowProjectInfo
更新时间：2025-12-27 GMT+08:00
在线调试
CLI示例
查看PDF
分享

根据id获取工程信息 - ShowProjectInfo

功能介绍

获取工程信息，成功返回工程信息，失败返回原因。

调用方法

请参见如何调用API。

URI

GET /v1/project/{project_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

group_id

否

String

分组唯一标识

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

必传。

取值范围：

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

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

code

String

错误码

error

CommonResponseErrorProject object

统一错误返回

reason

String

失败原因

result

Project object

结果

status

String

状态

  • success,请求成功

  • error,请求报错
表5 CommonResponseErrorProject

参数

参数类型

描述

code

String

错误码

detail

Project object

错误信息详情

reason

String

错误原因
表6 Project

参数

参数类型

描述

create_time

String

创建时间

create_time_stamp

Long

创建时间戳

create_time_string

String

创建时间字符串

create_user

String

创建人

deleteFlag

Integer

标记数据是否被删除 0-未删除,1-删除

dns_mapping

String

dns映射

domainId

String

创建项目的租户唯一标识

en_network_area

String

服务区域

globalDynamicParamNames

Array of strings

用例或测试套件执行时选定环境分组中的动态参数名称列表

groupId

String

环境参数分组唯一标识

httpTimeOut

String

超时时间，供接口自动化获取

id

String

唯一标识

name

String

名称

nfsPath

String

NFS相对路径

parent_id

String

关键字目录父编号

porjectid

Integer

工程唯一标识

project_path_on_git

String

工程git路径

region

String

区域名称

repoUUID

String

仓库唯一标识

repo_branch

String

仓库分支

repo_password

String

仓库密码

repo_private_key

String

仓库密钥

repo_type

Integer

仓库类型

  • 0,git

  • 1,svn

repo_url

String

仓库地址

repo_username

String

仓库用户名

repo_yaml_path

String

yaml文件在仓库中的地址

review_on

Boolean

是否开启配置化表示，true表示开启，false未开启

scene

Integer

场景：1（云化）2（cida）

share_baseline

Boolean

是否是基线库

stage_id

String

测试阶段唯一标识

stage_name

String

测试阶段名

tmss_addr

String

测试管理地址

tmss_password

String

测试管理密码

tmss_username

String

测试管理用户名

tmss_version_name

String

测试管理版本名

tmss_version_uri

String

测试管理版本uri

update_time

String

更新时间

update_time_stamp

Long

更新时间戳

update_time_string

String

更新时间字符串

update_user

String

更新人

variableGroupId

String

全局环境分组唯一标识

variableGroupName

String

全局变量环境名称

variables

Array of Variable objects

分组变量信息
表7 Variable

参数

参数类型

描述

by_order

Integer

顺序

category

String

节点顺序

create_time

String

创建时间

create_user

String

创建人

currentPermission

String

当前人员权限

description

String

描述

dynamicParamFlag

Boolean

动态参数标志,默认为false:true代表动态参数；false代表非动态参数

functionParams

String

变量参数（[]:空参、[a]:一参，[a,b]:两参）

groupId

String

环境参数分组唯一标识

id

String

唯一标识

isSensitiveInfo

Boolean

是否是敏感字段

isSensitiveModified

Boolean

敏感字段是否被修改，不敏感字段不关注此值

locked

Integer

是否上锁 上锁以后的全局变量进行工程复制时不会被覆盖 0-未上锁 1-上锁

name

String

名称

node_id

String

节点唯一标识

node_type

Integer

0/null-变量节点;1-目录节点

parent_id

String

关键字目录父编号

parent_node_id

String

父节点唯一标识

property

String

属性

region

String

区域名称

sensitiveInfoSetterTime

String

敏感参数设置时间

sensitiveInfoSetterUser

String

敏感参数设置者名称

sourceId

String

复制的全局变量的源唯一标识

type

String

变量类型

  • String

  • boolean

  • int

  • Integer

  • integer

  • float

  • short

  • double

  • long

  • BigDecimal

  • Object

  • ObjectNode

  • ArrayNode

  • file,file不是java的File类型，实际是String类型，传的文件路径

  • List[/topic/body/section/table/tgroup/tbody/row/entry/ul/li/p/br {""}) (br]

  • Json

  • JsonNode

update_time

String

更新时间

update_user

String

更新人

variableType

Integer

变量类型（0：text，10-16：7个内置函数）

  • 10,任意长度随机字符串

  • 11,指定范围随机int

  • 12,生成当前整数时间戳（从1970-01-01 00:00 UTC开始的秒数)

  • 13,按照指定的format格式化时间戳，如 $timestamp_format(timestamp, YYYY-MM-DD)

  • 14,生成UUID

  • 15,使用Base64方法编码参数

  • 16,使用指定参数生成MD5哈希值

  • 18,sha512编码参数

状态码：401

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

12-18个字符组成的字符串

error_msg

String

参数解释

接口调用失败错误信息

取值范围

3-1000个字符组成的字符串

状态码：403

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

12-18个字符组成的字符串

error_msg

String

参数解释

接口调用失败错误信息

取值范围

3-1000个字符组成的字符串

状态码：404

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

12-18个字符组成的字符串

error_msg

String

参数解释

接口调用失败错误信息

取值范围

3-1000个字符组成的字符串

请求示例

get https://{endpoint}/v1/project/341f88318b99464fbfb70ec62e25fc41?group_id=

响应示例

状态码：200

OK

{
  "status" : "success",
  "result" : {
    "id" : "c57a1769fd8249318a23477d5fd2bea6",
    "name" : "API接口测试项目_zC08aC",
    "porjectid" : null,
    "deleteFlag" : 0,
    "nfsPath" : "{region}/7b90e408636344328e44bf70bbae8351/341f88318b99464fbfb70ec62e25fc41",
    "httpTimeOut" : "10000",
    "variableGroupId" : "b1344459a7a14ee8970ca72402783c1c",
    "variableGroupName" : "Default Environment",
    "region" : "{region}",
    "globalDynamicParamNames" : [ ],
    "domainId" : "7b90e408636344328e44bf70bbae8351",
    "repoUUID" : null,
    "groupId" : null,
    "variables" : [ {
      "id" : "f7cc2926e0574f3eae3f3310c6ecca59",
      "type" : "String",
      "name" : "hostURL",
      "property" : "127.0.0.1:8080",
      "description" : null,
      "locked" : null,
      "groupId" : "b1344459a7a14ee8970ca72402783c1c",
      "category" : "Static",
      "isSensitiveInfo" : false,
      "isSensitiveModified" : false,
      "sourceId" : null,
      "variableType" : 0,
      "functionParams" : "127.0.0.1:8080",
      "dynamicParamFlag" : null,
      "sensitiveInfoSetterUser" : null,
      "sensitiveInfoSetterTime" : null,
      "currentPermission" : null,
      "region" : null,
      "create_user" : "fdc93bccd8d040778701d4d35a4a4313",
      "create_time" : "2025-06-12T07:39:19+0800",
      "update_user" : "fdc93bccd8d040778701d4d35a4a4313",
      "update_time" : "2025-06-12T07:39:19+0800",
      "parent_id" : "341f88318b99464fbfb70ec62e25fc41",
      "node_type" : null,
      "node_id" : null,
      "parent_node_id" : null,
      "by_order" : null
    } ],
    "create_time_string" : "2025-06-12 19:39:19 GMT+08:00",
    "update_time_string" : "2025-06-12 19:39:19 GMT+08:00",
    "create_time_stamp" : 1749728359000,
    "update_time_stamp" : 1749728359000,
    "create_user" : "fdc93bccd8d040778701d4d35a4a4313",
    "create_time" : "2025-06-12T07:39:19+0800",
    "update_user" : "fdc93bccd8d040778701d4d35a4a4313",
    "update_time" : "2025-06-12T07:39:19+0800",
    "stage_id" : "1",
    "stage_name" : "alpha",
    "tmss_addr" : null,
    "tmss_username" : null,
    "tmss_password" : null,
    "tmss_version_uri" : "v92s00010hrk1852",
    "tmss_version_name" : "基线",
    "repo_type" : null,
    "repo_url" : null,
    "repo_username" : null,
    "repo_password" : null,
    "repo_yaml_path" : null,
    "parent_id" : "341f88318b99464fbfb70ec62e25fc41",
    "scene" : 0,
    "repo_private_key" : null,
    "repo_branch" : null,
    "en_network_area" : null,
    "review_on" : false,
    "share_baseline" : false,
    "dns_mapping" : null,
    "project_path_on_git" : "ApiTest/API接口测试项目_zC08aC_alpha"
  },
  "reason" : null,
  "error" : null,
  "code" : null
}

状态码

状态码

描述

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。

父主题： 接口测试管理

相关文档