创建数据库实例-凯发k8国际娱乐官网入口

功能介绍

创建gaussdb实例。

• 调用接口前，您需要了解api 。
• 调用接口前，您需要提前获取到，即下文中的endpoint值。

调试

您可以在中调试该接口。

uri

• uri格式

  post https://{endpoint}/v3/{project_id}/instances

• uri样例

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

• 参数说明

  表1 参数说明

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

请求消息

• 请求样例

响应消息

• 正常响应要素说明

  表8 要素说明

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

  表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	规格码，取值范围：非空。参考中gaussdb的“规格编码”列内容获取。
  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
  version	string	数据库版本。

  表11 ha字段数据结构说明

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

  表12 backup_strategy字段数据结构说明

  名称	参数类型	说明
  start_time	string	备份时间段。自动备份将在该时间段内触发。 取值范围：非空，格式必须为hh:mm-hh:mm且有效，当前时间指utc时间。 hh取值必须比hh大1。 mm和mm取值必须相同，且取值必须为整点。 取值示例： 08:00-09:00 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盘。 essd,表示极速云盘。
  size	integer	磁盘大小。 gaussdb分布式实例创建时需指定大小：要求必须为（分片数 * 40gb）的倍数，取值范围：（分片数*40gb）~（分片数*16tb）。

  表14 charge_info字段数据结构说明

  名称	参数类型	说明
  charge_mode	string	计费模式。 postpaid：后付费，即按需付费。 prepaid：预付费，即包年/包月。
  period_type	string	订购周期类型。month：包月。year：包年。说明：“charge_mode”为“prepaid”时生效，且为必选值。 枚举值： month year
  period_num	integer	“charge_mode”为“prepaid”时生效，且为必选值，指定订购的时间。 取值范围： 当“period_type”为“month”时，取值为1~9。当“period_type”为“year”时，取值为1~3。
  is_auto_renew	boolean	创建包周期实例时可指定,表示是否自动续订,续订时会自动支付。 按月订购时续订周期默认为1个月,按年订购时续订周期默认为1年,续订周期可自定义修改。 true,表示自动续订。 false,表示不自动续订,默认为该方式。
  is_auto_pay	boolean	创建包周期实例时可指定，表示是否自动从账户中支付，该字段不影响自动续订的k8凯发的支付方式。 true，表示自动从账户中支付。 false，表示手动从账户中支付，默认为该k8凯发的支付方式。

• 正常响应样例

  gaussdb企业版实例：
  {
      "instance": {
          "id": "ad8cd1440aa94a02ae4580fcbebb3143in14",
          "name": "user1-v3-independent",
          "status": "build",
          "datastore": {
              "type": "gaussdb",
              "version": "1.4"
          },
          "ha": {
              "mode": "enterprise",
              "replication_mode": "sync",
              "consistency": "strong"
          },
          "port": "8000",
          "volume": {
              "type": "ultrahigh",
              "size": 120
          },
          "replica_num": 3,
          "region": "aaa",
             "region": "aaa",
          "backup_strategy": {
              "start_time": "17:00-18:00",
              "keep_days": 7
          },
          "enterprise_project_id": "0",
          "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in",
          "availability_zone": "bbb,bbb,bbb",
             "availability_zone": "bbb,ccc",
          "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"
  }
  

• 异常响应

  请参见。

状态码

• 正常

  202

• 异常

  请参见。

错误码

请参见。