API网关 APIGAPI网关 APIG

更新时间:2021/09/29 GMT+08:00
分享

查询变量列表

功能介绍

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

调试

您可以在API Explorer中调试该接口。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目编号

instance_id

String

实例编号

表2 Query参数

参数

是否必选

参数类型

描述

group_id

String

API分组编号

env_id

String

环境编号

variable_name

String

变量名

offset

Long

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

缺省值:0

limit

Integer

每页显示的条目数量

最小值:1

最大值:500

缺省值:20

precise_search

String

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

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

size

Integer

本次返回的列表长度

total

Long

满足条件的记录数

variables

Array of EnvVariableResp objects

本次返回的环境变量列表

表5 EnvVariableResp

参数

参数类型

描述

variable_value

String

变量值

env_id

String

环境编号

group_id

String

API分组编号

id

String

环境变量编号

variable_name

String

变量名

状态码: 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 500

表8 响应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

错误码

请参见错误码

分享:

    相关文档

    相关产品