文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 接口测试管理/ 根据指定的全局变量id返回查询对应的全局变量的属性值 - ShowSensitivePropertybyId
更新时间:2026-07-07 GMT+08:00
分享

根据指定的全局变量id返回查询对应的全局变量的属性值 - ShowSensitivePropertybyId

功能介绍

根据全局变量唯一标识查询该全局变量的属性值

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/variables/getSensitivePropertybyId

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

group_id

String

参数解释

分组唯一标识

约束限制

不涉及

取值范围

32个字符组成的字符串

默认取值

不涉及

获取方法

进入页面 环境参数,从接口GET /v4/{project_id}/variables 请求地址中获取group_id对应的值

var_id

String

参数解释

变量唯一标识

约束限制

不涉及

取值范围

32个字符组成的字符串

默认取值

不涉及

获取方法

从接口GET /v1/{project_id}/variables/getSensitivePropertybyId请求query中获取var_id对应的值

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

code

String

参数解释

接口调用失败错误码

取值范围

不超过256个字符组成的字符串

error

CommonResponseErrorOfString object

参数解释

统一错误返回

取值范围

不涉及

reason

String

参数解释

接口调用失败原因

取值范围

不超过1000个字符组成的字符串

result

String

参数解释

结果

取值范围

不涉及

status

String

参数解释

'状态值,如success、error'

取值范围

  • success,请求成功

  • error,请求报错

表5 CommonResponseErrorOfString

参数

参数类型

描述

code

String

参数解释

接口调用失败错误码

取值范围

不超过256个字符组成的字符串

detail

String

参数解释

错误信息详情

取值范围

不涉及

reason

String

参数解释

接口调用失败原因

取值范围

不超过1000个字符组成的字符串

状态码:201

Created

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

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

error_msg

String

参数解释

接口调用失败错误信息

取值范围

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

状态码:403

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

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

error_msg

String

参数解释

接口调用失败错误信息

取值范围

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

状态码:404

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

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

error_msg

String

参数解释

接口调用失败错误信息

取值范围

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

请求示例

get https://{endpoint}/v1/2113165c055146d7950d1cc552746dc1/variables/getSensitivePropertybyId?group_id=36983a11cd5e4354b31c301229c394c4&var_id=375dc994251643e4a7b430b6bfad2b7e

响应示例

状态码:200

SUCCESS

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

状态码

状态码

描述

200

SUCCESS

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码

相关文档