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

Return to the regular view of this page.

Models

1: AccessRuleRequest
2: AccessRuleResponse
3: Replication
4: ReplicationCreateRequest
5: ReplicationCreateRequestV1Dot2
6: ReplicationCreateResponse
7: ReplicationCreateResponseV1Dot2
8: ReplicationListResponse
9: ReplicationListResponseV1Dot2
10: ReplicationRegionListResponse
11: ReplicationShowResponse
12: ReplicationShowResponseV1Dot2
13: ReplicationUpdateRequest
14: ReplicationUpdateResponse
15: ReplicationV1Dot2
16: ReplicationZonesListResponse
17: Snapshot
18: SnapshotCreateRequest
19: SnapshotDetail
20: SnapshotListResponse
21: SnapshotRestoreResponse
22: SnapshotSchedule
23: SnapshotScheduleCreateRequest
24: SnapshotScheduleCreateResponse
25: SnapshotScheduleListResponse
26: SnapshotScheduleSetRequest
27: SnapshotScheduleSetResponse
28: SnapshotScheduleShow
29: SnapshotShowResponse
30: Tag
31: Volume
32: VolumeCreateRequest
33: VolumeCreateRequestV1Dot2
34: VolumeCreateResponse
35: VolumeCreateResponseV1Dot2
36: VolumeListResponse
37: VolumeListResponseV1Dot2
38: VolumeObjectAccessRuleListBase
39: VolumeObjectAccessRuleListResponse
40: VolumeSetRequest
41: VolumeSetResponse
42: VolumeShowResponse
43: VolumeShowResponseV1Dot2
44: VolumeV1Dot2

1 - AccessRuleRequest

Name	Description	Schema
object_id required	Object ID Example : `43fq3347-02q4-4aa8-ccf9-affe4917bb6f`	string
object_type required	Object Type Example : `VM` Pattern : `^(VM\|BM\|GPU\|GPU_NODE\|ENDPOINT)$`	string
action required	Access Rule Action Example : `add` Pattern : `^(add\|remove)$`	string

2 - AccessRuleResponse

Name	Description	Schema
volume_id required	Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
object_type required	Object Type Example : `VM`	string
object_id required	Object ID Example : `43fq3347-02q4-4aa8-ccf9-affe4917bb6f`	string
action required	Access Rule Action Example : `add`	string

3 - Replication

Name	Description	Schema
replication_id required	Replication ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
replication_frequency required	Frequency Example : `5min`	string
source_volume_id required	Source Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
source_volume_region required	Source Region Example : `kr-west1`	string
source_volume_access_level required	Source Access Level Example : `ro`	string
replication_volume_id required	Target Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
replication_volume_region required	Target Region Example : `kr-west1`	string
replication_volume_access_level required	Target Access Level Example : `ro`	string
replication_type required	Replication Type Example : `replication`	string

4 - ReplicationCreateRequest

Name	Description	Schema
name required	Target Volume Name Example : `my_volume` Pattern : `^[a-z]([a-z0-9_]){2,20}$`	string
cifs_password optional	CIFS Password Example : `cifspwd0!!`	any of [string, null]
replication_frequency required	Frequency Example : `5min` Pattern : `^(5min\|hourly\|daily\|weekly\|monthly)$`	string
region required	Target Region Example : `kr-west1`	string
volume_id required	Source Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
backup_retention_count optional	Backup Retention Count Example : `2`	any of [integer, null]
replication_type required	Replication Type Example : `replication` Pattern : `^(replication\|backup)$`	string

5 - ReplicationCreateRequestV1Dot2

Name	Description	Schema
name required	Target Volume Name Example : `my_volume` Pattern : `^[a-z]([a-z0-9_]){2,20}$`	string
cifs_password optional	CIFS Password Example : `cifspwd0!!`	any of [string, null]
replication_frequency required	Frequency Example : `5min` Pattern : `^(5min\|hourly\|daily\|weekly\|monthly)$`	string
zone required	Zone Example : `kr-west1-a`	string
volume_id required	Source Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
backup_retention_count optional	Backup Retention Count Example : `2`	any of [integer, null]
replication_type required	Replication Type Example : `replication` Pattern : `^(replication\|backup)$`	string

