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

查询tool列表

功能介绍

查询工具列表。

URI

GET /v1/tools

表1 请求参数

参数

是否必选

参数类型

描述

scope

String

工具使用范围,如果为空默认domain。范围为:

  • domain:租户内可用
  • public:全局可用(跨租户可用)

name

String

工具名称,适用于根据工具名称模糊查询工具ID场景。

whole_name

String

工具名称,适用于根据工具名称全匹配查询工具ID场景。

offset

String

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

limit

String

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

category

String

工具分类,适用于根据工具分类查询工具场景。

支持选项:

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

请求消息

请求示例

GET /v1/tools HTTP/1.1 
Host:Host Server   
Content-Type:application/json

响应消息

响应参数

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

响应示例

{
  "tools": [
    {
      "tool": [
        {
          "guid": "da46b3dd-ffa9-d99b-95fa-824eeeceebea",
          "name": "obs-util",
          "description": "",
          "project_id": "a573035fc*********8eaea580553667",
          "version": "0.1.1",
          "scope": "public",
          "domain": "gcs_container",
          "domain_id": "024014b87********30fbe790bda3e6",
          "vendor": "基因容器团队",
          "image": "obs-util:0.1.1",
          "create_at": "2019-06-13T06:59:14Z",
          "update_at": "2019-06-13T06:59:14Z",
          "category": "environment",
          "instruction": "",
          "cpu": "2C",
          "memory": "8G",
          "command": "",
          "logo": "",
          "type": "container",
          "enterprise_project":{"id": "ccc130bb-fa32-4af9-9370-7458470169cf", "name": "dts"}
        }
      ]
    }
  ],
  "total": 1
}

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

状态码

  • 正常

    状态码如表2所示。

表2 状态码

状态码

描述

200

查询工具列表成功

相关文档