이 섹션의 다중 페이지 출력 화면임. 여기를 클릭하여 프린트.

Models

1: AsyncResponse
2: AuditLogRequest
3: BackupHistoryApiItem
4: BackupHistoryListApiResponse
5: BackupHistoryNumberRequest
6: BlockStorageGroupRequest
7: BlockStorageResponse
8: ClusterRestoreRequest
9: Engine
10: EngineListResponse
11: EngineProperty
12: EnginePropertyListResponse
13: InstanceDetailResponse
14: InstanceGroupResizeRequest
15: InstanceResponse
16: LogExportConfig
17: LogExportConfigCreateRequest
18: LogExportConfigListResponse
19: LogExportConfigModifyRequest
20: MaintenanceOption
21: MaintenanceRequest
22: MaintenanceResponseOption
23: MinorPatchRequest
24: ParameterDTO
25: ParameterGroup
26: ParameterGroupListResponse
27: ParameterPageResponse
28: ParameterRequest
29: Parameters
30: ParametersRequest
31: ParametersResponse
32: RdbClusterPageResponse
33: RdbClusterResponse
34: RequestStateResponse
35: ResizeBlockStorageGroupRequest
36: ResourceInfo
37: ServerType
38: ServerTypeListResponse
39: SqlserverAdConfigRequest
40: SqlserverAdConfigResponse
41: SqlserverAddBlockStoragesRequest
42: SqlserverAddSecondaryRequest
43: SqlserverBackupOption
44: SqlserverBackupSettingRequest
45: SqlserverBlockStorageGroupResponse
46: SqlserverClusterCreateRequest
47: SqlserverClusterCreateRequestV1Dot1
48: SqlserverClusterDetailResponse
49: SqlserverClusterDetailResponseV1Dot1
50: SqlserverDatabaseOption
51: SqlserverDrSecondariesListResponse
52: SqlserverDrSecondaryCreateRequest
53: SqlserverDrSecondaryItem
54: SqlserverInitConfigOptionRequest
55: SqlserverInitConfigOptionResponse
56: SqlserverInstanceGroupRequest
57: SqlserverInstanceGroupResponse
58: SqlserverInstanceRequest
59: SqlserverUpdateDatabasesRequest
60: Tag
61: UpdateSecurityGroupRulesRequest

1 - AsyncResponse

Name	Description	Schema	Default
request_id required	Request ID Example : `req-4f668846-8a3d-49f1-8111-451ebccf445c`	string
resource required	Resource	ResourceInfo

2 - AuditLogRequest

Name	Description	Schema	Default
use_audit_log required	use_audit_log Example :	boolean

3 - BackupHistoryApiItem

Name	Description	Schema
backup_end_at required	Backup end time Example :	string
backup_history_number required	Backup id Example :	string
backup_size_gb required	Backup amount(GB) Example :	object
backup_start_at required	Backup start time Example :	string
backup_state required	Backup state Example :	string
backup_state_detail optional	Backup detail state Example :	any of [string, null]
software_version required	Software version Example :	string

4 - BackupHistoryListApiResponse

Name	Description	Schema	Default
contents required	backup list information	array[BackupHistoryApiItem]
total_count required	total number of backup history Example :	integer

5 - BackupHistoryNumberRequest

Name	Description	Schema	Default
backup_history_number required	Backup id	array[string]

6 - BlockStorageGroupRequest

Name	Description	Schema	Default
role_type required	Role type Example : `OS`	enum (OS, DATA, ARCHIVE, TEMP, BACKUP)
size_gb required	Size in GB Example : `104` Minimum : `16` Maximum : `5120`	integer
volume_type optional	Volume type Example : `SSD`	enum (SSD, SSD_KMS, HDD, HDD_KMS)	SSD

7 - BlockStorageResponse

Name	Description	Schema
name required	Name Example :	string
role_type required	Role type Example : `OS`	enum (OS, DATA, ARCHIVE, TEMP, BACKUP)
size_gb required	Size in GB Example :	integer
volume_type required	Volume type Example : `SSD`	enum (SSD, SSD_KMS, HDD, HDD_KMS)

8 - ClusterRestoreRequest