6 - ReplicationCreateResponse

Name	Description	Schema
replication_id required	Replication ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
replication_status required	Replication Status Example : `creating`	string
source_volume_id required	Source Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
source_volume_region required	Source Region Example : `kr-west1`	string
protocol required	Protocol Example : `NFS`	string
replication_volume_id required	Target Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
replication_volume_region required	Target Region Example : `kr-west1`	string

7 - ReplicationCreateResponseV1Dot2

Name	Description	Schema
replication_id required	Replication ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
replication_status required	Replication Status Example : `creating`	string
source_volume_id required	Source Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
source_volume_region required	Source Region Example : `kr-west1`	string
source_volume_zone required	Source Zone Example : `kr-west1-a`	string
protocol required	Protocol Example : `NFS`	string
replication_volume_id required	Target Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
replication_volume_region required	Target Region Example : `kr-west1`	string
replication_volume_zone required	Target Zone Example : `kr-west1-a`	string

8 - ReplicationListResponse

Name	Description	Schema	Default
count required	count Example : `1`	integer
replications required		array[Replication]

9 - ReplicationListResponseV1Dot2

Name	Description	Schema	Default
count required	count Example : `1`	integer
replications required		array[ReplicationV1Dot2]

10 - ReplicationRegionListResponse

Name	Description	Schema	Default
regions required	Replication Region List Example : `['kr-west1']`	array[string]

11 - ReplicationShowResponse

Name	Description	Schema
replication_id required	Replication ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
replication_frequency required	Frequency Example : `5min`	string
source_volume_id required	Source Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
source_volume_region required	Source Region Example : `kr-west1`	string
source_volume_access_level required	Source Access Level Example : `ro`	string
replication_volume_id required	Target Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
replication_volume_region required	Target Region Example : `kr-west1`	string
replication_volume_access_level required	Target Access Level Example : `ro`	string
replication_type required	Replication Type Example : `replication`	string
source_volume_name required	Source Volume Name Example : `my_volume`	string
replication_policy required	Policy Example : `use`	string
replication_status required	Replication Status Example : `creating`	string
replication_volume_name required	Target Volume Name Example : `my_volume`	string
backup_retention_count optional	Backup Retention Count Example : `2`	any of [integer, null]

12 - ReplicationShowResponseV1Dot2

Name	Description	Schema
replication_id required	Replication ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
replication_frequency required	Frequency Example : `5min`	string
source_volume_id required	Source Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
source_volume_region required	Source Region Example : `kr-west1`	string
source_volume_zone required	Source Zone Example : `kr-west1-a`	string
source_volume_access_level required	Source Access Level Example : `ro`	string
replication_volume_id required	Target Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
replication_volume_region required	Target Region Example : `kr-west1`	string
replication_volume_zone required	Target Zone Example : `kr-west1-a`	string
replication_volume_access_level required	Target Access Level Example : `ro`	string
replication_type required	Replication Type Example : `replication`	string
source_volume_name required	Source Volume Name Example : `my_volume`	string
replication_policy required	Policy Example : `use`	string
replication_status required	Replication Status Example : `creating`	string
replication_volume_name required	Target Volume Name Example : `my_volume`	string
backup_retention_count optional	Backup Retention Count Example : `2`	any of [integer, null]

13 - ReplicationUpdateRequest

Name	Description	Schema
replication_policy optional	Policy Example : `use`	any of [enum (use, paused), null]
replication_frequency optional	Frequency Example : `5min`	any of [enum (5min, hourly, daily, weekly, monthly), null]
backup_retention_count optional	Backup Retention Count Example : `2`	any of [integer, null]
replication_update_type required	Replication Update Type Example : `policy` Pattern : `^(policy\|modify_schedule)$`	string

14 - ReplicationUpdateResponse

