This is the multi-page printable view of this section. Click here to print.
Create Cluster
1 - 1.1
scp-cli vertica cluster create
--starting_time_hour <value>
--retention_period_day <value>
--database_user_password <value>
--database_user_name <value>
--database_name <value>
--timezone <value>
--subnet_id <value>
--service_watch_log_collection <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--dbaas_engine_version_id <value>
[--allowable_ip_addresses <value>]
[--license <value>]
[--nat_enabled <value>]
[--tags <value>]
[--database_locale <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| starting_time_hour required | string | Backup starting time (hour) | - |
| retention_period_day required | string | Backup retention period (day) | - |
| database_user_password required | string | Database user password | test123! |
| database_user_name required | string | Database User Name | mydatabaseusr |
| database_name required | string | Database Name | mydatabase |
| timezone required | string | Timezone. The timezone can be obtained via the “GET /support/v1/timezones” endpoint. | - |
| subnet_id required | string | Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint. | - |
| service_watch_log_collection required | boolean | ServiceWatch log collection | True |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| instance_groups required | array | Instance groups list | '{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}, {"role_type": "DATA", "size_gb": 56, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "DATA", "service_ip_address": "192.168.10.10/32"}], "role_type": "DATA", "server_type_name": "db1v2m4"}' |
| dbaas_engine_version_id required | string | DBaaS engine version ID. The ID can be obtained via the “GET /v1/engine-versions” endpoint. | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| license optional | string | license | - |
| nat_enabled optional | boolean | NAT availability | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| database_locale optional | string | Database locale information | ko_KR.utf8 |
| period_hour optional | string | Period in hours | 5 |
| starting_day_of_week optional | string | Starting day of week | MON |
| starting_time optional | string | Starting time | 0000 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |
2 - 1.0
scp-cli vertica cluster create
--starting_time_hour <value>
--retention_period_day <value>
--database_user_password <value>
--database_user_name <value>
--database_name <value>
--timezone <value>
--subnet_id <value>
--name <value>
--instance_name_prefix <value>
--instance_groups <value>
--dbaas_engine_version_id <value>
[--allowable_ip_addresses <value>]
[--license <value>]
[--nat_enabled <value>]
[--tags <value>]
[--database_locale <value>]
[--period_hour <value>]
[--starting_day_of_week <value>]
[--starting_time <value>]
Description
Create Cluster.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20261031 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| starting_time_hour required | string | Backup starting time (hour) | - |
| retention_period_day required | string | Backup retention period (day) | - |
| database_user_password required | string | Database user password | test123! |
| database_user_name required | string | Database User Name | mydatabaseusr |
| database_name required | string | Database Name | mydatabase |
| timezone required | string | Timezone. The timezone can be obtained via the “GET /support/v1/timezones” endpoint. | - |
| subnet_id required | string | Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint. | - |
| name required | string | Cluster name | - |
| instance_name_prefix required | string | Instance name prefix | - |
| instance_groups required | array | Instance groups list | '{"block_storage_groups": [{"role_type": "OS", "size_gb": 104, "volume_type": "SSD"}, {"role_type": "DATA", "size_gb": 56, "volume_type": "SSD"}], "instances": [{"public_ip_id": "", "role_type": "DATA", "service_ip_address": "192.168.10.10/32"}], "role_type": "DATA", "server_type_name": "db1v2m4"}' |
| dbaas_engine_version_id required | string | DBaaS engine version ID. The ID can be obtained via the “GET /v1/engine-versions” endpoint. | - |
| allowable_ip_addresses optional | array | Allowed IP addresses list | - |
| license optional | string | license | - |
| nat_enabled optional | boolean | NAT availability | - |
| tags optional | array | tag | '{"key": "", "value": ""}' |
| database_locale optional | string | Database locale information | ko_KR.utf8 |
| period_hour optional | string | Period in hours | 5 |
| starting_day_of_week optional | string | Starting day of week | MON |
| starting_time optional | string | Starting time | 0000 |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | req-4f668846-8a3d-49f1-8111-451ebccf445c |
| resource | Resource |