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: BaremetalActionResponse
3: BaremetalCreateRequest
4: BaremetalCreateRequestV1Dot2
5: BaremetalListResponse
6: BaremetalListResponseV1Dot1
7: BaremetalListResponseV1Dot2
8: BaremetalListV1Dot1
9: BaremetalListV1Dot2
10: BaremetalServerAssignPrivateNatIpRequest
11: BaremetalServerAssignPublicNatIpRequest
12: BaremetalServerIdResponse
13: BaremetalShowResponse
14: BaremetalShowResponseV1Dot1
15: BaremetalShowResponseV1Dot2
16: BaremetalsOperationRequest
17: BaremetalStaticNatResponseV1Dot1
18: BaremetalTerminateRequest
19: ImageListResponse
20: ImageShowResponse
21: LocalDiskPartitionsRequest
22: LocalSubnetAttachRequest
23: LocalSubnetDetachRequest
24: LocalSubnetInfoResponse
25: LocalSubnetResponse
26: ProductListResponse
27: ProductListResponseV1Dot1
28: ProductShowResponse
29: ProductShowResponseV1Dot1
30: ServerDetailsRequest
31: ServerDetailsRequestV1Dot2
32: TagRequest

1 - AsyncResponse

Name	Description	Schema
account_id required	Account ID Example : `f5c8e56a4d9b49a8bd89e14758a32d53`	string
request_id required	Request ID Example : `req-002daa83-52d9-41e8-9b0f-d31d35610f65`	string
resource_id required	Resource ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string

2 - BaremetalActionResponse

Name	Description	Schema	Default
baremetal_id required	Bare Metal Server ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string

3 - BaremetalCreateRequest

Name	Description	Schema
region_id required	Region ID Example : `kr-west1`	string
lock_enabled optional	Use Lock Example : `True`	boolean
image_id required	Image ID Example : `IMAGE-7XFMaJpLsapKvskFMjCtmm`	string
init_script optional	Init script Example : `init script`	any of [string, null]
os_user_id required	OS user ID Example : `user001`	string
os_user_password required	OS user password Example : `password`	string
vpc_id required	VPC ID Example : `e58348b1bc9148e5af86500fd4ef99ca`	string
subnet_id required	Subnet ID Example : `ab313c43291e4b678f4bacffe10768ae`	string
server_details required	Detailed settings for each server	array[ServerDetailsRequest]
use_placement_group optional	Use Placement Group Example : `False`	boolean
placement_group_name optional	Placement Group Name Example : `pgtest`	any of [string, null]
tags optional	Tag	any of [array[TagRequest], null]

4 - BaremetalCreateRequestV1Dot2

Name	Description	Schema
region_id required	Region ID Example : `kr-west1`	string
lock_enabled optional	Use Lock Example : `True`	boolean
image_id required	Image ID Example : `IMAGE-7XFMaJpLsapKvskFMjCtmm`	string
init_script optional	Init script Example : `init script`	any of [string, null]
os_user_id required	OS user ID Example : `user001`	string
os_user_password required	OS user password Example : `password`	string
vpc_id required	VPC ID Example : `e58348b1bc9148e5af86500fd4ef99ca`	string
subnet_id required	Subnet ID Example : `ab313c43291e4b678f4bacffe10768ae`	string
server_details required	Detailed settings for each server	array[ServerDetailsRequestV1Dot2]
use_placement_group optional	Use Placement Group Example : `False`	boolean
placement_group_name optional	Placement Group Name Example : `pgtest`	any of [string, null]
tags optional	Tag	any of [array[TagRequest], null]

5 - BaremetalListResponse

Name	Description	Schema	Default
baremetals required		array[BaremetalShowResponse]
count required	count Example : `20`	any of [integer, null]

6 - BaremetalListResponseV1Dot1

Name	Description	Schema	Default
baremetals required		array[BaremetalListV1Dot1]
count required	count Example : `20`	integer

7 - BaremetalListResponseV1Dot2

Name	Description	Schema	Default
baremetals required		array[BaremetalListV1Dot2]
count required	count Example : `20`	integer

8 - BaremetalListV1Dot1

