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

Return to the regular view of this page.

Models

1: AsyncResponse
2: BlockStorageGroupRequest
3: BlockStorageGroupResponse
4: BlockStorageResponse
5: ClusterPageResponse
6: ClusterResponse
7: Engine
8: EngineListResponse
9: EngineProperty
10: EnginePropertyListResponse
11: EventStreamsClusterAddInstancesRequest
12: EventStreamsClusterCreateRequest
13: EventStreamsClusterCreateRequestV1Dot1
14: EventStreamsClusterDetailResponse
15: EventStreamsClusterDetailResponseV1Dot1
16: EventStreamsInitConfigOptionDetail
17: EventStreamsInitConfigOptionRequest
18: EventStreamsInstanceGroupRequest
19: EventStreamsInstanceRequest
20: InstanceDetailResponse
21: InstanceGroupResizeRequest
22: InstanceGroupResponse
23: InstanceResponse
24: MaintenanceOption
25: MaintenanceRequest
26: MaintenanceResponseOption
27: MinorPatchDbEngineRequest
28: ParameterDTO
29: ParameterGroup
30: ParameterGroupListResponse
31: ParameterPageResponse
32: ParameterRequest
33: Parameters
34: ParametersRequest
35: ParametersResponse
36: RequestStateResponse
37: ResizeBlockStorageGroupRequest
38: ResourceInfo
39: ServerType
40: ServerTypeListResponse
41: Tag
42: 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 - 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

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

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

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

6 - 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, 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)

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

8 - EngineListResponse

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

9 - EngineProperty

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

10 - EnginePropertyListResponse

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

11 - EventStreamsClusterAddInstancesRequest

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]

12 - EventStreamsClusterCreateRequest

Name	Description	Schema
akhq_enabled optional	AKHQ availability Example : `False`	boolean
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 :	string
init_config_option required	DB initial configuration option	EventStreamsInitConfigOptionRequest
instance_groups required	Instance groups list	array[EventStreamsInstanceGroupRequest]
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	HA availability Example : `False`	boolean
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. The ID can be obtained via the GET /vpc/v1/subnets endpoint. Example :	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 :	string

13 - EventStreamsClusterCreateRequestV1Dot1

Name	Description	Schema
akhq_enabled optional	AKHQ availability Example : `False`	boolean
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 :	string
init_config_option required	DB initial configuration option	EventStreamsInitConfigOptionRequest
instance_groups required	Instance groups list	array[EventStreamsInstanceGroupRequest]
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	HA availability Example : `False`	boolean
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
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 :	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 :	string

14 - EventStreamsClusterDetailResponse

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
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
init_config_option required	DB initial configuration option	EventStreamsInitConfigOptionDetail
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]
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 : `Event Streams`	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

15 - EventStreamsClusterDetailResponseV1Dot1

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
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
init_config_option required	DB initial configuration option	EventStreamsInitConfigOptionDetail
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]
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 : `Event Streams`	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

16 - EventStreamsInitConfigOptionDetail

Name	Description	Schema	Default
broker_port optional	broker port Example : `9091` Minimum : `1024` Maximum : `65535`	integer	9091
zookeeper_port optional	zookeeper port Example : `2180` Minimum : `1024` Maximum : `65535`	integer	2180

17 - EventStreamsInitConfigOptionRequest

Name	Description	Schema	Default
akhq_id optional	akhq id Example : Pattern : `^[a-z]+$`	any of [string, null]
akhq_password optional	akhq password Example :	any of [string, null]
broker_port optional	broker port Example : `9091` Minimum : `1200` Maximum : `65535`	integer	9091
broker_sasl_id required	broker sasl id Example : `brokeradmin` Pattern : `^[a-z]+$` Minimum length : `2` Maximum length : `20`	string
broker_sasl_password required	broker sasl password Example : `brokerpass123` Maximum length : `30`	string
zookeeper_port optional	zookeeper port Example : `2180` Minimum : `1200` Maximum : `65535`	integer	2180
zookeeper_sasl_id required	zookeeper sasl id Example : `zkadmin` Pattern : `^[a-z]+$` Minimum length : `2` Maximum length : `20`	string
zookeeper_sasl_password required	zookeeper sasl password Example : `zkpass123` Maximum length : `30`	string

18 - EventStreamsInstanceGroupRequest

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[EventStreamsInstanceRequest]
role_type required	Role type Example : `BROKER`	enum (AKHQ, BROKER, ZOOKEEPER, ZOOKEEPER_BROKER)
server_type_name required	Server type name Example : `ess1v2m4`	string

19 - EventStreamsInstanceRequest

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 : `BROKER`	enum (AKHQ, BROKER, ZOOKEEPER, ZOOKEEPER_BROKER)
service_ip_address optional	User subnet IP address Example : `192.168.10.10/32`	any of [string, null]

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

21 - InstanceGroupResizeRequest

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

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

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

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

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

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

27 - MinorPatchDbEngineRequest

Name	Description	Schema	Default
dbaas_engine required	dbaas_engine Example :	string
software_version required	software_version Example :	string

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

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

30 - ParameterGroupListResponse

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

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

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

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

34 - ParametersRequest

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

35 - ParametersResponse

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

36 - RequestStateResponse

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

37 - ResizeBlockStorageGroupRequest

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

38 - ResourceInfo

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

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

40 - ServerTypeListResponse

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

41 - Tag

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

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