Name	Description	Schema
allowable_ip_addresses optional	Allowed IP addresses list	array[string]
backup_history_number optional	Backup id Example : `202501010000`	any of [string, null]
backup_recovery_time optional	Backup Recovery Time Example :	any of [string (date-time), null]
block_storage_groups optional	Block storage groups list	any of [array[BlockStorageGroupRequest], null]
instance_name_prefix required	Instance name prefix Example : `myprefix` Pattern : `^[a-z][a-zA-Z0-9\-]$` Minimum length* : `3` Maximum length : `16`	string
maintenance_option optional	Maintenance option	any of [MaintenanceOption, null]
name required	Cluster name Example : `mycluster` Pattern : `^[a-zA-Z]$` Minimum length* : `3` Maximum length : `20`	string
server_type_name required	Server type name Example :	string
tags optional	tag	any of [array[Tag], null]

9 - Engine

Name	Description	Schema
end_of_service optional	End of Service Example : `False`	boolean
id required	ID Example :	string
major_version required	Software major version Example :	string
name required	DBaaS engine version name Example :	string
os_type required	OS type Example :	string
os_version required	OS version Example :	string
product_image_type optional	Product type Example :	any of [string, null]
software_version required	Software version Example :	string

10 - EngineListResponse

Name	Description	Schema	Default
contents required	DBaaS engine list	array[Engine]

11 - EngineProperty

Name	Description	Schema	Default
name required	DBaas engine property name Example :	string
value required	DBaas engine property value Example :	string

12 - EnginePropertyListResponse

Name	Description	Schema	Default
contents required	DBaas engine property list	array[EngineProperty]

13 - InstanceDetailResponse

Name	Description	Schema
account_id required	Account ID Example :	string
block_storages required	Block storages	array[BlockStorageResponse]
cluster_id required	Cluster ID Example :	string
cluster_name required	Cluster name Example :	string
cpu_core required	Server type cpu core Example :	integer
created_at required	Creation time Example : `2024-01-15T10:30:00.000Z`	string (date-time)
created_by required	Creator Example :	string
dbaas_engine required	DBaaS engine Example :	string
memory_gb required	Server type memory Example :	integer
modified_at required	Modification time Example : `2024-01-15T10:30:00.000Z`	string (date-time)
modified_by required	Modifier Example :	string
name required	Name Example :	string
os_type required	OS type Example :	string
os_version required	OS version Example :	string
product_image_type required	Product image type Example :	string
product_type required	Product type Example :	string
public_ip_address optional	Public IP Address. The address can be obtained via “GET /vpc/v1/publicips” endpoint. Example :	any of [string, null]
public_ip_id optional	Public IP ID. The ID can be obtained via “GET /vpc/v1/publicips” endpoint. Example :	any of [string, null]
region required	Region Example :	string
role_type required	Role type Example : `ACTIVE`	enum (ACTIVE, STANDBY, PRIMARY, SECONDARY, MASTER, REPLICA, SENTINEL, MASTER_DATA, DATA, KIBANA, DASHBOARDS, ZOOKEEPER_BROKER, BROKER, ZOOKEEPER, AKHQ, CONSOLE, READ_REPLICA)
server_type_name required	Server type name Example :	string
service_ip_address optional	User subnet IP address Example :	any of [string, null]
service_state required	Service state Example : `RUNNING`	enum (RUNNING, STOPPED, UNKNOWN, ERROR, FAILED, TERMINATED, CREATING, STOPPING, STARTING, RESTARTING, EDITING, SYNCHRONIZING, UPGRADING, TERMINATING, MIGRATING)
software_version required	Software version Example :	string
zone required	Availability Zone Example :	string

14 - InstanceGroupResizeRequest

Name	Description	Schema	Default
server_type_name required	Server type name Example :	string

15 - InstanceResponse

Name	Description	Schema
name required	Name Example :	string
public_ip_address optional	Public IP Address. The address can be obtained via “GET /vpc/v1/publicips” endpoint. Example :	any of [string, null]
public_ip_id optional	Public IP ID. The ID can be obtained via “GET /vpc/v1/publicips” endpoint. Example :	any of [string, null]
role_type required	Role type Example : `ACTIVE`	enum (ACTIVE, STANDBY, PRIMARY, SECONDARY, MASTER, REPLICA, SENTINEL, MASTER_DATA, DATA, KIBANA, DASHBOARDS, ZOOKEEPER_BROKER, BROKER, ZOOKEEPER, AKHQ, CONSOLE, READ_REPLICA)
service_ip_address optional	User subnet IP address Example :	any of [string, null]
service_state required	Service state Example : `RUNNING`	enum (RUNNING, STOPPED, UNKNOWN, ERROR, FAILED, TERMINATED, CREATING, STOPPING, STARTING, RESTARTING, EDITING, SYNCHRONIZING, UPGRADING, TERMINATING, MIGRATING)