Name	Description	Schema
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
server_name required	Bare Metal Server name Example : `bmserver-001`	string
lock_enabled optional	Use Lock Example : `True`	boolean
policy_ip required	Policy IP Example : `192.168.0.1`	string
product_type_id required	Bare Metal Server scale ID Example : `f90e8ef54cc2451b825608e9f95f7bcb`	string
server_type required	Bare Metal Server scale type Example : `s1v8m32_metal`	string
image_id required	Image ID Example : `IMAGE-7XFMaJpLsapKvskFMjCtmm`	string
image_version required	Image version Example : `RHEL 8.7 for BM`	string
state required	Bare Metal Server state Example : `RUNNING`	string
os_type required	OS type Example : `WINDOWS`	string
vpc_id required	VPC ID Example : `e58348b1bc9148e5af86500fd4ef99ca`	string
network_id required	Subnet ID Example : `ab313c43291e4b678f4bacffe10768ae`	string
region_id required	Region ID Example : `kr-west1`	string
placement_group_name optional	Placement Group Name Example : `pgtest`	any of [string, null]

9 - BaremetalListV1Dot2

Name	Description	Schema
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
server_name required	Bare Metal Server name Example : `bmserver-001`	string
lock_enabled optional	Use Lock Example : `True`	boolean
policy_ip required	Policy IP Example : `192.168.0.1`	string
product_type_id required	Bare Metal Server scale ID Example : `f90e8ef54cc2451b825608e9f95f7bcb`	string
server_type required	Bare Metal Server scale type Example : `s1v8m32_metal`	string
image_id required	Image ID Example : `IMAGE-7XFMaJpLsapKvskFMjCtmm`	string
image_version required	Image version Example : `RHEL 8.7 for BM`	string
state required	Bare Metal Server state Example : `RUNNING`	string
os_type required	OS type Example : `WINDOWS`	string
vpc_id required	VPC ID Example : `e58348b1bc9148e5af86500fd4ef99ca`	string
network_id required	Subnet ID Example : `ab313c43291e4b678f4bacffe10768ae`	string
region_id required	Region ID Example : `kr-west1`	string
placement_group_name optional	Placement Group Name Example : `pgtest`	any of [string, null]
zone optional	Availability Zone Example : `kr-west1-a`	any of [string, null]

10 - BaremetalServerAssignPrivateNatIpRequest

Name	Description	Schema	Default
private_nat_id required	Private NAT ID Example : `a4fd0216cd32442a82733bbb8be0e82b`	string
private_nat_ip_id required	Private NAT IP ID Example : `03cd065d8acc4e47b11a11dc1411323e`	string

11 - BaremetalServerAssignPublicNatIpRequest

Name	Description	Schema	Default
public_ip_address_id required	Public IP ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string

12 - BaremetalServerIdResponse

Name	Description	Schema	Default
baremetal_id required	Bare Metal Server ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string

13 - BaremetalShowResponse

Name	Description	Schema
id required	Bare Metal Server ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created by Example : `ef716e80-1fac-4faa-892d-0132fc7f5583`	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified by Example : `ef716e80-1fac-4faa-892d-0132fc7f5583`	string
account_id required	Account ID Example : `f5c8e56a4d9b49a8bd89e14758a32d53`	string
region_id required	Region ID Example : `kr-west1`	string
server_name required	Bare Metal Server name Example : `bmserver-001`	string
lock_enabled optional	Use Lock Example : `True`	boolean
root_account required	Root Account Example : `rootaccount`	string
time_zone required	Time Zone Example : `Asia/Seoul`	string
vpc_id required	VPC ID Example : `e58348b1bc9148e5af86500fd4ef99ca`	string
network_id required	Subnet ID Example : `ab313c43291e4b678f4bacffe10768ae`	string
policy_ip required	Policy IP Example : `192.168.0.1`	string
use_local_subnet optional	Use Local Subnet Example : `True`	boolean
local_subnet_info optional	Local Subnet info	any of [array[LocalSubnetInfoResponse], null]
policy_use_nat optional	Use Public NAT Example : `True`	boolean
policy_nat optional	Public NAT IP Example : `192.168.0.1`	any of [string, null]
public_nat_status optional	Public NAT status Example : `ACTIVE`	any of [string, null]
product_type_id required	Bare Metal Server scale ID Example : `f90e8ef54cc2451b825608e9f95f7bcb`	string
server_type required	Bare Metal Server scale type Example : `s1v8m32_metal`	string
image_id required	Image ID Example : `IMAGE-7XFMaJpLsapKvskFMjCtmm`	string
image_version required	Image version Example : `RHEL 8.7 for BM`	string
state required	Bare Metal Server state Example : `RUNNING`	string
init_script required	Init script Example : `init script`	string
hyper_threading_use required	Use Hyper Threading Example : `True`	boolean
os_type required	OS type Example : `WINDOWS`	string
placement_group_name optional	Placement Group Name Example : `pgtest`	any of [string, null]

