文档首页/ 分布式数据库中间件 DDM/ API参考/ API（推荐）/ 逻辑库管理/ 创建逻辑库V3
更新时间：2025-11-28 GMT+08:00
查看PDF
分享

创建逻辑库V3

功能介绍

创建DDM逻辑库。

URI

POST /v3/{project_id}/instances/{instance_id}/databases

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的项目ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

逻辑库名称，需要满足以下条件：

  • 长度为2-48个字符。

  • 必须以小写字母开头。

  • 可以包含小写字母、数字、下划线，不能包含大写字母和其它特殊字符。

  • 禁用关键字：

"information_schema"、"mysql"、"performance_schema"、"sys"。

shard_mode

是

String

逻辑库的拆分模式。

  • cluster表示逻辑库是拆分模式。

  • single表示逻辑库是非拆分模式。

shard_number

是

Integer

同一种工作模式下逻辑库分片的数量。

  • shard_unit不为空， shard_unit与关联DN数量的乘积

  • shard_unit为空，大于关联的DN数量，小于等于关联DN数量*64。

dn_instances

是

Array of DatabaseDnInstances objects

逻辑库关联的DN信息,最大个数为256。
表4 DatabaseDnInstances

参数

是否必选

参数类型

描述

id

是

String

逻辑库关联的DN实例的id

user_name

是

String

关联DN实例的用户名。

user_password

是

String

关联DN实例的用户密码。

响应参数

状态码：202

表5 响应Body参数

参数

参数类型

描述

name

String

逻辑库名称，需要满足以下条件：

  • 长度为2-48个字符。

  • 必须以小写字母开头。

  • 可以包含小写字母、数字、下划线，不能包含大写字母和其它特殊字符。

  • 禁用关键字：

"information_schema"、"mysql"、"performance_schema"、"sys"。

job_id

String

工作流id。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码：500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

POST https://cn-north-1/v3/{project_id}/instances/{instance_id}/databases

{
  "name" : "mytestdb",
  "shard_mode" : "cluster",
  "shard_number" : 8,
  "dn_instances" : [ {
    "id" : "f296c394f13f48449d715bf99af07e59in01",
    "user_name" : "root",
    "user_password" : "PassWord_234"
  } ]
}

响应示例

状态码：202

Success.

{
  "name" : "mytestdb",
  "job_id" : "0e20f87b-cb3a-4612-a2ae-16e3f04e1f4c"
}

状态码：400

bad request

{
  "error_code" : "DBS.280001",
  "error_msg" : "Parameter error."
}

状态码：500

server error

{
  "error_code" : "DBS.280001",
  "error_msg" : "Parameter error."
}

状态码

状态码

描述

202

Success.

400

bad request

500

server error

错误码

请参见错误码。

父主题： 逻辑库管理

相关文档