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

Return to the regular view of this page.

Models

1: AsyncResponse
2: AttachedServer
3: AttachmentListModel
4: ExternalError
5: MemberVolume
6: MemberVolumeWithRecoveryInfo
7: QoSModel
8: RecoveryInfo
9: RecoveryVolumeGroupInfo
10: RecoveryVolumeInfo
11: RelationVolumeGroupModel
12: RelationVolumeModel
13: SetVolumeQoSRequest
14: SetVolumeQoSResponse
15: SimpleAttachedServer
16: SimpleIdNameInfo
17: SnapshotSchedule
18: TagModel
19: VolumeAttachmentRequest
20: VolumeAttachmentResponse
21: VolumeCreateRequest
22: VolumeCreateRequestV1Dot2
23: VolumeDetachRequest
24: VolumeGroupCreationRequest
25: VolumeGroupInfo
26: VolumeGroupListModel
27: VolumeGroupListResponse
28: VolumeGroupMemberRequest
29: VolumeGroupMemberResponse
30: VolumeGroupModel
31: VolumeGroupRecoveryCreateRequest
32: VolumeGroupReplicationCreateRequest
33: VolumeGroupReplicationDeleteResponse
34: VolumeGroupReplicationSyncTabModel
35: VolumeGroupReplicationSyncTabResponse
36: VolumeGroupReplicationUpdateCycleRequest
37: VolumeGroupReplicationUpdateCycleResponse
38: VolumeGroupReplicationUpdatePolicyRequest
39: VolumeGroupReplicationUpdatePolicyResponse
40: VolumeGroupResponse
41: VolumeGroupSnapshotDeleteResponse
42: VolumeGroupSnapshotListModel
43: VolumeGroupSnapshotListResponse
44: VolumeGroupSnapshotResponse
45: VolumeGroupSnapshotRestoreResponse
46: VolumeGroupSnapshotScheduleRequest
47: VolumeGroupSnapshotScheduleResponse
48: VolumeListModel
49: VolumeListResponse
50: VolumeModel
51: VolumeModelV1Dot2
52: VolumeRecoveryCreateRequest
53: VolumeReplicationCreateRequest
54: VolumeReplicationCycleRequest
55: VolumeReplicationCycleResponse
56: VolumeReplicationModel
57: VolumeReplicationPolicyRequest
58: VolumeReplicationPolicyResponse
59: VolumeReplicationResponse
60: VolumeResponse
61: VolumeResponseV1Dot2
62: VolumeSnapshotDeleteResponse
63: VolumeSnapshotListModel
64: VolumeSnapshotListResponse
65: VolumeSnapshotRateRequest
66: VolumeSnapshotRateResponse
67: VolumeSnapshotResponse
68: VolumeSnapshotRestoreResponse
69: VolumeSnapshotScheduleRequest
70: VolumeSnapshotScheduleResponse

1 - AsyncResponse

Name	Description	Schema	Default
request_id optional	Request id Example : `req-0006064c-c008-458c-8977-19671c6b32d4`	string
resource_id optional	Resource id Example : `8bf55e738d4e44b5a21dbe133a42ecbe`	string

2 - AttachedServer

Name	Description	Schema
id optional	Server id Example : `83c3c73d457345e3829ee6d5557c0011`	string
image_name optional	Image name Example : `RHEL 8.8 for BM`	string
name optional	Server name Example : `baremetal-01`	string
srn optional	SRN Example : `srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0`	string
state optional	Server state Example : `RUNNING`	string
type optional	Server type Example : `BM`	enum (BM, MNGC)

3 - AttachmentListModel

Name	Description	Schema	Default
object_id optional	Object id Example : `83c3c73d457345e3829ee6d5557c0016`	string
object_type optional	Object type Example : `BM`	enum (BM, MNGC)

4 - ExternalError

Name	Description	Schema
code optional	Code Example : `Forbidden`	string
object_type optional	Server type Example : `BM`	enum (BM, MNGC)
status optional	Status Example : `403`	integer

