创建实例

功能介绍

创建云数据库GaussDB(for MySQL)实例。

该接口计划于2025-03-31下线，建议及时切换到新接口创建数据库实例。

• 调用接口前，您需要了解API认证鉴权。
• 调用接口前，您需要提前获取到地区和终端节点，即下文中的Endpoint值。

URI

• URI格式

  POST https://{endpoint}/mysql/v3/{project_id}/instances

• URI样例

  POST https://{endpoint}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances

• 参数说明

  表1 参数说明

  名称	是否必选	说明
  project_id	是	租户在某一Region下的project ID。 获取方法请参见获取项目ID。

请求消息

请求样例中参数“region”的值为示例值。

• 请求样例

  {
  "charge_info":{
          "charge_mode":"postPaid"
      },
      "region":"xxx",
      "name":"gaussdb-2d34",
      "datastore":{
          "type":"gaussdb-mysql",
          "version":"8.0"
      },
      "mode":"Cluster",
      "flavor_ref":"gaussdb.mysql.large.x86.4",
      "vpc_id":"f7ee62e2-9705-4523-ba49-a85ea1a1fa87",
      "subnet_id":"140af7bf-a9da-4dcf-8837-34199fd6d186",
      "security_group_id":"c7f69884-fe2b-4630-8114-70a11499d902",
      "configuration_id":"43570e0de32e40c5a15f831aa5ce4176pr07",
      "password":"xxxx",
      "backup_strategy":{
          "start_time":"17:00-18:00"
      },
      "time_zone":"UTC+08:00",
      "availability_zone_mode":"multi",
      "master_availability_zone":"az1pod1",
      "slave_count":1,
      "enterprise_project_id":"0",
      "lower_case_table_names":1
  }

响应消息

• 正常响应要素说明

  表8 要素说明

  名称	参数类型	说明
  instance	Object	实例信息。 详情请参见表9。
  job_id	String	实例创建的任务id。 仅创建按需实例时会返回该参数。
  order_id	String	订单号, 创建包年包月时返回该参数。

  表9 instance字段数据结构说明

  名称	参数类型	说明
  id	String	实例id。
  name	String	实例名称。用于表示实例的名称，同一租户下，同类型的实例名称可相同。 取值范围：4~64个字符之间，必须以字母开头，不区分大小写，可以包含字母、数字、中划线或者下划线，不能包含其他的特殊字符。
  status	String	实例状态。 仅创建按需实例时会返回该参数。
  datastore	Object	数据库信息。 详情请参见表10。
  mode	String	实例类型，仅支持Cluster。
  configuration_id	String	参数组ID。
  port	String	数据库端口信息，与请求参数相同。
  backup_strategy	Object	自动备份策略。 详情请参见表11。
  enterprise_project_id	String	企业项目ID。与请求参数相同。
  region	String	区域ID。与请求参数相同。
  availability_zone_mode	String	可用区模式。与请求参数相同。
  master_ availability_zone	String	主可用区ID。
  vpc_id	String	虚拟私有云ID。与请求参数相同。
  security_group_id	String	安全组ID。与请求参数相同。
  subnet_id	String	子网ID。与请求参数相同。
  flavor_ref	String	规格码。与请求参数相同。 详情请参见表3。
  charge_info	Object	付费方式信息，支持包年/包月和按需。 详情请参见表12。

  表10 datastore字段数据结构说明

  名称	参数类型	说明
  type	String	数据库引擎
  version	String	数据库版本。

  表11 backup_strategy字段数据结构说明

  名称	参数类型	说明
  start_time	String	备份时间段。自动备份将在该时间段内触发。
  keep_days	Integer	指定已生成备份文件的可保存天数。

  表12 charge_info字段数据结构说明

  名称	参数类型	说明
  charge_mode	String	创建类型，支持包年/包月和按需。
  period_num	Integer	订购周期长度，按月计算。 “charge_mode”为“prePaid”，即包年/包月时该字段生效。

响应样例中参数“region”和“master_availability_zone”的值为示例值。

• 正常响应样例

  {
      "instance":{
          "id":"5eebbb4c0f9f4a99b42ed1b6334569aain07",
          "name":"gaussdb-2d34",
          "status":"BUILD",
          "datastore":{
              "type":"gaussdb-mysql",
              "version":"8.0"
          },
          "mode":"Cluster",
          "configuration_id": "",
          "port":null,
          "backup_strategy":{
              "start_time":null,
              "keep_days":"7"
          },
          "enterprise_project_id": "0",
          "region":"aaa",
          "availability_zone_mode":"multi",
          "master_availability_zone":"aaa",
          "vpc_id":"f7ee62e2-9705-4523-ba49-a85ea1a1fa87",
          "security_group_id":"c7f69884-fe2b-4630-8114-70a11499d902",
          "subnet_id":"140af7bf-a9da-4dcf-8837-34199fd6d186"
          "charge_info":{
              "charge_mode":"postPaid"
          },
          "flavor_ref":"gaussdb.mysql.large.x86.4"
      },
      "job_id":"43672fe5-56bd-47f1-8fd1-595cded08a7c"
      }

状态码

请参见状态码。

错误码

请参见错误码。