14 - BaremetalShowResponseV1Dot1

Name	Description	Schema
id required	Bare Metal Server ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created by Example : `ef716e80-1fac-4faa-892d-0132fc7f5583`	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified by Example : `ef716e80-1fac-4faa-892d-0132fc7f5583`	string
account_id required	Account ID Example : `f5c8e56a4d9b49a8bd89e14758a32d53`	string
region_id required	Region ID Example : `kr-west1`	string
server_name required	Bare Metal Server name Example : `bmserver-001`	string
lock_enabled optional	Use Lock Example : `True`	boolean
root_account required	Root Account Example : `rootaccount`	string
time_zone required	Time Zone Example : `Asia/Seoul`	string
vpc_id required	VPC ID Example : `e58348b1bc9148e5af86500fd4ef99ca`	string
network_id required	Subnet ID Example : `ab313c43291e4b678f4bacffe10768ae`	string
policy_ip required	Policy IP Example : `192.168.0.1`	string
use_local_subnet optional	Use Local Subnet Example : `True`	boolean
local_subnet_info optional	Local Subnet info	any of [array[LocalSubnetInfoResponse], null]
product_type_id required	Bare Metal Server scale ID Example : `f90e8ef54cc2451b825608e9f95f7bcb`	string
server_type required	Bare Metal Server scale type Example : `s1v8m32_metal`	string
image_id required	Image ID Example : `IMAGE-7XFMaJpLsapKvskFMjCtmm`	string
image_version required	Image version Example : `RHEL 8.7 for BM`	string
state required	Bare Metal Server state Example : `RUNNING`	string
init_script required	Init script Example : `init script`	string
hyper_threading_use required	Use Hyper Threading Example : `True`	boolean
os_type required	OS type Example : `WINDOWS`	string
placement_group_name optional	Placement Group Name Example : `pgtest`	any of [string, null]
private_nat_info optional	Private NAT info	any of [BaremetalStaticNatResponseV1Dot1, null]
public_nat_info optional	Public NAT info	any of [BaremetalStaticNatResponseV1Dot1, null]

15 - BaremetalShowResponseV1Dot2

Name	Description	Schema
id required	Bare Metal Server ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created by Example : `ef716e80-1fac-4faa-892d-0132fc7f5583`	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified by Example : `ef716e80-1fac-4faa-892d-0132fc7f5583`	string
account_id required	Account ID Example : `f5c8e56a4d9b49a8bd89e14758a32d53`	string
region_id required	Region ID Example : `kr-west1`	string
server_name required	Bare Metal Server name Example : `bmserver-001`	string
lock_enabled optional	Use Lock Example : `True`	boolean
root_account required	Root Account Example : `rootaccount`	string
time_zone required	Time Zone Example : `Asia/Seoul`	string
vpc_id required	VPC ID Example : `e58348b1bc9148e5af86500fd4ef99ca`	string
network_id required	Subnet ID Example : `ab313c43291e4b678f4bacffe10768ae`	string
policy_ip required	Policy IP Example : `192.168.0.1`	string
use_local_subnet optional	Use Local Subnet Example : `True`	boolean
local_subnet_info optional	Local Subnet info	any of [array[LocalSubnetInfoResponse], null]
product_type_id required	Bare Metal Server scale ID Example : `f90e8ef54cc2451b825608e9f95f7bcb`	string
server_type required	Bare Metal Server scale type Example : `s1v8m32_metal`	string
image_id required	Image ID Example : `IMAGE-7XFMaJpLsapKvskFMjCtmm`	string
image_version required	Image version Example : `RHEL 8.7 for BM`	string
state required	Bare Metal Server state Example : `RUNNING`	string
init_script required	Init script Example : `init script`	string
hyper_threading_use required	Use Hyper Threading Example : `True`	boolean
os_type required	OS type Example : `WINDOWS`	string
placement_group_name optional	Placement Group Name Example : `pgtest`	any of [string, null]
private_nat_info optional	Private NAT info	any of [BaremetalStaticNatResponseV1Dot1, null]
public_nat_info optional	Public NAT info	any of [BaremetalStaticNatResponseV1Dot1, null]
zone optional	Availability Zone Example : `kr-west1-a`	any of [string, null]
cpu_socket required	CPU 소켓 수 Example : `1`	integer
total_cpu_vcore optional	전체 CPU vCore 수 Example : `64`	any of [integer, null]
cpu_core_use optional	CPU 코어 비활성화 기능 사용 여부 Example : `True`	any of [boolean, null]
cpu_core_active optional	활성화된 CPU 코어 수 Example : `32`	any of [integer, null]
cpu_core_state optional	CPU 코어 상태 Example : `SUCCESS`	any of [string, null]
server_model optional	서버 모델 Example : `ThinkSystem SR650 V2`	any of [string, null]
cpu_unit optional	CPU Unit Example : `vCPU`	any of [string, null]

