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]

Note

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": "09ab8135722440b9bf5d107f2a09d409",
		"env_id": "cca3616af3684b329064b2a631cb3eeb",
		"group_id": "73c58022f20d495aa18885d718647f09",
		"variable_name": "port",
		"variable_value": "8080"
	},
	{
		"id": "104185e53e8f4c63a7e5ef4117bf870c",
		"env_id": "cca3616af3684b329064b2a631cb3eeb",
		"group_id": "73c58022f20d495aa18885d718647f09",
		"variable_name": "address",
		"variable_value": "192.168.1.5"
	}]
}

Status Codes

Table 5 Status codes
Status Code	Description
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Server Internal Error

Parent topic: Environment Variable Management

Предыдущая статья

Querying Environment Variable Details

Следующая статья

Request Throttling Policy Management

Была ли эта статья полезна?

Поддержка Юридические документы