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: AsyncResponse
3: BackupHistoryApiItem
4: BackupHistoryListApiResponse
5: BackupHistoryNumberRequest
6: BackupSettingExcludingArchiveRequest
7: BlockStorageGroupRequest
8: BlockStorageGroupResponse
9: ClusterPageResponse
10: ClusterResponse
11: Engine
12: EngineListResponse
13: EngineProperty
14: EnginePropertyListResponse
15: InstanceGroupRequest
16: InstanceGroupResizeRequest
17: InstanceGroupResponse
18: InstanceRequest
19: InstanceResponse
20: MaintenanceOption
21: MaintenanceRequest
22: MaintenanceResponseOption
23: RequestStateResponse
24: ResizeBlockStorageGroupRequest
25: ResourceInfo
26: SearchEngineClusterAddInstancesRequest
27: SearchEngineClusterCreateRequest
28: SearchEngineClusterDetailResponse
29: SearchEngineClusterRestoreRequest
30: SearchEngineInitConfigOptionRequest
31: SearchEngineInitConfigOptionResponse
32: SearchEngineLicenseResponse
33: SearchEngineRestoreInstanceGroup
34: ServerType
35: ServerTypeListResponse
36: Tag
37: 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 - AsyncResponse

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

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 - 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	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By 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	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)

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

12 - EngineListResponse

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

13 - EngineProperty

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

14 - EnginePropertyListResponse

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

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

16 - InstanceGroupResizeRequest

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

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

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

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

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

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

24 - ResizeBlockStorageGroupRequest

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

25 - ResourceInfo

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

26 - SearchEngineClusterAddInstancesRequest

Name	Description	Schema
instance_count required	Instance Count Example :	integer
public_ip_ids optional	Public IP ID List Example :	any of [array[string], null]
service_ip_addresses required	User subnet IP address	array[string]

27 - SearchEngineClusterCreateRequest

Name	Description	Schema
allowable_ip_addresses optional	Allowed IP addresses list	array[string]
dbaas_engine_version_id required	DBaaS engine version ID Example :	string
init_config_option required	DB initial configuration option	SearchEngineInitConfigOptionRequest
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
is_combined optional	Master Data server separation state Example : `False`	boolean
license optional	license Example :	any of [string, null]
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
subnet_id required	Subnet ID Example :	string
tags optional	tag	any of [array[Tag], null]
timezone required	Timezone Example :	string

28 - SearchEngineClusterDetailResponse

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 : `PostgreSQL`	enum (PostgreSQL, Redis, Valkey Sentinel, MariaDB, MySQL, Elasticsearch Enterprise, OpenSearch, EPAS, Microsoft SQL Server, Kafka, Vertica)
dbaas_engine_version_name required	DBaaS engine version name Example :	string
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
init_config_option required	DB initial configuration option	SearchEngineInitConfigOptionResponse
instance_count optional	Instance Count Example : `0`	integer
instance_groups required	Instance groups list	array[InstanceGroupResponse]
is_combined optional	Master Data server separation state Example :	any of [boolean, null]
license optional	Maintenance option	any of [SearchEngineLicenseResponse, null]
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 :	any of [boolean, null]
product_image_type required	Product image type Example :	string
product_type required	Product type Example : `Search Engine`	enum (QOS, PostgreSQL Community, EPAS, MariaDB, MySQL, Redis, Microsoft SQL Server, Search Engine, Event Streams, Vertica, Scalable DB)
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

29 - SearchEngineClusterRestoreRequest

Name	Description	Schema
allowable_ip_addresses optional	Allowed IP addresses list	array[string]
backup_history_number required	Backup id Example :	string
instance_groups required	Instance groups list	array[SearchEngineRestoreInstanceGroup]
instance_name_prefix required	Instance name prefix Example : Pattern : `^[a-z][a-zA-Z0-9\-]$` Minimum length* : `3` Maximum length : `16`	string
license optional	license Example :	any of [string, null]
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
tags optional	tag	any of [array[Tag], null]

30 - SearchEngineInitConfigOptionRequest

Name	Description	Schema	Default
backup_option optional	Backup setting option	any of [BackupSettingExcludingArchiveRequest, null]
database_port optional	Database service port Example : `9200`	any of [integer, null]	9200
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

31 - SearchEngineInitConfigOptionResponse

Name	Description	Schema	Default
backup_option optional	Backup setting option	any of [BackupSettingExcludingArchiveRequest, null]
dashboards_port optional	Dashboards port Example :	any of [integer, null]
database_port optional	Database service port Example : `9200`	any of [integer, null]	9200
database_user_name required	Database User Name Example :	string
kibana_port optional	Kibana port Example :	any of [integer, null]

32 - SearchEngineLicenseResponse

Name	Description	Schema
license_expiry_date required	License expiry date Example :	string
license_status required	License state Example :	string
license_type required	License type Example :	string

33 - SearchEngineRestoreInstanceGroup

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

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

35 - ServerTypeListResponse

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

36 - Tag

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

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