Creating a DB Instance¶
Function¶
This API is used to create a GaussDB(for MySQL) instance. Before calling this API:
Learn how to authorize and authenticate it.
Obtain the required region and endpoint.
URI¶
POST /v3/{project_id}/instances
Parameter | Mandatory | Type | Description |
---|---|---|---|
project_id | Yes | String | Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. |
Request Parameters¶
Parameter | Mandatory | Type | Description |
---|---|---|---|
X-Auth-Token | Yes | String | User token. |
X-Language | No | String | Language. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
charge_info | No | MysqlChargeInfo object | Billing mode. |
region | Yes | String | Region ID. The value cannot be empty. To obtain this value, see Regions and Endpoints. |
name | Yes | String | DB instance name. DB instances of the same type can have same names under the same tenant. The value consists of 4 to 64 characters and starts with a letter. It is case-sensitive and contains only letters, digits, hyphens (-), and underscores (_). |
datastore | Yes | MysqlDatastore object | Database information. |
mode | Yes | String | DB instance type. Its value is Cluster. |
flavor_ref | Yes | String | Specification code. |
vpc_id | Yes | String | VPC ID. To obtain this value, use either of the following methods:
|
subnet_id | Yes | String | Network ID. To obtain this value, use either of the following methods:
|
security_group_id | No | String | Security group ID. If network ACL is enabled, this parameter cannot be specified. If network ACL is disabled, this parameter is mandatory.
|
configuration_id | No | String | Parameter template ID. |
password | Yes | String | Database password. The password consists of 8 to 32 characters and contains at least three types of the following: uppercase letters, lowercase letters, digits, and special characters ( |
backup_strategy | No | MysqlBackupStrategy object | Automated backup policy. |
time_zone | No | String | Time zone. The default time zone is UTC. |
availability_zone_mode | Yes | String | AZ type. The value can be single or multi. |
master_availability_zone | No | String | Primary AZ.
|
slave_count | Yes | Integer | Number of read replicas. A maximum of nine read replicas can be created at a time. |
tags | No | Array of MysqlTags objects | Tag list. DB instances are created based on tag keys and values.
To create DB instances with multiple tag keys and values, separate key-value pairs with commas (,). Up to 10 key-value pairs can be added. |
enterprise_project_id | No | String | Enterprise project ID. This parameter is mandatory when the enterprise project is enabled. |
dedicated_resource_id | No | String | Dedicated resource pool ID. This parameter is displayed only when the dedicated resource pool is enabled. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
charge_mode | Yes | String | Billing mode. Value: postPaid |
Parameter | Mandatory | Type | Description |
---|---|---|---|
type | Yes | String | DB engine. Currently, only gaussdb-mysql is supported. |
version | Yes | String | DB version. For details about supported DB versions, see Querying Version Information About a DB Engine. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
start_time | Yes | String | Automated backup start time. The automated backup will be triggered within one hour after the time specified by this parameter. 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.
Example value:
|
keep_days | No | String | Automated backup retention days. Value: 1-732. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
key | Yes | String | Tag key. It contains a maximum of 36 Unicode characters. The value cannot be an empty string, a space, or left blank. Only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_) are allowed. |
value | Yes | String | Tag value. It contains a maximum of 43 Unicode characters. It can be an empty string. Only uppercase letters, lowercase letters, digits, periods (.), hyphens (-), and underscores (_) are allowed. |
Response Parameters¶
Status code: 201
Parameter | Type | Description |
---|---|---|
instance | MysqlInstanceResponse object | DB instance information. |
job_id | String | DB instance creation task ID. |
Parameter | Type | Description |
---|---|---|
id | String | DB instance ID. |
name | String | DB instance name. DB instances of the same type can have same names under the same tenant. The name consists of 4 to 64 characters and starts with a letter. It is case-insensitive and contains only letters, digits, hyphens (-), and underscores (_). |
status | String | DB instance status. |
datastore | MysqlDatastore object | Database information. |
mode | String | DB instance type. Its value is Cluster. |
configuration_id | String | Parameter template ID. |
port | String | Database port. |
backup_strategy | MysqlBackupStrategy object | Automated backup policy. |
region | String | Region ID, which is the same as the request parameter. |
availability_zone_mode | String | AZ mode, which is the same as the request parameter. |
master_availability_zone | String | Primary AZ ID. |
vpc_id | String | VPC ID, which is the same as the request parameter. |
security_group_id | String | Security group ID, which is the same as the request parameter. |
subnet_id | String | Subnet ID, which is the same as the request parameter. |
flavor_ref | String | Specification code, which is the same as the request parameter. |
charge_info | MysqlChargeInfo object | Billing mode. |
Parameter | Type | Description |
---|---|---|
type | String | DB engine. Currently, only gaussdb-mysql is supported. |
version | String | DB version. To obtain details about supported DB engine versions, call the API for querying the DB engine versions. |
Parameter | Type | Description |
---|---|---|
start_time | String | Automated backup start time. The automated backup will be triggered within one hour after the time specified by this parameter. 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.
|
keep_days | String | Automated backup retention days. Value: 1-732. |
Parameter | Type | Description |
---|---|---|
charge_mode | String | Billing mode. |
Status code: 400
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Status code: 500
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Example Request¶
Note
The value of region is used as an example.
Creating a DB instance
POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances
{
"name" : "gaussdb-mysql-instance1",
"region" : "br-iaas-odin1",
"charge_info" : {
"charge_mode" : "postPaid"
},
"datastore" : {
"type" : "gaussdb-mysql",
"version" : "8.0"
},
"mode" : "Cluster",
"flavor_ref" : "gaussdb.mysql.xlarge.arm.8",
"vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58",
"subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad",
"security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55",
"configuration_id" : "43570e0de32e40c5a15f831aa5ce4176pr07",
"password" : "xxxxxx",
"backup_strategy" : {
"start_time" : "08:00-09:00"
},
"availability_zone_mode" : "single",
"slave_count" : 1,
"enterprise_project_id" : 0
}
Example Response¶
Status code: 201
Note
The values of region and master_availability_zone are used as examples.
Success.
{
"instance" : {
"id" : "5eebbb4c0f9f4a99b42ed1b6334569aain07",
"name" : "gaussdb-mysql-instance1",
"region" : "br-iaas-odin1",
"charge_info" : {
"charge_mode" : "postPaid"
},
"datastore" : {
"type" : "gaussdb-mysql",
"version" : "8.0"
},
"mode" : "Cluster",
"flavor_ref" : "gaussdb.mysql.xlarge.arm.8",
"vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58",
"subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad",
"security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55",
"configuration_id" : "43570e0de32e40c5a15f831aa5ce4176pr07",
"backup_strategy" : {
"start_time" : "08:00-09:00",
"keep_days" : 7
},
"availability_zone_mode" : "single",
"slave_count" : 1
},
"job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d"
}
Status Code¶
For details, see Status Codes.
Error Code¶
For details, see Error Codes.