16 - LogExportConfig

Name	Description	Schema
bucket_name required	Bucket name Example : `examplebucket`	any of [string, null]
delete_on_export required	Delete on export Example : `True`	any of [boolean, null]
is_bucket_deleted required	Bucket deleted Example : `False`	any of [boolean, null]
is_registered required	Log type registration state Example : `True`	boolean
log_label required	Log label Example : `DB Alert Log`	string
log_type required	Log type Example : `alert`	string
schedule_day_of_month required	Schedule day of month Example : `28`	any of [string, null]
schedule_day_of_week required	Schedule day of week Example : `MON`	any of [enum (MON, TUE, WED, THU, FRI, SAT, SUN), null]
schedule_frequency_type required	Schedule frequency type Example : `DAY`	any of [string, null]
schedule_hour required	Schedule hour Example : `12`	any of [string, null]

17 - LogExportConfigCreateRequest

Name	Description	Schema
access_key required	Access key Example : `13952a8851244213f2de8d95069bf161`	any of [string, null]
bucket_name required	Bucket name Example : `examplebucket`	string
delete_on_export required	Delete on export Example : `True`	any of [boolean, null]
log_type required	Log type Example : `alert`	string
schedule_day_of_month required	Schedule day of month Example : `28` Pattern : `^(-1\|[1-9]\|1[0-9]\|2[0-9]\|3[0-1])$`	any of [string, null]
schedule_day_of_week required	Schedule day of week Example : `MON`	any of [enum (MON, TUE, WED, THU, FRI, SAT, SUN), null]
schedule_frequency_type required	Schedule frequency type Example : `DAY`	any of [string, null]
schedule_hour required	Schedule hour Example : `12` Pattern : `^(\d\|1\d\|2[0-3])$`	any of [string, null]
secret_key required	Secret key Example : `secretkey`	any of [string, null]

18 - LogExportConfigListResponse

Name	Description	Schema	Default
contents required	Log export config contents	array[LogExportConfig]
count required	Log export config count Example : `1`	integer

19 - LogExportConfigModifyRequest

Name	Description	Schema
access_key required	Access key Example : `13952a8851244213f2de8d95069bf161`	any of [string, null]
delete_on_export required	Delete on export Example : `True`	any of [boolean, null]
schedule_day_of_month required	Schedule day of month Example : `28` Pattern : `^(-1\|[1-9]\|1[0-9]\|2[0-9]\|3[0-1])$`	any of [string, null]
schedule_day_of_week required	Schedule day of week Example : `MON`	any of [enum (MON, TUE, WED, THU, FRI, SAT, SUN), null]
schedule_frequency_type required	Schedule frequency type Example : `DAY`	any of [string, null]
schedule_hour required	Schedule hour Example : `12` Pattern : `^(\d\|1\d\|2[0-3])$`	any of [string, null]
secret_key required	Secret key Example : `secretkey`	any of [string, null]

20 - MaintenanceOption

Name	Description	Schema
period_hour optional	Period in hours Example : `5` Pattern : `^(0\.5\|[1-5]\.5\|[1-9]\|1[0-9]\|2[0-4])$`	string
starting_day_of_week optional	Starting day of week Example : `MON`	enum (MON, TUE, WED, THU, FRI, SAT, SUN)
starting_time optional	Starting time Example : `0000`	string

21 - MaintenanceRequest

Name	Description	Schema
start_day_of_week required	start_day_of_week Example : `MON`	enum (MON, TUE, WED, THU, FRI, SAT, SUN)
start_minute required	start_minute Example :	string
start_time required	start_time Example :	string
term_hour required	term_hour Example : Pattern : `^(0\.5\|[1-5]\.5\|[1-9]\|1[0-9]\|2[0-4])$`	string

22 - MaintenanceResponseOption

Name	Description	Schema
period_hour optional	Period in hours Example :	any of [string, null]
starting_day_of_week optional	Starting day of week Example : `MON`	any of [enum (MON, TUE, WED, THU, FRI, SAT, SUN), null]
starting_time optional	Starting time Example :	any of [string, null]
use_maintenance_option optional	Maintenance period usage state Example : `False`	boolean

