更新时间:2022-12-07 GMT+08:00

创建数据库

功能介绍

该API用于新增数据库。

URI

  • URI格式:

    POST /v1.0/{project_id}/databases

  • 参数说明
    表1 URI参数

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目编号,用于资源隔离。获取方式请参考获取项目ID

请求消息

表2 请求参数

参数名称

是否必选

参数类型

说明

database_name

String

新增数据库名称。

  • 数据库名称只能包含数字、英文字母和下划线,但不能是纯数字,且不能以下划线开头。
  • 数据库名称大小写不敏感且不能为空。
  • 输入长度不能超过128个字符。
说明:

“default”为内置数据库,不能创建名为“default”的数据库。

description

String

新增数据库的描述信息。

enterprise_project_id

String

企业项目ID,“0”表示default,即默认的企业项目。

说明:

开通了企业管理服务的用户可设置该参数绑定指定的项目。

tags

Array of Objects

数据库的标签。具体请参考表3

表3 tags参数

参数名称

是否必选

参数类型

说明

key

String

标签的键。

value

String

标签的值。

响应消息

表4 响应参数

参数名称

是否必选

参数类型

说明

is_success

Boolean

执行请求是否成功。“true”表示请求执行成功。

message

String

系统提示信息,执行成功时,信息可能为空。

请求示例

{
  "database_name": "db1",
  "description": "this is for test"
}

响应示例

{
 "is_success": true,
 "message": ""
}

状态码

状态码如表5所示。

表5 状态码

状态码

描述

200

创建成功。

400

请求错误。

500

内部服务器错误。

错误码

调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码