Name	Description	Schema
replication_id required	Replication ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
replication_frequency required	Frequency Example : `5min`	string
source_volume_id required	Source Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
source_volume_region required	Source Region Example : `kr-west1`	string
source_volume_access_level required	Source Access Level Example : `ro`	string
replication_volume_id required	Target Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
replication_volume_region required	Target Region Example : `kr-west1`	string
replication_volume_access_level required	Target Access Level Example : `ro`	string
replication_type required	Replication Type Example : `replication`	string
backup_retention_count optional	Backup Retention Count Example : `2`	any of [integer, null]

15 - ReplicationV1Dot2

Name	Description	Schema
replication_id required	Replication ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
replication_frequency required	Frequency Example : `5min`	string
source_volume_id required	Source Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
source_volume_region required	Source Region Example : `kr-west1`	string
source_volume_zone required	Source Zone Example : `kr-west1-a`	string
source_volume_access_level required	Source Access Level Example : `ro`	string
replication_volume_id required	Target Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
replication_volume_region required	Target Region Example : `kr-west1`	string
replication_volume_zone required	Target Zone Example : `kr-west1-a`	string
replication_volume_access_level required	Target Access Level Example : `ro`	string
replication_type required	Replication Type Example : `replication`	string

16 - ReplicationZonesListResponse

Name	Description	Schema	Default
zones required	Replication Region List Example : `['kr-west1']`	array[string]

17 - Snapshot

Name	Description	Schema
id required	Snapshot ID Example : `40htrre5b-eww25-ff2b-a426-6afefas65a3b`	string
name required	Snapshot Name Example : `my_volume.2024-10-01_14215`	string
state required	Snapshot State Example : `available`	string
size optional	Example :	any of [integer, null]
created_at required	Created At Example : `2024-07-30T04:54:33.219373`	string (date-time)

18 - SnapshotCreateRequest

Name	Description	Schema	Default
volume_id required	Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string

19 - SnapshotDetail

Name	Description	Schema
id required	Snapshot ID Example : `40htrre5b-eww25-ff2b-a426-6afefas65a3b`	string
name required	Snapshot Name Example : `my_volume.2024-10-01_14215`	string
state required	Snapshot State Example : `available`	string
size optional	Example :	any of [integer, null]
created_at required	Created At Example : `2024-07-30T04:54:33.219373`	string (date-time)
volume_id required	Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string

20 - SnapshotListResponse

Name	Description	Schema
count required	count Example : `1`	integer
snapshots required		array[Snapshot]
snapshot_size_total_byte optional	Example :	any of [integer, null]

21 - SnapshotRestoreResponse

Name	Description	Schema	Default
snapshot required		Snapshot

22 - SnapshotSchedule

Name	Description	Schema
frequency required	Frequency of the snapshot Example : `WEEKLY` Pattern : `^(WEEKLY\|DAILY)$`	string
day_of_week optional	Day of week of the snapshot schedule Example : `MON` Pattern : `^(SUN\|MON\|TUE\|WED\|THU\|FRI\|SAT)$`	any of [string, null]
hour required	Hour of the snapshot schedule Example : `23` Pattern : `^([0-9]\|1[0-9]\|2[0-3])$`	string

23 - SnapshotScheduleCreateRequest

Name	Description	Schema
snapshot_retention_count optional	Retention count Example : `10`	any of [integer, null]
volume_id required	Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
snapshot_schedule required		SnapshotSchedule

24 - SnapshotScheduleCreateResponse

Name	Description	Schema
snapshot_retention_count optional	Retention count Example : `10`	integer
volume_id required	Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	any of [string, null]
snapshot_schedule required		SnapshotSchedule

25 - SnapshotScheduleListResponse

Name	Description	Schema
snapshot_retention_count optional	Retention count Example : `10`	integer
volume_id required	Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
snapshot_policy_enabled optional	Snapshot Schedule Policy Enabled Example : `true`	any of [boolean, null]
snapshot_schedule required		array[SnapshotScheduleShow]

26 - SnapshotScheduleSetRequest

Name	Description	Schema	Default
snapshot_retention_count optional	Retention count Example : `10`	any of [integer, null]
snapshot_schedule required		SnapshotSchedule

27 - SnapshotScheduleSetResponse

