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

Return to the regular view of this page.

Models

1: AccessIp
2: AccessRule
3: AccessRuleListResponse
4: AccessRules
5: AccessRuleUpdateRequest
6: AccessRuleUpdateResponse
7: Snapshot
8: SnapshotCreateRequest
9: SnapshotCreateResponse
10: SnapshotListResponse
11: SnapshotResponse
12: Tag
13: Volume
14: VolumeCapacityRequest
15: VolumeCreateRequest
16: VolumeListResponse
17: VolumeShowResponse

1 - AccessIp

Name	Description	Schema	Default
access_ip required	Access IP Example : `xxx.xxx.xxx.xxx`	string
access_ip_state required	Access IP State Example : `active`	string

2 - AccessRule

Name	Description	Schema	Default
object_id required	Object ID Example : `43fq3347-02q4-4aa8-ccf9-affe4917bb6f`	string
object_type required	Object Type Example : `GPU_NODE` Pattern : `^(GPU_NODE)$`	string

3 - AccessRuleListResponse

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

4 - AccessRules

Name	Description	Schema	Default
object_id required	Object ID Example : `43fq3347-02q4-4aa8-ccf9-affe4917bb6f`	string
object_type required	Object Type Example : `GPU_NODE`	string
object_name required	Object Name Example : `objectname`	string
object_state required	Object State Example : `RUNNING`	string
access_state required	Access State Example : `all`	string
access_ip_list required		array[AccessIp]

5 - AccessRuleUpdateRequest

Name	Description	Schema	Default
add_access_rules required		array[AccessRule]
remove_access_rules required		array[AccessRule]

6 - AccessRuleUpdateResponse

Name	Description	Schema	Default
add_access_rules required		array[AccessRule]
remove_access_rules required		array[AccessRule]
volume_id required	Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string

7 - Snapshot

Name	Description	Schema	Default
id required	Snapshot ID Example : `40htrre5b-eww25-ff2b-a426-6afefas65a3b`	string
name required	Snapshot Name Example : `snapshot.2025-10-30_121212`	string
size required	Snapshot Size Example : `100`	integer
state required	Snapshot State Example : `available`	string
created_at required	Created At Example : `2024-10-30T04:54:33.219373`	string (date-time)

8 - SnapshotCreateRequest

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

9 - SnapshotCreateResponse

Name	Description	Schema	Default
snapshot required	Snapshot	SnapshotResponse

10 - SnapshotListResponse

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

11 - SnapshotResponse

Name	Description	Schema	Default
id required	Snapshot ID Example : `40htrre5b-eww25-ff2b-a426-6afefas65a3b`	string
name required	Snapshot Name Example : `snapshot.2025-10-30_121212`	string
size required	Snapshot Size Example : `100`	integer
state required	Snapshot State Example : `available`	string
created_at required	Created At Example : `2024-10-30T04:54:33.219373`	string (date-time)
volume_id required	Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string

12 - Tag

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

13 - Volume

Name	Description	Schema	Default
id required	Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
name required	Volume Name Example : `my_volume`	string
state required	Volume State Example : `available`	string
created_at required	Created At Example : `2024-07-30T04:54:33.219373`	string (date-time)
capacity_tb required	Volume Capacity Example : `100` Minimum : `1` Maximum : `1000`	integer
account_id required	Account ID Example : `rwww523320dfvwbbefefsdvwdadsfa24c`	string

14 - VolumeCapacityRequest

Name	Description	Schema	Default
capacity_tb required	Volume Capacity Example : `100` Minimum : `1` Maximum : `1000`	integer

15 - VolumeCreateRequest

Name	Description	Schema	Default
name required	Volume Name Example : `my_volume` Pattern : `^[a-z]([a-z0-9_]){2,20}$`	string
capacity_tb required	Volume Capacity Example : `100` Minimum : `1` Maximum : `1000`	integer
tags optional		any of [array[Tag], null]

16 - VolumeListResponse

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

17 - VolumeShowResponse

Name	Description	Schema	Default
id required	Volume ID Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
name required	Volume Name Example : `my_volume`	string
state required	Volume State Example : `available`	string
created_at required	Created At Example : `2024-07-30T04:54:33.219373`	string (date-time)
capacity_tb required	Volume Capacity Example : `100` Minimum : `1` Maximum : `1000`	integer
account_id required	Account ID Example : `rwww523320dfvwbbefefsdvwdadsfa24c`	string
mount_path optional	Volume Mount Path Example : `xxx.xx.xxx:/xxxxxxxx`	any of [string, null]