23 - MinorPatchRequest

Name	Description	Schema	Default
software_version required	software_version Example :	string

24 - ParameterDTO

Name	Description	Schema
allows_value required	Parameter allows value Example :	string
applied_value required	Parameter applied value Example :	string
apply_type required	Parameter apply type Example :	string
data_type required	Parameter data type Example :	string
default_value required	Parameter default value Example :	string
description required	Parameter description Example :	any of [string, null]
id required	Parameter id Example :	string
is_modifiable required	Parameter is_modifiable Example :	boolean
name required	Parameter name Example :	string
software_type required	Parameter software type Example :	any of [string, null]

25 - ParameterGroup

Name	Description	Schema
id required	Parameter group ID Example :	string
major_version required	Software major version Example :	string
name required	Parameter group name Example :	string
product_image_type required	Product image type Example :	string
product_type required	Product type Example :	string

26 - ParameterGroupListResponse

Name	Description	Schema	Default
contents required	Parameter group list	array[ParameterGroup]
sort optional	sort Example :	any of [array[string], null]

27 - ParameterPageResponse

Name	Description	Schema
contents required	Parameter list	array[Parameters]
count required	count Example : `20`	integer
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

28 - ParameterRequest

Name	Description	Schema
id required	Parameter id Example :	string
new_value required	Parameter new value Example :	string
old_value required	Parameter old value Example :	string

29 - Parameters

Name	Description	Schema
dbaas_parameter_group_id required	Parameter id Example :	string
default_value required	Parameter default value Example :	string
description required	Parameter description Example :	string
id required	Parameter id Example :	string
name required	Parameter name Example :	string
software_type required	Parameter software type Example :	any of [string, null]

30 - ParametersRequest

Name	Description	Schema	Default
parameters required	Parameter request list	array[ParameterRequest]

31 - ParametersResponse

Name	Description	Schema
contents required	Parameter contents	array[ParameterDTO]
count required	Parameter count Example :	integer
modified_at required	Modification time Example :	string

32 - RdbClusterPageResponse

Name	Description	Schema
contents required	Clusters list	any of [array[RdbClusterResponse], null]
count required	count Example : `20`	integer
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

33 - RdbClusterResponse

Name	Description	Schema
account_id required	Account ID Example :	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
database_name required	Database Name Example :	any of [string, null]
ha_enabled optional	HA availability Example : `False`	boolean
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
instance_count optional	Instance Count Example : `0`	integer
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Cluster name Example :	string
role_type required	Role type Example : `ORIGIN`	any of [enum (ORIGIN, REPLICA, RECOVERY, SECONDARY, MIGRATION, RESTORE, DR_REPLICA, DR_SECONDARY), null]
service_state required	Service state Example : `RUNNING`	enum (RUNNING, STOPPED, UNKNOWN, ERROR, FAILED, TERMINATED, CREATING, STOPPING, STARTING, RESTARTING, EDITING, SYNCHRONIZING, UPGRADING, TERMINATING, MIGRATING)

34 - RequestStateResponse

Name	Description	Schema	Default
request_id required	Request ID Example :	string
state required	Request state Example :	string

35 - ResizeBlockStorageGroupRequest

Name	Description	Schema	Default
size_gb required	Size in GB Example : `16` Minimum : `16` Maximum : `5120`	integer

36 - ResourceInfo

Name	Description	Schema	Default
id required	request resource id Example : `109a585ae67b4e8482fdafc8a4a5be74`	string

37 - ServerType

Name	Description	Schema
cpu_core required	Server type cpu core Example :	integer
description required	Server type description Example :	string
memory_gb required	Server type memory Example :	integer
name required	Server type name Example :	string
product_image_type required	Product image type Example :	string
product_type required	Product type Example :	string
purpose required	Server type purpose Example :	string
type required	Server type class Example :	string

38 - ServerTypeListResponse

Name	Description	Schema	Default
contents required	Server type list	array[ServerType]

39 - SqlserverAdConfigRequest