Name	Description	Schema
snapshot_retention_count optional	Retention count Example : `10`	integer
volume_id required	Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	any of [string, null]
snapshot_schedule required		SnapshotSchedule

28 - SnapshotScheduleShow

Name	Description	Schema
frequency required	Frequency of the snapshot Example : `WEEKLY` Pattern : `^(WEEKLY\|DAILY)$`	string
day_of_week optional	Day of week of the snapshot schedule Example : `MON` Pattern : `^(SUN\|MON\|TUE\|WED\|THU\|FRI\|SAT)$`	any of [string, null]
hour required	Hour of the snapshot schedule Example : `23` Pattern : `^([0-9]\|1[0-9]\|2[0-3])$`	string
id optional	Snapshot Schedule ID Example : `d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31`	any of [string, null]

29 - SnapshotShowResponse

Name	Description	Schema	Default
snapshot required		SnapshotDetail

30 - Tag

Name	Description	Schema	Default
key required	Key Example : `key` Maximum length : `128`	string
value optional	Value Example : `value`	any of [string, null]

31 - Volume

Name	Description	Schema
id required	Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
name required	Volume Name Example : `my_volume`	string
protocol required	Protocol Example : `NFS`	string
state required	Volume State Example : `available`	string
account_id required	Account ID Example : `rwww523320dfvwbbefefsdvwdadsfa24c`	string
created_at required	Created At Example : `2024-07-30T04:54:33.219373`	string (date-time)
type_id required	Volume Type ID Example : `jef22f67-ee83-4gg2-2ab6-3lf774ekfjdu`	string
type_name required	Volume Type Name Example : `HDD`	string
purpose required	Purpose Example : `replication`	string

32 - VolumeCreateRequest

Name	Description	Schema
name required	Volume Name Example : `my_volume` Pattern : `^[a-z]([a-z0-9_]){2,20}$`	string
protocol required	Protocol Example : `NFS` Pattern : `^(NFS\|CIFS)$`	string
type_name required	Volume Type Name Example : `HDD`	string
snapshot_id optional	Snapshot ID Example : `40htrre5b-eww25-ff2b-a426-6afefas65a3b`	any of [string, null]
cifs_password optional	CIFS Password Example : `cifspwd0!!`	any of [string, null]
tags optional		any of [array[Tag], null]

33 - VolumeCreateRequestV1Dot2

Name	Description	Schema
name required	Volume Name Example : `my_volume` Pattern : `^[a-z]([a-z0-9_]){2,20}$`	string
protocol required	Protocol Example : `NFS` Pattern : `^(NFS\|CIFS)$`	string
type_name required	Volume Type Name Example : `HDD`	string
snapshot_id optional	Snapshot ID Example : `40htrre5b-eww25-ff2b-a426-6afefas65a3b`	any of [string, null]
cifs_password optional	CIFS Password Example : `cifspwd0!!`	any of [string, null]
tags optional		any of [array[Tag], null]
zone required	Zone Example : `kr-west1-a`	string

34 - VolumeCreateResponse

Name	Description	Schema
protocol required	Protocol Example : `NFS`	string
snapshot_id optional	Snapshot ID Example : `40htrre5b-eww25-ff2b-a426-6afefas65a3b`	any of [string, null]
type_name required	Volume Type Name Example : `HDD`	string
volume_id required	Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
volume_name required	Volume Name Example : `my_volume`	string

35 - VolumeCreateResponseV1Dot2

Name	Description	Schema
protocol required	Protocol Example : `NFS`	string
snapshot_id optional	Snapshot ID Example : `40htrre5b-eww25-ff2b-a426-6afefas65a3b`	any of [string, null]
type_name required	Volume Type Name Example : `HDD`	string
volume_id required	Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
volume_name required	Volume Name Example : `my_volume`	string
zone required	Zone Example : `kr-west1-a`	string

36 - VolumeListResponse

Name	Description	Schema	Default
count required	count Example : `1`	integer
filestorages required		array[Volume]

37 - VolumeListResponseV1Dot2

