文档首页/ 基因容器 GCS/ API参考/ API/ Environment/ 查询environment列表
更新时间:2022-06-15 GMT+08:00
分享

查询environment列表

功能介绍

查询环境列表。

URI

GET /v1/environments

表1 请求参数

参数

是否必选

参数类型

描述

offset

String

偏移量,查询起始偏移,默认为0。

取值范围:必须由数字组成。

limit

String

限制量,单次查询总量,和offset必须成对出现。

取值范围:必须由数字组成。

source

String

查询环境的类型。默认为空,若为空则返回cce和cci的环境。支持选项:

  • cce:指GCS部署的底层资源使用的是华为云服务云容器引擎(简称CCE)。
  • cci:指GCS部署的底层资源使用的是华为云服务云容器实例(简称CCI)。

请求消息

请求示例

GET /v1/environments 
Content-Type:application/json

响应消息

响应参数

响应中含有多个环境结构,结构如表2所示。

表2 环境结构

参数

参数类型

描述

guid

String

环境ID。

project_id

String

环境所属项目ID。

domain_id

String

环境所属租户ID。

name

String

环境名称。

description

String

环境描述。

status

String

环境运行状态。

create_at

String

环境创建时间。

update_at

String

环境更新时间。

cluster_id

String

环境所属集群ID。

cluster_name

String

环境所属集群名称。

cpu

Integer

环境Cpu核数。

memory

Integer

环境内存量。

source

String

部署环境的方式。

stack_id

String

堆栈ID。

is_gene_cluster

Boolean

是否为部署环境时新创建的集群。

bucket_name

String

关联的OBS桶名。

default_env

Boolean

是否为默认环境。

order_id

String

若为CCE包周期计费,order_id表示订单号,否则默认为空。

cluster_info

String

集群的补充信息。

enterprise_project

表3 object

企业项目信息

表3 enterprise_project

参数

参数类型

描述

id

String

企业项目id

name

String

企业项目的名称

响应示例

{
	"environments":[{
		"guid":"9c1e684f-d574-99e0-19fa-3f4ac7156c4f",
		"project_id":"c5156752********8a8a81ede51894ac",
		"domain_id":"b0148a********289b477bab429e48e7",
		"name":"gcs-env-cci-auto-env",
		"description":"Gene container environment from cci",
		"status":"Running",
		"create_at":"2019-03-01T07:39:38Z",
		"update_at":"2019-03-01T07:47:31Z",
		"cluster_id":"4461ec15-3a62-11e9-8c5d-80d4a5ae3e2b",
		"cluster_name":"cci-auto-1551252918989",
		"cpu":0,"memory":0,
		"source":"cci",
		"stack_id":"",
		"is_gene_cluster":false,
		"bucket_name":"",
		"default_env":true,
		"order_id":"",
                "enterprise_project":{"id":"0", "name":"default"}
	}],
	"total":1
}

状态码

  • 正常

    状态码如表4所示。

表4 状态码

状态码

描述

200

环境列表查询成功。

相关文档