5 - MemberVolume

Name	Description	Schema
disk_type optional	disk_type Example : `SSD`	enum (SSD, HDD)
id optional	volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string
name optional	volume name Example : `volume-01`	string
purpose optional	volume purpose Example : `ORG`	enum (ORG, REPL, BACKUP, RECOVERY)
size_gb optional	size_gb Example : `10`	integer
so_volume_id optional	so volume id Example :	string
so_volume_name optional	so volume name Example :	string

6 - MemberVolumeWithRecoveryInfo

Name	Description	Schema
disk_type optional	Disk type Example : `SSD`	enum (SSD, HDD)
id optional	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string
name optional	Volume name Example : `bs-01`	string
origin_volume optional	origin volume information	SimpleIdNameInfo
recovery_volume optional	recovery volume information	SimpleIdNameInfo
size_gb optional	Volume capacity(GB) Example : `10`	integer
snapshot_rate optional	Snapshot rate Example : `100`	integer
state optional	Current state Example : `CREATING`	enum (CREATING, IN_USE, EDITING, DELETING, DELETED, ATTACHING, DETACHING, AVAILABLE, ERROR_DELETING, ERROR_EDITING, ERROR)

7 - QoSModel

Name	Description	Schema	Default
iops required	Enter the value between at least 3,000 IOPS and up to 16,000 IOPS. Example : `3000`	integer
throughput required	Enter the value between at least 125MB/s and up to 1,000MB/s. Example : `125`	integer

8 - RecoveryInfo

Name	Description	Schema	Default
origin_volume optional	origin volume information	RecoveryVolumeInfo
recovery_volume optional	recovery volume information	RecoveryVolumeInfo

9 - RecoveryVolumeGroupInfo

Name	Description	Schema	Default
origin_volume_group optional	Origin volume group information	SimpleIdNameInfo
recovery_volume_group optional	Recovery volume group information	SimpleIdNameInfo

10 - RecoveryVolumeInfo

Name	Description	Schema
attachments optional	Attached server	array[SimpleAttachedServer]
id optional	id Example : `7239779c01e3405f82bb71c7f4b55fcd`	string
name optional	Volume name Example : `bs-01`	string

11 - RelationVolumeGroupModel

Name	Description	Schema
auth optional	Auth Example : `READ`	enum (READ, READ_WRITE, UNKNOWN)
id optional	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string
name optional	Volume name Example : `bs-01`	string
purpose optional	Volume group purpose Example : `ORG`	enum (ORG, REPL, RECOVERY)
region optional	Region Example : `kr-west1`	string

12 - RelationVolumeModel

Name	Description	Schema
auth optional	Auth Example : `READ`	enum (READ, READ_WRITE, UNKNOWN)
id optional	id Example : `7239779c01e3405f82bb71c7f4b55fcd`	string
name optional	Volume name Example : `bs-01`	string
purpose optional	Volume purpose Example : `ORG`	enum (ORG, REPL, BACKUP, RECOVERY)
region optional	Region Example : `kr-west1`	string

13 - SetVolumeQoSRequest

Name	Description	Schema	Default
iops optional	IOPS. If omitted, the existing value will be retained. Example : `3000`	integer
throughput optional	Throughput. If omitted, the existing value will be retained. Example : `125`	integer

14 - SetVolumeQoSResponse

Name	Description	Schema	Default
iops optional	IOPS Example : `3000`	integer
throughput optional	Throughput Example : `125`	integer

15 - SimpleAttachedServer

Name	Description	Schema	Default
id optional	Server id Example : `83c3c73d457345e3829ee6d5557c0011`	string
type optional	Server type Example : `BM`	enum (BM, MNGC)

16 - SimpleIdNameInfo

Name	Description	Schema	Default
id optional	id Example : `7239779c01e3405f82bb71c7f4b55fcd`	string
name optional	name Example : `my_name`	string

