Querying an Environment List of an Application

Function

This API is used to query an environment list of an application.

Calling Method

For details, see Calling APIs.

URI

GET /v1/applications/{application_id}/environments

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
application_id	Yes	String	Definition: Application ID. Constraints: N/A. Value range: 32 characters, including letters and digits. Default value: N/A.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details, see Obtaining a Project ID. Constraints: N/A. Value range: 32 characters, including letters and digits. Default value: N/A.
page_index	No	Integer	Definition: Page number, indicating that the query starts from this page. Constraints: N/A. Value range: [1–50]. Default value: N/A.
page_size	No	Integer	Definition: Number of records displayed on each page. Constraints: N/A. Value range: [1–100]. Default value: N/A.
name	No	String	Definition: Name of the environment to be queried. Constraints: N/A. Value range: Max. 128 characters. Default value: N/A.
sort_key	No	String	Definition: Sorting field. Constraints: N/A. Value range: NAME: Sort by environment name. USER_NAME: Sort by username. CREATED_TIME: Sort by creation time. NICK_NAME: Sort by user nickname. Default value: N/A.
sort_dir	No	String	Definition: Sorting order. Constraints: N/A. Value range: DESC: Descending order. ASC: Ascending order. Default value: N/A.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API used for. Constraints: N/A. Value range: String. Max. 20,000 characters. Default value: N/A.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
status	String	Definition: Request status (successful or failed). Value range: success: Successful. failed: Failed.
total	Integer	Definition: Number of environments that match requirements. Value range: 0–100.
result	Array of EnvironmentDetail objects	Definition: Environment list information.

**Table 5** EnvironmentDetail
Parameter	Type	Description
id	String	Definition: Environment ID. Value range: 32 characters, including letters and digits.
name	String	Definition: Environment name. Value range: N/A.
description	String	Definition: Environment description. Value range: N/A.
os	String	Definition: OS of environments. Value range: window: Windows OS. linux: Linux OS.
project_id	String	Definition: Project ID. Value range: 32 characters, including letters and digits.
nick_name	String	Definition: Nickname of the environment creator. Value range: N/A.
deploy_type	Integer	Definition: Deployment type. Value range: 0: Host type. 1: Kubernetes type.
created_time	String	Definition: Environment creation time. Format: yyyy-MM-dd HH:mm:ss. Value range: N/A.
instance_count	Integer	Definition: Number of host instances in the environment. Value range: N/A.
created_by	UserInfo object	Definition: Information about the environment creator, including the user ID and username.
permission	EnvironmentPermissionDetail object	Definition: Environment operation permission matrix of the current user.

**Table 6** UserInfo
Parameter	Type	Description
user_id	String	Parameter description: User ID. Value range: The value consists of 32 characters. Only letters and digits are allowed.
user_name	String	Parameter description: Username. Value range: The value consists of 1-255 characters. Only letters and digits are allowed.

**Table 7** EnvironmentPermissionDetail
Parameter	Type	Description
can_delete	Boolean	Definition: Whether you have the permission to delete environments. Value range: true: Yes. false: No.
can_deploy	Boolean	Definition: Whether you have the permission to deploy environments. Value range: true: Yes. false: No.
can_edit	Boolean	Definition: Whether you have permission to edit environments. Value range: true: Yes. false: No.
can_manage	Boolean	Definition: Whether you have permission to edit the environment permission matrix. Value range: true: Yes. false: No.
can_view	Boolean	Definition: Whether you have permission to view environments. Value range: true: Yes. false: No.

Example Requests

https://{endpoint}/v1/applications/43943381f7764c52baae8e697720873f/environments?project_id=55837d272adf4eee90319800e2da6961

Example Responses

Status code: 200

OK: The request is successful.

{
  "status" : "success",
  "total" : 1,
  "result" : [ {
    "created_by" : {
      "user_id" : "6baa7454109d47c192f22078fe6cda20",
      "user_name" : "devcloud_devcloud_l00490255_01"
    },
    "created_time" : "2023-06-20 16:53:29.0",
    "deploy_type" : 0,
    "description" : "",
    "id" : "a0a2274acc4f482bb2ecf49f865879fa",
    "name" : "casdasd",
    "project_id" : "55837d272adf4eee90319800e2da6961",
    "nick_name" : "A/B Side Account",
    "instance_count" : 1,
    "os" : "linux",
    "permission" : {
      "can_delete" : true,
      "can_deploy" : true,
      "can_edit" : true,
      "can_manage" : true,
      "can_view" : true
    }
  } ]
}