Name	Description	Schema
ad_dns_servers required	AD DNS Servers	array[string]
ad_domain_name required	AD Domain Name Example : Pattern : `^[a-zA-Z0-9.\-]+$` Minimum length : `3` Maximum length : `20`	string
ad_netbios_name required	AD NetBIOS Name Example : Pattern : `^[a-zA-Z0-9.\-]+$` Minimum length : `1` Maximum length : `15`	string
ad_user_id required	AD User ID Example : Pattern : `^[a-zA-Z0-9.\-]+$` Minimum length : `3` Maximum length : `20`	string
ad_user_password required	AD User Password Example : `test123!` Minimum length : `8` Maximum length : `30`	string
failover_cluster_name optional	Failover Cluster Name Example : Pattern : `^[a-zA-Z0-9.\-]+$`	any of [string, null]

40 - SqlserverAdConfigResponse

Name	Description	Schema
ad_dns_servers optional	AD DNS Servers Example :	any of [array[string], null]
ad_domain_name optional	AD Domain Name Example :	any of [string, null]
ad_netbios_name optional	AD NetBIOS Name Example :	any of [string, null]
ad_user_id optional	AD User ID Example :	any of [string, null]
failover_cluster_name optional	Failover Cluster Name Example :	any of [string, null]

41 - SqlserverAddBlockStoragesRequest

Name	Description	Schema	Default
role_type required	Role type Example : `OS`	enum (OS, DATA, ARCHIVE, TEMP, BACKUP)
size_gb required	Size in GB Example : `104` Minimum : `16` Maximum : `5120`	integer
volume_type optional	Volume type Example : `SSD`	enum (SSD, SSD_KMS, HDD, HDD_KMS)	SSD

42 - SqlserverAddSecondaryRequest

Name	Description	Schema
ad_user_id optional	AD User ID Example : Pattern : `^[a-zA-Z0-9.\-]+$`	any of [string, null]
ad_user_password optional	AD User Password Example : `test123!`	any of [string, null]
license required	license Example :	string
name required	Secondary Name Example : Pattern : `^[a-z][a-z0-9\-][a-z0-9]$` Minimum length* : `3` Maximum length : `15`	string
service_ip_address optional	User subnet IP address Example :	any of [string, null]

43 - SqlserverBackupOption

Name	Description	Schema	Default
archive_frequency_minute required	Backup starting time (minute) Example : Pattern : `^(5\|10\|30\|60)$`	string
full_backup_day_of_week optional	Full backup day of week Example : `SUN`	enum (MON, TUE, WED, THU, FRI, SAT, SUN)	SUN
retention_period_day optional	Backup retention period (day) Example : `7`	any of [string, null]
starting_time_hour optional	Backup starting time (hour) Example : `2`	any of [string, null]

44 - SqlserverBackupSettingRequest

Name	Description	Schema	Default
archive_frequency_minute required	Backup starting time (minute) Example : Pattern : `^(5\|10\|30\|60)$`	string
full_backup_day_of_week optional	Full backup day of week Example : `SUN`	enum (MON, TUE, WED, THU, FRI, SAT, SUN)	SUN
retention_period_day required	Backup retention period (day) Example : Pattern : `^([7-9]\|^[1-2]\d\|^3[0-5])$`	string
starting_time_hour required	Backup starting time (hour) Example : Pattern : `^(\d\|1\d\|2[0-3])$`	string

45 - SqlserverBlockStorageGroupResponse

Name	Description	Schema
drive_letter required	Drive letter Example :	string
id required	ID Example :	string
name required	Name Example :	string
role_type required	Role type Example : `OS`	enum (OS, DATA, ARCHIVE, TEMP, BACKUP)
size_gb required	Size in GB Example :	integer
volume_type required	Volume type Example : `SSD`	enum (SSD, SSD_KMS, HDD, HDD_KMS)

46 - SqlserverClusterCreateRequest

