文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 接口测试管理/ 保存全局变量 - SaveBatchOperate

更新时间：2026-07-07 GMT+08:00

查看PDF

保存全局变量 - SaveBatchOperate

功能介绍

批量保存全局变量与分组，分添加、修改、删除6组数据传递返回成功/失败。

调用方法

请参见如何调用API。

URI

POST /v3/{project_id}/variables/batch-deal

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释: 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID 约束限制: 不涉及取值范围: 项目uuid应符合如下规则：长度等于32位字符，包含大小写字母、数字默认取值: 不涉及

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。约束限制：必传。取值范围：字符串长度不少于1，不超过10万。默认取值：不涉及。

表3 请求Body参数
参数	是否必选	参数类型	描述
addVar	否	Array of Variable objects	新增变量
addgroup	否	Array of VariableGroup objects	新增分组
createVariableReq	否	Array of CreateVariableReq objects	创建变量请求参数
deleteVar	否	Array of Variable objects	删除变量
deletegroup	否	Array of VariableGroup objects	删除分组
syncVariableList	否	Array of SyncVariable objects	同步变量相关信息
updateVar	否	Array of Variable objects	更新变量
updategroup	否	Array of VariableGroup objects	更新分组

表4 CreateVariableReq
参数	是否必选	参数类型	描述
by_order	否	Integer	参数解释顺序取值范围 0-9999
category	否	String	节点顺序
description	否	String	描述
locked	否	Integer	参数解释是否上锁上锁以后的全局变量进行工程复制时不会被覆盖 0,未上锁 1,上锁
name	否	String	参数解释名称取值范围不超过300个字符组成的字符串
node_id	否	String	参数解释节点唯一标识取值范围 32个字符组成的字符串
node_type	否	Integer	参数解释节点类型取值范围 0,变量节点 null,变量节点 1,目录节点
parent_node_id	否	String	参数解释父节点唯一标识取值范围 32个字符组成的字符串
property	否	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

表5 SyncVariable
参数	是否必选	参数类型	描述
syncAddGroupIds	否	Array of strings	同步添加的组唯一标识
syncUpdateGroupIds	否	Array of strings	同步更新的组唯一标识
syncVar	否	Variable object	融合变量PO类

表6 Variable
参数	是否必选	参数类型	描述
by_order	否	Integer	参数解释顺序取值范围 0-9999
category	否	String	参数解释节点顺序取值范围自然数
create_time	否	String	参数解释创建时间(格式：yyyy-MM-dd HH:mm:ss) 取值范围不涉及
create_user	否	String	参数解释创建者取值范围不超过255个字符组成的字符串
currentPermission	否	String	参数解释当前用户权限取值范围不涉及
description	否	String	描述
dynamicParamFlag	否	Boolean	参数解释动态参数标志,默认为false:true代表动态参数；false代表非动态参数 true,代表动态参数 false,代表非动态参数
functionParams	否	String	参数解释变量参数（[]:空参、[a]:一参，[a,b]:两参）取值范围不涉及
groupId	否	String	参数解释环境参数分组唯一标识取值范围 32个字符组成的字符串
id	否	String	参数解释唯一标识取值范围 32个字符组成的字符串
isSensitiveInfo	否	Boolean	参数解释是否是敏感字段取值范围 true, false
isSensitiveModified	否	Boolean	参数解释敏感字段是否被修改，不敏感字段不关注此值取值范围 true, false
locked	否	Integer	参数解释是否上锁上锁以后的全局变量进行工程复制时不会被覆盖 0,未上锁 1,上锁
name	否	String	参数解释名称取值范围不超过300个字符组成的字符串
node_id	否	String	参数解释节点唯一标识取值范围 32个字符组成的字符串
node_type	否	Integer	参数解释节点类型取值范围 0,变量节点 null,变量节点 1,目录节点
parent_id	否	String	参数解释关键字目录父编号取值范围 32个字符组成的字符串
parent_node_id	否	String	参数解释父节点唯一标识取值范围 32个字符组成的字符串
property	否	String	参数解释属性取值范围不涉及
region	否	String	参数解释区域名称取值范围不超过32个字符组成的字符串
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	参数解释更新时间(格式：yyyy-MM-dd HH:mm:ss) 取值范围不涉及
update_user	否	String	参数解释更新者取值范围不超过32个字符组成的字符串
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编码参数