16 - BaremetalsOperationRequest

Name	Description	Schema	Default
bare_metal_server_ids required	Bare Metal Server IDs Example : `['20c507a036c447cdb3b19468d8ea62ac']`	array[object]

17 - BaremetalStaticNatResponseV1Dot1

Name	Description	Schema
nat_id optional	NAT ID Example : `a4fd0216cd32442a82733bbb8be0e82b`	any of [string, null]
nat_ip_id required	NAT IP ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string
nat_ip required	NAT IP Example : `192.170.2.10`	string
static_nat_id optional	Static NAT ID Example : `a1b97ae4695b40b0866e86a19cb191d3`	any of [string, null]
state required	Static NAT state Example : `ACTIVE`	string

18 - BaremetalTerminateRequest

Name	Description	Schema	Default
baremetal_id_list required	Bare Metal Server IDs Example : `['20c507a036c447cdb3b19468d8ea62ac']`	array[object]

19 - ImageListResponse

Name	Description	Schema	Default
images required		array[ImageShowResponse]

20 - ImageShowResponse

Name	Description	Schema
id required	Image ID Example : `IMAGE-7XFMaJpLsapKvskFMjCtmm`	string
created_at required	Created at Example : `2024-07-11 08:56:59`	string (date-time)
name required	Image name Example : `RHEL 8.8 for BM`	string
os_distro required	OS type Example : `RHEL`	string
scp_os_version required	OS version Example : `8.7`	string
scp_image_type required	Image Type Example : `STANDARD`	string

21 - LocalDiskPartitionsRequest

Name	Description	Schema
mount_point required	Mount Point Example : `/mountpoint`	string
partition_name optional	Partition Name Example : `partitionname`	any of [string, null]
partition_size required	Partition Size Example : `20`	integer
partition_type required	Partition Type Example : `ext4`	string

22 - LocalSubnetAttachRequest

Name	Description	Schema	Default
local_subnet_id required	Local Subnet ID Example : `ab313c43291e4b678f4bacffe10768ae`	string
local_subnet_ip optional	Policy Local Subnet IP Example : `192.168.0.1`	any of [string, null]

23 - LocalSubnetDetachRequest

Name	Description	Schema	Default
local_subnet_id required	Local Subnet ID Example : `ab313c43291e4b678f4bacffe10768ae`	string
local_subnet_ip required	Policy Local Subnet IP Example : `192.168.0.1`	string

24 - LocalSubnetInfoResponse

Name	Description	Schema
local_subnet_id required	Local Subnet ID Example : `ab313c43291e4b678f4bacffe10768ae`	string
policy_local_subnet_ip required	Policy Local Subnet IP Example : `192.168.0.1`	string
vlan_id required	Vlan Id Example : `500`	string
vni_role_name required	VNI Role Name Example : `mgmtJ4dzQBo`	string
interface_name required	Interface Name Example : `ens8f1,bond_serv.2`	string
state required	LocalSubnet IP state Example : `CREATING`	string

25 - LocalSubnetResponse

Name	Description	Schema	Default
baremetal_id required	Bare Metal Server ID Example : `20c507a036c447cdb3b19468d8ea62ac`	string
is_success optional	success flag Example : `True`	boolean

26 - ProductListResponse

Name	Description	Schema	Default
products required	Product List	array[ProductShowResponse]

27 - ProductListResponseV1Dot1

Name	Description	Schema	Default
products required	Product List	array[ProductShowResponseV1Dot1]

28 - ProductShowResponse

