Help Center/ ROMA Connect/ API Reference/ Service Integration APIs/ Environment Variable Management/ Querying Environment Variables
Updated on 2023-06-29 GMT+08:00
View PDF
Share

Querying Environment Variables

Function

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

URI

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

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.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Long

Offset from which the query starts. If the offset is less than 0, the value is automatically converted to 0.

Default: 0

limit

No

Integer

Number of items displayed on each page.

Minimum: 1

Maximum: 500

Default: 20

group_id

Yes

String

API group ID.

env_id

No

String

Environment ID.

variable_name

No

String

Environment variable name.

precise_search

No

String

Parameter name for exact matching. If multiple parameters need to support exact match, separate them with commas (,).

Currently, only variable_name is supported.

Request Parameters

Table 3 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 4 Response body parameters

Parameter

Type

Description

size

Integer

Length of the returned resource list.

total

Long

Number of resources that match the query conditions.

variables

Array of EnvVariableInfo objects

Environment variable list.
Table 5 EnvVariableInfo

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, which can contain 3 to 32 characters, starting with a letter. Only letters, digits, hyphens (-), and underscores (_) are allowed. The variable name is equivalent to "#Name#" in API definitions. Characters between the number signs are case-sensitive. The variable name will be replaced with the variable value after API publication.

id

String

Environment variable ID.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 10 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

{
  "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
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation"
}

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.3030",
  "error_msg" : "The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620ec"
}

Status code: 500

Internal Server Error

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

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.