更新时间:2025-12-25 GMT+08:00

查询环境详情

功能介绍

查询环境详情。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

application_id

String

参数解释

应用id。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

environment_id

String

参数解释

环境id。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。 通过调用IAM服务接口获取(响应消息头中X-Subject-Token的值)。

约束限制

不涉及。

取值范围

字符串,长度不超过20000个字符。

默认取值

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

status

String

参数解释

请求成功失败状态。

取值范围

  • success: 请求成功。

  • failed: 请求失败。

result

EnvironmentDetailResponse object

参数解释

环境详情。

表4 EnvironmentDetailResponse

参数

参数类型

描述

id

String

参数解释

环境id。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

name

String

参数解释

环境名称。

取值范围

只能中英文,数字和-_.组成,且长度范围为3-128个字符。

description

String

参数解释

环境描述。

取值范围

长度不能超过500个字符。

os

String

参数解释

环境操作系统。

取值范围

  • windows:windows操作系统类型。

  • linux:linux操作系统类型。

project_id

String

参数解释

项目id,获取方式请参见获取项目id

取值范围

只能由英文字母、数字组成,且长度为32个字符。

nick_name

String

参数解释

环境创建者用户昵称。

取值范围

字符串,长度为[1-30]个字符。

deploy_type

Integer

参数解释

部署类型。

取值范围

  • 0: 主机类型。

  • 1: kubernetes类型。

instance_count

Integer

参数解释

环境下主机实例数量。

取值范围

最大值不能超过200

created_time

String

参数解释

环境创建时间。时间格式:yyyy-MM-dd HH:mm:ss。

取值范围

不涉及。

created_by

UserInfo object

参数解释

环境创建者用户信息,包含用户id,用户名等。

permission

EnvironmentPermissionDetail object

参数解释

当前用户对环境的操作权限矩阵。

表5 UserInfo

参数

参数类型

描述

user_id

String

参数解释

用户id。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

user_name

String

参数解释

用户名。

取值范围

只能由英文字母、数字组成,且长度为[1-255]个字符。

表6 EnvironmentPermissionDetail

参数

参数类型

描述

can_delete

Boolean

参数解释

当前用户是否有环境删除权限。

取值范围

  • true:有环境删除权限。

  • false:无环境删除权限。

can_deploy

Boolean

参数解释

当前用户是否有环境部署权限。

取值范围

  • true:有环境部署权限。

  • false:无环境部署权限。

can_edit

Boolean

参数解释

当前用户是否有环境编辑权限。

取值范围

  • true:有环境编辑权限。

  • false:无环境编辑权限。

can_manage

Boolean

参数解释

当前用户是否有环境权限矩阵编辑权限。

取值范围

  • true:有环境权限矩阵编辑权限。

  • false:无环境权限矩阵编辑权限。

can_view

Boolean

参数解释

当前用户是否有环境查看权限。

取值范围

  • true:有环境查看权限。

  • false:无环境查看权限。

请求示例

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

响应示例

状态码:200

OK 请求响应成功

{
  "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" : "140ca97e701d4c4c93c5932d5bdb32ec",
    "name" : "casdasd",
    "nick_name" : "AB边账号",
    "os" : "linux",
    "permission" : {
      "can_delete" : true,
      "can_deploy" : true,
      "can_edit" : true,
      "can_manage" : true,
      "can_view" : true
    }
  }
}

状态码

状态码

描述

200

OK 请求响应成功

错误码

请参见错误码