Creating a DB Instance

Function

This API is used to create a single-node or primary/standby FlexusRDS instance.

This API allows you to set the X-Client-Token request header in the HTTP request header when you create a FlexusRDS instance, to ensure the request idempotence. For details, see Idempotent Requests.

URI

• URI format

  POST /v3/{project_id}/instances

• Parameter description

  Table 1 Parameters

  Parameter	Mandatory	Type	Description
  project_id	Yes	String	Explanation: Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints: N/A Value range: N/A Default value: N/A

Request

Example Request

NOTE:

The values of region and availability_zone in the example request are only for reference.

• Create a single-node FlexusRDS instance.

  POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances
  
  {
  	"name": "flexusrds-instance",
  	"datastore": {
  		"type": "MySQL",
  		"version": "5.7"
  	},
  	"flavor_ref": "rds.mysql.y1.large.2",
  	"volume": {
  		"type": "CLOUDSSD",
  		"size": 100
  	},
  	"region": "aaa",
  	"availability_zone": "bbb",
  	"port": 3306,
  	"backup_strategy": {
  		"start_time": "08:15-09:15",
  		"keep_days": 12
  	},
  	"charge_info": {
  		"charge_mode": "prePaid"
  	},
  	"password": "****",
  	"time_zone": "UTC+04:00",
  	"tags": [
  		{
  			"key": "key1",
  			"value": "value1"
  		},
  		{
  			"key": "key2",
  			"value": "value2"
  		}
  	],
  	"is_flexus": true
  }

• Create a primary/standby FlexusRDS instance.

  {
  	"name": "flexusrds-instance-ha",
  	"datastore": {
  		"type": "MySQL",
  		"version": "5.7"
  	},
  	"ha": {
  		"mode": "ha",
  		"replication_mode": "semisync"
  	},
  	"flavor_ref": "rds.mysql.y1.xlarge.2.ha",
  	"volume": {
  		"type": "CLOUDSSD",
  		"size": 100
  	},
  	"region": "aaa",
  	"availability_zone": "bbb",
  	"port": 3306,
  	"backup_strategy": {
  		"start_time": "08:15-09:15",
  		"keep_days": 12
  	},
  	"charge_info": {
  		"charge_mode": "prePaid"
  	},
  	"password": "****",
         "tags": [
  		{
  			"key": "key1",
  			"value": "value1"
  		},
  		{
  			"key": "key2",
  			"value": "value2"
  		}
  	],
  	"is_flexus": true
  }

Response

