查询全局变量 - ListVariables

功能介绍

查询全局变量

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
codeartsperftest:cpts:getPerfTestProject
Read
cpts *
g:ResourceTag/<tag-key>
-
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
codeartsperftest:cpts:getPerfTestProject	Read	cpts *	g:ResourceTag/<tag-key>	-	-

URI

GET /v1/{project_id}/variables/{variable_type}/test-suites/{test_suite_id}

表1 路径参数
参数	是否必选	参数类型	描述
variable_type	是	Integer	变量类型（1：整数；2：枚举；3：文件；5：文本）
project_id	是	String	表示项目ID，参见获取方法说明。
test_suite_id	是	Integer	测试工程ID，通过“创建工程”接口获取响应体中的project_id字段的值。

请求参数

无

响应参数

状态码：200

表2 响应Body参数
参数	参数类型	描述
code	String	响应码
message	String	响应消息
variable_list	Array of VariableDetail objects	变量列表

表3 VariableDetail
参数	参数类型	描述
file_size	Integer	文件大小
id	Integer	变量ID，通过“创建变量”接口获取响应体中的json.variable_id字段的值。
is_quoted	Boolean	是否被引用
name	String	变量名称
variable	Array of objects	变量值
variable_type	Integer	变量类型（1：整数；2：枚举；3：文件；5：文本）
variable_mode	Integer	变量读取模式（0：顺序模式；1：随机模式）
share_mode	Integer	变量共享模式（0：用例模式；1：并发模式）

状态码：501

表4 响应Body参数
参数	参数类型	描述
-	String	response message

请求示例

查询PerfTest工程的变量列表。

/v1/{project_id}/variables/{variable_type}/test-suites/1

{
  "code" : "SVCSTG.CPTS.0000000",
  "message" : "success",
  "variable_list" : [ {
    "file_size" : 0,
    "id" : 156769,
    "is_quoted" : false,
    "is_sensitive" : false,
    "name" : "var1",
    "share_mode" : 0,
    "variable" : [ "test" ],
    "variable_mode" : 0,
    "variable_type" : 2
  } ]
}

响应示例

状态码：200

success

{
  "code" : "SVCSTG.CPTS.0000000",
  "message" : "success",
  "variable_list" : [ {
    "file_size" : 0,
    "id" : 37615,
    "is_quoted" : false,
    "name" : "var1",
    "share_mode" : 0,
    "variable" : [ 1, 20 ],
    "variable_mode" : 0,
    "variable_type" : 1
  }, {
    "file_size" : 0,
    "id" : 36306,
    "is_quoted" : true,
    "name" : "var2",
    "share_mode" : 0,
    "variable" : [ "domain-example.com" ],
    "variable_mode" : 0,
    "variable_type" : 2
  } ]
}