文档首页/文档数据库服务 DDS/API参考（联盟区域）/API v3（推荐）/管理数据库和用户/创建数据库角色
更新时间：2026-01-07 GMT+08:00
查看PDF
分享

创建数据库角色

接口说明

给指定实例创建数据库角色。

约束说明

  • 该接口只支持DDS社区版。
  • 实例在创建、规格变更、修改端口、冻结、重启等过程中以及状态为非“normal”时，不允许执行该操作。

URI

  • URI格式

    POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db-role

表1 路径参数

名称

类型

IN

是否必选

描述

project_id

string

path

是

租户在某一region下的project ID。请参考获取项目ID章节获取项目编号。

instance_id

string

path

是

实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

请求参数

表2 请求Header参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

是

用户Token。

表3 参数说明

名称

参数类型

是否必选

描述

role_name

String

是

创建角色名称。

取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、中划线、下划线和点。

roles

Array of objects

否

新建角色所继承的角色列表。请参见表4。

db_name

String

否

角色所在的数据库名称，默认admin。

取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、下划线。

表4 roles字段数据结构说明

名称

参数类型

是否必选

描述

role_db_name

String

是

被继承角色所在数据库名称。

取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、下划线。

role_name

String

是

被继承角色的名称。

取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、中划线、下划线和点。

  • 请求示例 
    {
    "role_name": "testRole",
    "roles" : [{
        "role_name":"readWrite",
        "role_db_name":"testDb" 
    }],
    "db_name":"testDb" 
}

响应参数

  • 响应示例 
    {}

状态码

详情请参见状态码。

错误码

详情请参见错误码。