17 - SnapshotSchedule

Name	Description	Schema	Default
day_of_week optional	Day of week Example : `MON`	string	MON
frequency optional	Frequency DAILY	WEEKLY	NONE Example : `DAILY`
hour optional	Hour Example : `18`	integer

18 - TagModel

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

19 - VolumeAttachmentRequest

Name	Description	Schema	Default
attachments required	List of server id and type	array[AttachmentListModel]

20 - VolumeAttachmentResponse

Name	Description	Schema	Default
attachments optional	List of server id and type	array[AttachmentListModel]

21 - VolumeCreateRequest

Name	Description	Schema
attachments required	List of server id and type	array[AttachmentListModel]
disk_type required	Disk type Example : `SSD`	enum (SSD, HDD)
name required	Volume name Example : `bs-01`	string
size_gb required	Volume capacity(GB) Example : `10`	integer
tags optional	Tags	any of [array[TagModel], null]

22 - VolumeCreateRequestV1Dot2

Name	Description	Schema
attachments required	List of server id and type	array[AttachmentListModel]
disk_type required	Disk type Example : `SSD`	enum (SSD, HDD)
name required	Volume name Example : `bs-01`	string
qos optional	Volume QoS	QoSModel
size_gb required	Volume capacity(GB) Example : `10`	integer
tags optional	Tags	any of [array[TagModel], null]

23 - VolumeDetachRequest

Name	Description	Schema	Default
attachments required	List of object id to detach	array[string]

24 - VolumeGroupCreationRequest

Name	Description	Schema
name required	Volume group name Example : `vg-01`	string
tags optional	Tags	any of [array[TagModel], null]
volume_ids required	List of volume(Block Storage) id to add Example : `['17e0b4fd27784dfb843440ec08bdd148']`	array[string]

25 - VolumeGroupInfo

Name	Description	Schema	Default
id optional	id Example : `7239779c01e3405f82bb71c7f4b55fcd`	string
name optional	Volume group name Example : `vg-01`	string

26 - VolumeGroupListModel

Name	Description	Schema	Default
account_id optional	Account id Example : `36827d9b643f46c2ae6bb7e63d633bfe`	string
created_at optional	Created at Example : `2024-08-01T07:06:23.315Z`	string (date-time)
created_by optional	Created by Example : `samsung-cloud-platform1@samsung.com`	string
id optional	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string
modified_at optional	Modified at Example : `2024-08-01T07:06:25.315Z`	string (date-time)
modified_by optional	Modified by Example : `samsung-cloud-platform2@samsung.com`	string
name optional	Volume group name Example : `vg-01`	string
num_of_block_storages optional	Number of volumes Example : `2`	integer	1
purpose optional	Volume group purpose Example : `ORG`	string
state optional	Current state Example : `CREATING`	enum (CREATING, AVAILABLE, DELETING, EDITING, DELETED, ERROR_DELETING, ERROR_EDITING, ERROR)

27 - VolumeGroupListResponse

Name	Description	Schema	Default
total_count optional	Total count Example : `1`	integer
volume_groups optional	List of volume groups	array[VolumeGroupListModel]

28 - VolumeGroupMemberRequest

Name	Description	Schema	Default
volume_ids required	List of volume(Block Storage) id Example : `['13666d6c32d4456e8421f7768d0bf225']`	array[string]

29 - VolumeGroupMemberResponse

Name	Description	Schema	Default
id optional	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string
member_volumes optional	List of member volumes	array[MemberVolume]

30 - VolumeGroupModel

