Querying an Environment Variable List

Function

This API is used to query the list of all environment variables under an API group.

URI

The following table lists the HTTP/HTTPS request method and URI of the API.

**Table 1** HTTP/HTTPS request method and URI
Request Method	URI
GET	/v1.0/apigw/env-variables[?page_size, page_no, env_id, group_id, variable_name]

A combination of different query conditions can be added at the end of the URI by using question marks (?) and ampersands (&).
Query conditions include: env_id, group_id, variable_name, page_size, and page_no.

**Table 2** Parameter description
Parameter	Mandatory	Type	Description
env_id	No	String	Environment ID
group_id	Yes	String	API group ID
variable_name	No	String	Variable name
page_size	No	Integer	Number of records displayed on each page. The default value is 20.
page_no	No	Integer	Page number. The default value is 1.
precise_search	No	String	Parameter name (variable_name) for exact matching

Request

N/A

Response

**Table 3** Parameter description
Parameter	Type	Description
variables	Dictionary	Environment variable list
total	Integer	Number of environment variables that match the query conditions
size	Integer	Length of the returned environment variable list

**Table 4** Parameter description of variables
Parameter	Type	Description
id	String	Environment variable ID
env_id	String	Environment ID
group_id	String	API group ID
variable_name	String	Variable name
variable_value	String	Variable value

Example response:

{
	"total": 2,
	"size": 2,
	"variables": [{
		"id": "09ab8135-7224-40b9-bf5d-107f2a09d409",
		"env_id": "cca3616a-f368-4b32-9064-b2a631cb3eeb",
		"group_id": "73c58022-f20d-495a-a188-85d718647f09",
		"variable_name": "port",
		"variable_value": "8080"
	},
	{
		"id": "104185e5-3e8f-4c63-a7e5-ef4117bf870c",
		"env_id": "cca3616a-f368-4b32-9064-b2a631cb3eeb",
		"group_id": "73c58022-f20d-495a-a188-85d718647f09",
		"variable_name": "address",
		"variable_value": "192.168.1.5"
	}]
}