Name	Description	Schema
allowable_ip_addresses optional	Allowed IP addresses list	array[string]
dbaas_engine_version_id required	DBaaS engine version ID. The ID can be obtained via the “GET /v1/engine-versions” endpoint. Example : `c1b856dd12754c0ba2614a39d0ed3ad1`	string
ha_enabled optional	HA availability Example : `False`	boolean
init_config_option required	DB initial configuration option	SqlserverInitConfigOptionRequest
instance_groups required	Instance groups list	array[SqlserverInstanceGroupRequest]
instance_name_prefix required	Instance name prefix Example : Pattern : `^[a-z][a-zA-Z0-9\-]$` Minimum length* : `3` Maximum length : `12`	string
maintenance_option optional	Maintenance option	any of [MaintenanceOption, null]
name required	Cluster name Example : `mycluster` Pattern : `^[a-zA-Z]$` Minimum length* : `3` Maximum length : `20`	string
nat_enabled optional	NAT availability Example : `False`	boolean
subnet_id required	Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint. Example : `1ddd7f1e4a8a43ed8b82d70cade0b321`	string
tags optional	tag	any of [array[Tag], null]
timezone required	Timezone. The timezone can be obtained via the “GET /support/v1/timezones” endpoint. Example : `Asia/Seoul`	string
vip_public_ip_id optional	(VIP) Public IP ID. The ID can be obtained via “GET /vpc/v1/publicips” endpoint. Example :	any of [string, null]
virtual_ip_address optional	Virtual IP address Example :	any of [string, null]

47 - SqlserverClusterCreateRequestV1Dot1

Name	Description	Schema
allowable_ip_addresses optional	Allowed IP addresses list	array[string]
dbaas_engine_version_id required	DBaaS engine version ID. The ID can be obtained via the “GET /v1/engine-versions” endpoint. Example : `c1b856dd12754c0ba2614a39d0ed3ad1`	string
ha_enabled optional	HA availability Example : `False`	boolean
init_config_option required	DB initial configuration option	SqlserverInitConfigOptionRequest
instance_groups required	Instance groups list	array[SqlserverInstanceGroupRequest]
instance_name_prefix required	Instance name prefix Example : Pattern : `^[a-z][a-zA-Z0-9\-]$` Minimum length* : `3` Maximum length : `12`	string
maintenance_option optional	Maintenance option	any of [MaintenanceOption, null]
name required	Cluster name Example : `mycluster` Pattern : `^[a-zA-Z]$` Minimum length* : `3` Maximum length : `20`	string
nat_enabled optional	NAT availability Example : `False`	boolean
service_watch_log_collection required	ServiceWatch log collection Example : `True`	any of [boolean, null]
subnet_id required	Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint. Example : `1ddd7f1e4a8a43ed8b82d70cade0b321`	string
tags optional	tag	any of [array[Tag], null]
timezone required	Timezone. The timezone can be obtained via the “GET /support/v1/timezones” endpoint. Example : `Asia/Seoul`	string
vip_public_ip_id optional	(VIP) Public IP ID. The ID can be obtained via “GET /vpc/v1/publicips” endpoint. Example :	any of [string, null]
virtual_ip_address optional	Virtual IP address Example :	any of [string, null]

48 - SqlserverClusterDetailResponse

Name	Description	Schema
account_id required	Account ID Example :	string
allowable_ip_addresses optional	Allowed IP addresses list	array[string]
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
dbaas_engine required	DBaaS engine Example :	string
dbaas_engine_version_name required	DBaaS engine version name Example :	string
ha_enabled optional	HA availability Example : `False`	boolean
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
init_config_option required		SqlserverInitConfigOptionResponse
instance_count optional	Instance Count Example : `0`	integer
instance_groups required		array[SqlserverInstanceGroupResponse]
maintenance_option optional	Maintenance option	any of [MaintenanceResponseOption, null]
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Cluster name Example :	string
nat_enabled optional	NAT availability Example : `False`	boolean
product_image_type required	Product image type Example :	string
product_type required	Product type Example : `QOS`	enum (QOS, PostgreSQL Community, EPAS, MariaDB, MySQL, Redis, Microsoft SQL Server, Search Engine, Event Streams, Vertica, Scalable DB)
role_type required	Role type Example : `ORIGIN`	any of [enum (ORIGIN, REPLICA, RECOVERY, SECONDARY, MIGRATION, RESTORE, DR_REPLICA, DR_SECONDARY), null]
service_state required	Service state Example : `RUNNING`	enum (RUNNING, STOPPED, UNKNOWN, ERROR, FAILED, TERMINATED, CREATING, STOPPING, STARTING, RESTARTING, EDITING, SYNCHRONIZING, UPGRADING, TERMINATING, MIGRATING)
software_version required	Software version Example :	string
subnet_id required	Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint. Example :	string
timezone required	Timezone. The timezone can be obtained via the “GET /support/v1/timezones” endpoint. Example :	string
vip_public_ip_address optional	(VIP) Public IP Address. The address can be obtained via “GET /vpc/v1/publicips” endpoint. Example :	any of [string, null]
vip_public_ip_id optional	(VIP) Public IP ID. The ID can be obtained via “GET /vpc/v1/publicips” endpoint. Example :	any of [string, null]
virtual_ip_address optional	Virtual IP address Example :	any of [string, null]