Name	Description	Schema
account_id optional	Account id Example : `36827d9b643f46c2ae6bb7e63d633bfe`	string
created_at optional	Created at Example : `2024-08-01T07:06:23.315Z`	string
created_by optional	Created by Example : `samsung-cloud-platform1@samsung.com`	string
has_origin optional	Whether origin relation exists Example : `True`	boolean
has_replication optional	Whether replication relation exists Example : `True`	boolean
id optional	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string
member_volumes optional	List of member volumes	array[MemberVolumeWithRecoveryInfo]
modified_at optional	Modified at Example : `2024-08-01T07:06:25.315Z`	string
modified_by optional	Modified by Example : `samsung-cloud-platform2@samsung.com`	string
name optional	Volume group name Example : `vg-01`	string
purpose optional	Volume group purpose Example : `ORG`	enum (ORG, REPL, RECOVERY)
recovery optional	Recovery volume group information	RecoveryVolumeGroupInfo
snapshot_schedule optional	Snapshot schedule	SnapshotSchedule
so_storage_id optional	So Storage Id Example : `200`	integer
so_volume_pool_id optional	So Volume pool id Example : `bm-01`	string
state optional	Current state Example : `CREATING`	enum (CREATING, AVAILABLE, DELETING, EDITING, DELETED, ERROR_DELETING, ERROR_EDITING, ERROR)
storage_volume_group_name optional	So volume group name Example : `go02407310544da8aadc775f`	string

31 - VolumeGroupRecoveryCreateRequest

Name	Description	Schema	Default
block_storage_name_prefix required	Block Storage name prefix Example : `prefix-`	string
snapshot_id required	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string

32 - VolumeGroupReplicationCreateRequest

Name	Description	Schema
cycle required	Replication cycle Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)
name required	Replication volume group name Example : `replica-vg-01`	string
region required	Region Example : `kr-west1`	string
replication_volume_name_prefix required	Replication volume name prefix Example : `dr`	string

33 - VolumeGroupReplicationDeleteResponse

Name	Description	Schema	Default
result optional	Result Example :	boolean

34 - VolumeGroupReplicationSyncTabModel

Name	Description	Schema
related_volume_groups optional	List of related volume groups	array[RelationVolumeGroupModel]
sync_cycle optional	Replication cycle Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)
sync_state optional	Replication state Example : `SNAPMIRROED`	string

35 - VolumeGroupReplicationSyncTabResponse

Name	Description	Schema	Default
result optional	Volume group replication detail	VolumeGroupReplicationSyncTabModel

36 - VolumeGroupReplicationUpdateCycleRequest

Name	Description	Schema	Default
cycle required	Replication cycle Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)

37 - VolumeGroupReplicationUpdateCycleResponse

Name	Description	Schema	Default
cycle optional	Replication cycle Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)
volume_group_id optional	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string

38 - VolumeGroupReplicationUpdatePolicyRequest

Name	Description	Schema	Default
policy required	Policy Example : `RESYNC`	enum (RESYNC, BREAK)

39 - VolumeGroupReplicationUpdatePolicyResponse

Name	Description	Schema	Default
cycle optional	Replication cycle Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)
sync_state optional	Replication state Example : `SNAPMIRROED`	string

40 - VolumeGroupResponse

Name	Description	Schema	Default
result optional	Volume group detail	VolumeGroupModel

41 - VolumeGroupSnapshotDeleteResponse

Name	Description	Schema
account_id optional	Account id Example : `36827d9b643f46c2ae6bb7e63d633bfe`	string
snapshot_id optional	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string
volume_group_id optional	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string

42 - VolumeGroupSnapshotListModel

Name	Description	Schema
created_dt optional	Created dt Example : `2024-08-01T07:07:23.315Z`	string
snapshot_id optional	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string
snapshot_name optional	Snapshot name Example : `vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932`	string

43 - VolumeGroupSnapshotListResponse

Name	Description	Schema
is_snapshot_policy optional	Whether to activate snapshot Example : `False`	boolean
snapshots optional	List of snapshots	array[VolumeGroupSnapshotListModel]
volume_group_id optional	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string

44 - VolumeGroupSnapshotResponse

