文档首页/ 应用管理与运维平台 ServiceStage/ API参考/ 应用管理API（v3版本）/ 环境/ 获取所有环境 - ObtainAllEnvironments
更新时间：2025-11-20 GMT+08:00
查看PDF
分享

获取所有环境 - ObtainAllEnvironments

功能介绍

此API用于获取所有已经创建的环境。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    servicestage:environment:list

    list

    -

    -

    servicestage:app:list

    -

URI

GET /v3/{project_id}/cas/environments

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户项目ID。获取方法，请参考获取项目ID。
表2 查询参数

参数

是否必选

参数类型

描述

limit

否

Integer

查询个数，取值[0, 100]。

offset

否

Integer

查询偏移量，表示查询第n条数据后的结果。

order_by

否

String

排序字段。

排序字段支持如下枚举值：

  • create_time，环境创建时间，默认排序字段。
  • name，环境名称。
  • update_time，环境修改时间。

传值不在支持的枚举值范围内按默认排序字段排序。

order

否

String

排序方式。

  • desc，降序排序，默认排序方式。
  • asc，升序排序。

name

否

String

指定环境名称，查询对应环境名称的环境信息。

environment_id

否

String

指定环境ID，查询对应环境ID的环境信息。

enterprise_project_id

否

String

指定企业项目ID，查询对应企业项目ID的环境信息。

请求消息

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

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

X-Auth-Token

是

String

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

响应消息

表4 响应参数

参数

参数类型

描述

count

Integer

环境总数。

environments

Array of objects

环境参数，请参考表5。
表5 environments

参数

参数类型

描述

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

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

type

String

Kubernetes环境是否高可用类型。

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

resource_create_mode

String

资源配置模式。

  • none：纳管资源。

config_mode

String

配置模式。

  • ui：基于UI页面配置。

env_status

String

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

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

参数

参数类型

描述

key

String

标签名称。

value

String

标签值。

请求示例

无

响应示例

{
	"environments": [
		{
			"id": "00078e9d-a61c-476e-ac63-a10c9cb2638e",
			"name": "development-env",
			"description": "",
			"project_id": "e7d2e9c589e5445e808a8ff0d1235aca",
			"enterprise_project_id": "0",
                        "deploy_mode": "virtualmachine",
			"vpc_id": "29d55020-ae0e-4a18-871c-93e6976ee7bd",
			"creator": "ss-test",
			"create_time": 1610418873730,
			"update_time": 1610418873730,
                        "labels": null
		}
	],
	"count": 1
}

状态码

状态码

描述

200

操作成功。

400

错误的请求。

404

请求对象不存在。

500

内部错误。

错误码

请参考ServiceStage错误码。

父主题： 环境

相关文档