Help Center/ API Gateway/ API Reference/ Shared Gateway APIs (for Existing Users)/ Environment Variable Management/ Querying Environment Variable Details
Updated on 2023-07-28 GMT+08:00
View PDF
Share

Querying Environment Variable Details

Function

This API is used to query the details of an environment variable.

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/{id}

The following table lists the parameter in the URI.

Table 2 Parameter description

Parameter

Mandatory

Type

Description

id

Yes

String

Environment variable ID

Request

N/A

Response

Table 3 Parameter description

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:

{
	"id": "104185e53e8f4c63a7e5ef4117bf870c",
	"env_id": "cca3616af3684b329064b2a631cb3eeb",
	"group_id": "73c58022f20d495aa18885d718647f09",
	"variable_name": "address",
	"variable_value": "192.168.1.5"
}

Status Codes

Table 4 Status codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Internal Error