Name	Description	Schema	Default
count required	count Example : `1`	integer
filestorages required		array[VolumeV1Dot2]

38 - VolumeObjectAccessRuleListBase

Name	Description	Schema
access_rule_state required	Access Rule State Example : `active`	string
object_type required	Object Type Example : `VM`	string
object_id required	Object ID Example : `43fq3347-02q4-4aa8-ccf9-affe4917bb6f`	string

39 - VolumeObjectAccessRuleListResponse

Name	Description	Schema
count required	count Example : `1`	integer
volume_id required	Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
access_rules required		array[VolumeObjectAccessRuleListBase]

40 - VolumeSetRequest

Name	Description	Schema	Default
file_unit_recovery_enabled required	Volume File Unit Recovery Enabled Example : `True`	boolean

41 - VolumeSetResponse

Name	Description	Schema	Default
file_unit_recovery_enabled required	Volume File Unit Recovery Enabled Example : `True`	boolean

42 - VolumeShowResponse

Name	Description	Schema
id required	Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
name required	Volume Name Example : `my_volume`	string
protocol required	Protocol Example : `NFS`	string
state required	Volume State Example : `available`	string
account_id required	Account ID Example : `rwww523320dfvwbbefefsdvwdadsfa24c`	string
created_at required	Created At Example : `2024-07-30T04:54:33.219373`	string (date-time)
type_id required	Volume Type ID Example : `jef22f67-ee83-4gg2-2ab6-3lf774ekfjdu`	string
type_name required	Volume Type Name Example : `HDD`	string
purpose required	Purpose Example : `replication`	string
path optional	Volume Mount Path Example : `xxx.xx.xxx:/xxxxxxxx`	any of [string, null]
usage optional	Example :	any of [integer, null]
encryption_enabled required	Volume Encryption Enabled Example : `True`	boolean
file_unit_recovery_enabled optional	Volume File Unit Recovery Enabled Example : `True`	any of [boolean, null]
cifs_id optional	CIFS ID Example : `cifsid`	any of [string, null]
endpoint_path optional	Volume Endpoint Path Example : `xxx.xx.xxx.xxx`	any of [string, null]

43 - VolumeShowResponseV1Dot2

Name	Description	Schema
id required	Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
name required	Volume Name Example : `my_volume`	string
protocol required	Protocol Example : `NFS`	string
state required	Volume State Example : `available`	string
account_id required	Account ID Example : `rwww523320dfvwbbefefsdvwdadsfa24c`	string
created_at required	Created At Example : `2024-07-30T04:54:33.219373`	string (date-time)
type_name required	Volume Type Name Example : `HDD`	string
purpose required	Purpose Example : `replication`	string
path optional	Volume Mount Path Example : `xxx.xx.xxx:/xxxxxxxx`	any of [string, null]
usage optional	Example :	any of [integer, null]
encryption_enabled required	Volume Encryption Enabled Example : `True`	boolean
file_unit_recovery_enabled optional	Volume File Unit Recovery Enabled Example : `True`	any of [boolean, null]
cifs_id optional	CIFS ID Example : `cifsid`	any of [string, null]
endpoint_path optional	Volume Endpoint Path Example : `xxx.xx.xxx.xxx`	any of [string, null]
zone required	Zone Example : `kr-west1-a`	string
az_type required	Availability Zone Type Example : `single`	any of [string, null]

44 - VolumeV1Dot2

Name	Description	Schema
id required	Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
name required	Volume Name Example : `my_volume`	string
protocol required	Protocol Example : `NFS`	string
state required	Volume State Example : `available`	string
account_id required	Account ID Example : `rwww523320dfvwbbefefsdvwdadsfa24c`	string
created_at required	Created At Example : `2024-07-30T04:54:33.219373`	string (date-time)
type_id required	Volume Type ID Example : `jef22f67-ee83-4gg2-2ab6-3lf774ekfjdu`	string
type_name required	Volume Type Name Example : `HDD`	string
purpose required	Purpose Example : `replication`	string
zone required	Zone Example : `kr-west1-a`	string
az_type required	Availability Zone Type Example : `single`	any of [string, null]