更新时间:2022-06-15 GMT+08:00
分享

删除environment

功能介绍

清理基因测序的环境。如果您不再使用此环境,建议您清理环境,避免资源及费用的浪费。如默认环境被清理,则最新创建的环境会自动变成默认环境。

如果您使用的环境是云容器实例,环境清理后,基因容器将不再使用该命名空间,但是命名空间并未删除。如果需要删除命名空间,请前往CCI控制台删除。

如果您使用的环境是云容器引擎,环境清理后,基因容器将不再使用该集群。对于部署环境时创建的集群,可以通过入参“delete_cluster”选择是否同时删除集群,对于部署环境前已创建的集群,只能往CCE控制台删除。

URI

DELETE /v1/environments/{environment_id}

表1 请求参数

参数

是否必选

参数类型

描述

environment_id

String

环境ID。

delete_cluster

String

通过部署环境而新创的集群资源,可以使用delete_cluster字段来删除该集群;通过已有集群来部署环境不允许删除集群,需通过云容器引擎界面删除,默认false。

支持的取值:

  • "1", "t", "T", "true", "TRUE", "True":表示需要删除集群。
  • "0", "f", "F", "false", "FALSE", "False":表示不删除集群。

请求消息

请求示例

DELETE /v1/workflows/e19d3faf-9f04-9685-e5c0-fbe8d40b96cd 
Content-Type:application/json

响应消息

如果删除成功响应消息的响应体为空,仅有http头。

状态码

  • 正常

    状态码如表2所示。

表2 状态码

状态码

描述

204

环境清理成功。

相关文档