表7 VariableGroup
参数	是否必选	参数类型	描述
create_time	否	String	参数解释创建时间(格式：yyyy-MM-dd HH:mm:ss) 取值范围不涉及
create_user	否	String	参数解释创建者取值范围不超过255个字符组成的字符串
description	否	String	描述
id	否	String	参数解释唯一标识取值范围 32个字符组成的字符串
isDefault	否	String	参数解释是否是默认取值范围 1,默认 0,非默认
name	否	String	参数解释名称取值范围不超过300个字符组成的字符串
projectId	否	String	参数解释项目唯一标识取值范围 32个字符组成的字符串
region	否	String	参数解释区域名称取值范围不超过32个字符组成的字符串
update_time	否	String	参数解释更新时间(格式：yyyy-MM-dd HH:mm:ss) 取值范围不涉及
update_user	否	String	参数解释更新者取值范围不超过32个字符组成的字符串
variableList	否	Array of Variable objects	参数解释融合变量取值范围不涉及

响应参数

状态码：200

表8 响应Body参数
参数	参数类型	描述
code	String	参数解释接口调用失败错误码取值范围不超过256个字符组成的字符串
error	CommonResponseErrorOfString object	参数解释统一错误返回取值范围不涉及
reason	String	参数解释接口调用失败原因取值范围不超过1000个字符组成的字符串
result	String	参数解释结果取值范围不涉及
status	String	参数解释 '状态值，如success、error' 取值范围 success，请求成功 error，请求报错

表9 CommonResponseErrorOfString
参数	参数类型	描述
code	String	参数解释接口调用失败错误码取值范围不超过256个字符组成的字符串
detail	String	参数解释错误信息详情取值范围不涉及
reason	String	参数解释接口调用失败原因取值范围不超过1000个字符组成的字符串

状态码：201

Created

状态码：401

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释接口调用失败错误码取值范围 12-18个字符组成的字符串
error_msg	String	参数解释接口调用失败错误信息取值范围 3-1000个字符组成的字符串

状态码：403

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释接口调用失败错误码取值范围 12-18个字符组成的字符串
error_msg	String	参数解释接口调用失败错误信息取值范围 3-1000个字符组成的字符串

状态码：404

**表12** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释接口调用失败错误码取值范围 12-18个字符组成的字符串
error_msg	String	参数解释接口调用失败错误信息取值范围 3-1000个字符组成的字符串

请求示例

{
  "addVar" : [ {
    "groupId" : "6865082c81344e6da36d062b48c945ab",
    "description" : "",
    "type" : "String",
    "isSensitiveInfo" : true,
    "variableType" : 0,
    "property" : "127.0.0.1",
    "currentPermission" : "0",
    "id" : "",
    "sensitiveInfoSetterUser" : "",
    "isSensitiveModified" : false,
    "name" : "hostIp",
    "category" : "Static"
  } ],
  "deleteVar" : [ ],
  "deletegroup" : [ ],
  "syncVariableList" : [ ],
  "updategroup" : [ ],
  "addgroup" : [ {
    "isDefault" : "0",
    "name" : "envName_UarAY7Uf",
    "description" : "",
    "variableList" : [ ],
    "id" : "6865082c81344e6da36d062b48c945ab",
    "projectId" : "6830a3bf596a436995abdcdbd0d8634c"
  } ],
  "updateVar" : [ ]
}

响应示例

状态码：200

SUCCESS

{
  "status" : "success",
  "result" : "ok",
  "reason" : null,
  "error" : null,
  "code" : null
}

状态码

状态码	描述
200	SUCCESS
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

错误码

请参见错误码。

父主题： 接口测试管理

上一篇：变量导出 - DownloadVariables

下一篇：查询全局变量参数列表 - ListVarByGroup