Help Center> CodeArts Deploy> API Reference> APIs> Environment Management> Querying the Environment List of an Application

Updated on 2023-11-28 GMT+08:00

View PDF

Querying the Environment List of an Application

Function

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

URI

GET /v1/applications/{application_id}/environments

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
application_id	Yes	String	Application ID. Minimum: 32 Maximum: 32

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID. Minimum: 32 Maximum: 32
page_index	No	Integer	Page number, indicating that the query starts from this page. The value of page is no less than 1. Minimum: 1 Maximum: 50 Default: 1
page_size	No	Integer	Number of items displayed on each page. The value of size is no more than 100. Minimum: 1 Maximum: 100 Default: 100
name	No	String	Name of the environment to be queried. Maximum: 128
sort_key	No	String	Sorting field. Data can be sorted by environment name, username, creation time, or user alias. Default: CREATED_TIME Enumeration values: NAME USER_NAME CREATED_TIME NICK_NAME
sort_dir	No	String	Sorting order: DESC (descending order) and ASC (ascending order). Default: DESC Enumeration values: DESC ASC

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. Minimum: 0 Maximum: 20000

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
status	String	Response status.
total	Integer	Total number of environments in an application.
result	Array of EnvironmentDetail objects	Environment list information. Array Length: 0 - 100

**Table 5** EnvironmentDetail
Parameter	Type	Description
id	String	Environment ID.
name	String	Environment name.
description	String	Environment description.
os	String	OS.
nick_name	String	User alias.
deploy_type	Integer	Deployment type. 0: host; 1: kubernetes.
created_time	String	Creation time.
instance_count	Integer	Number of host instances in the environment.
created_by	UserInfo object	User information.
permission	EnvironmentPermissionDetail object	Environment permission details.

**Table 6** UserInfo
Parameter	Type	Description
user_id	String	User ID.
user_name	String	Username.

**Table 7** EnvironmentPermissionDetail
Parameter	Type	Description
can_delete	Boolean	Whether you have the permission to delete the environment.
can_deploy	Boolean	Whether you have the deployment permission.
can_edit	Boolean	Whether you have the permission to edit the environment.
can_manage	Boolean	Whether you have permission to edit the environment permission matrix.
can_view	Boolean	Whether you have the permission to view the environment.

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",
    "nick_name" : "A-B Side Account",
    "os" : "linux",
    "permission" : {
      "can_delete" : true,
      "can_deploy" : true,
      "can_edit" : true,
      "can_manage" : true,
      "can_view" : true
    }
  } ]
}