• Normal response

  Table 9 Parameters

  Parameter	Type	Description
  instance	Object	Explanation: Instance information. For details, see Table 10.
  order_id	String	Explanation: Order ID. Value range: N/A

  Table 10 instance field data structure description

  Parameter	Type	Description
  id	String	Explanation: Instance ID. Value range: N/A
  name	String	Explanation: Instance name. Instances of the same type can have the same name under the same tenant. Value range: The value is the same as that of the corresponding request parameter.
  status	String	Explanation: Instance status. Value range: BUILD: indicates that the instance is being created.
  datastore	Object	Explanation: Database information. For details, see Table 11.
  ha	Object	Explanation: HA configuration. This parameter is returned only when primary/standby instances are created. For details, see Table 12.
  port	String	Explanation: Database port. Value range: The value is the same as that of the corresponding request parameter.
  backup_strategy	Object	Explanation: Automated backup policy. For details, see Table 13.
  flavor_ref	String	Explanation: Specification code. Value range: The value is the same as that of the corresponding request parameter.
  volume	Object	Explanation: Volume information. For details, see Table 14.
  region	String	Explanation: Region ID. Value range: The value is the same as that of the corresponding request parameter.
  availability_zone	String	Explanation: AZ ID. Value range: The value is the same as that of the corresponding request parameter.
  vpc_id	String	Explanation: VPC ID. Value range: vpc-default-smb
  subnet_id	String	Explanation: Subnet ID. Value range: subnet-default-smb
  security_group_id	String	Explanation: Security group which the instance is associated with. Value range: sg-default-smb
  charge_info	Object	Explanation: Billing information. For details, see Table 15.

  Table 11 datastore field data structure description

  Parameter	Type	Description
  type	String	Explanation: DB engine. Value range: MySQL
  version	String	Explanation: DB engine version. Value range: 5.7 or 8.0

  Table 12 ha field data structure description

  Parameter	Type	Description
  mode	String	Explanation: Instance type. Value range: HA (case-insensitive)
  replication_mode	String	Explanation: Replication mode for the standby instance. Value range: async: asynchronous replication semisync: semi-synchronous replication

  Table 13 backupStrategy field data structure description

  Parameter	Type	Description
  start_time	String	Explanation: Backup time window. Automated backups will be triggered during the backup time window. Value range: The value cannot be empty. It must be a valid value in the "hh:mm-HH:MM" format. The current time is the UTC time. 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 00, 15, 30, or 45. Example: 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	Explanation: Retention days for backups. Value range: 0–732. 0 indicates that the automated backup policy is disabled. To extend the retention period, contact customer service. Automated backups can be retained for up to 2,562 days. If backup_strategy in the request body is empty, 7 is returned for keep_days by default.

  Table 14 volume field data structure description

  Parameter	Type	Description
  type	String	Explanation: Storage type. Value range: CLOUDSSD (case-sensitive): cloud SSD storage. This storage type is supported only with general-purpose and dedicated instances.
  size	Integer	Explanation: Storage space. Value range: 40–4000, in GB. The value must be a multiple of 10.

  Table 15 chargeInfo field data structure description

  Parameter	Type	Description
  charge_mode	String	Explanation: Billing mode. Value range: prePaid: indicates the yearly/monthly billing mode.
  period_num	Integer	Explanation: Subscription period. Value range: The value is the same as that of the corresponding request parameter.

NOTE:

The values of region and availability_zone in the example response are only for reference.

• Example normal response

  Single-node FlexusRDS instance created.

  {
  	"instance": {
  		"id": "dsfae23fsfdsae3435in01",
  		"name": "flexusrds-instance",
  		"datastore": {
  			"type": "MySQL",
  			"version": "5.7"
  		},
  		"flavor_ref": "rds.mysql.y1.large.2",
  		"volume": {
  			"type": "CLOUDSSD",
  			"size": 100
  		},
                  "region": "aaa",
  		"availability_zone": "bbb",
  		"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
  		"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
  		"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
  		"port": "3306",
  		"backup_strategy": {
  			"start_time": "08:15-09:15",
  			"keep_days": 3
  		},
  		"charge_info": {
  			"charge_mode": "postPaid"
  		}
  	},
  	"job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d"
  }

  Primary/standby FlexusRDS instance created.

  {
    "instance":{ 
             "id": "dsfae23fsfdsae3435in01",
             "name": "flexusrds-instance-ha", 
             "datastore": { 
               "type": "MySQL", 
               "version": "5.7" 
              }, 
             "ha": {
               "mode": "ha",
               "replication_mode": "semisync"
             },
             "flavor_ref": "rds.mysql.y1.xlarge.2.ha",
             "volume": { 
                 "type": "CLOUDSSD", 
                 "size": 100 
               },
             "region": "aaa",
             "availability_zone": "bbb,ccc",
             "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", 
             "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
             "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", 
             "port": "3306", 
             "backup_strategy": { 
               "start_time": "08:15-09:15", 
               "keep_days": 3 
              }, 
             "charge_info": {
                     "charge_mode": "postPaid"
                                 },
           },
    "job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d" 
  }
• Abnormal response

  For details, see Abnormal Request Results.

Status Code

• Normal

  202

• Abnormal

  For details, see Status Codes.