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

创建逻辑库V3

功能介绍

创建DDM逻辑库。

接口约束

创建前需确保已导入RDS实例，RDS实例状态正常且没有被其他DDM实例关联使用。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

  • URL格式

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

  • 参数说明
表1 路径参数

参数

参数类型

是否必选

描述

project_id

String

是

租户在某一region下的project ID。

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

instance_id

String

是

DDM实例ID。

请求

表2 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

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

  • 长度为2-48个字符。
  • 必须以小写字母开头。
  • 可以包含小写字母、数字、下划线，不能包含大写字母和其它特殊字符。
  • 禁用关键字： "information_schema"、"mysql"、"performance_schema"、"sys"。

最小长度：2

最大长度：48

shard_mode

是

String

逻辑库的拆分模式。

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

枚举值：

  • cluster
  • single

shard_number

是

Integer

同一种工作模式下逻辑库分片的数量，大于等于关联的RDS数量，小于等于关联rds数量*64。

dn_instances

是

Array of DatabaseDnInstanceInfo objects

逻辑库关联的DN实例。
表3 DatabaseDnInstanceInfo

参数

是否必选

参数类型

描述

id

是

String

逻辑库关联的DN实例的ID。

user_name

是

String

关联DN实例的用户。

user_password

是

String

关联DN实例的密码。

请求示例

  • 创建逻辑库时不新建DDM账号，关联已有账号。 
    POST https://{endpoint}/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"
    }
  ]
}

响应消息

  • 正常响应参数说明
    表4 响应Body参数

    参数

    参数类型

    描述

    job_id

    String

    删除逻辑库的任务ID。

    name

    String

    逻辑库名。
  • 正常响应示例 
    {
 "job_id": "eff1d289-xxxx-xxxx-8b9f-463ea07c000c"，
  "name": "mytestdb"
}
  • 异常响应

    请参见异常请求结果。

状态码

错误码

请参见错误码。

父主题： 逻辑库管理

相关文档