Name	Description	Schema
id required	ID Example : `f90e8ef54cc2451b825608e9f95f7bcb`	string
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
attri_name required	Attribute name Example : `attri name`	string
attri_value required	Attribute value Example : `attri value`	string
cpu_generation required	CPU generation Example : `cpu generation`	string
cpu_name required	CPU name Example : `cpu 16 vCore`	string
cpu_unit required	CPU unit Example : `vCPU`	string
cpu_value required	CPU value Example : `64`	string
description required	Description Example : `vCPU 16 │ Memory 128G │ Disk 480G`	string
disk_name required	Disk name Example : `disk_name`	string
disk_unit required	Disk unit Example : `GB`	string
disk_value required	Disk value Example : `480`	string
infiniband_name required	InfiniBand name Example : `infiniband_name`	string
infiniband_unit required	InfiniBand unit Example : `infiniband_unit`	string
infiniband_value required	Infiniband value Example : `infiniband_value`	string
memory_name required	Memory name Example : `server memory 128GB`	string
memory_unit required	Memory unit Example : `GB`	string
memory_value required	Memory value Example : `128`	string
name required	Name Example : `s2v16m128_metal`	string
socket_name required	Socket name Example : `socket_name`	string
socket_unit required	Socket unit Example : `socket_unit`	string
socket_value required	Socket value Example : `socket_value`	string
state required	State Example : `AVAILABLE`	string
type required	Type Example : `SCALE`	string
compute_class_type_name required	Compute class type name Example : `StandardMetal-2`	string
compute_class_type_unit required	Compute class type unit Example : `compute_class_type_unit`	string
compute_class_type_value required	Compute class type value Example : `s2_metal`	string
name_with_generation required	Name with generation Example : `s2v16m128_metal`	string

29 - ProductShowResponseV1Dot1

Name	Description	Schema
cpu_name required	CPU name Example : `cpu 16 vCore`	any of [string, null]
cpu_unit required	CPU unit Example : `vCPU`	string
cpu_value required	CPU value Example : `64`	string
description required	Description Example : `vCPU 16 │ Memory 128G │ Disk 480G`	any of [string, null]
disk_unit required	Disk unit Example : `GB`	any of [string, null]
disk_value required	Disk value Example : `480`	string
id required	ID Example : `f90e8ef54cc2451b825608e9f95f7bcb`	string
memory_name required	Memory name Example : `server memory 128GB`	any of [string, null]
memory_unit required	Memory unit Example : `GB`	any of [string, null]
memory_value required	Memory value Example : `128`	string
name required	Name Example : `s2v16m128_metal`	string
state required	State Example : `AVAILABLE`	string
type required	Type Example : `SCALE`	string
compute_class_type_name required	Compute class type name Example : `StandardMetal-2`	string
compute_class_type_value required	Compute class type value Example : `s2_metal`	string
name_with_generation required	Name with generation Example : `s2v16m128_metal`	string
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
os_disk_gb required	OS disk value Example : `480`	string

30 - ServerDetailsRequest

Name	Description	Schema
bare_metal_local_subnet_id optional	Local Subnet ID Example : `ab313c43291e4b678f4bacffe10768ae`	any of [string, null]
bare_metal_local_subnet_ip_address optional	Policy Local Subnet IP Example : `192.168.0.1`	any of [string, null]
bare_metal_server_name required	Bare Metal Server name Example : `bmserver-001`	string
server_type_id required	Server Type ID Example : `f90e8ef54cc2451b825608e9f95f7bcb`	string
ip_address optional	Private IP Example : `192.168.0.1`	any of [string, null]
nat_enabled required	Use Public NAT Example : `True`	boolean
public_ip_address_id optional	Public IP ID Example : `20c507a036c447cdb3b19468d8ea62ac`	any of [string, null]
local_disk_partitions optional	Local Disk Partitions	any of [array[LocalDiskPartitionsRequest], null]
local_disk_type optional	Local Disk Type Example : `flat`	any of [string, null]
use_hyper_threading optional	Use Hyper Threading Example : `True`	boolean

31 - ServerDetailsRequestV1Dot2

Name	Description	Schema
bare_metal_local_subnet_id optional	Local Subnet ID Example : `ab313c43291e4b678f4bacffe10768ae`	any of [string, null]
bare_metal_local_subnet_ip_address optional	Policy Local Subnet IP Example : `192.168.0.1`	any of [string, null]
bare_metal_server_name required	Bare Metal Server name Example : `bmserver-001`	string
server_type_id required	Server Type ID Example : `f90e8ef54cc2451b825608e9f95f7bcb`	string
ip_address optional	Private IP Example : `192.168.0.1`	any of [string, null]
nat_enabled required	Use Public NAT Example : `True`	boolean
public_ip_address_id optional	Public IP ID Example : `20c507a036c447cdb3b19468d8ea62ac`	any of [string, null]
local_disk_partitions optional	Local Disk Partitions	any of [array[LocalDiskPartitionsRequest], null]
local_disk_type optional	Local Disk Type Example : `flat`	any of [string, null]
zone required	Availability Zone Example : `kr-west1-a`	string

32 - TagRequest

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