Name	Description	Schema
account_id optional	Account id Example : `36827d9b643f46c2ae6bb7e63d633bfe`	string
snapshot_id optional	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string
snapshot_name optional	Snapshot name Example : `vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932`	string
volume_group_id optional	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string

45 - VolumeGroupSnapshotRestoreResponse

Name	Description	Schema
account_id optional	Account id Example : `36827d9b643f46c2ae6bb7e63d633bfe`	string
snapshot_id optional	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string
volume_group_id optional	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string

46 - VolumeGroupSnapshotScheduleRequest

Name	Description	Schema	Default
day_of_week optional	Day of week(If this field is excluded, the schedule frequency is set to DAILY.) Example : `SUN`	enum (SUN, MON, TUE, WED, THU, FRI, SAT)
hour required	Hour Example : `18`	integer

47 - VolumeGroupSnapshotScheduleResponse

Name	Description	Schema	Default
day_of_week optional	Day of week Example : `SUN`	enum (SUN, MON, TUE, WED, THU, FRI, SAT)
frequency optional	Frequency DAILY	WEEKLY	NONE Example : `DAILY`
hour optional	Hour Example : `18`	integer
volume_group_id optional	Volume group id Example : `c9ecae8b973b425c81c3817893cd8063`	string

48 - VolumeListModel

Name	Description	Schema
attachments optional	Attached server Example : `[{'id': 'd7682135392e42489948c189e29011cc', 'name': 'baremetal-01'}]`	array[object]
created_at optional	Created at Example :	string (date-time)
created_by optional	Created by Example : `samsung-cloud-platform1@samsung.com`	string
disk_type optional	Disk type Example : `SSD`	enum (SSD, HDD)
has_relation optional	Whether relation exists Example : `False`	boolean
id optional	id Example : `7239779c01e3405f82bb71c7f4b55fcd`	string
is_in_volume_group optional	Whether to belong to the volume group Example : `False`	boolean
is_snapshot_activated optional	Whether to activate snapshot Example : `True`	boolean
iscsi_target_ips optional	List of iscsi ips Example : `{'description': 'List of iscsi ips', 'example': ['172.30.4.3', '172.30.4.4']}`	array[string]
modified_at optional	Modified at Example :	string (date-time)
modified_by optional	Modified by Example : `samsung-cloud-platform2@samsung.com`	string
name optional	Volume name Example : `bs-01`	string
purpose optional	Volume purpose Example : `ORG`	enum (ORG, REPL, BACKUP, RECOVERY)
size_gb optional	Volume capacity(GB) Example : `10`	integer
state optional	Current state Example : `CREATING`	enum (CREATING, IN_USE, EDITING, DELETING, DELETED, ATTACHING, DETACHING, AVAILABLE, ERROR_DELETING, ERROR_EDITING, ERROR)
volume_group optional	Volume group Example :	object

49 - VolumeListResponse

Name	Description	Schema	Default
total_count optional	Total count Example : `1`	integer
volumes optional	List of volumes	array[VolumeListModel]

50 - VolumeModel

