文档首页/API网关 APIG/API参考（联盟区域）/专享版API（V2）/专享版-环境变量管理/查询变量列表
更新时间：2025-12-18 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询变量列表

功能介绍

查询分组下的所有环境变量的列表。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/env-variables

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见获取项目ID。

instance_id

是

String

实例ID，在API网关控制台的“实例信息”中获取。

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Long

偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0

缺省值：0

limit

否

Integer

每页显示的条目数量，条目数量小于等于0时，自动转换为20，条目数量大于500时，自动转换为500

最小值：1

最大值：500

缺省值：20

group_id

是

String

API分组编号

env_id

否

String

环境编号

variable_name

否

String

变量名

precise_search

否

String

指定需要精确匹配查找的参数名称，目前仅支持variable_name

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

size

Integer

本次返回的列表长度

total

Long

满足条件的记录数

variables

Array of EnvVariableInfo objects

本次返回的环境变量列表

表5 EnvVariableInfo

参数

参数类型

描述

variable_value

String

变量值支持英文字母、数字、英文格式的下划线、中划线，斜线（/）、点、冒号，1 ~ 255个字符。

env_id

String

环境编号

最小长度：1

最大长度：65

group_id

String

API分组编号

最小长度：1

最大长度：65

variable_name

String

变量名，支持英文字母、数字、英文格式的下划线、中划线，必须以英文字母开头，3~32个字符。在API定义中等于#Name的值#部分（区分大小写），发布到环境里的API被变量值替换。

说明：
中文字符必须为UTF-8或者unicode编码。

id

String

环境变量编号

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

无

响应示例

状态码：200

OK

{
  "variables" : [ {
    "variable_value" : "8080",
    "env_id" : "cca3616af3684b329064b2a631cb3eeb",
    "group_id" : "73c58022f20d495aa18885d718647f09",
    "id" : "09ab8135722440b9bf5d107f2a09d409",
    "variable_name" : "port"
  }, {
    "variable_value" : "192.168.1.5",
    "env_id" : "7a1ad0c350844ee69479b47df9a881cb",
    "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
    "id" : "25054838a624400bbf2267cf5b3a3f70",
    "variable_name" : "address"
  } ],
  "total" : 2,
  "size" : 2
}

状态码：400

Bad Request

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation"
}

状态码：401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码：403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

状态码：500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

错误码

请参见错误码。