文档首页/医疗智能体/API参考/API（盘古辅助制药平台）/药物数据库管理/创建数据库
更新时间：2024-12-13 GMT+08:00
查看PDF
分享

创建数据库

功能介绍

创建数据库。

URI

POST /v1/{project_id}/drug/databases

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，您可以从获取项目ID中获取。

最小长度：1

最大长度：128

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。

最小长度：1

最大长度：32768

表3 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

数据库名称，长度为5-32个字符，首位需以小写英文字母开头，仅可以使用小写字母、数字、下划线“_”和中划线“-”。

最小长度：5

最大长度：32

description

否

String

数据库描述。

最小长度：0

最大长度：1024

css_id

是

String

css集群id。

最小长度：1

最大长度：128

file

是

DatabaseFile object

数据库文件。

columns

是

Array of strings

数据文件列名。

最小长度：1

最大长度：128

数组长度：2 - 12

shareable

否

Boolean

是否打开组织共享。

缺省值：false

表4 DatabaseFile

参数

是否必选

参数类型

描述

source

是

String

数据库文件来源。

枚举值：

  • public
  • private

url

是

String

文件URL，用户私有数据中心为项目路径、公共数据场景为obs地址。

最小长度：1

最大长度：2000

eihealth_project_id

否

String

数据库文件所在项目id，仅文件为数据中心时填写。

最小长度：1

最大长度：128

响应参数

状态码： 201

表5 响应Body参数

参数

参数类型

描述

id

String

数据库id。

请求示例

创建数据库，数据库名称为database_name，选择css集群，上传项目桶中file/test.csv的数据库数据，设置列名为SMILES和NAME，打开共享开关。

https://{endpoint}/v1/{project_id}/drug/drug-database

{
  "name" : "database_name",
  "css_id" : "2f042ad4-6aca-11ed-b7f6-fa163e504fdd",
  "description" : "simple database",
  "file" : {
    "source" : "PRIVATE",
    "url" : "project:/file/test.csv",
    "eihealth_project_id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1"
  },
  "columns" : [ "SMILES", "NAME" ],
  "shareable" : true
}

响应示例

状态码： 201

CREATED

{
  "id": "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1"
}

状态码

状态码

描述

201

CREATED

错误码

请参见错误码。

相关文档