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

Models

1: AsyncResponse
2: BackupHistoryApiItem
3: BackupHistoryListApiResponse
4: BackupHistoryNumberRequest
5: BackupOption
6: BackupSettingExcludingArchiveRequest
7: BlockStorageGroupRequest
8: BlockStorageGroupResponse
9: ClusterPageResponse
10: ClusterResponse
11: ClusterRestoreRequest
12: CommandItem
13: CommandListResponse
14: Engine
15: EngineListResponse
16: EngineProperty
17: EnginePropertyListResponse
18: InstanceGroupResizeRequest
19: InstanceRequest
20: MaintenanceOption
21: MaintenanceRequest
22: MaintenanceResponseOption
23: ModifyCommandItem
24: ModifyCommandRequest
25: ParameterDTO
26: ParameterGroup
27: ParameterGroupListResponse
28: ParameterPageResponse
29: ParameterRequest
30: Parameters
31: ParametersRequest
32: ParametersResponse
33: RedisBlockStorageGroupRequest
34: RedisClusterCreateRequest
35: RedisClusterDetailResponse
36: RedisInitConfigOption
37: RedisInitConfigOptionResponse
38: RedisInstanceGroupRequest
39: RedisInstanceGroupResponse
40: RedisInstanceResponse
41: RedisSwitchOverTargetRequest
42: RequestStateResponse
43: ResizeBlockStorageGroupRequest
44: ResourceInfo
45: ServerType
46: ServerTypeListResponse
47: Tag
48: 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 - 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

3 - BackupHistoryListApiResponse

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

4 - BackupHistoryNumberRequest

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

5 - BackupOption

Name	Description	Schema	Default
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]

6 - BackupSettingExcludingArchiveRequest

Name	Description	Schema	Default
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

7 - 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

8 - BlockStorageGroupResponse

Name	Description	Schema
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)

9 - ClusterPageResponse

Name	Description	Schema
contents required	Clusters list	any of [array[ClusterResponse], 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]

10 - ClusterResponse

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
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), null]
service_state required	Service state Example : `RUNNING`	enum (RUNNING, STOPPED, UNKNOWN, ERROR, FAILED, TERMINATED, CREATING, STOPPING, STARTING, RESTARTING, EDITING, SYNCHRONIZING, UPGRADING, TERMINATING, MIGRATING)

11 - ClusterRestoreRequest

Name	Description	Schema
allowable_ip_addresses optional	Allowed IP addresses list	array[string]
backup_history_number optional	Backup id Example :	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 : 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 : 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]

12 - CommandItem

Name	Description	Schema
applied_value optional	Example :	any of [string, null]
description optional	Example :	any of [string, null]
id required	Example :	string
modifiable required	Example :	boolean
name required	Example :	string

13 - CommandListResponse

Name	Description	Schema
contents required	Command list information	array[CommandItem]
last_updated_at required	Modification time Example :	string
total_count required	Total number of commands Example :	integer

14 - 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

15 - EngineListResponse

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

16 - EngineProperty

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

17 - EnginePropertyListResponse

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

18 - InstanceGroupResizeRequest

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

19 - InstanceRequest

Name	Description	Schema
public_ip_id optional	Public IP ID 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]

20 - MaintenanceOption

Name	Description	Schema
period_hour optional	Period in hours Example : 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 :	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 - ModifyCommandItem

Name	Description	Schema
id required	Example :	string
name required	Example :	string
new_value required	Command modification value Example : Minimum length : `3` Maximum length : `20`	string

24 - ModifyCommandRequest

Name	Description	Schema	Default
commands required	Apply command information	array[ModifyCommandItem]

25 - 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]

26 - 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

27 - ParameterGroupListResponse

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

28 - 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]

29 - 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

30 - 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]

31 - ParametersRequest

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

32 - ParametersResponse

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

33 - RedisBlockStorageGroupRequest

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

34 - RedisClusterCreateRequest

Name	Description	Schema
allowable_ip_addresses optional	Allowed IP addresses list	array[string]
dbaas_engine_version_id required	DBaaS engine version ID Example :	string
ha_enabled optional	HA availability Example : `False`	boolean
init_config_option required		RedisInitConfigOption
instance_groups required		array[RedisInstanceGroupRequest]
instance_name_prefix required	Instance name prefix Example : Pattern : `^[a-z][a-zA-Z0-9\-]$` Minimum length* : `3` Maximum length : `13`	string
maintenance_option optional	Maintenance option	any of [MaintenanceOption, null]
name required	Cluster name Example : Pattern : `^[a-zA-Z]$` Minimum length* : `3` Maximum length : `20`	string
nat_enabled optional	NAT availability Example : `False`	boolean
replica_count optional	Replica count Example : `0`	any of [integer, null]
subnet_id required	Subnet ID Example :	string
tags optional	tag	any of [array[Tag], null]
timezone required	Timezone Example :	string

35 - RedisClusterDetailResponse

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		RedisInitConfigOptionResponse
instance_count optional	Instance Count Example : `0`	integer
instance_groups required		array[RedisInstanceGroupResponse]
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), 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 Example :	string
timezone required	Timezone Example :	string

36 - RedisInitConfigOption

Name	Description	Schema	Default
backup_option optional	Backup setting option	any of [BackupOption, null]
database_port optional	Database service port Example : `6378`	any of [integer, null]	6378
database_user_password required	Database user password Example :	any of [string, null]
sentinel_port optional	Sentinel port Example : `26378`	any of [integer, null]	26378

37 - RedisInitConfigOptionResponse

Name	Description	Schema
backup_option optional	Backup setting option	any of [BackupOption, null]
database_port optional	Example :	any of [integer, null]
sentinel_port optional	Example :	any of [integer, null]

38 - RedisInstanceGroupRequest

Name	Description	Schema
block_storage_groups required	Block storage groups list	array[RedisBlockStorageGroupRequest]
instances required	Instances list	any of [array[InstanceRequest], null]
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

39 - RedisInstanceGroupResponse

Name	Description	Schema
block_storage_groups required	Block storage groups list	array[BlockStorageGroupResponse]
id required	ID Example :	string
instances required	Instances list	any of [array[RedisInstanceResponse], null]
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

40 - RedisInstanceResponse

Name	Description	Schema
floating_ip_id optional	Floating IP ID Example :	any of [string, null]
name required	Name Example :	string
public_ip_address optional	Public IP Address Example :	any of [string, null]
public_ip_id optional	Public IP ID 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)

41 - RedisSwitchOverTargetRequest

Name	Description	Schema	Default
switch_host_name required	Switch over target Example :	string

42 - RequestStateResponse

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

43 - ResizeBlockStorageGroupRequest

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

44 - ResourceInfo

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

45 - 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

46 - ServerTypeListResponse

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

47 - Tag

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

48 - 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]