Updated on 2025-05-27 GMT+08:00

Querying Environment Details

Function

This API is used to query environment details.

Calling Method

For details, see Calling APIs.

URI

GET /v1/applications/{application_id}/environments/{environment_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

application_id

Yes

String

Application ID

environment_id

Yes

String

Environment ID

Request Parameters

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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

status

String

Request success or failure status

result

EnvironmentDetail object

Environment details

Table 4 EnvironmentDetail

Parameter

Type

Description

id

String

Environment ID

name

String

Environment name

description

String

Environment description

os

String

OS

nick_name

String

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

Parameter description:

User information, including user ID and username.

Constraints:

N/A

permission

EnvironmentPermissionDetail object

Environment permission details

Table 5 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 6 EnvironmentPermissionDetail

Parameter

Type

Description

can_delete

Boolean

Whether you have the permission to delete environments

can_deploy

Boolean

Whether you have the deploy permission

can_edit

Boolean

Whether you have the permission to edit environments

can_manage

Boolean

Whether you have permission to edit the environment permission matrix.

can_view

Boolean

Whether you have the permission to check environments

Example Requests

https://{endpoint}/v1/applications/43943381f7764c52baae8e697720873f/environments/140ca97e701d4c4c93c5932d5bdb32ec

Example Responses

Status code: 200

OK: The request is successful.

{
  "status" : "success",
  "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
    }
  }
}

Status Codes

Status Code

Description

200

OK: The request is successful.

Error Codes

See Error Codes.