文档首页/ 基因容器 GCS/ API参考/ API/ Tool/ 查询tool
更新时间：2022-06-15 GMT+08:00
查看PDF
分享

查询tool

功能介绍

查询工具详情。

URI

GET /v1/tools/{tool_id}

表1 请求参数

参数

是否必选

参数类型

描述

tool_id

是

String

工具ID，即创建tool接口返回值。

请求消息

请求示例

GET /v1/tools/d078e49c-124c-7706-bcbb-81885661f431 HTTP/1.1 
Host:Host Server   
Content-Type:application/json

响应消息

响应参数

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

表2 成功响应参数

参数

参数类型

描述

guid

String

工具ID。

name

String

工具名称。

description

String

工具描述。

project_id

String

工具所属项目ID。

version

String

工具版本。

scope

String

工具可用范围，包括：

  • domain：租户内可用
  • public：全局可用（跨租户可用）

domain

String

工具所属租户名称。

domain_id

String

工具所属租户ID。

vendor

String

工具创建者。

image

String

工具包含镜像地址。

create_at

String

工具创建时间。

update_at

String

工具更新时间。

category

String

工具分类。

instruction

String

工具使用说明。

cpu

String

使用工具，设置的虚机节点cpu限制。

memory

String

使用工具，设置的虚机节点内存限制。

command

String

使用工具，常用指令。

logo

String

工具logo图片地址。

type

String

工具类型。

enterprise_project

表3 object

企业项目信息
表3 enterprise_project

参数

参数类型

描述

id

String

企业项目id

name

String

企业项目的名称

响应示例

{
  "guid": "457fe199-1e81-6cd7-d1b2-6e25c13aeaa2",
  "name": "nginx",
  "description": "",
  "project_id": "30a8c4d********18a9c45a87c3a854a",
  "version": "latest",
  "scope": "domain",
  "domain": "gcs-user",
  "domain_id": "bf8441478cb6********c4395d0b3e5",
  "vendor": "gcs-user",
  "image": "nginx:latest",
  "create_at": "2018-08-20T08:32:29Z",
  "update_at": "2018-08-20T08:32:29Z",
  "category": "",
  "instruction": "",
  "cpu": "2C",
  "memory": "8G",
  "command": "",
  "logo": "",
  "type":"container",
  "enterprise_project": {"id": "ccc130bb-fa32-4af9-9370-7458470169cf", "name": "dts"}
}

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

状态码

  • 正常

    状态码如表4所示。

表4 状态码

状态码

描述

200

查询工具成功
父主题： Tool

相关文档