Name	Description	Schema
account_id optional	Account id Example : `36827d9b643f46c2ae6bb7e63d633bfe`	string
attachments optional	Attached server	array[AttachedServer]
created_at optional	Created at Example : `2024-08-01T07:06:23.315Z`	string
created_by optional	Created by Example : `samsung-cloud-platform1@samsung.com`	string
disk_type optional	Disk type Example : `SSD`	enum (SSD, HDD)
external_errors optional	Error during external call	array[ExternalError]
has_origin optional	Whether origin relation exists Example : `True`	boolean
has_replication optional	Whether replication relation exists Example : `True`	boolean
id optional	id Example : `7239779c01e3405f82bb71c7f4b55fcd`	string
is_encryption optional	Whether to apply encryption Example : `True`	boolean
iscsi_target_ips optional	List of iscsi ips Example : `['172.30.4.3', '172.30.4.4']`	array[string]
modified_at optional	Modified at Example : `2024-08-01T07:06:25.315Z`	string
modified_by optional	Modified by Example : `samsung-cloud-platform2@samsung.com`	string
name optional	Volume name Example : `bs-01`	string
previous_state optional	Previous state Example : `CREATING`	enum (CREATING, IN_USE, EDITING, DELETING, DELETED, ATTACHING, DETACHING, AVAILABLE, ERROR_DELETING, ERROR_EDITING, ERROR)
purpose optional	Volume purpose Example : `ORG`	enum (ORG, REPL, BACKUP, RECOVERY)
recovery optional	Recovery information	RecoveryInfo
size_gb optional	Volume capacity(GB) Example : `10`	integer
snapshot_rate optional	Snapshot rate Example : `100`	integer
snapshot_schedule optional	Snapshot schedule	SnapshotSchedule
srn optional	SRN Example : `srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0`	string
state optional	Current state Example : `CREATING`	enum (CREATING, IN_USE, EDITING, DELETING, DELETED, ATTACHING, DETACHING, AVAILABLE, ERROR_DELETING, ERROR_EDITING, ERROR)
storage_volume_name optional	Storage volume name Example : `vo202407310544da8aadc775f`	string
volume_group optional	Volume group	VolumeGroupInfo

51 - VolumeModelV1Dot2

Name	Description	Schema
account_id optional	Account id Example : `36827d9b643f46c2ae6bb7e63d633bfe`	string
attachments optional	Attached server	array[AttachedServer]
created_at optional	Created at Example : `2024-08-01T07:06:23.315Z`	string
created_by optional	Created by Example : `samsung-cloud-platform1@samsung.com`	string
disk_type optional	Disk type Example : `SSD`	enum (SSD, HDD)
external_errors optional	Error during external call	array[ExternalError]
has_origin optional	Whether origin relation exists Example : `True`	boolean
has_replication optional	Whether replication relation exists Example : `True`	boolean
id optional	id Example : `7239779c01e3405f82bb71c7f4b55fcd`	string
is_encryption optional	Whether to apply encryption Example : `True`	boolean
iscsi_target_ips optional	List of iscsi ips Example : `['172.30.4.3', '172.30.4.4']`	array[string]
modified_at optional	Modified at Example : `2024-08-01T07:06:25.315Z`	string
modified_by optional	Modified by Example : `samsung-cloud-platform2@samsung.com`	string
name optional	Volume name Example : `bs-01`	string
previous_state optional	Previous state Example : `CREATING`	enum (CREATING, IN_USE, EDITING, DELETING, DELETED, ATTACHING, DETACHING, AVAILABLE, ERROR_DELETING, ERROR_EDITING, ERROR)
purpose optional	Volume purpose Example : `ORG`	enum (ORG, REPL, BACKUP, RECOVERY)
qos optional	Volume QoS	QoSModel
recovery optional	Recovery information	RecoveryInfo
size_gb optional	Volume capacity(GB) Example : `10`	integer
snapshot_rate optional	Snapshot rate Example : `100`	integer
snapshot_schedule optional	Snapshot schedule	SnapshotSchedule
srn optional	SRN Example : `srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0`	string
state optional	Current state Example : `CREATING`	enum (CREATING, IN_USE, EDITING, DELETING, DELETED, ATTACHING, DETACHING, AVAILABLE, ERROR_DELETING, ERROR_EDITING, ERROR)
storage_volume_name optional	Storage volume name Example : `vo202407310544da8aadc775f`	string
volume_group optional	Volume group	VolumeGroupInfo

52 - VolumeRecoveryCreateRequest

Name	Description	Schema	Default
name required	Recovery volume name Example : `recovery-volume`	string
snapshot_id required	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string

53 - VolumeReplicationCreateRequest

Name	Description	Schema
cycle required	Replication cycle Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)
name required	Replication volume name Example : `replica-bs-01`	string
region required	Region Example : `kr-west1`	string

54 - VolumeReplicationCycleRequest

