租户管理
DMP提供openapi开放接口可以对租户进行管理,比如查看租户所使用的数据库(RDS)列表,创建数据库(RDS)实例,创建租户等
租户创建流程示意图
OpenAPI开放接口说明
一、调试环境
第三方OpenAPI独立部署环境:第三方OpenAPI独立部署域名
二、OpenAPI全局认证GET(QueryString)参数
apikey: OpenAPI接口调用权限认证密钥(DMP-ADMIN中的项目管理中项目信息的OpenApi Key)
三、OpenAPI接口
1、获取数据库(RDS)列表:
接口(Path): /openapi/rds-list
请求方法(Method): GET
返回响应:
{
"result": true,
"data": [
{
"id": "39d9f199-57bd-d477-fd11-27f7f18a7a96",
"host": "localhost",
"port": 5588,
"name": "测试数据库",
"account": "test"
}
],
"msg": "ok"
}
2、新增数据库(RDS):
接口(Path): /openapi/rds
请求方法(Method): POST
请求头(Headers):
Content-Type: application/json
请求体数据(Body):
{
"name": "rds_instance",
"host": "000.0.0.0",
"account": "****",
"pwd": "****",
"port": 3306
}
返回响应(Response):
{
"result": true,
"msg": "ok",
"data": "######", # 返回新创建数据库实例ID
}
3、创建租户
接口(Path): /openapi/projects
请求方法(Method): POST
请求头(Headers):
Content-Type: application/json
请求体数据(Body):
{
"title": "test{平台标题}",
"name{项目名称}": "test",
"code{项目代码}": "test",
"description{描述(可选)}": "xx",
"rds_id{可选参数,当deliver_strategy是自定义时使用}": "xx",
"rds_strategy{分发到rds策略.支持的策略:average(均匀分配),custom(自定义)}": "average",
"type{平台或可视化}": "平台",
"need_mreporting{是否需要移动报表}": 0,
"admin_pwd{管理员初始密码}": "",
"odps_proj{type为平台时需要}": "xx",
"odps_access_id{type为平台时需要}": "zz",
"odps_access_secret{type为平台时需要}": "xx",
"is_domain_account{是否使用域帐号登录}": 0,
"need_mreporting{是否创建移动报表租户}": 0
}
返回响应(Response):
{
"result": true,
"msg": "ok",
"data": {
'task_id': task_id # 异步创建项目(租户)任务ID
}
}