49 - SqlserverClusterDetailResponseV1Dot1

Name	Description	Schema
account_id required	Account ID Example :	string
allowable_ip_addresses optional	Allowed IP addresses list	array[string]
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
dbaas_engine required	DBaaS engine Example :	string
dbaas_engine_version_name required	DBaaS engine version name Example :	string
ha_enabled optional	HA availability Example : `False`	boolean
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
init_config_option required		SqlserverInitConfigOptionResponse
instance_count optional	Instance Count Example : `0`	integer
instance_groups required		array[SqlserverInstanceGroupResponse]
maintenance_option optional	Maintenance option	any of [MaintenanceResponseOption, null]
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Cluster name Example :	string
nat_enabled optional	NAT availability Example : `False`	boolean
product_image_type required	Product image type Example :	string
product_type required	Product type Example : `QOS`	enum (QOS, PostgreSQL Community, EPAS, MariaDB, MySQL, Redis, Microsoft SQL Server, Search Engine, Event Streams, Vertica, Scalable DB)
role_type required	Role type Example : `ORIGIN`	any of [enum (ORIGIN, REPLICA, RECOVERY, SECONDARY, MIGRATION, RESTORE, DR_REPLICA, DR_SECONDARY), null]
service_state required	Service state Example : `RUNNING`	enum (RUNNING, STOPPED, UNKNOWN, ERROR, FAILED, TERMINATED, CREATING, STOPPING, STARTING, RESTARTING, EDITING, SYNCHRONIZING, UPGRADING, TERMINATING, MIGRATING)
service_watch_log_collection optional	ServiceWatch log collection Example : `False`	boolean
software_version required	Software version Example :	string
subnet_id required	Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint. Example :	string
timezone required	Timezone. The timezone can be obtained via the “GET /support/v1/timezones” endpoint. Example :	string
vip_public_ip_address optional	(VIP) Public IP Address. The address can be obtained via “GET /vpc/v1/publicips” endpoint. Example :	any of [string, null]
vip_public_ip_id optional	(VIP) Public IP ID. The ID can be obtained via “GET /vpc/v1/publicips” endpoint. Example :	any of [string, null]
virtual_ip_address optional	Virtual IP address Example :	any of [string, null]

50 - SqlserverDatabaseOption

Name	Description	Schema	Default
database_name required	Database Name Example : Pattern : `^[a-zA-Z][a-zA-Z0-9._]$` Minimum length* : `3` Maximum length : `20`	string
drive_letter optional	Drive letter Example : `E` Pattern : `[E-Z]`	string	E

51 - SqlserverDrSecondariesListResponse

Name	Description	Schema	Default
contents required	DR Secondaries list	array[SqlserverDrSecondaryItem]
count required	DR Secondary count Example :	integer

52 - SqlserverDrSecondaryCreateRequest

Name	Description	Schema
ad_user_id required	AD User ID Example : `aduser123` Pattern : `^[a-zA-Z0-9.\-]+$` Minimum length : `3` Maximum length : `20`	string
ad_user_password required	AD User Password Example : `test123!` Minimum length : `8` Maximum length : `30`	string
license required	license Example :	string
name required	Secondary Name Example : Minimum length : `3` Maximum length : `15`	string
region required	Region Example :	string
service_ip_address optional	User subnet IP address Example :	any of [string, null]
subnet_id required	Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint. Example :	string

53 - SqlserverDrSecondaryItem

Name	Description	Schema
check_time required	DR Secondary check time Example :	any of [string, null]
name required	Server name Example :	string
region_nm required	DR Secondary region Example :	any of [string, null]
state required	DR Secondary state Example :	any of [string, null]
state_detail required	DR Secondary detail state Example :	any of [string, null]

54 - SqlserverInitConfigOptionRequest

