Creating a DB Instance

Function

This API is used to create a GaussDB(openGauss) DB instance. GaussDB(openGauss) supports distributed instances.

• Before calling an API, you need to understand the API in Using APIs.
• Before calling this API, obtain the required region and endpoint.

URI

• URI format

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

• Example

  https://gaussdb.eu-de.otc.t-systems.com/opengauss/v3/0483b6b16e954cb88930a360d2c4e663/instances

• Parameter description

  Table 1 Parameter description

  Name	Mandatory	Description
  project_id	Yes	Specifies the project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID.

Request

• Request example

Creating a DB instance of the enterprise edition:
{
    "name": "user1-v3-independent", 
    "datastore": {
        "type": "GaussDB(openGauss)", 
        "version": "1.1"
    }, 
    "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in", 
    "volume": {
        "type": "ULTRAHIGH", 
        "size": 120
    },
    "region": "eu-de",
     "availability_zone": "eu-de-01,eu-de-01,eu-de-01",
    "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329", 
    "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189", 
    "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f", 
    "backup_strategy": {
        "start_time": "17:00-18:00", 
        "keep_days": 7
    }, 
    "charge_info": {
        "charge_mode": "postPaid"
    }, 
    "password": "Gauss_234", 
    "configuration_id": "b000d7c91f1749da87315700793a11d4pr14", 
    "time_zone": "UTC+08:00",
    "ha":{
        "mode":"enterprise",
        "consistency":"strong",
        "replication_mode":"sync"
    },
    "sharding_num":1,
    "coordinator_num":1,
    "port":8000
}

Response

• Normal response

  Table 8 Parameter description

  Name	Type	Description
  instance	Object	Indicates the DB instance information. For details, see Table 9.
  job_id	String	Indicates the ID of the DB instance creation task. This parameter is returned only for the creation of pay-per-use DB instances.

  Table 9 instance field data structure description

  Name	Type	Description
  id	String	Indicates the DB instance ID.
  name	String	Indicates the DB instance name. DB instances of the same type can have same names under the same tenant. The value must be 4 to 64 characters in length and start with a letter. It is case-insensitive and contains only letters, digits, hyphens (-), and underscores (_).
  status	String	Indicates the DB instance status. For example, BUILD indicates that the DB instance is being created. Returned only for the creation of pay-per-use DB instances.
  datastore	Object	Indicates the database information. For details, see Table 10.
  ha	Object	Returned when a distributed instance is created. For details, see Table 11.
  port	String	Indicates the database port, which is the same as the request parameter.
  backup_strategy	Object	Indicates the automated backup policy. For details, see Table 12.
  flavor_ref	String	Indicates the specification code. The value cannot be empty. For details on how to obtain the GaussDB(openGauss) specification code, see Table 1.
  volume	Object	Indicates the volume information. For details, see Table 13.
  region	String	Indicates the region ID.
  availability_zone	String	Indicates the AZ ID.
  vpc_id	String	Indicates the VPC ID.
  subnet_id	String	Indicates the network ID of the subnet.
  security_group_id	String	Indicates the security group to which the DB instance belongs.
  charge_info	Object	Indicates the payment mode. Only pay-per-use is supported. For details, see Table 14.

  Table 10 datastore field data structure description

  Name	Type	Description
  type	String	Indicates the DB engine. Value: GaussDB(openGauss)
  version	String	Indicates the database version.

  Table 11 ha field data structure description

  Name	Type	Description
  mode	String	Indicates the distributed model. The returned value is Enterprise. Currently, only the distributed model is supported.
  replication_mode	String	Indicates the replication mode for the standby node. Value: For GaussDB(openGauss), the value is sync. NOTE: sync indicates the synchronous replication mode.
  consistency	String	Indicates the GaussDB(openGauss) reserved parameter, referring to the instance consistency type. The value can be strong or eventual.

  Table 12 backup_strategy field data structure description

  Name	Type	Description
  start_time	String	Indicates the backup time window. Automated backups will be triggered during the backup time window. The value cannot be empty. It must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format. The HH value must be 1 greater than the hh value. The values of mm and MM must be the same and must be set to any of the following: 00, 15, 30, or 45. Example value: 08:15-09:15 23:00-00:00 If backup_strategy in the request body is empty, 02:00-03:00 is returned for start_time by default.
  keep_days	Integer	Indicates the retention days for specific backup files. The value ranges from 0 to 732. If this parameter is not specified or set to 0, the automated backup policy is disabled. If backup_strategy in the request body is empty, 7 is returned for keep_days by default.

  Table 13 volume field data structure description

  Name	Type	Description
  type	String	Indicates the volume type. Its value can be any of the following and is case-sensitive: ULTRAHIGH: indicates the SSD type.
  size	Integer	Indicates the volume size. When creating a distributed instance, you need to specify the size to be a multiple of the number of shards multiplied by 40 GB, ranging from the number of shards multiplied by 40 GB to the number of shards multiplied by 16 TB.

  Table 14 chargeInfo field data structure description

  Name	Type	Description
  charge_mode	String	Indicates the billing information, which is pay-per-use.

• Example normal response

  Creating a DB instance of the enterprise edition:
  {
      "instance": {
          "id": "ad8cd1440aa94a02ae4580fcbebb3143in14",
          "name": "user1-v3-independent",
          "status": "BUILD",
          "datastore": {
              "type": "GaussDB(openGauss)",
              "version": "1.1"
          },
          "ha": {
              "mode": "Enterprise",
              "replication_mode": "sync",
              "consistency": "strong"
          },
          "port": "8000",
          "volume": {
              "type": "ULTRAHIGH",
              "size": 120
          },
  	"region": "eu-de",
          "backup_strategy": {
              "start_time": "17:00-18:00",
              "keep_days": 7
          },
          "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in",
  	"availability_zone": "eu-de-01,eu-de-01,eu-de-01",
          "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"
  }

• Abnormal response

  For details, see Abnormal Request Results.

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.