文档首页/ 应用管理与运维平台 ServiceStage/ API参考/ 应用管理API（v3版本）/ 环境/ 根据环境ID获取环境详细信息-ObtainEnvironmentDetailsBasedOnTheEnvironmentID
更新时间：2025-11-05 GMT+08:00
查看PDF
分享

根据环境ID获取环境详细信息 - ObtainEnvironmentDetailsBasedOnTheEnvironmentID

功能介绍

此API用于通过环境ID获取环境详细信息。

URI

GET /v3/{project_id}/cas/environments/{environment_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户项目ID。获取方法，请参考获取项目ID。

environment_id

是

String

环境ID。获取方法，请参考获取所有环境 - ObtainAllEnvironments。

请求消息

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

消息体的类型（格式），默认取值为“application/json;charset=utf8”。

X-Auth-Token

是

String

调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考认证鉴权。

响应消息

表3 响应参数

参数

参数类型

描述

id

String

环境ID。

name

String

环境名称。

description

String

环境描述。

project_id

String

项目ID。

enterprise_project_id

String

企业项目ID。

deploy_mode

String

环境类型。

  • virtualmachine：虚拟机。
  • container：Kubernetes。
  • mixed ：虚拟机+Kubernetes。

vpc_id

String

虚拟私有云ID。

creator

String

环境创建人。

create_time

Integer

环境创建时间。

update_time

Integer

环境修改时间。

labels

Array of objects

标签，可使用标签管理服务通过标签过滤资源，请参考表4。

resources

Array of objects

资源，请参考表5。

type

String

Kubernetes环境是否高可用类型。

  • normal：非高可用环境。
  • high：高可用环境。

resource_create_mode

String

资源配置模式。

  • none：纳管资源。

config_mode

String

配置模式。

  • ui：基于UI页面配置部署。

env_status

String

环境资源状态（获取的非实时状态）

  • REFRESHING：刷新中。
  • UNKNOWN：未知。
  • NORMAL：正常。
  • PARTIALLY_NORMAL：部分正常。

configuration

Object

环境级环境变量，请参考表7。
表4 labels

参数

参数类型

描述

key

String

标签名称。

value

String

标签值。
表5 resources

参数

参数类型

描述

id

String

资源ID。

name

String

资源名称。

type

String

资源类型。

  • vpc，虚拟私有云。
  • eip，弹性IP。
  • elb，弹性负载均衡。
  • cce，云容器引擎。
  • ecs，弹性云服务器。
  • as，弹性伸缩组。
  • cse，ServiceComb引擎。
  • nacos，注册配置中心。
  • dcs，分布式缓存服务。
  • rds，云数据库。
  • subnet，子网。
  • acl，网络ACL。
  • customServer，自定义服务器。
  • gaussdb，云数据库GaussDB。
  • dms_rocketmq，分布式消息服务RocketMQ。
  • css_es，云搜索服务Elasticsearch。
  • custom_k8s，自定义kubernetes集群。

core

String

自定义服务器的内核数。

资源类型为customServer时会返回此参数。

gib

String

自定义服务器的内存（单位为Gib）。

资源类型为customServer时会返回此参数。

parameters

Map<String, String>

资源参数，请参考表6。
表6 parameters

参数

参数类型

描述

kube_config

String

Kubernetes连接配置文件。

资源类型为custom_k8s时返回此参数。
表7 configuration

参数

参数类型

描述

resource_envs

Array of objects

环境绑定的资源变量，请参考表8。

envs

Array of objects

环境级环境变量，请参考表9。
表8 resource_env

参数

参数类型

描述

resource_id

String

环境绑定的资源变量关联的资源ID。

resource_name

String

环境绑定的资源变量关联的资源名称。

resource_type

String

环境绑定的资源变量关联的资源类型。

envs

Array of objects

环境绑定的资源变量，请参考表9。
表9 config_env

参数

参数类型

描述

name

String

环境级环境变量的键。

value

String

环境级环境变量的值。

请求示例

无

响应示例

{
    "id": "ea011e01-2eb5-453f-87bf-874e4a855abe", 
    "name": "dev-env",
    "description": "develop environment", 
    "project_id": "bf8523d898b64e4eb956e3be3555ca16", 
    "enterprise_project_id": "0", 
    "deploy_mode": "virtualmachine",
    "vpc_id": "234241234124xxvasf2342xxxxxxxxxxx", 
    "resources": [
        {
            "id": "329b135e-7b31-4ea6-afb9-b69017bd0a80",
            "type": "ecs",
            "name": "ecs-test"
        }
    ], 
    "creator": "ss-test", 
    "create_time": 1578984198394, 
    "update_time": 1578984198394,
    "labels": null
}

状态码

状态码

描述

200

操作成功。

400

错误的请求。

404

请求对象不存在。

500

内部错误。

错误码

请参考ServiceStage错误码。

父主题： 环境