Name	Description	Schema	Default
cycle required	Replication cycle Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)

55 - VolumeReplicationCycleResponse

Name	Description	Schema	Default
cycle optional	Replication cycle Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)
volume_id optional	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string

56 - VolumeReplicationModel

Name	Description	Schema
related_volumes optional	List of related volumes	array[RelationVolumeModel]
sync_cycle optional	Replication cycle Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)
sync_state optional	Replication state Example : `SNAPMIRROED`	string

57 - VolumeReplicationPolicyRequest

Name	Description	Schema	Default
policy required	Policy Example : `RESYNC`	enum (RESYNC, BREAK)

58 - VolumeReplicationPolicyResponse

Name	Description	Schema	Default
sync_cycle optional	Replication cycle Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)
sync_state optional	Replication state Example : `SNAPMIRROED`	string

59 - VolumeReplicationResponse

Name	Description	Schema	Default
result optional	Volume replication detail	VolumeReplicationModel

60 - VolumeResponse

Name	Description	Schema	Default
result optional	Volume detail	VolumeModel

61 - VolumeResponseV1Dot2

Name	Description	Schema	Default
result optional	Volume detail	VolumeModelV1Dot2

62 - VolumeSnapshotDeleteResponse

Name	Description	Schema
account_id optional	Account id Example : `36827d9b643f46c2ae6bb7e63d633bfe`	string
snapshot_id optional	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string
volume_id optional	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string

63 - VolumeSnapshotListModel

Name	Description	Schema
created_dt optional	Created dt Example : `2024-08-01T07:07:23.315Z`	string
snapshot_id optional	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string
snapshot_name optional	Snapshot name Example : `vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932`	string
snapshot_size_mb optional	Snapshot size(MB) Example : `0`	object

64 - VolumeSnapshotListResponse

Name	Description	Schema
is_snapshot_policy optional	Whether to activate snapshot Example : `False`	boolean
snapshot_capacity_mb optional	Snapshot size(MB) Example : `0`	object
snapshot_capacity_rate optional	Snapshot capacity rate Example : `0`	object
snapshot_total_usage optional	Snapshot total usage Example : `0`	object
snapshots optional	List of snapshots	array[VolumeSnapshotListModel]
volume_id optional	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string

65 - VolumeSnapshotRateRequest

Name	Description	Schema	Default
snapshot_rate required	Snapshot rate Example : `100`	integer

66 - VolumeSnapshotRateResponse

Name	Description	Schema
is_snapshot_activated optional	Whether to activate snapshot Example : `True`	boolean
snapshot_rate optional	Snapshot rate Example : `100`	integer
volume_id optional	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string

67 - VolumeSnapshotResponse

Name	Description	Schema
account_id optional	Account id Example : `36827d9b643f46c2ae6bb7e63d633bfe`	string
snapshot_id optional	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string
snapshot_name optional	Snapshot name Example : `vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932`	string
volume_id optional	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string

68 - VolumeSnapshotRestoreResponse

Name	Description	Schema
account_id optional	Account id Example : `36827d9b643f46c2ae6bb7e63d633bfe`	string
snapshot_id optional	Snapshot id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string
volume_id optional	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string

69 - VolumeSnapshotScheduleRequest

Name	Description	Schema	Default
day_of_week optional	Day of week(If this field is excluded, the schedule frequency is set to DAILY.) Example : `SUN`	enum (SUN, MON, TUE, WED, THU, FRI, SAT)
hour required	Hour Example : `18`	integer

70 - VolumeSnapshotScheduleResponse

Name	Description	Schema	Default
day_of_week optional	Day of week Example : `SUN`	enum (SUN, MON, TUE, WED, THU, FRI, SAT)
frequency optional	Frequency DAILY	WEEKLY	NONE Example : `DAILY`
hour optional	Hour Example : `18`	integer
volume_id optional	Volume id Example : `92cd16fe8ebc4f73832513a172bf0000`	string