This is the multi-page printable view of this section. Click here to print.
Models
- 1: AutoScalingGroup
- 2: AutoScalingGroupCreateRequest
- 3: AutoScalingGroupLbServerGroup
- 4: AutoScalingGroupLbServerGroupListResponse
- 5: AutoScalingGroupLbServerGroupSetRequest
- 6: AutoScalingGroupLbServerGroupShowResponse
- 7: AutoScalingGroupListResponse
- 8: AutoScalingGroupNotificationCreateRequest
- 9: AutoScalingGroupNotificationListResponse
- 10: AutoScalingGroupNotificationShowResponse
- 11: AutoScalingGroupNotificationUpdateRequest
- 12: AutoScalingGroupPolicyCreateRequest
- 13: AutoScalingGroupPolicyListResponse
- 14: AutoScalingGroupPolicyShowResponse
- 15: AutoScalingGroupPolicyUpdateRequest
- 16: AutoScalingGroupScheduleCreateRequest
- 17: AutoScalingGroupScheduleListResponse
- 18: AutoScalingGroupScheduleShowResponse
- 19: AutoScalingGroupScheduleUpdateRequest
- 20: AutoScalingGroupSetRequest
- 21: AutoScalingGroupSetServerCountRequest
- 22: AutoScalingGroupShowResponse
- 23: AutoScalingGroupVirtualServerListResponse
- 24: AutoScalingGroupVirtualServerShowResponse
- 25: DefaultConfigListResponse
- 26: ImageCreateRequest
- 27: ImageImportRequest
- 28: ImageListResponse
- 29: ImageMemberCreateRequest
- 30: ImageMemberListResponse
- 31: ImageMemberSetRequest
- 32: ImageMemberShowResponse
- 33: ImageSetRequest
- 34: ImageShowResponse
- 35: InterfaceAttachmentFixedIp
- 36: InterfaceResponse
- 37: Keypair
- 38: KeypairCreateRequest
- 39: KeypairCreateResponse
- 40: KeypairListResponse
- 41: KeypairShowResponse
- 42: LaunchConfigurationCreateRequest
- 43: LaunchConfigurationDetailShowResponse
- 44: LaunchConfigurationListResponse
- 45: LaunchConfigurationShowResponse
- 46: LaunchConfigurationVolume
- 47: Network
- 48: PrivateStaticNat
- 49: PublicStaticNat
- 50: SecurityGroupResponse
- 51: SecurityGroupResponseRule
- 52: SecurityGroupResponseRuleIpRange
- 53: ServerConsoleLogResponse
- 54: ServerCreateImageRequestBody
- 55: ServerCreateImageResponse
- 56: ServerCreateRequest
- 57: ServerCreateResponse
- 58: ServerCreateResponseParam
- 59: ServerGroup
- 60: ServerGroupCreateRequest
- 61: ServerGroupListResponse
- 62: ServerGroupPartitionSizeResponse
- 63: ServerInterfaceCreateRequest
- 64: ServerInterfaceListResponse
- 65: ServerInterfaceUpdateRequest
- 66: ServerIpsResponse
- 67: ServerListResponse
- 68: ServerPasswordRequest
- 69: ServerPasswordResponse
- 70: ServerPrivateStaticNatCreateRequest
- 71: ServerQuotaSet
- 72: ServerQuotaSetObject
- 73: ServerRebootRequestBody
- 74: ServerSecurityGroupActionRequestBody
- 75: ServerSecurityGroupListResponse
- 76: ServerSetServerTypeRequestBody
- 77: ServerShowResponse
- 78: ServerShowResponseAddress
- 79: ServerShowResponseAddressIpAddress
- 80: ServerShowResponseSecurityGroup
- 81: ServerShowResponseServerType
- 82: ServerShowResponseVolume
- 83: ServerStaticNatCreateRequest
- 84: ServersVolumeResponse
- 85: ServerType
- 86: ServerTypeListResponse
- 87: ServerUpdateRequest
- 88: ServerVolumesCreateRequest
- 89: ServerVolumesResponse
- 90: ServerVolumesUpdateRequest
- 91: SnapshotCreateRequest
- 92: SnapshotDetailResponse
- 93: SnapshotListResponse
- 94: SnapshotUpdateRequest
- 95: Tag
- 96: Volume
- 97: VolumeCreateRequest
- 98: VolumeExtendRequest
- 99: VolumeImageMetadataResponse
- 100: VolumeListResponse
- 101: VolumeQuotaSet
- 102: VolumeQuotaSetObject
- 103: VolumeRevertRequest
- 104: VolumeServer
- 105: VolumeServerAttachRequest
- 106: VolumeServerAttachResponse
- 107: VolumeShowResponse
- 108: VolumeTransferAcceptResponse
- 109: VolumeTransferAccessRequest
- 110: VolumeTransferCreateResponse
- 111: VolumeTransferListResponse
- 112: VolumeTransferRequest
- 113: VolumeTransferShowResponse
- 114: VolumeTypeDetailResponse
- 115: VolumeTypeExtraSpecs
- 116: VolumeTypeListResponse
- 117: VolumeUpdateRequest
1 - AutoScalingGroup
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| desired_server_count required | Desired server count Example : 1 | integer | |
| desired_server_count_editable required | Desired server count editable Example : True | boolean | |
| drain_enabled required | Drain enabled Example : True | boolean | |
| drain_timeout optional | Drain timeout Example : 300 | any of [integer, null] | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| launch_configuration_id required | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | string | |
| launch_configuration_name required | Launch Configuration name Example : launch-configuration-name | string | |
| lb_server_groups optional | LB Server Group list | any of [array[AutoScalingGroupLbServerGroup], null] | |
| max_server_count required | Max server count Example : 2 | integer | |
| min_server_count required | Min server count Example : 1 | 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 | Auto-Scaling Group name Example : auto-scaling-group-name | string | |
| security_group_ids optional | Security Group ID list Example : ['c09c3f05-03d9-443f-b27a-40e0f973c75f'] | any of [array[string], null] | |
| server_name_prefix required | Server name prefix Example : server-name-prefix | string | |
| state required | Auto-Scaling Group state Example : IN_SERVICE | string | |
| subnet_ids optional | Subnet ID list | array[string] | |
| vpc_id required | VPC ID Example : cc976b621087484ea5fd527f4b78708b | string |
2 - AutoScalingGroupCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| desired_server_count required | Desired server count Example : 1 | integer | |
| desired_server_count_editable required | Desired server count editable Example : True | boolean | |
| drain_enabled optional | Drain enabled Example : True | any of [boolean, null] | |
| drain_timeout optional | Drain timeout Example : 300 | any of [integer, null] | |
| launch_configuration_id required | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | string | |
| lb_server_groups optional | LB Server Group list | any of [array[AutoScalingGroupLbServerGroup], null] | |
| max_server_count required | Max server count Example : 2 | integer | |
| min_server_count required | Min server count Example : 1 | integer | |
| name required | Auto-Scaling Group name Example : auto-scaling-group-namePattern : ^[a-zA-Z0-9-_]*$Minimum length : 1Maximum length : 63 | string | |
| notifications optional | Notifications | any of [array[AutoScalingGroupNotificationCreateRequest], null] | |
| scaling_policies optional | Scaling policy list | any of [array[AutoScalingGroupPolicyCreateRequest], null] | |
| security_group_ids optional | Security Group ID list Example : ['c09c3f05-03d9-443f-b27a-40e0f973c75f'] | any of [array[string], null] | |
| server_name_prefix required | Server name prefix Example : server-name-prefixPattern : ^[a-zA-Z0-9-_]*$Minimum length : 1Maximum length : 61 | string | |
| subnet_ids required | Subnet ID list | array[string] | |
| tags optional | Tags Example : [{'key': 'key', 'value': 'value'}] | any of [array[Tag], null] |
3 - AutoScalingGroupLbServerGroup
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | LB Server Group ID Example : d06e87d3-ca9a-461b-8e88-077a542a7335 | string | |
| port required | LB Server Group port Example : 8080Minimum : 1Maximum : 65534 | integer |
4 - AutoScalingGroupLbServerGroupListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| lb_server_groups required | LB Server Group list | array[AutoScalingGroupLbServerGroupShowResponse] |
5 - AutoScalingGroupLbServerGroupSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| lb_server_groups required | LB Server Group list | array[AutoScalingGroupLbServerGroup] |
6 - AutoScalingGroupLbServerGroupShowResponse
| 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 | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | LB Server Group name Example : lb-server-group-name | string | |
| port required | LB Server Group port Example : 8080 | integer |
7 - AutoScalingGroupListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| auto_scaling_groups required | Auto-Scaling Group list | array[AutoScalingGroup] | |
| count required | count Example : 20 | integer |
8 - AutoScalingGroupNotificationCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| notification_events required | Auto-Scaling Group notification events Example : ['SCALE_OUT', 'SCALE_OUT_FAIL'] | array[string] | |
| user_ids required | User ID list Example : ['570907805e5447be84b618450ef52o0t'] | array[string] |
9 - AutoScalingGroupNotificationListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| notifications required | Auto-Scaling Group notification list | array[AutoScalingGroupNotificationShowResponse] |
10 - AutoScalingGroupNotificationShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | |
| 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 | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| notification_events required | Auto-Scaling Group notification events Example : ['SCALE_OUT', 'SCALE_OUT_FAIL'] | array[string] | |
| notification_state required | Auto-Scaling Group notification state Example : ACTIVE | string | |
| user_id required | User ID Example : 570907805e5447be84b618450ef52o0t | string | |
| user_name required | User name Example : scpuser | string |
11 - AutoScalingGroupNotificationUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| notification_events optional | Auto-Scaling Group notification events Example : ['SCALE_OUT', 'SCALE_OUT_FAIL'] | any of [array[string], null] | |
| notification_state optional | Auto-Scaling Group notification state Example : ACTIVE | any of [string, null] |
12 - AutoScalingGroupPolicyCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| comparison_operator required | Comparison operator Example : gePattern : ^(ge|gt|le|lt)$ | string | |
| cooldown_seconds required | Cooldown seconds Example : 300 | integer | |
| evaluation_minutes required | Evaluation minutes Example : 1 | integer | |
| metric_method required | Metric method Example : AVGPattern : ^(AVG|MIN|MAX)$ | string | |
| metric_type required | Metric type Example : CPUPattern : ^(CPU|MEMORY|NETWORK_IN_BYTES|NETWORK_OUT_BYTES|NETWORK_IN_PACKETS|NETWORK_OUT_PACKETS)$ | string | |
| name required | Policy name Example : policy-namePattern : ^[a-zA-Z0-9-_]*$Minimum length : 1Maximum length : 63 | string | |
| scale_method required | Scale method Example : AMOUNTPattern : ^(AMOUNT|PERCENTAGE|FIXED)$ | string | |
| scale_type required | Scale type Example : SCALE_OUTPattern : ^(SCALE_IN|SCALE_OUT)$ | string | |
| scale_value required | Scale value Example : 10 | integer | |
| threshold required | Threshold Example : 60 | integer |
13 - AutoScalingGroupPolicyListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| policies required | array[AutoScalingGroupPolicyShowResponse] |
14 - AutoScalingGroupPolicyShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | |
| comparison_operator required | Comparison operator Example : ge | string | |
| cooldown_seconds required | Cooldown seconds Example : 300 | integer | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| evaluation_minutes required | Evaluation minutes Example : 1 | integer | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| metric_method required | Metric method Example : AVG | string | |
| metric_type required | Metric type Example : CPU | 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 | Policy name Example : policy-name | string | |
| scale_method required | Scale method Example : AMOUNT | string | |
| scale_type required | Scale type Example : SCALE_OUT | string | |
| scale_value required | Scale value Example : 10 | integer | |
| state required | Policy state Example : ACTIVE | string | |
| threshold required | Threshold Example : 60 | integer | |
| threshold_unit required | Threshold unit Example : % | string |
15 - AutoScalingGroupPolicyUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| comparison_operator optional | Comparison operator Example : gePattern : ^(ge|gt|le|lt)$ | any of [string, null] | |
| cooldown_seconds optional | Cooldown seconds Example : 300 | any of [integer, null] | |
| evaluation_minutes optional | Evaluation minutes Example : 1 | any of [integer, null] | |
| metric_method optional | Metric method Example : AVGPattern : ^(AVG|MIN|MAX)$ | any of [string, null] | |
| metric_type optional | Metric type Example : CPUPattern : ^(CPU|MEMORY|NETWORK_IN_BYTES|NETWORK_OUT_BYTES|NETWORK_IN_PACKETS|NETWORK_OUT_PACKETS)$ | any of [string, null] | |
| name optional | Policy name Example : policy-namePattern : ^[a-zA-Z0-9-_]*$ | any of [string, null] | |
| scale_method optional | Scale method Example : AMOUNTPattern : ^(AMOUNT|PERCENTAGE|FIXED)$ | any of [string, null] | |
| scale_type optional | Scale type Example : SCALE_OUTPattern : ^(SCALE_IN|SCALE_OUT)$ | any of [string, null] | |
| scale_value optional | Scale value Example : 10 | any of [integer, null] | |
| state optional | Policy state Example : ACTIVEPattern : ^(ACTIVE|INACTIVE)$ | any of [string, null] | |
| threshold optional | Threshold Example : 60 | any of [integer, null] |
16 - AutoScalingGroupScheduleCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| day_of_month optional | Day of the month Example : -1,1 | any of [string, null] | |
| day_of_week optional | Day of the week Example : SU,SA | any of [string, null] | |
| description optional | Description Example : description | any of [string, null] | |
| desired_server_count optional | Desired server count Example : 1 | any of [integer, null] | |
| end_date optional | End date Example : 2025-01-01 | any of [string, null] | |
| frequency required | Frequency Example : WEEKLY | enum (ONCE, DAILY, WEEKLY, MONTHLY) | |
| hour required | Hour Example : 9Maximum : 23 | integer | |
| max_server_count optional | Max server count Example : 2 | any of [integer, null] | |
| min_server_count optional | Min server count Example : 1 | any of [integer, null] | |
| minute required | Minute Example : 0 | integer | |
| name required | Schedule name Example : schedulenamePattern : ^[a-zA-Z0-9-_]*$Minimum length : 1Maximum length : 63 | string | |
| start_date required | Start date Example : 2024-01-01 | string | |
| state optional | Schedule state Example : ACTIVE | enum (ACTIVE, INACTIVE, DELETED) | |
| timezone required | Timezone Example : Asia/Seoul | string |
17 - AutoScalingGroupScheduleListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| schedules required | array[AutoScalingGroupScheduleShowResponse] | ||
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
18 - AutoScalingGroupScheduleShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| day_of_month required | Day of the month Example : -1,1 | any of [string, null] | |
| day_of_week required | Day of the week Example : SU,SA | any of [string, null] | |
| description required | Description Example : description | any of [string, null] | |
| desired_server_count required | Desired server count Example : 1 | any of [integer, null] | |
| end_date required | End date Example : 2025-01-01 | any of [string, null] | |
| frequency required | Frequency Example : WEEKLY | enum (ONCE, DAILY, WEEKLY, MONTHLY) | |
| hour required | Hour Example : 9 | integer | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| max_server_count required | Max server count Example : 2 | any of [integer, null] | |
| min_server_count required | Min server count Example : 1 | any of [integer, null] | |
| minute required | Minute 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 | Schedule name Example : schedulename | string | |
| start_date required | Start date Example : 2024-01-01 | string | |
| state required | Schedule state Example : ACTIVE | string | |
| timezone required | Timezone Example : Asia/Seoul | string |
19 - AutoScalingGroupScheduleUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| day_of_month optional | Day of the month Example : -1,1 | any of [string, null] | |
| day_of_week optional | Day of the week Example : SU,SA | any of [string, null] | |
| description optional | Description Example : description | any of [string, null] | |
| desired_server_count optional | Desired server count Example : 1 | any of [integer, null] | |
| end_date optional | End date Example : 2025-01-01 | any of [string, null] | |
| frequency optional | Frequency Example : WEEKLY | any of [enum (ONCE, DAILY, WEEKLY, MONTHLY), null] | |
| hour optional | Hour Example : 9 | any of [integer, null] | |
| max_server_count optional | Max server count Example : 2 | any of [integer, null] | |
| min_server_count optional | Min server count Example : 1 | any of [integer, null] | |
| minute optional | Minute Example : 0 | any of [integer, null] | |
| name optional | Schedule name Example : schedulenamePattern : ^[a-zA-Z0-9-_]*$ | any of [string, null] | |
| start_date optional | Start date Example : 2024-01-01 | any of [string, null] | |
| state optional | Schedule state Example : ACTIVE | enum (ACTIVE, INACTIVE, DELETED) | |
| timezone optional | Timezone Example : Asia/Seoul | any of [string, null] |
20 - AutoScalingGroupSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| desired_server_count_editable optional | Desired server count editable Example : True | any of [boolean, null] | |
| drain_enabled optional | Drain enabled Example : True | any of [boolean, null] | |
| drain_timeout optional | Drain timeout Example : 300 | any of [integer, null] | |
| launch_configuration_id optional | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | any of [string, null] | |
| security_group_ids optional | Security Group ID list Example : ['c09c3f05-03d9-443f-b27a-40e0f973c75f'] | any of [array[string], null] |
21 - AutoScalingGroupSetServerCountRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| desired_server_count optional | Desired server count Example : 1 | any of [integer, null] | |
| max_server_count optional | Max server count Example : 2 | any of [integer, null] | |
| min_server_count optional | Min server count Example : 1 | any of [integer, null] |
22 - AutoScalingGroupShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| desired_server_count required | Desired server count Example : 1 | integer | |
| desired_server_count_editable required | Desired server count editable Example : True | boolean | |
| drain_enabled required | Drain enabled Example : True | boolean | |
| drain_timeout optional | Drain timeout Example : 300 | any of [integer, null] | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| launch_configuration_id required | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | string | |
| launch_configuration_name required | Launch Configuration name Example : launch-configuration-name | string | |
| lb_server_groups optional | LB Server Group list | any of [array[AutoScalingGroupLbServerGroup], null] | |
| max_server_count required | Max server count Example : 2 | integer | |
| min_server_count required | Min server count Example : 1 | 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 | Auto-Scaling Group name Example : auto-scaling-group-name | string | |
| security_group_ids optional | Security Group ID list Example : ['c09c3f05-03d9-443f-b27a-40e0f973c75f'] | any of [array[string], null] | |
| server_name_prefix required | Server name prefix Example : server-name-prefix | string | |
| state required | Auto-Scaling Group state Example : IN_SERVICE | string | |
| subnet_ids optional | Subnet ID list | array[string] | |
| total_server_count required | Total server count Example : 1 | integer | |
| vpc_id required | VPC ID Example : cc976b621087484ea5fd527f4b78708b | string |
23 - AutoScalingGroupVirtualServerListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| servers required | Server list | array[AutoScalingGroupVirtualServerShowResponse] |
24 - AutoScalingGroupVirtualServerShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| addresses optional | Addresses | any of [array[ServerShowResponseAddress], null] | |
| auto_scaling_group_id required | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | string | |
| created_at required | Created at Example : | string (date-time) | |
| created_by required | Created by Example : 97e6b22c9a4143789ca522df7457a32f | string | |
| disk_config required | Disk config Example : MANUAL | string | |
| id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | |
| image_id optional | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | any of [string, null] | |
| is_marketplace optional | Is Marketplace Example : False | any of [boolean, null] | |
| keypair_name optional | Keypair name Example : keypairname | any of [string, null] | |
| launch_configuration_id optional | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | any of [string, null] | |
| lb_linked_state optional | Load Balancer linked state Example : ATTACHED | any of [string, null] | |
| locked required | Locked Example : False | boolean | |
| metadata required | Metadata Example : | object | |
| modified_at required | Modified at Example : | string (date-time) | |
| name required | Server name Example : servername | string | |
| partition_number optional | Partition number Example : 1 | any of [integer, null] | |
| planned_compute_os_type optional | Planned Compute OS type Example : windows | any of [enum (open_source, windows, rhel), null] | |
| product_category optional | Product category Example : compute | any of [enum (compute, container), null] | |
| product_offering optional | Product offering Example : virtual_server | any of [enum (virtual_server, gpu_server, k8s_vm, k8s_gpu_vm), null] | |
| security_groups optional | Security Groups | any of [array[ServerShowResponseSecurityGroup], null] | |
| server_group_id optional | Server Group ID Example : 616fb98f-46ca-475e-917e-2563e5a8cd19 | any of [string, null] | |
| server_type required | Server type | ServerShowResponseServerType | |
| state required | Server state Example : ACTIVE | string | |
| volumes required | Volumes | array[ServerShowResponseVolume] | |
| vpc_id optional | VPC ID Example : cc976b621087484ea5fd527f4b78708b | any of [string, null] |
25 - DefaultConfigListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| configs required | Configs Example : ('key': 'value'} | object | |
| count required | count Example : 20 | integer |
26 - ImageCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| container_format optional | Container format Example : barePattern : bare | string | bare |
| disk_format optional | Disk format Example : qcow2Pattern : qcow2 | string | qcow2 |
| min_disk optional | Minimum disk Example : 100 | integer | |
| min_ram optional | Minimum RAM Example : 0Maximum : 2097151 | integer | |
| name required | Image name Example : imagenamePattern : ^[a-zA-Z0-9-_ ]*$Minimum length : 1Maximum length : 255 | string | |
| os_distro required | OS distribution Example : alma | enum (alma, centos, rhel, rocky, ubuntu, windows, oracle) | |
| protected optional | Protected Example : False | boolean | |
| tags optional | Tags Example : [{'key': 'key', 'value': 'value'}] | any of [array[Tag], null] | |
| url required | Object Storage URL for Image file (only qcow2 format allowed) Example : https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2Maximum length : 255 | string | |
| visibility optional | Visibility Example : privatePattern : private|shared | string | private |
27 - ImageImportRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| url required | Object Storage URL for Image file (only qcow2 format allowed) Example : https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2Pattern : .*\.qcow2$Maximum length : 255 | string |
28 - ImageListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| images required | array[ImageShowResponse] |
29 - ImageMemberCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| member_id required | Member ID Example : a8f10467abfc4b87b64614ab36eb9ae4Pattern : ^[A-Za-z0-9-]*$Minimum length : 1Maximum length : 64 | string |
30 - ImageMemberListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| members required | array[ImageMemberShowResponse] |
31 - ImageMemberSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| status required | Member status Example : pending | enum (pending, accepted, rejected) |
32 - ImageMemberShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created at Example : 2025-07-22T09:00:00Z | string | |
| image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | |
| member_id required | Member ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| status required | Member status Example : pending | string | |
| updated_at required | Updated at Example : 2025-07-26T12:00:00Z | string |
33 - ImageSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| min_disk optional | Minimum disk Example : 100 | any of [integer, null] | |
| min_ram optional | Minimum RAM Example : 0 | any of [integer, null] | |
| protected optional | Protected Example : False | any of [boolean, null] | |
| visibility optional | Visibility Example : privatePattern : private|shared | any of [string, null] |
34 - ImageShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| checksum optional | Checksum Example : 7538e0fcb56e0e272cfd89eb384d6613 | any of [string, null] | |
| container_format required | Container format Example : bare | string | |
| created_at required | Created at Example : 2025-07-22T09:00:00Z | string | |
| disk_format required | Disk format Example : qcow2 | string | |
| file required | File Example : /v2/images/e08a37c1-2162-416e-b7fa-19902419170b/file | string | |
| id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | |
| min_disk required | Minimum disk Example : 100 | integer | |
| min_ram required | Minimum RAM Example : 0 | integer | |
| name required | Image name Example : imagename | string | |
| os_distro optional | OS distribution Example : alma | any of [string, null] | |
| os_hash_algo optional | OS hash algorithm Example : sha512 | any of [string, null] | |
| os_hash_value optional | OS hash value Example : c6a32fc3b7c909b8900b46f5e6066c028a1d799c0a263cf064a600c430a714627c21f98ac248e2f2bf29870a1a2773c7908244745016878e1a5f31dc2c405b99 | any of [string, null] | |
| os_hidden required | OS hidden Example : False | boolean | |
| owner required | Owner account ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| owner_account_name optional | Owner account name Example : AccountName | any of [string, null] | |
| owner_user_name optional | Owner user name Example : user@samsung.com | any of [string, null] | |
| protected required | Protected Example : False | boolean | |
| root_device_name optional | Root device name Example : /dev/vda | any of [string, null] | |
| scp_image_type optional | Image type Example : custom | any of [string, null] | |
| scp_k8s_version optional | K8S version Example : v1.28.7 | any of [string, null] | |
| scp_original_image_type optional | Original Image type Example : standard | any of [string, null] | |
| scp_os_build_version optional | OS build version Example : 20250101 | any of [string, null] | |
| scp_os_version optional | OS version Example : 8.8 | any of [string, null] | |
| size optional | Size Example : 2429747200 | any of [integer, null] | |
| status required | Status Example : active | string | |
| updated_at required | Updated at Example : 2025-07-26T12:00:00Z | string | |
| url optional | Object Storage URL for Image file (only qcow2 format allowed) Example : https://object-store.kr-west1.s.samsungsdscloud.com/8989447062e04a818baf9e073fd04fa7/bucket/object.qcow2 | any of [string, null] | |
| virtual_size optional | Virtual size Example : 17179869184 | any of [integer, null] | |
| visibility required | Visibility Example : private | string | |
| volumes optional | Volumes Example : [{"tag": null, "volume_id": null, "encryption_options": null, "encryption_secret_uuid": null, "encryption_format": null, "device_name": "/dev/vda", "disk_bus": "virtio", "volume_type": null, "encrypted": null, "image_id": null, "device_type": "disk", "source_type": "snapshot", "delete_on_termination": false, "volume_size": 104, "guest_format": null, "boot_index": 0, "destination_type": "volume", "snapshot_id": "abde9e38-2ed5-4ecd-b23c-b0120e30690e", "no_device": null}] | any of [string, null] |
35 - InterfaceAttachmentFixedIp
| Name | Description | Schema | Default |
|---|---|---|---|
| ip_address required | IP address Example : 192.169.3.2 | string |
36 - InterfaceResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| fixed_ips required | Fixed Ip list | array[InterfaceAttachmentFixedIp] | |
| mac_addr required | MAC Address Example : fa:16:3e:c0:71:2b | string | |
| port_id required | Port ID Example : f2b02fc5-a5fd-4b5f-b1a9-987f4c0d66cc | string | |
| port_state required | Port State Example : ACTIVE | string | |
| private_static_nat optional | Private Static NAT | PrivateStaticNat | |
| static_nat optional | Public Static NAT | PublicStaticNat | |
| subnet_id required | Subnet ID Example : 183c6c30df0c4fcbb16422aa2d64aa21 | string |
37 - Keypair
| Name | Description | Schema | Default |
|---|---|---|---|
| fingerprint required | Fingerprint Example : 7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd | string | |
| name required | Keypair name Example : keypairname | string | |
| public_key required | Public Key Example : publickey | string | |
| type required | Keypair type Example : ssh | string |
38 - KeypairCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| name required | Keypair name Example : keypairnamePattern : ^[a-zA-Z0-9-_ ]*$Minimum length : 1Maximum length : 255 | string | |
| public_key optional | Public Key Example : publickey | any of [string, null] | |
| tags optional | Tags Example : [{'key': 'key', 'value': 'value'}] | any of [array[Tag], null] |
39 - KeypairCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| fingerprint required | Fingerprint Example : 7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd | string | |
| name required | Keypair name Example : keypairname | string | |
| private_key optional | Private key Example : privatekey | any of [string, null] | |
| public_key required | Public Key Example : publickey | string | |
| type required | Keypair type Example : ssh | string |
40 - KeypairListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| keypairs required | array[Keypair] |
41 - KeypairShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created at Example : 2025-07-22T09:00:00Z | string (date-time) | |
| fingerprint required | Fingerprint Example : 7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd | string | |
| id required | Keypair ID Example : 1 | integer | |
| name required | Keypair name Example : keypairname | string | |
| public_key required | Public Key Example : publickey | string | |
| type required | Keypair type Example : ssh | string | |
| user_id required | User ID Example : 570907805e5447be84b618450ef52o0t | string |
42 - LaunchConfigurationCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | |
| keypair_name required | Keypair name Example : keypairname | string | |
| name required | Launch Configuration name Example : launch-configuration-namePattern : ^[a-zA-Z0-9-_]*$Minimum length : 1Maximum length : 63 | string | |
| server_type_id required | Server type ID Example : s1v1m2 | string | |
| tags optional | Tags Example : [{'key': 'key', 'value': 'value'}] | any of [array[Tag], null] | |
| user_data optional | User data Example : IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg== | any of [string, null] | |
| volumes optional | Volumes | any of [array[LaunchConfigurationVolume], null] |
43 - LaunchConfigurationDetailShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| auto_scaling_group_count optional | Number of Auto-Scaling Group attached to Launch Configuration Example : 1 | any of [integer, null] | |
| 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 : 70a599e0-31e7-49b7-b260-868f441e862b | string | |
| image_name required | Image name Example : imagename | string | |
| keypair_name required | Keypair name Example : keypairname | 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 | Launch Configuration name Example : launch-configuration-name | string | |
| public_key optional | Public Key Example : publickey | any of [string, null] | |
| server_type_id required | Server type ID Example : s1v1m2 | string | |
| state required | Launch Configuration state Example : ACTIVE | string | |
| user_data optional | User data Example : IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg== | any of [string, null] | |
| volumes optional | Volumes | any of [array[LaunchConfigurationVolume], null] |
44 - LaunchConfigurationListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count optional | count Example : 20 | integer | |
| launch_configurations required | Launch Configuration list | array[LaunchConfigurationShowResponse] |
45 - LaunchConfigurationShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| auto_scaling_group_count optional | Number of Auto-Scaling Group attached to Launch Configuration Example : 1 | any of [integer, null] | |
| boot_disk_size optional | Size of default volume Example : 104 | any of [integer, null] | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| extra_disk_size optional | Size of additional volume Example : 104 | any of [integer, null] | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | |
| image_name required | Image name Example : imagename | string | |
| keypair_name required | Keypair name Example : keypairname | 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 | Launch Configuration name Example : launch-configuration-name | string | |
| public_key optional | Public Key Example : publickey | any of [string, null] | |
| server_type_id required | Server type ID Example : s1v1m2 | string | |
| state required | Launch Configuration state Example : ACTIVE | string | |
| user_data optional | User data Example : IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg== | any of [string, null] | |
| volumes optional | Volumes | any of [array[LaunchConfigurationVolume], null] |
46 - LaunchConfigurationVolume
| Name | Description | Schema | Default |
|---|---|---|---|
| boot_index required | Boot index Example : 0 | integer | |
| size required | Volume size Example : 104 | integer | |
| type optional | Volume type Example : SSD | any of [string, null] |
47 - Network
| Name | Description | Schema | Default |
|---|---|---|---|
| fixed_ip optional | Fixed Ip Example : 192.169.3.2 | any of [string, null] | |
| port_id optional | Port ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | any of [string, null] | |
| public_ip_id optional | Public IP ID Example : 615fa9cd5cff486c9de679b3ce63e601 | any of [string, null] | |
| subnet_id optional | Subnet ID Example : 78b2ee3f074145c580ab6abac4821f97 | any of [string, null] |
48 - PrivateStaticNat
| Name | Description | Schema | Default |
|---|---|---|---|
| external_ip_address required | External IP Address Example : 182.197.61.81 | string | |
| id required | NAT ID Example : 224b80106e6f41b38efe98ac9ddbf280 | string | |
| private_nat_ip_id optional | Private NAT IP ID Example : 1f0cb5390c40483592ddc5a282f53496 | any of [string, null] | |
| state required | NAT State Example : ACTIVE | string |
49 - PublicStaticNat
| Name | Description | Schema | Default |
|---|---|---|---|
| external_ip_address required | External IP Address Example : 182.197.61.81 | string | |
| id required | NAT ID Example : 224b80106e6f41b38efe98ac9ddbf280 | string | |
| publicip_id optional | Public IP ID Example : 615fa9cd5cff486c9de679b3ce63e601 | any of [string, null] | |
| state required | NAT State Example : ACTIVE | string |
50 - SecurityGroupResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Server Group owner’s account ID Example : 6f70656e737461636b20342065766572 | string | |
| description required | Security group description Example : Security group description | string | |
| id required | Security Group ID Example : 616fb98f-46ca-475e-917e-2563e5a8cd19 | string | |
| name required | Security Group name Example : securitygroup | string | |
| rules required | Security group rules | array[SecurityGroupResponseRule] |
51 - SecurityGroupResponseRule
| Name | Description | Schema | Default |
|---|---|---|---|
| from_port required | From port rule Example : 1 | any of [integer, null] | |
| id required | Security group rule ID Example : ca5cb96b-9df6-4af7-9682-4d60a58d38a5 | string | |
| ip_protocol required | Ip protocol Example : tcp | any of [string, null] | |
| ip_range optional | Ip range | any of [SecurityGroupResponseRuleIpRange, null] | |
| to_port required | To port rule Example : 65535 | any of [integer, null] |
52 - SecurityGroupResponseRuleIpRange
| Name | Description | Schema | Default |
|---|---|---|---|
| cidr optional | Cidr Example : 0.0.0.0/0 | any of [string, null] |
53 - ServerConsoleLogResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| output optional | Server console log output Example : FAKE CONSOLE OUTPUT | any of [string, null] |
54 - ServerCreateImageRequestBody
| Name | Description | Schema | Default |
|---|---|---|---|
| image_name required | Image name Example : imagename | string |
55 - ServerCreateImageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string |
56 - ServerCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| image_id required | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | string | |
| keypair_name required | Keypair name Example : keypairname | string | |
| lock optional | Locked Example : False | any of [boolean, null] | |
| max_count optional | Max count Example : 2 | any of [integer, null] | 1 |
| metadata optional | Metadata Example : | any of [object, null] | |
| name required | Server name Example : servernamePattern : ^[a-zA-Z0-9-_ ]*$Minimum length : 1Maximum length : 63 | string | |
| networks required | List of Network | array[Network] | |
| partition_number optional | Partition number Example : 1 | any of [integer, null] | |
| product_category optional | Product category Example : compute | any of [enum (compute, container), null] | |
| product_offering optional | Product offering Example : virtual_server | any of [enum (virtual_server, gpu_server, k8s_vm, k8s_gpu_vm), null] | |
| security_groups optional | Security Groups Example : ['c09c3f05-03d9-443f-b27a-40e0f973c75f'] | any of [array[string], null] | |
| server_group_id optional | Server Group ID Example : 616fb98f-46ca-475e-917e-2563e5a8cd19 | any of [string, null] | |
| server_type_id required | Server type ID Example : s1v1m2 | string | |
| tags optional | Tags Example : [{'key': 'key', 'value': 'value'}] | any of [array[Tag], null] | |
| user_data optional | User data Example : IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg== | any of [string, null] | |
| volumes optional | Volumes | any of [array[Volume], null] |
57 - ServerCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| servers required | Server ID list | array[ServerCreateResponseParam] |
58 - ServerCreateResponseParam
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string |
59 - ServerGroup
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| id required | Server Group ID Example : 616fb98f-46ca-475e-917e-2563e5a8cd19 | string | |
| members required | Server Group members Example : ['2a9be312-5d4b-4bc8-b2ae-35100fa9241f'] | array[string] | |
| name required | Server Group name Example : server-group | string | |
| partition_size required | Partition Size Example : 3 | any of [integer, null] | |
| policy required | Server Group policy Example : anti-affinity | string | |
| user_id required | User ID Example : 570907805e5447be84b618450ef52o0t | string |
60 - ServerGroupCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| name required | Server Group name Example : server-groupPattern : ^[a-zA-Z0-9-_ ]*$Minimum length : 1Maximum length : 255 | string | |
| policy required | Server Group policy Example : anti-affinityPattern : ^affinity$|^anti-affinity$|^partition$ | string | |
| tags optional | Tags Example : [{'key': 'key', 'value': 'value'}] | any of [array[Tag], null] |
61 - ServerGroupListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| server_groups required | array[ServerGroup] |
62 - ServerGroupPartitionSizeResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| partition_size required | Example : | integer |
63 - ServerInterfaceCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| fixed_ips optional | Fixed Ip list | any of [array[InterfaceAttachmentFixedIp], null] | |
| port_id optional | Port ID Example : 91424c08-0b26-49fb-9808-ed042292ceef | any of [string, null] | |
| subnet_id optional | Subnet ID Example : 78b2ee3f074145c580ab6abac4821f97 | any of [string, null] |
64 - ServerInterfaceListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| interfaces required | Interface List | array[InterfaceResponse] |
65 - ServerInterfaceUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| fixed_ip_address optional | IP address Example : 192.169.3.2 | any of [string, null] | |
| subnet_id optional | Subnet ID Example : | any of [string, null] |
66 - ServerIpsResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| addresses required | IP addresses | array[ServerShowResponseAddress] |
67 - ServerListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| servers required | Server list | array[ServerShowResponse] |
68 - ServerPasswordRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| private_key optional | Private key Example : privatekey | any of [string, null] |
69 - ServerPasswordResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| password optional | Server password Example : password | any of [string, null] |
70 - ServerPrivateStaticNatCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| private_nat_id required | Private NAT ID Example : 3a6c1dc6b1b24e02a444d672c2798a1c | string | |
| private_nat_ip_id required | Private NAT IP ID Example : 1f0cb5390c40483592ddc5a282f53496 | string |
71 - ServerQuotaSet
| Name | Description | Schema | Default |
|---|---|---|---|
| cores required | Core quota | ServerQuotaSetObject | |
| id required | Quota set ID Example : fc7283354c6143a58629b59f4c3e16b2 | string | |
| instances required | Instance quota | ServerQuotaSetObject | |
| keypairs required | Keypairs quota | ServerQuotaSetObject | |
| metadata_items required | Metadata items quota | ServerQuotaSetObject | |
| ram required | RAM quota | ServerQuotaSetObject | |
| server_group_members required | Server group members quota | ServerQuotaSetObject | |
| server_groups required | Server groups quota | ServerQuotaSetObject |
72 - ServerQuotaSetObject
| Name | Description | Schema | Default |
|---|---|---|---|
| in_use required | Quota set in use Example : 10 | integer | |
| limit required | Quota set limit Example : 20 | integer | |
| reserved required | Quota set reserved Example : 0 | integer |
73 - ServerRebootRequestBody
| Name | Description | Schema | Default |
|---|---|---|---|
| reboot_type optional | Reboot type Example : SOFT | any of [enum (SOFT, HARD), null] | SOFT |
74 - ServerSecurityGroupActionRequestBody
| Name | Description | Schema | Default |
|---|---|---|---|
| security_group_id required | Security Group ID Example : c09c3f05-03d9-443f-b27a-40e0f973c75f | string |
75 - ServerSecurityGroupListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| security_groups required | Security Groups | array[SecurityGroupResponse] |
76 - ServerSetServerTypeRequestBody
| Name | Description | Schema | Default |
|---|---|---|---|
| server_type required | Server type Example : s1v1m2 | string |
77 - ServerShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : a8f10467abfc4b87b64614ab36eb9ae4 | string | |
| addresses optional | Addresses | any of [array[ServerShowResponseAddress], null] | |
| auto_scaling_group_id optional | Auto-Scaling Group ID Example : 52613bd852b04b39adcb15a8364d856d | any of [string, null] | |
| created_at required | Created at Example : | string (date-time) | |
| created_by required | Created by Example : 97e6b22c9a4143789ca522df7457a32f | string | |
| disk_config required | Disk config Example : MANUAL | string | |
| id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | |
| image_id optional | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | any of [string, null] | |
| is_marketplace optional | Is Marketplace Example : False | any of [boolean, null] | |
| keypair_name optional | Keypair name Example : keypairname | any of [string, null] | |
| launch_configuration_id optional | Launch Configuration ID Example : b5aea5a675fc4f6b9e0fcd1288354c5f | any of [string, null] | |
| locked required | Locked Example : False | boolean | |
| metadata required | Metadata Example : | object | |
| modified_at required | Modified at Example : | string (date-time) | |
| name required | Server name Example : servername | string | |
| partition_number optional | Partition number Example : 1 | any of [integer, null] | |
| planned_compute_os_type optional | Planned Compute OS type Example : windows | any of [enum (open_source, windows, rhel), null] | |
| product_category optional | Product category Example : compute | any of [enum (compute, container), null] | |
| product_offering optional | Product offering Example : virtual_server | any of [enum (virtual_server, gpu_server, k8s_vm, k8s_gpu_vm), null] | |
| security_groups optional | Security Groups | any of [array[ServerShowResponseSecurityGroup], null] | |
| server_group_id optional | Server Group ID Example : 616fb98f-46ca-475e-917e-2563e5a8cd19 | any of [string, null] | |
| server_type required | Server type | ServerShowResponseServerType | |
| state required | Server state Example : ACTIVE | string | |
| volumes required | Volumes | array[ServerShowResponseVolume] | |
| vpc_id optional | VPC ID Example : cc976b621087484ea5fd527f4b78708b | any of [string, null] |
78 - ServerShowResponseAddress
| Name | Description | Schema | Default |
|---|---|---|---|
| ip_addresses required | IP addresses | array[ServerShowResponseAddressIpAddress] | |
| subnet_name required | Subnet name Example : subnetname | string |
79 - ServerShowResponseAddressIpAddress
| Name | Description | Schema | Default |
|---|---|---|---|
| ip_address required | IP address Example : 192.169.3.2 | string | |
| version required | IP address version Example : 4 | integer |
80 - ServerShowResponseSecurityGroup
| Name | Description | Schema | Default |
|---|---|---|---|
| name required | Security Group name Example : securitygroup | string |
81 - ServerShowResponseServerType
| Name | Description | Schema | Default |
|---|---|---|---|
| disk required | Size of root disk Example : 100 | integer | |
| ephemeral required | Size of ephemeral disk Example : 0 | integer | |
| extra_specs required | Extra specs Example : | object | |
| id optional | Server type ID Example : s1v1m2 | any of [string, null] | |
| name required | Server type name Example : s1v1m2 | string | |
| ram required | Amount of RAM Example : 2 | integer | |
| swap required | Size of dedicated swap disk Example : 0 | integer | |
| vcpus required | Number of CPUs Example : 1 | integer |
82 - ServerShowResponseVolume
| Name | Description | Schema | Default |
|---|---|---|---|
| delete_on_termination required | Delete on termination Example : False | boolean | |
| id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string |
83 - ServerStaticNatCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| publicip_id required | Public IP ID Example : 615fa9cd5cff486c9de679b3ce63e601 | string |
84 - ServersVolumeResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| delete_on_termination required | Delete on termination Example : False | boolean | |
| device required | Device name Example : /dev/vda | string | |
| id required | Volume Attachment ID Example : 3ad1cc18-1b09-4f51-9b1d-4ce4243f6a4c | string | |
| server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | |
| volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string |
85 - ServerType
| Name | Description | Schema | Default |
|---|---|---|---|
| description required | Description Example : description | any of [string, null] | |
| disk required | Size of root disk Example : 100 | integer | |
| ephemeral required | Size of ephemeral disk Example : 0 | integer | |
| extra_specs required | Extra specs Example : | object | |
| id required | Server type ID Example : s1v1m2 | string | |
| name required | Server type name Example : s1v1m2 | string | |
| ram required | Amount of RAM Example : 2 | integer | |
| swap required | Size of dedicated swap disk Example : 0 | integer | |
| vcpus required | Number of CPUs Example : 1 | integer |
86 - ServerTypeListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| server_types required | array[ServerType] |
87 - ServerUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| name required | Server name Example : servernamePattern : ^[a-zA-Z0-9-_ ]*$Minimum length : 1Maximum length : 63 | string |
88 - ServerVolumesCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| delete_on_termination optional | Delete on termination Example : False | any of [boolean, null] | |
| device optional | Device name Example : /dev/vda | any of [string, null] | |
| volume_id required | Volume ID Example : | string |
89 - ServerVolumesResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| volumes required | Volumes | array[ServersVolumeResponse] |
90 - ServerVolumesUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| delete_on_termination optional | Delete on termination Example : False | any of [boolean, null] | |
| volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string |
91 - SnapshotCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : description | any of [string, null] | |
| force optional | Force Example : True | any of [boolean, null] | |
| metadata optional | Snapshot metadata Example : | any of [object, null] | |
| name required | Snapshot name Example : snapshot-1Pattern : ^[a-zA-Z0-9-_ ]+$Maximum length : 255 | string | |
| volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string |
92 - SnapshotDetailResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created at Example : 2025-07-22T09:00:00Z | string | |
| description optional | Description Example : description | any of [string, null] | |
| id required | Snapshot ID Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 | string | |
| metadata optional | Snapshot metadata Example : | any of [object, null] | |
| name optional | Snapshot name Example : snapshot-1 | any of [string, null] | |
| size required | Volume size Example : 104 | integer | |
| status optional | Volume state Example : available | any of [string, null] | |
| updated_at optional | Updated at Example : 2025-07-26T12:00:00Z | any of [string, null] | |
| user_id optional | User ID Example : 570907805e5447be84b618450ef52o0t | any of [string, null] | |
| volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string |
93 - SnapshotListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count optional | Total count Example : 100 | any of [integer, null] | |
| snapshots required | array[SnapshotDetailResponse] |
94 - SnapshotUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : description | any of [string, null] | |
| name required | Snapshot name Example : snapshot-1Pattern : ^[a-zA-Z0-9-_ ]+$ | any of [string, null] |
95 - Tag
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | Key Example : Key | string | |
| value optional | Value Example : Value | any of [string, null] |
96 - Volume
| Name | Description | Schema | Default |
|---|---|---|---|
| boot_index required | Boot index Example : 0 | integer | |
| delete_on_termination optional | Delete on termination Example : False | any of [boolean, null] | |
| size required | Volume size Example : 104 | integer | |
| source_type optional | Source type Example : image | any of [enum (blank, image), null] | |
| type optional | Volume type Example : SSD | any of [string, null] |
97 - VolumeCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| name required | Volume name Example : volume01Pattern : ^[a-zA-Z0-9-_ ]*$Minimum length : 1Maximum length : 255 | string | |
| size required | Volume size Example : 104Minimum : 8 | integer | |
| snapshot_id optional | Snapshot ID Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 | any of [string, null] | |
| tags optional | Tags Example : [{'key': 'key', 'value': 'value'}] | any of [array[Tag], null] | |
| volume_type optional | Volume type Example : SSD | any of [string, null] |
98 - VolumeExtendRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| size required | Volume size Example : 104Minimum : 8 | integer |
99 - VolumeImageMetadataResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| checksum optional | Checksum Example : 7538e0fcb56e0e272cfd89eb384d6613 | any of [string, null] | |
| container_format optional | Container format Example : bare | any of [string, null] | |
| disk_format optional | Disk format Example : qcow2 | any of [string, null] | |
| image_id optional | Image ID Example : 70a599e0-31e7-49b7-b260-868f441e862b | any of [string, null] | |
| image_name optional | Image name Example : imagename | any of [string, null] | |
| min_disk optional | Minimum disk Example : 100 | any of [integer, null] | |
| min_ram optional | Minimum RAM Example : 0 | any of [integer, null] | |
| os_distro optional | OS distribution Example : alma | any of [string, null] | |
| scp_image_type optional | Image type Example : custom | any of [string, null] | |
| scp_k8s_version optional | K8S version Example : v1.28.7 | any of [string, null] | |
| scp_original_image_type optional | Original Image type Example : standard | any of [string, null] | |
| signature_verified optional | Signature verified Example : False | any of [boolean, null] | |
| size optional | Size Example : 2429747200 | any of [integer, null] |
100 - VolumeListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count optional | Total count Example : 100 | any of [integer, null] | |
| volumes required | array[VolumeShowResponse] |
101 - VolumeQuotaSet
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | Quota set ID Example : fc7283354c6143a58629b59f4c3e16b2 | string | |
| per_volume_size required | Per volume size quota | VolumeQuotaSetObject | |
| snapshots required | Snapshot Quota | VolumeQuotaSetObject | |
| usages required | Usage quota | VolumeQuotaSetObject | |
| volumes required | Volume Quota | VolumeQuotaSetObject |
102 - VolumeQuotaSetObject
| Name | Description | Schema | Default |
|---|---|---|---|
| in_use required | Quota set in use Example : 10 | integer | |
| limit required | Quota set limit Example : | integer | |
| reserved required | Quota set reserved Example : 0 | integer |
103 - VolumeRevertRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| snapshot_id required | Snapshot ID Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 | string |
104 - VolumeServer
| Name | Description | Schema | Default |
|---|---|---|---|
| attached_at required | The time when the volume was attached to the server. Example : | string (date-time) | |
| device required | Device name Example : /dev/vda | string | |
| id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string |
105 - VolumeServerAttachRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| delete_on_termination optional | Delete on termination Example : False | any of [boolean, null] | |
| server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string |
106 - VolumeServerAttachResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| delete_on_termination required | Delete on termination Example : False | boolean | |
| device required | Device name Example : /dev/vda | string | |
| server_id required | Server ID Example : 2a9be312-5d4b-4bc8-b2ae-35100fa9241f | string | |
| volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string |
107 - VolumeShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| bootable required | Bootable Example : False | boolean | |
| created_at required | Created at Example : | string (date-time) | |
| encrypted required | Encrypted Example : True | boolean | |
| id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string | |
| modified_at optional | Modified at Example : 2025-07-26T12:00:00Z | any of [string (date-time), null] | |
| multiattach required | Multiattach Example : False | boolean | |
| name optional | Volume name Example : volume01 | any of [string, null] | |
| servers required | Attached servers | array[VolumeServer] | |
| size required | Volume size Example : 104 | integer | |
| snapshot_id optional | Snapshot ID Example : cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 | any of [string, null] | |
| state required | Volume state Example : available | string | |
| user_id required | User ID Example : 570907805e5447be84b618450ef52o0t | string | |
| volume_image_metadata optional | Volume Image metadata | any of [VolumeImageMetadataResponse, null] | |
| volume_type required | Volume type Example : SSD | string | |
| volume_type_id required | Volume type ID Example : c643ac35-3aec-43e6-b97a-3d6f666c5207 | string |
108 - VolumeTransferAcceptResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | Transfer ID Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a | string | |
| name optional | Volume name Example : volume01 | any of [string, null] | |
| volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string |
109 - VolumeTransferAccessRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| auth_key required | Auth key Example : f5972fdb456897eb | string |
110 - VolumeTransferCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| auth_key required | Auth key Example : f5972fdb456897eb | string | |
| created_at required | Created at Example : | string | |
| id required | Transfer ID Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a | string | |
| name optional | Volume name Example : volume01 | any of [string, null] | |
| volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string |
111 - VolumeTransferListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| transfers required | Volume Transfer List | array[VolumeTransferAcceptResponse] |
112 - VolumeTransferRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| name optional | Volume name Example : volume01 | any of [string, null] | |
| volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string |
113 - VolumeTransferShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created at Example : | string | |
| id required | Transfer ID Example : 1ac231be-823b-4a4d-8ff0-aac503a7118a | string | |
| name optional | Volume name Example : volume01 | any of [string, null] | |
| volume_id required | Volume ID Example : 3f500f00-ed80-4566-a057-e31760226f9a | string |
114 - VolumeTypeDetailResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Volume type description Example : Volume type description | any of [string, null] | |
| extra_specs required | Extra specs | any of [VolumeTypeExtraSpecs, null] | |
| id required | Volume type ID Example : c643ac35-3aec-43e6-b97a-3d6f666c5207 | string | |
| name optional | Volume type name Example : SSD | any of [string, null] |
115 - VolumeTypeExtraSpecs
| Name | Description | Schema | Default |
|---|---|---|---|
| multiattach optional | Multiattach Example : <is> True | any of [string, null] |
116 - VolumeTypeListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| volume_types required | Volume type list | array[VolumeTypeDetailResponse] |
117 - VolumeUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| name optional | Volume name Example : volume01Pattern : ^[a-zA-Z0-9-_ ]*$ | any of [string, null] |