文档首页/ 分布式数据库中间件 DDM/ API参考（吉隆坡区域）/ DDM实例管理/ 申请DDM实例
更新时间：2022-08-16 GMT+08:00
查看PDF
分享

申请DDM实例

功能介绍

申请一个DDM实例。

接口约束

DDM运行于虚拟私有云。申请DDM实例前，需保证有可用的虚拟私有云，并且已配置好子网与安全组。

URI

POST /v1/{project_id}/instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

参数

是否必选

参数类型

描述

instance

是

CreateDDMInstanceDetail object

实例相关信息的集合。

extend_param

否

CreateDDMInstanceExtendParam object

扩展参数。
表4 申请DDM实例参数

参数

是否必选

参数类型

描述

name

是

String

DDM实例名称，命名要求如下。

  • 长度为4-64个字符。
  • 必须以字母开头。
  • 可以包含字母、数字、中划线，不能包含其它特殊字符。

最小长度：4

最大长度：64

flavor_id

是

String

规格ID。

node_num

是

Integer

节点个数。

engine_id

是

String

引擎ID。

enterprise_project_id

否

String

企业项目ID。

available_zones

是

Array of strings

可用区code。

vpc_id

是

String

虚拟私有云的ID。

security_group_id

是

String

安全组ID。

subnet_id

是

String

子网ID。

param_group_id

否

String

参数模板ID。
表5 申请DDM实例附加参数

参数

是否必选

参数类型

描述

charge_mode

否

String

取值范围：

  • postPaid： 默认值为postPaid。

响应参数

状态码： 200

表6 响应Body参数

参数

参数类型

描述

id

String

实例ID。

状态码： 400

表7 响应Body参数

参数

参数类型

描述

errCode

String

业务错误码

externalMessage

String

错误信息

请求示例

  • 请求示例 
    POST https://{endpoint}/v1/{project_id}/instances

{
  "instance" : {
    "name" : "ddm-test-001",
    "flavor_id" : "8f2e696c-a9c1-30bd-af90-25522bc67606",
    "node_num" : "4",
    "engine_id" : "2325a707-0361-8be6-dd01-13474bbac437",
    "enterprise_project_id" : "0",
    "available_zones" : [ "az1xahz" ],
    "vpc_id" : "e1d886ec-cfe7-4cd4-b748-fc55a10b4172",
    "security_group_id" : "035b70ed-319b-4086-9fd7-62a2e8548b2e",
    "subnet_id" : "f942f970-1a02-4eee-8927-xxxxxxxx",
     "param_group_id" : "035b70ed-319b-4086-9fd7-xxxxxxxx"
  }
}
  • 请求示例 
    POST https://{endpoint}/v1/{project_id}/instances

{
  "instance" : {
    "name" : "ddm-test-002",
    "flavor_id" : "8f2e696c-a9c1-30bd-af90-25522bc67606",
    "node_num" : 4,
    "engine_id" : "2325a707-0361-8be6-dd01-13474bbac437",
    "enterprise_project_id" : "0",
    "available_zones" : [ "az1xahz" ],
    "vpc_id" : "e1d886ec-cfe7-4cd4-b748-fc55a10b4172",
    "security_group_id" : "035b70ed-319b-4086-9fd7-62a2e8548b2e",
    "subnet_id" : "f942f970-1a02-4eee-8927-e8670ce5a882"
    "param_group_id" : "035b70ed-319b-4086-9fd7-xxxxxxxx"
  },
  "extend_param" : {
    "charge_mode" : "postPaid"
  }
}

响应示例

状态码： 200

OK

{
  "id" : "",
  "order_id" : "CS1810251738L8VVD"
}

状态码： 400

bad request

{
  "externalMessage" : "Parameter error.",
  "errCode" : "DBS.280001"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： DDM实例管理