Help Center> API Gateway> API Reference (Kuala Lumpur Region)> Dedicated Gateway APIs (V2)> Environment Management> Querying Environments
Updated on 2022-08-15 GMT+08:00
View PDF

Querying Environments

Function

This API is used to query environments.

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/envs

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain a project ID, see "Appendix" > "Obtaining a Project ID" in this document.

instance_id

Yes

String

Gateway ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Long

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

Default: 0

limit

No

Integer

Number of records displayed on each page.

Minimum: 1

Maximum: 500

Default: 20

name

No

String

Environment name.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

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.

envs

Array of EnvInfo objects

Environment list.
Table 5 EnvInfo

Parameter

Type

Description

create_time

String

Creation time.

name

String

Environment name.

remark

String

Description.

id

String

Environment ID.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

None

Example Responses

Status code: 200

OK

{
  "total" : 2,
  "size" : 2,
  "envs" : [ {
    "create_time" : "2019-02-12T19:42:19.914989Z",
    "name" : "RELEASE",
    "remark" : "xxx",
    "id" : "DEFAULT_ENVIRONMENT_RELEASE_ID"
  }, {
    "create_time" : "2020-07-31T06:41:43Z",
    "name" : "DEV",
    "remark" : "Development environment",
    "id" : "7a1ad0c350844ee69479b47df9a881cb"
  } ]
}

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: 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

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: Environment Management