功能介绍

创建GaussDB(for openGauss)实例。GaussDB(for openGauss)支持创建分布式和实例。

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

URI

• URI格式

  POST https://{Endpoint}/opengauss/v3/{project_id}/instances

• URI样例

  https://gaussdb.cn-north-4.myhuaweicloud.com/opengauss/v3/054b61972980d4552f0bc00ac8d3f5cd/instances

• 参数说明

  表1 参数说明

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

请求消息

• 请求样例

响应消息

• 正常响应要素说明

  表8 要素说明

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

  表9 instance说明

  名称	参数类型	说明
  id	String	实例id。
  name	String	实例名称。用于表示实例的名称，同一租户下，同类型的实例名称可相同。 取值范围：4~64个字符之间，必须以字母开头，不区分大小写，可以包含字母、数字、中划线或者下划线，不能包含其他的特殊字符。
  status	String	实例状态。如BUILD，表示创建中。 仅创建按需实例时会返回该参数。
  datastore	Object	数据库信息。 详情请参见表10。
  ha	Object	数据库部署形态。 详情请参见表11。
  replica_num	Integer	实例副本数。
  port	String	数据库端口信息，与请求参数相同。
  backup_strategy	Object	自动备份策略。 详情请参见表12。
  enterprise_project_id	String	项目标签。
  flavor_ref	String	规格码，取值范围：非空。参考表1中GaussDB(for openGauss)的“规格编码”列内容获取。
  volume	Object	volume信息。 详情请参见表13。
  region	String	区域ID。
  availability_zone	String	可用区ID。
  vpc_id	String	虚拟私有云ID。
  subnet_id	String	子网的网络ID信息。
  security_group_id	String	实例所属的安全组。
  charge_info	Object	付费方式信息，仅支持按需。 详情请参见表14。

  表10 datastore字段数据结构说明

  名称	参数类型	说明
  type	String	数据库引擎，返回值如下： GaussDB(for openGauss)
  version	String	数据库版本。

  表11 ha字段数据结构说明

  名称	参数类型	说明
  mode	String	GaussDB(for openGauss)为分布式模式，取值：enterprise(企业版) ，不区分大小写。
  replication_mode	String	备机同步参数。 取值： GaussDB(for openGauss)为“sync”。 说明： “sync”为同步模式。
  consistency	String	GaussDB(for openGauss)的预留参数：指定事务一致性类型，取值范围：strong（强一致性） | eventual(最终一致性)。

  表12 backup_strategy字段数据结构说明

  名称	参数类型	说明
  start_time	String	备份时间段。自动备份将在该时间段内触发。 取值范围：非空，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同，且取值必须为00、15、30或45。 取值示例： 08:15-09:15 23:00-00:00 如果请求体中不填写“backup_strategy”字段，则响应体中 “start_time”默认返回“02:00-03:00”。
  keep_days	Integer	指定已生成备份文件的可保存天数。 取值范围：1～732。如果请求体中不填写“backup_strategy”字段，则响应体中 “keep_days”默认返回“7”。

  表13 volume字段数据结构说明

  名称	参数类型	说明
  type	String	磁盘类型。 取值如下，区分大小写： ULTRAHIGH，表示SSD盘。
  size	Integer	磁盘大小。 GaussDB(for openGauss)分布式实例创建时需指定大小：要求必须为（分片数 * 40GB）的倍数，取值范围：（分片数*40GB）~（分片数*16TB）。

  表14 chargeInfo字段数据结构说明

  名称	参数类型	说明
  charge_mode	String	创建类型，支持按需。

• 正常响应样例}

  GaussDB(for openGauss)企业版实例：
  {
      "instance": {
          "id": "ad8cd1440aa94a02ae4580fcbebb3143in14",
          "name": "user1-v3-independent",
          "status": "BUILD",
          "datastore": {
              "type": "GaussDB(for openGauss)",
              "version": "1.1"
          },
          "ha": {
              "mode": "Enterprise",
              "replication_mode": "sync",
              "consistency": "strong"
          },
          "port": "8000",
          "volume": {
              "type": "ULTRAHIGH",
              "size": 120
          },
          "replica_num": 3,
          "region": "cn-north-4",
          "backup_strategy": {
              "start_time": "17:00-18:00",
              "keep_days": 7
          },
          "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in",
          "availability_zone": "cn-north-4a,cn-north-4a,cn-north-4a",
          "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329",
          "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189",
          "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f",
          "charge_info": {
              "charge_mode": "postPaid"
          }
      },
      "job_id": "30f2790a-a5b6-4a13-a5ab-733c746609af"
  }
  

• 异常响应

  请参见异常请求结果。

状态码

请参见状态码。

错误码

请参见错误码。