查询全局变量分组列表
功能介绍
查询全局变量分组列表
调用方法
请参见如何调用API。
URI
GET /v1/variables/getVarGroupList
| 
        参数  | 
      
        是否必选  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|---|
| 
        page_no  | 
      
        是  | 
      
        String  | 
      
        当前页数  | 
     
| 
        page_size  | 
      
        是  | 
      
        String  | 
      
        每页多少记录  | 
     
| 
        project_id  | 
      
        是  | 
      
        String  | 
      
        工程唯一标识  | 
     
请求参数
| 
        参数  | 
      
        是否必选  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|---|
| 
        X-Auth-Token  | 
      
        是  | 
      
        String  | 
      
        参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。  | 
     
响应参数
状态码:200
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        code  | 
      
        String  | 
      
        错误码  | 
     
| 
        error  | 
      
        统一错误返回  | 
     |
| 
        reason  | 
      
        String  | 
      
        失败原因  | 
     
| 
        result  | 
      
        PageResultVariableGroup object  | 
      
        结果  | 
     
| 
        status  | 
      
        String  | 
      
        状态  | 
     
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        code  | 
      
        String  | 
      
        错误码  | 
     
| 
        detail  | 
      
        PageResultVariableGroup object  | 
      
        错误信息详情  | 
     
| 
        reason  | 
      
        String  | 
      
        错误原因  | 
     
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        page_list  | 
      
        Array of VariableGroup objects  | 
      
        当前页数据  | 
     
| 
        page_no  | 
      
        Integer  | 
      
        当前页数  | 
     
| 
        page_size  | 
      
        Integer  | 
      
        每页条数  | 
     
| 
        total_page  | 
      
        Integer  | 
      
        总页数  | 
     
| 
        total_size  | 
      
        Long  | 
      
        总条数  | 
     
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        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  | 
      
        融合变量  | 
     
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        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个内置函数)  | 
     
状态码: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个字符组成的字符串  | 
     
请求示例
get https://{endpoint}/v1/variables/getVarGroupList?page_no=1&page_size=10&project_id=e0c6f8fb503f413b84bb0f83417b33ff
 响应示例
状态码:200
OK
{
  "status" : "success",
  "result" : {
    "page_no" : 1,
    "page_size" : 10,
    "total_page" : 1,
    "total_size" : 3,
    "page_list" : [ {
      "id" : "60f26fac760344d6b8e9f057c239ef12",
      "name" : "Default Environment",
      "projectId" : "e0c6f8fb503f413b84bb0f83417b33ff",
      "description" : null,
      "isDefault" : "1",
      "variableList" : 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"
    }, {
      "id" : "122e8df96ffc4be99ddcc25436359394",
      "name" : "envName_LslZqrpy",
      "projectId" : "e0c6f8fb503f413b84bb0f83417b33ff",
      "description" : "",
      "isDefault" : "0",
      "variableList" : null,
      "region" : null,
      "create_user" : "CloudTest-0704",
      "create_time" : "2025-06-12T07:50:36+0800",
      "update_user" : "CloudTest-0704",
      "update_time" : "2025-06-12T07:50:36+0800"
    }, {
      "id" : "9172d0bf2ae44a699c36855a35e05e3f",
      "name" : "envName_SZ7N0ba0",
      "projectId" : "e0c6f8fb503f413b84bb0f83417b33ff",
      "description" : "",
      "isDefault" : "0",
      "variableList" : null,
      "region" : null,
      "create_user" : "CloudTest-0704",
      "create_time" : "2025-06-12T07:50:36+0800",
      "update_user" : "",
      "update_time" : "2025-06-12T07:50:36+0800"
    } ]
  },
  "reason" : null,
  "error" : null
}
 状态码
| 
        状态码  | 
      
        描述  | 
     
|---|---|
| 
        200  | 
      
        OK  | 
     
| 
        401  | 
      
        Unauthorized  | 
     
| 
        403  | 
      
        Forbidden  | 
     
| 
        404  | 
      
        Not Found  | 
     
错误码
请参见错误码。