创建数据库 - CreateDrugDatabase

功能介绍

创建数据库。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

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个字符，首位需以小写英文字母开头，仅可以使用小写字母、数字、下划线"_"和中划线"-"。默认取值：不涉及
description	否	String	参数解释：数据库描述。约束限制：不涉及取值范围：长度为[0-1024]个字符。默认取值：不涉及
css_id	否	String	参数解释： CSS集群ID。约束限制：不涉及取值范围：仅支持字母、数字、中划线和下划线，长度为[1-128]个字符。默认取值：不涉及
file	是	DatabaseFile object	参数解释：数据库文件。约束限制：不涉及取值范围：不涉及默认取值：不涉及
columns	是	Array of strings	参数解释：数据文件列名。约束限制：文件列名数量范围为[2-12]，文件列名长度为[1-128]个字符。取值范围：不涉及默认取值：不涉及
shareable	否	Boolean	参数解释：是否打开组织共享。约束限制：不涉及取值范围： true：组织共享。 false：组织不共享。默认取值： false

表4 DatabaseFile
参数	是否必选	参数类型	描述
source	是	String	参数解释：数据库文件来源。约束限制：不涉及取值范围： public：公共数据 private：私有数据默认取值：不涉及
url	是	String	参数解释：文件URL。约束限制：当数据源source为外部网络数据时为https地址，为用户私有数据中心时为空间路径，为公共数据场景时为obs地址。取值范围：仅支持csv格式文件，长度为[1-2000]个字符。默认取值：不涉及
eihealth_project_id	否	String	参数解释：数据库文件所在空间ID，您可以从获取空间ID中获取。约束限制：仅文件为数据中心时填写。取值范围：仅支持字母、数字、中划线和下划线，长度为[1-128]个字符。默认取值：不涉及

响应参数

状态码：201

表5 响应Body参数
参数	参数类型	描述
id	String	参数解释：数据库ID。约束限制：不涉及取值范围：不涉及默认取值：不涉及

请求示例

创建数据库，数据库名称为database_name，上传空间桶中file/test.csv的数据库数据，设置列名为SMILES和NAME，打开共享开关。

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

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