根据环境ID获取环境详细信息 - ObtainEnvironmentDetailsBasedOnTheEnvironmentID
功能介绍
此API用于通过环境ID获取环境详细信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
servicestage:environment:get
read
environment *
servicestage:app:get
-
URI
GET /v3/{project_id}/cas/environments/{environment_id}
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 参数解释: 租户项目ID。获取方法,请参考获取项目ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
environment_id | 是 | String | 参数解释: 环境ID。获取方法,请参考获取所有环境 - ObtainAllEnvironments。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求消息
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
Content-Type | 是 | String | 参数解释: 消息体的类型(格式)。 约束限制: 不涉及 取值范围: application/json;charset=utf8 默认取值: 不涉及 |
X-Auth-Token | 是 | String | 参数解释: 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考认证鉴权。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应消息
参数 | 参数类型 | 描述 |
|---|---|---|
id | String | 参数解释: 环境ID。 取值范围: 不涉及 |
name | String | 参数解释: 环境名称。 取值范围: 不涉及 |
description | String | 参数解释: 环境描述。 取值范围: 不涉及 |
project_id | String | 参数解释: 项目ID。 取值范围: 不涉及 |
enterprise_project_id | String | 参数解释: 企业项目ID。 取值范围: 不涉及 |
deploy_mode | String | 参数解释: 环境类型。 取值范围:
|
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环境是否高可用类型。 取值范围:
|
resource_create_mode | String | 参数解释: 资源配置模式。 取值范围:
|
config_mode | String | 参数解释: 配置模式。 取值范围:
|
env_status | String | 参数解释: 环境资源状态(获取的非实时状态) 取值范围:
|
configuration | Object | 参数解释: 环境级环境变量,请参考表7。 |
参数 | 参数类型 | 描述 |
|---|---|---|
id | String | 参数解释: 资源ID。 取值范围: 不涉及 |
name | String | 参数解释: 资源名称。 取值范围: 不涉及 |
type | String | 参数解释: 资源类型。 取值范围:
|
core | String | 参数解释: 自定义服务器的内核数。 资源类型为customServer时会返回此参数。 取值范围: 不涉及 |
gib | String | 参数解释: 自定义服务器的内存(单位为Gib)。 资源类型为customServer时会返回此参数。 取值范围: 不涉及 |
parameters | Map<String, String> | 参数解释: 资源参数,请参考表6。 |
参数 | 参数类型 | 描述 |
|---|---|---|
resource_envs | Array of objects | 参数解释: 环境绑定的资源变量,请参考表8。 |
envs | Array of objects | 参数解释: 环境级环境变量,请参考表9。 |
参数 | 参数类型 | 描述 |
|---|---|---|
resource_id | String | 参数解释: 环境绑定的资源变量关联的资源ID。 取值范围: 不涉及 |
resource_name | String | 参数解释: 环境绑定的资源变量关联的资源名称。 取值范围: 不涉及 |
resource_type | String | 参数解释: 环境绑定的资源变量关联的资源类型。 取值范围:
|
envs | Array of objects | 参数解释: 环境绑定的资源变量,请参考表9。 |
请求示例
无
响应示例
{
"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错误码。

