This is the multi-page printable view of this section. Click here to print.
Models
- 1: AsyncResponse
- 2: BaremetalActionResponse
- 3: BaremetalCreateRequest
- 4: BaremetalListResponse
- 5: BaremetalListResponseV1Dot1
- 6: BaremetalListV1Dot1
- 7: BaremetalServerAssignPrivateNatIpRequest
- 8: BaremetalServerAssignPublicNatIpRequest
- 9: BaremetalServerIdResponse
- 10: BaremetalShowResponse
- 11: BaremetalShowResponseV1Dot1
- 12: BaremetalsOperationRequest
- 13: BaremetalStaticNatResponseV1Dot1
- 14: BaremetalTerminateRequest
- 15: ImageListResponse
- 16: ImageShowResponse
- 17: LocalDiskPartitionsRequest
- 18: LocalSubnetAttachRequest
- 19: LocalSubnetDetachRequest
- 20: LocalSubnetInfoResponse
- 21: LocalSubnetResponse
- 22: ProductListResponse
- 23: ProductListResponseV1Dot1
- 24: ProductShowResponse
- 25: ProductShowResponseV1Dot1
- 26: ServerDetailsRequest
- 27: TagRequest
1 - AsyncResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 | Default |
|---|---|---|---|
| image_id required | Image ID Example : IMAGE-7XFMaJpLsapKvskFMjCtmm | string | |
| init_script optional | Init script Example : init script | any of [string, null] | |
| lock_enabled optional | Use Lock Example : True | boolean | |
| os_user_id required | OS user ID Example : user001 | string | |
| os_user_password required | OS user password Example : password | string | |
| placement_group_name optional | Placement Group Name Example : pgtest | any of [string, null] | |
| region_id required | Region ID Example : kr-west1 | string | |
| server_details required | Detailed settings for each server | array[ServerDetailsRequest] | |
| subnet_id required | Subnet ID Example : ab313c43291e4b678f4bacffe10768ae | string | |
| tags optional | Tag | any of [array[TagRequest], null] | |
| use_placement_group optional | Use Placement Group Example : False | boolean | |
| vpc_id required | VPC ID Example : e58348b1bc9148e5af86500fd4ef99ca | string |
4 - BaremetalListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| baremetals required | array[BaremetalShowResponse] | ||
| count required | count Example : 20 | any of [integer, null] |
5 - BaremetalListResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| baremetals required | array[BaremetalListV1Dot1] | ||
| count required | count Example : 20 | integer |
6 - BaremetalListV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| image_id required | Image ID Example : IMAGE-7XFMaJpLsapKvskFMjCtmm | string | |
| image_version required | Image version Example : RHEL 8.7 for BM | string | |
| lock_enabled optional | Use Lock Example : True | boolean | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| network_id required | Subnet ID Example : ab313c43291e4b678f4bacffe10768ae | string | |
| os_type required | OS type Example : WINDOWS | string | |
| placement_group_name optional | Placement Group Name Example : pgtest | any of [string, null] | |
| policy_ip required | Policy IP Example : 192.168.0.1 | string | |
| product_type_id required | Bare Metal Server scale ID Example : PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg | string | |
| region_id required | Region ID Example : kr-west1 | string | |
| server_name required | Bare Metal Server name Example : bmserver-001 | string | |
| server_type required | Bare Metal Server scale type Example : s1v8m32_metal | string | |
| state required | Bare Metal Server state Example : RUNNING | string | |
| vpc_id required | VPC ID Example : e58348b1bc9148e5af86500fd4ef99ca | string |
7 - 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 |
8 - BaremetalServerAssignPublicNatIpRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| public_ip_address_id required | Public IP ID Example : 20c507a036c447cdb3b19468d8ea62ac | string |
9 - BaremetalServerIdResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string |
10 - BaremetalShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : f5c8e56a4d9b49a8bd89e14758a32d53 | 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 | |
| hyper_threading_use required | Use Hyper Threading Example : True | boolean | |
| id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | |
| image_id required | Image ID Example : IMAGE-7XFMaJpLsapKvskFMjCtmm | string | |
| image_version required | Image version Example : RHEL 8.7 for BM | string | |
| init_script required | Init script Example : init script | string | |
| local_subnet_info optional | Local Subnet info | any of [array[LocalSubnetInfoResponse], null] | |
| lock_enabled optional | Use Lock Example : True | boolean | |
| 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 | |
| network_id required | Subnet ID Example : ab313c43291e4b678f4bacffe10768ae | string | |
| os_type required | OS type Example : WINDOWS | string | |
| placement_group_name optional | Placement Group Name Example : pgtest | any of [string, null] | |
| policy_ip required | Policy IP Example : 192.168.0.1 | string | |
| policy_nat optional | Public NAT IP Example : 192.168.0.1 | any of [string, null] | |
| policy_use_nat optional | Use Public NAT Example : True | boolean | |
| product_type_id required | Bare Metal Server scale ID Example : PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg | string | |
| public_nat_status optional | Public NAT status Example : ACTIVE | any of [string, null] | |
| region_id required | Region ID Example : kr-west1 | string | |
| root_account required | Root Account Example : rootaccount | string | |
| server_name required | Bare Metal Server name Example : bmserver-001 | string | |
| server_type required | Bare Metal Server scale type Example : s1v8m32_metal | string | |
| state required | Bare Metal Server state Example : RUNNING | string | |
| time_zone required | Time Zone Example : Asia/Seoul | string | |
| use_local_subnet optional | Use Local Subnet Example : True | boolean | |
| vpc_id required | VPC ID Example : e58348b1bc9148e5af86500fd4ef99ca | string |
11 - BaremetalShowResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : f5c8e56a4d9b49a8bd89e14758a32d53 | 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 | |
| hyper_threading_use required | Use Hyper Threading Example : True | boolean | |
| id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | |
| image_id required | Image ID Example : IMAGE-7XFMaJpLsapKvskFMjCtmm | string | |
| image_version required | Image version Example : RHEL 8.7 for BM | string | |
| init_script required | Init script Example : init script | string | |
| local_subnet_info optional | Local Subnet info | any of [array[LocalSubnetInfoResponse], null] | |
| lock_enabled optional | Use Lock Example : True | boolean | |
| 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 | |
| network_id required | Subnet ID Example : ab313c43291e4b678f4bacffe10768ae | string | |
| os_type required | OS type Example : WINDOWS | string | |
| placement_group_name optional | Placement Group Name Example : pgtest | any of [string, null] | |
| policy_ip required | Policy IP Example : 192.168.0.1 | string | |
| private_nat_info optional | Private NAT info | any of [BaremetalStaticNatResponseV1Dot1, null] | |
| product_type_id required | Bare Metal Server scale ID Example : PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg | string | |
| public_nat_info optional | Public NAT info | any of [BaremetalStaticNatResponseV1Dot1, null] | |
| region_id required | Region ID Example : kr-west1 | string | |
| root_account required | Root Account Example : rootaccount | string | |
| server_name required | Bare Metal Server name Example : bmserver-001 | string | |
| server_type required | Bare Metal Server scale type Example : s1v8m32_metal | string | |
| state required | Bare Metal Server state Example : RUNNING | string | |
| time_zone required | Time Zone Example : Asia/Seoul | string | |
| use_local_subnet optional | Use Local Subnet Example : True | boolean | |
| vpc_id required | VPC ID Example : e58348b1bc9148e5af86500fd4ef99ca | string |
12 - BaremetalsOperationRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| bare_metal_server_ids required | Bare Metal Server IDs Example : ['20c507a036c447cdb3b19468d8ea62ac'] | array[object] |
13 - BaremetalStaticNatResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| nat_id optional | NAT ID Example : a4fd0216cd32442a82733bbb8be0e82b | any of [string, null] | |
| nat_ip required | NAT IP Example : 192.170.2.10 | string | |
| nat_ip_id required | NAT IP ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | |
| state required | Static NAT state Example : ACTIVE | string | |
| static_nat_id optional | Static NAT ID Example : a1b97ae4695b40b0866e86a19cb191d3 | any of [string, null] |
14 - BaremetalTerminateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| baremetal_id_list required | Bare Metal Server IDs Example : ['20c507a036c447cdb3b19468d8ea62ac'] | array[object] |
15 - ImageListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| images required | array[ImageShowResponse] |
16 - ImageShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created at Example : 2024-07-11 08:56:59 | string | |
| id required | Image ID Example : IMAGE-7XFMaJpLsapKvskFMjCtmm | string | |
| name required | Image name Example : RHEL 8.8 for BM | string | |
| os_distro required | OS type Example : RHEL | string | |
| scp_image_type required | Image Type Example : STANDARD | string | |
| scp_os_version required | OS version Example : 8.7 | string |
17 - LocalDiskPartitionsRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
18 - 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] |
19 - 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 |
20 - LocalSubnetInfoResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| interface_name required | Interface Name Example : ens8f1,bond_serv.2 | string | |
| 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 | |
| state required | LocalSubnet IP state Example : CREATING | string | |
| vlan_id required | Vlan Id Example : 500 | string | |
| vni_role_name required | VNI Role Name Example : mgmtJ4dzQBo | string |
21 - LocalSubnetResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| baremetal_id required | Bare Metal Server ID Example : 20c507a036c447cdb3b19468d8ea62ac | string | |
| is_success optional | success flag Example : True | boolean |
22 - ProductListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| products required | Product List | array[ProductShowResponse] |
23 - ProductListResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| products required | Product List | array[ProductShowResponseV1Dot1] |
24 - ProductShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| attri_name required | Attribute name Example : attri name | string | |
| attri_value required | Attribute value Example : attri value | 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 | |
| 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 | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | 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 | |
| id required | ID Example : PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg | 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 | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | Name Example : s2v16m128_metal | string | |
| name_with_generation required | Name with generation 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 |
25 - ProductShowResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 | |
| 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 | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| 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 : PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg | 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 | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| name required | Name Example : s2v16m128_metal | string | |
| name_with_generation required | Name with generation Example : s2v16m128_metal | string | |
| os_disk_gb required | OS disk value Example : 480 | string | |
| state required | State Example : AVAILABLE | string | |
| type required | Type Example : SCALE | string |
26 - ServerDetailsRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 | |
| ip_address optional | Private IP Example : 192.168.0.1 | 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] | |
| nat_enabled required | Use Public NAT Example : True | boolean | |
| public_ip_address_id optional | Public IP ID Example : 20c507a036c447cdb3b19468d8ea62ac | any of [string, null] | |
| server_type_id required | Server Type ID Example : PRODUCT-0iT9dNiLr4lVoYmjlY2Vgg | string | |
| use_hyper_threading optional | Use Hyper Threading Example : True | boolean |
27 - TagRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | key Example : key | string | |
| value optional | value Example : value | any of [string, null] |