保存全局变量
功能介绍
批量保存全局变量与分组，分添加、修改、删除6组数据传递返回成功/失败。
调用方法
请参见如何调用API。
URI
POST /v3/{project_id}/variables/batch-deal
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目唯一标识。 约束限制 不涉及 取值范围 32个字符组成的字符串 默认取值 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制： 必传。 取值范围： 字符串长度不少于1，不超过10万。 默认取值： 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
更新分组 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
by_order |
否 |
Integer |
顺序 |
|
category |
否 |
String |
节点顺序 |
|
description |
否 |
String |
描述 |
|
locked |
否 |
Integer |
是否上锁 上锁以后的全局变量进行工程复制时不会被覆盖 0-未上锁 1-上锁 |
|
name |
否 |
String |
名称 |
|
node_id |
否 |
String |
节点唯一标识 |
|
node_type |
否 |
Integer |
0/null-变量节点;1-目录节点 |
|
parent_node_id |
否 |
String |
父节点id |
|
property |
否 |
String |
属性名称 |
|
type |
否 |
String |
变量类型 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
syncAddGroupIds |
否 |
Array of strings |
同步添加的组唯一标识 |
|
syncUpdateGroupIds |
否 |
Array of strings |
同步更新的组唯一标识 |
|
syncVar |
否 |
Variable object |
融合变量PO类 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
变量类型 |
|
update_time |
否 |
String |
更新时间 |
|
update_user |
否 |
String |
更新人 |
|
variableType |
否 |
Integer |
变量类型（0：text，10-16：7个内置函数） |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
create_time |
否 |
String |
创建时间 |
|
create_user |
否 |
String |
创建人 |
|
description |
否 |
String |
描述 |
|
id |
否 |
String |
唯一标识 |
|
isDefault |
否 |
String |
是否是默认 |
|
name |
否 |
String |
名称 |
|
projectId |
否 |
String |
项目唯一标识 |
|
region |
否 |
String |
区域名称 |
|
update_time |
否 |
String |
更新时间 |
|
update_user |
否 |
String |
更新人 |
|
variableList |
否 |
Array of Variable objects |
融合变量 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
错误码 |
|
error |
CommonResponseErrorOfString object |
统一错误返回 |
|
reason |
String |
失败原因 |
|
result |
String |
结果 |
|
status |
String |
状态 |
状态码：201
Created
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 12-18个字符组成的字符串 |
|
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 3-1000个字符组成的字符串 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 12-18个字符组成的字符串 |
|
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 3-1000个字符组成的字符串 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
错误码
请参见错误码。
