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

更新tool

功能介绍

更新工具。

URI

PUT /v1/tools/{tool_id}

表1 请求参数

参数

是否必选

参数类型

描述

tool_id

String

工具ID。

请求消息

请求参数

请求参数如表2所示。

表2 请求参数

参数

是否必选

参数类型

描述

description

String

工具描述,如果为空,表明描述不更新。

取值范围:输入字符最大长度为255,中文算单个字符,不能包含<>#%&字符。

version

String

工具版本,如果为空,表明版本不更新。

取值范围:

长度[0,24],满足正则表达式

^[a-zA-Z0-9]+([-.][a-zA-Z0-9]+)*$

scope

String

工具范围,如果为空,表明scope不更新。

支持选项:

  • domain:表示仅当前租户可见可用
  • public:表示所有租户均可见可用

vendor

String

工具创建者,如果为空,表明工具创建和不更新。

取值范围:长度[0,64],中文算单个字符,不能包含<>()#%&/字符。

image

String

工具所包含镜像的地址,如果为空,表明工具镜像不更新。

取值范围:长度[0-128]。

instruction

String

工具使用说明,如果为空,表明工具使用指导不更新。

取值范围:长度[0,255],中文算单个字符,不能包含<>()#%&/字符。

cpu

String

使用工具对节点的CPU限制,如果为空,表明工具CPU限制不更新。

取值范围:由数字和单位组成,单位为“C”,数字大于0,小于2000。

memory

String

使用工具对节点的memory限制,如果为空,表明工具memory限制不更新。

取值范围:由数字和单位组成,单位为“G”,数字大于0, 小于2000。

command

String

使用工具的推荐执行脚本,如果为空,表明工具命令不更新。

取值范围:长度[0-1024]。

category

String

工具分类,如果为空,表明工具分类不更新。

支持选项:

  • "others”:其他
  • "qualitycontrol":预处理
  • "basic":基因组分析基础
  • "gatk":GATK流程
  • "callvariant":深度学习突变检测
  • "environment":软件环境

请求示例

PUT /v1/tools/d078e49c-124c-7706-bcbb-81885661f431 HTTP/1.1 
Host:Host Server   
Content-Type:application/json
{
     "category": "others"
}

响应消息

响应参数

请求成功的响应参数如表3所示。

表3 成功响应参数

参数

参数类型

描述

id

String

环境ID

响应示例

{
    "id": "d078e49c-124c-7706-bcbb-81885661f431"
}

请求失败的响应参数如表9所示。

状态码

  • 正常

    状态码如表1-4所示。

表4 状态码

状态码

描述

200

工具更新成功

相关文档