This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Models

1: AddBlockStoragesRequest
2: ArchiveConfigDetailResponse
3: ArchiveConfigSetRequest
4: AsyncResponse
5: BackupHistoryApiItem
6: BackupHistoryListApiResponse
7: BackupHistoryNumberRequest
8: BackupSettingRequest
9: BlockStorageGroupRequest
10: BlockStorageGroupResponse
11: ClusterRestoreRequest
12: Engine
13: EngineListResponse
14: EngineProperty
15: EnginePropertyListResponse
16: InstanceGroupRequest
17: InstanceGroupResizeRequest
18: InstanceGroupResponse
19: InstanceRequest
20: InstanceResponse
21: LogExportConfig
22: LogExportConfigCreateRequest
23: LogExportConfigListResponse
24: LogExportConfigModifyRequest
25: MaintenanceOption
26: MaintenanceRequest
27: MaintenanceResponseOption
28: MinorPatchRequest
29: MysqlBackupOption
30: MysqlClusterCreateRequest
31: MysqlClusterDetailResponse
32: MysqlInitConfigOptionRequest
33: MysqlInitConfigOptionResponseDetail
34: ParameterDTO
35: ParameterGroup
36: ParameterGroupListResponse
37: ParameterPageResponse
38: ParameterRequest
39: Parameters
40: ParametersRequest
41: ParametersResponse
42: RdbClusterPageResponse
43: RdbClusterResponse
44: ReplicaItem
45: Replicas
46: ReplicasCreateRequest
47: ReplicasListResponse
48: RequestStateResponse
49: ResizeBlockStorageGroupRequest
50: ResourceInfo
51: ServerType
52: ServerTypeListResponse
53: Tag
54: UpdateSecurityGroupRulesRequest

1 - AddBlockStoragesRequest

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

2 - ArchiveConfigDetailResponse

Name	Description	Schema	Default
archive_enabled required	Archive enabled Example : `True`	boolean
retention_period_day optional	Backup retention period (day) Example : `1`	any of [integer, null]	1

3 - ArchiveConfigSetRequest

Name	Description	Schema	Default
archive_enabled required	Archive enabled Example : `True`	boolean
retention_period_day optional	Backup retention period (day) Example : `1`	any of [integer, null]	1

4 - AsyncResponse

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

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

6 - BackupHistoryListApiResponse

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

7 - BackupHistoryNumberRequest

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

8 - BackupSettingRequest

Name	Description	Schema
archive_frequency_minute required	Backup starting time (minute) Example : Pattern : `^(5\|10\|30\|60)$`	string
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

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

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

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

13 - EngineListResponse

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

14 - EngineProperty

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

15 - EnginePropertyListResponse

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

16 - InstanceGroupRequest

Name	Description	Schema
block_storage_groups required	Block storage groups list	array[BlockStorageGroupRequest]
instances optional	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

17 - InstanceGroupResizeRequest

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

18 - InstanceGroupResponse

Name	Description	Schema
block_storage_groups required	Block storage groups list	array[BlockStorageGroupResponse]
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

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

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

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

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

23 - LogExportConfigListResponse

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

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

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

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

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

28 - MinorPatchRequest

Name	Description	Schema	Default
backup_before_upgrade required	backup_before_upgrade Example :	boolean
software_version required	software_version Example :	string

29 - MysqlBackupOption

Name	Description	Schema	Default
archive_frequency_minute optional	Backup starting time (minute) Example : `60` Pattern : `^(5\|10\|30\|60)$`	any of [string, null]	60
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]

30 - MysqlClusterCreateRequest

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	DB initial configuration option	MysqlInitConfigOptionRequest
instance_groups required	Instance groups list	array[InstanceGroupRequest]
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
origin_cluster_id optional	Origin cluster ID Example :	any of [string, null]
subnet_id required	Subnet ID Example :	string
tags optional	tag	any of [array[Tag], null]
timezone required	Timezone Example :	string
vip_public_ip_id optional	(VIP) Public IP ID Example :	any of [string, null]
virtual_ip_address optional	Virtual IP address Example :	any of [string, null]

