获取所有环境
功能介绍
此API用于获取所有已经创建的环境。
URI
GET /v3/{project_id}/cas/environments
| 
        参数  | 
      
        是否必选  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|---|
| 
        project_id  | 
      
        是  | 
      
        String  | 
      
        租户项目ID。获取方法,请参考获取项目ID。  | 
     
| 
        参数  | 
      
        是否必选  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|---|
| 
        limit  | 
      
        否  | 
      
        Integer  | 
      
        查询个数,取值[0, 100]。  | 
     
| 
        offset  | 
      
        否  | 
      
        Integer  | 
      
        查询偏移量,表示查询第n条数据后的结果。  | 
     
| 
        order_by  | 
      
        否  | 
      
        String  | 
      
        排序字段。 排序字段支持如下枚举值: 
 传值不在支持的枚举值范围内按默认排序字段排序。  | 
     
| 
        order  | 
      
        否  | 
      
        String  | 
      
        排序方式。 
  | 
     
| 
        name  | 
      
        否  | 
      
        String  | 
      
        指定环境名称,查询对应环境名称的环境信息。  | 
     
| 
        environment_id  | 
      
        否  | 
      
        String  | 
      
        指定环境ID,查询对应环境ID的环境信息。  | 
     
| 
        enterprise_project_id  | 
      
        否  | 
      
        String  | 
      
        指定企业项目ID,查询对应企业项目ID的环境信息。  | 
     
请求消息
| 
        参数  | 
      
        是否必选  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|---|
| 
        Content-Type  | 
      
        是  | 
      
        String  | 
      
        消息体的类型(格式),默认取值为“application/json;charset=utf8”。  | 
     
| 
        X-Auth-Token  | 
      
        是  | 
      
        String  | 
      
        调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考认证鉴权。  | 
     
响应消息
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        count  | 
      
        Integer  | 
      
        环境总数。  | 
     
| 
        environments  | 
      
        Array of objects  | 
      
        环境参数,请参考表5。  | 
     
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        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  | 
      
        标签,可使用标签管理服务通过标签过滤资源,请参考表6。  | 
     
| 
        type  | 
      
        String  | 
      
        Kubernetes环境是否高可用类型。 
  | 
     
| 
        resource_create_mode  | 
      
        String  | 
      
        资源配置模式。 
  | 
     
| 
        config_mode  | 
      
        String  | 
      
        配置模式。 
  | 
     
| 
        env_status  | 
      
        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错误码。