Name	Description	Schema	Default
ad_config optional	AD Configuration	any of [SqlserverAdConfigRequest, null]
ad_enabled optional	AD Enabled Example : `False`	boolean
audit_enabled optional	Audit usage state Example : `False`	boolean
backup_option optional	Backup setting option	any of [SqlserverBackupOption, null]
database_collation optional	Example : `SQL_Latin1_General_CP1_CI_AS`	enum (SQL_Latin1_General_CP1_CI_AS, Korean_Wansung_CS_AS, Chinese_PRC_CI_AS)	SQL_Latin1_General_CP1_CI_AS
database_name optional	Example : `{}`	object
database_port optional	Database service port Example : `2866` Minimum : `1200` Maximum : `65535`	integer	2866
database_service_name required	Database Service Name Example : `Sqldbadmin` Pattern : `^[A-Z][a-zA-Z]$` Minimum length* : `1` Maximum length : `15`	string
database_user_name required	Database User Name Example : `mydatabaseusr` Pattern : `^[a-zA-Z0-9]$` Minimum length* : `2` Maximum length : `20`	string
database_user_password required	Database user password Example : `test123!` Minimum length : `8` Maximum length : `30`	string
databases required	Databases	array[SqlserverDatabaseOption]
license required	license Example : `AAAAA-AAAAA-AAAAA-AAAAA`	string

55 - SqlserverInitConfigOptionResponse

Name	Description	Schema	Default
ad_config optional		any of [SqlserverAdConfigResponse, null]
ad_enabled optional	AD Enabled Example : `False`	boolean
audit_enabled optional	Audit usage state Example : `False`	boolean
backup_option optional	Backup setting option	any of [SqlserverBackupOption, null]
database_collation optional	Example : `SQL_Latin1_General_CP1_CI_AS`	enum (SQL_Latin1_General_CP1_CI_AS, Korean_Wansung_CS_AS, Chinese_PRC_CI_AS)	SQL_Latin1_General_CP1_CI_AS
database_port optional	Database service port Example : `2866` Minimum : `1024` Maximum : `65535`	integer	2866
database_service_name required	Database Service Name Example :	string
database_user_name required	Database User Name Example :	string
databases required	Databases	array[SqlserverDatabaseOption]

56 - SqlserverInstanceGroupRequest

Name	Description	Schema
block_storage_groups required	Block storage groups list Example : `[{'role_type': 'OS', 'size_gb': 104, 'volume_type': 'SSD'}, {'role_type': 'DATA', 'size_gb': 56, 'volume_type': 'SSD'}]`	array[BlockStorageGroupRequest]
instances required	Instances list	array[SqlserverInstanceRequest]
role_type required	Role type Example : `ACTIVE`	enum (ACTIVE, PRIMARY_SECONDARY)
server_type_name required	Server type name Example : `db1v2m4`	string

57 - SqlserverInstanceGroupResponse

Name	Description	Schema
block_storage_groups required		array[SqlserverBlockStorageGroupResponse]
id required	ID Example :	string
instances required	Instances list	array[InstanceResponse]
role_type required	Role type Example : `ACTIVE`	enum (ACTIVE, ACTIVE_STANDBY, PRIMARY_SECONDARY, MASTER, MASTER_REPLICA, REPLICA, SENTINEL, MASTER_DATA, DATA, KIBANA, DASHBOARDS, ZOOKEEPER_BROKER, BROKER, ZOOKEEPER, AKHQ, CONSOLE, PRIMARY, PRIMARY_NODE, READ_NODE)
server_type_name required	Server type name Example :	string

58 - SqlserverInstanceRequest

Name	Description	Schema
public_ip_id optional	Public IP ID. The ID can be obtained via “GET /vpc/v1/publicips” endpoint. Example :	any of [string, null]
role_type required	Role type Example : `ACTIVE`	enum (ACTIVE, PRIMARY, SECONDARY)
service_ip_address optional	User subnet IP address Example : `192.168.10.10/32`	any of [string, null]

59 - SqlserverUpdateDatabasesRequest

Name	Description	Schema	Default
add_databases optional	Databases	any of [array[SqlserverDatabaseOption], null]
del_databases optional	Databases	any of [array[SqlserverDatabaseOption], null]

60 - Tag

Name	Description	Schema	Default
key optional	Example :	string
value optional	Example :	any of [string, null]

61 - UpdateSecurityGroupRulesRequest

Name	Description	Schema	Default
add_ip_addresses optional	Allowed IP addresses list	array[string]
del_ip_addresses optional	Allowed IP addresses list	array[string]