31 - MysqlClusterDetailResponse

Name	Description	Schema
account_id required	Account ID Example :	string
allowable_ip_addresses optional	Allowed IP addresses list	array[string]
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By 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		MysqlInitConfigOptionResponseDetail
instance_count optional	Instance Count Example : `0`	integer
instance_groups required	Instance groups list	array[InstanceGroupResponse]
maintenance_option optional	Maintenance option	any of [MaintenanceResponseOption, null]
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Cluster name Example :	string
nat_enabled optional	NAT availability Example : `False`	boolean
origin_cluster_id optional	Origin cluster ID Example :	any of [string, null]
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)
replicas optional	Replicas list Example :	any of [array[string], null]
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
vip_public_ip_address optional	(VIP) Public IP Address Example :	any of [string, null]
vip_public_ip_id optional	(VIP) Public IP ID Example :	any of [string, null]
virtual_ip_address optional	Virtual IP address Example :	any of [string, null]

32 - MysqlInitConfigOptionRequest

Name	Description	Schema	Default
audit_enabled optional	Example : `{}`	object
backup_option optional	Backup setting option	any of [MysqlBackupOption, null]
database_case_sensitive optional	Database case sensitivity Example : `False`	boolean
database_character_set optional	Database encoding Example : `utf8`	any of [string, null]	utf8
database_name required	Database Name Example : Pattern : `^[a-zA-Z][a-zA-Z0-9]$` Minimum length* : `3` Maximum length : `20`	string
database_port optional	Database service port Example : `2866`	any of [integer, null]	2866
database_user_name required	Database User Name Example : Pattern : `^[a-z]$` Minimum length* : `2` Maximum length : `20`	string
database_user_password required	Database user password Example : Minimum length : `8` Maximum length : `30`	string

33 - MysqlInitConfigOptionResponseDetail

Name	Description	Schema	Default
backup_option optional	Backup setting option	any of [MysqlBackupOption, null]
database_character_set optional	Database encoding Example : `utf8`	any of [string, null]	utf8
database_name required	Database Name Example :	string
database_port optional	Database service port Example : `2866`	any of [integer, null]	2866
database_user_name required	Database User Name Example :	string
origin_region optional	Origin Region Example :	any of [string, null]

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

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

36 - ParameterGroupListResponse

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

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

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

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

40 - ParametersRequest

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

41 - ParametersResponse

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

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

43 - RdbClusterResponse

Name	Description	Schema
account_id required	Account ID Example :	string
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By 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	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By 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)

44 - ReplicaItem

Name	Description	Schema
name required	Server name Example :	string
region required	Replica region Example :	any of [string, null]
replica_state required	Replica state Example :	any of [string, null]
replica_state_detail required	Replica detail state Example :	any of [string, null]
synced_at required	Replica check time Example :	any of [string, null]

45 - Replicas

Name	Description	Schema	Default
instance_groups required	Instance groups list	array[InstanceGroupRequest]
name required	Replica Name Example : Pattern : `^[a-z][a-z0-9\-][a-z0-9]$` Minimum length* : `3` Maximum length : `19`	string

46 - ReplicasCreateRequest

Name	Description	Schema
allowable_ip_addresses required	Allowed IP addresses list Example :	any of [array[string], null]
maintenance_option optional	Maintenance option	any of [MaintenanceOption, null]
replica_count required	Replica count Example :	integer
replicas required	Replicas list	array[Replicas]
tags optional	tag	any of [array[Tag], null]

47 - ReplicasListResponse

Name	Description	Schema	Default
contents required	Replicas list	array[ReplicaItem]
count required	Replica count Example :	integer

48 - RequestStateResponse

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

49 - ResizeBlockStorageGroupRequest

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

50 - ResourceInfo

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

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

52 - ServerTypeListResponse

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

53 - Tag

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

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