Help Center> ROMA Connect> API Reference> APIC APIs> Environment Variable Management> Querying Details of an Environment Variable
View PDF

Querying Details of an Environment Variable

Function

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

URI

GET /v2/{project_id}/apic/instances/{instance_id}/env-variables/{env_variable_id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference.

instance_id

Yes

String

Instance ID.

env_variable_id

Yes

String

Environment variable ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

variable_value

String

The variable value can contain 1 to 255 characters, including letters, digits, underscores (_), hyphens (-), slashes (/), periods (.), and colons (:).

env_id

String

Environment ID.

Minimum: 1

Maximum: 65

group_id

String

API group ID.

Minimum: 1

Maximum: 65

variable_name

String

Variable name. The value is a string of 3 to 32 characters, which can contain letters, digits, underscores (_), and hyphens (-) and must start with a letter. In the API definition, the number sign (#) (case-sensitive) in the value of #Name is replaced with the variable value when the API is published in the environment.

id

String

Environment variable ID.

Status code: 401

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

None

Example Responses

Status code: 200

OK

{
  "variable_value" : "192.168.1.5",
  "env_id" : "7a1ad0c350844ee69479b47df9a881cb",
  "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
  "id" : "25054838a624400bbf2267cf5b3a3f70",
  "variable_name" : "address"
}

Status code: 401

Unauthorized

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

Status code: 403

Forbidden

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

Status code: 404

Not Found

{
  "error_code" : "APIG.3011",
  "error_msg" : "The environment variable does not exist, id: 25054838a624400bbf2267cf5b3a3f70"
}

Status code: 500

Internal Server Error

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

Status Codes

Status Code

Description

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.