This is the multi-page printable view of this section. Click here to print.
APIs
1 - CreateSnapshot
1.1 - 1.1
post /v1/snapshots
Description
Create snapshot
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | SnapshotCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | SnapshotCreateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/snapshots
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = parallel-filestorage 1.1"
Request body
{
"volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438"
}
Example HTTP response
Response 202
{
"snapshot": {
"id": "40htrre5b-eww25-ff2b-a426-6afefas65a3b",
"name": "snapshot.2025-10-30_121212",
"size": "",
"state": "available",
"created_at": "2024-10-30T04:54:33.219373",
"volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438"
}
}
1.2 - 1.0
post /v1/snapshots
Description
Create snapshot
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | SnapshotCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | SnapshotCreateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/snapshots
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = parallel-filestorage 1.0"
Request body
{
"volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438"
}
Example HTTP response
Response 202
{
"snapshot": {
"id": "40htrre5b-eww25-ff2b-a426-6afefas65a3b",
"name": "snapshot.2025-10-30_121212",
"size": "",
"state": "available",
"created_at": "2024-10-30T04:54:33.219373",
"volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438"
}
}
2 - CreateVolume
2.1 - 1.1
post /v1/volumes
Description
Create volume
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | VolumeCreateRequestV1Dot1 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | VolumeV1Dot1 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = parallel-filestorage 1.1"
Request body
{
"name": "my_volume",
"capacity_tb": 100,
"tags": [
{
"key": "key",
"value": "value"
}
],
"zone": "kr-west1-a"
}
Example HTTP response
Response 202
{
"id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
"name": "my_volume",
"state": "available",
"created_at": "2024-07-30T04:54:33.219373",
"capacity_tb": 100,
"account_id": "rwww523320dfvwbbefefsdvwdadsfa24c",
"zone": "kr-west1-a"
}
2.2 - 1.0
post /v1/volumes
Description
Create volume
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | VolumeCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | Volume |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = parallel-filestorage 1.0"
Request body
{
"name": "my_volume",
"capacity_tb": 100,
"tags": [
{
"key": "key",
"value": "value"
}
]
}
Example HTTP response
Response 202
{
"id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
"name": "my_volume",
"state": "available",
"created_at": "2024-07-30T04:54:33.219373",
"capacity_tb": 100,
"account_id": "rwww523320dfvwbbefefsdvwdadsfa24c"
}
3 - DeleteSnapshot
3.1 - 1.1
delete /v1/snapshots/{snapshot_id}
Description
Delete snapshot
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | snapshot_id required | Snapshot ID Example : 40htrre5b-eww25-ff2b-a426-6afefas65a3b | string | None |
| query | volume_id required | Volume ID Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/snapshots/{snapshot_id}?volume_id={volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = parallel-filestorage 1.1"
Example HTTP response
Response 202
3.2 - 1.0
delete /v1/snapshots/{snapshot_id}
Description
Delete snapshot
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | snapshot_id required | Snapshot ID Example : 40htrre5b-eww25-ff2b-a426-6afefas65a3b | string | None |
| query | volume_id required | Volume ID Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/snapshots/{snapshot_id}?volume_id={volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = parallel-filestorage 1.0"
Example HTTP response
Response 202
4 - DeleteVolume
4.1 - 1.1
delete /v1/volumes/{volume_id}
Description
Delete volume
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | Volume ID Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = parallel-filestorage 1.1"
Example HTTP response
Response 202
4.2 - 1.0
delete /v1/volumes/{volume_id}
Description
Delete volume
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | Volume ID Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = parallel-filestorage 1.0"
Example HTTP response
Response 202
5 - ListAccessRule
5.1 - 1.1
get /v1/volumes/{volume_id}/access-rules
Description
List access rule
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | Volume ID Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AccessRuleListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/access-rules
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = parallel-filestorage 1.1"
Example HTTP response
Response 200
{
"count": 1,
"volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
"access_rules": [
{
"object_id": "43fq3347-02q4-4aa8-ccf9-affe4917bb6f",
"object_type": "GPU_NODE",
"object_name": "objectname",
"object_state": "RUNNING",
"access_state": "all",
"access_ip_list": [
{
"access_ip": "xxx.xxx.xxx.xxx",
"access_ip_state": "active"
}
]
}
]
}
5.2 - 1.0
get /v1/volumes/{volume_id}/access-rules
Description
List access rule
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | Volume ID Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AccessRuleListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/access-rules
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = parallel-filestorage 1.0"
Example HTTP response
Response 200
{
"count": 1,
"volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
"access_rules": [
{
"object_id": "43fq3347-02q4-4aa8-ccf9-affe4917bb6f",
"object_type": "GPU_NODE",
"object_name": "objectname",
"object_state": "RUNNING",
"access_state": "all",
"access_ip_list": [
{
"access_ip": "xxx.xxx.xxx.xxx",
"access_ip_state": "active"
}
]
}
]
}
6 - ListSnapshots
6.1 - 1.1
get /v1/snapshots
Description
List snapshots
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | volume_id required | Volume ID Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SnapshotListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/snapshots?volume_id={volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = parallel-filestorage 1.1"
Example HTTP response
Response 200
{
"count": 1,
"snapshot_size_total_byte": "",
"snapshots": [
{
"id": "40htrre5b-eww25-ff2b-a426-6afefas65a3b",
"name": "snapshot.2025-10-30_121212",
"size": "",
"state": "available",
"created_at": "2024-10-30T04:54:33.219373"
}
]
}
6.2 - 1.0
get /v1/snapshots
Description
List snapshots
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | volume_id required | Volume ID Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SnapshotListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/snapshots?volume_id={volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = parallel-filestorage 1.0"
Example HTTP response
Response 200
{
"count": 1,
"snapshot_size_total_byte": "",
"snapshots": [
{
"id": "40htrre5b-eww25-ff2b-a426-6afefas65a3b",
"name": "snapshot.2025-10-30_121212",
"size": "",
"state": "available",
"created_at": "2024-10-30T04:54:33.219373"
}
]
}
7 - ListVolumes
7.1 - 1.1
get /v1/volumes
Description
List volumes
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | offset optional | offset Example : 0 | integer | 0 |
| query | limit optional | limit Example : 20 | integer | 20 |
| query | name optional | Volume Name Example : my_volume | any of [string, null] | None |
| query | sort optional | sort Example : | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeListResponseV1Dot1 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/volumes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = parallel-filestorage 1.1"
Example HTTP response
Response 200
{
"count": 1,
"parallel_filestorages": [
{
"id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
"name": "my_volume",
"state": "available",
"created_at": "2024-07-30T04:54:33.219373",
"capacity_tb": 100,
"account_id": "rwww523320dfvwbbefefsdvwdadsfa24c",
"zone": "kr-west1-a"
}
]
}
7.2 - 1.0
get /v1/volumes
Description
List volumes
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | offset optional | offset Example : 0 | integer | 0 |
| query | limit optional | limit Example : 20 | integer | 20 |
| query | name optional | Volume Name Example : my_volume | any of [string, null] | None |
| query | sort optional | sort Example : | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/volumes
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = parallel-filestorage 1.0"
Example HTTP response
Response 200
{
"count": 1,
"parallel_filestorages": [
{
"id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
"name": "my_volume",
"state": "available",
"created_at": "2024-07-30T04:54:33.219373",
"capacity_tb": 100,
"account_id": "rwww523320dfvwbbefefsdvwdadsfa24c"
}
]
}
8 - RestoreSnapshot
8.1 - 1.1
put /v1/snapshots/{snapshot_id}/restore
Description
Restore snapshot
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | snapshot_id required | Snapshot ID Example : 40htrre5b-eww25-ff2b-a426-6afefas65a3b | string | None |
| query | volume_id required | Volume ID Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/snapshots/{snapshot_id}/restore?volume_id={volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = parallel-filestorage 1.1"
Example HTTP response
Response 202
8.2 - 1.0
put /v1/snapshots/{snapshot_id}/restore
Description
Restore snapshot
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | snapshot_id required | Snapshot ID Example : 40htrre5b-eww25-ff2b-a426-6afefas65a3b | string | None |
| query | volume_id required | Volume ID Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/snapshots/{snapshot_id}/restore?volume_id={volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = parallel-filestorage 1.0"
Example HTTP response
Response 202
9 - SetAccessRule
9.1 - 1.1
put /v1/volumes/{volume_id}/access-rules
Description
Set access rule
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | Volume ID Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438 | string | None |
| body | body required | AccessRuleUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AccessRuleUpdateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/access-rules
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = parallel-filestorage 1.1"
Request body
{
"add_access_rules": [
{
"object_id": "43fq3347-02q4-4aa8-ccf9-affe4917bb6f",
"object_type": "GPU_NODE"
}
],
"remove_access_rules": [
{
"object_id": "43fq3347-02q4-4aa8-ccf9-affe4917bb6f",
"object_type": "GPU_NODE"
}
]
}
Example HTTP response
Response 202
{
"add_access_rules": [
{
"object_id": "43fq3347-02q4-4aa8-ccf9-affe4917bb6f",
"object_type": "GPU_NODE"
}
],
"remove_access_rules": [
{
"object_id": "43fq3347-02q4-4aa8-ccf9-affe4917bb6f",
"object_type": "GPU_NODE"
}
],
"volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438"
}
9.2 - 1.0
put /v1/volumes/{volume_id}/access-rules
Description
Set access rule
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | Volume ID Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438 | string | None |
| body | body required | AccessRuleUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AccessRuleUpdateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/access-rules
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = parallel-filestorage 1.0"
Request body
{
"add_access_rules": [
{
"object_id": "43fq3347-02q4-4aa8-ccf9-affe4917bb6f",
"object_type": "GPU_NODE"
}
],
"remove_access_rules": [
{
"object_id": "43fq3347-02q4-4aa8-ccf9-affe4917bb6f",
"object_type": "GPU_NODE"
}
]
}
Example HTTP response
Response 202
{
"add_access_rules": [
{
"object_id": "43fq3347-02q4-4aa8-ccf9-affe4917bb6f",
"object_type": "GPU_NODE"
}
],
"remove_access_rules": [
{
"object_id": "43fq3347-02q4-4aa8-ccf9-affe4917bb6f",
"object_type": "GPU_NODE"
}
],
"volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438"
}
10 - SetVolumeCapacity
10.1 - 1.1
put /v1/volumes/{volume_id}/capacity
Description
Set volume capacity
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | Volume ID Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438 | string | None |
| body | body required | VolumeCapacityRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/capacity
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = parallel-filestorage 1.1"
Request body
{
"capacity_tb": 100
}
Example HTTP response
Response 202
10.2 - 1.0
put /v1/volumes/{volume_id}/capacity
Description
Set volume capacity
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | Volume ID Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438 | string | None |
| body | body required | VolumeCapacityRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}/capacity
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = parallel-filestorage 1.0"
Request body
{
"capacity_tb": 100
}
Example HTTP response
Response 202
11 - ShowVolume
11.1 - 1.1
get /v1/volumes/{volume_id}
Description
Show volume
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | Volume ID Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeShowResponseV1Dot1 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = parallel-filestorage 1.1"
Example HTTP response
Response 200
{
"id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
"name": "my_volume",
"state": "available",
"created_at": "2024-07-30T04:54:33.219373",
"capacity_tb": 100,
"account_id": "rwww523320dfvwbbefefsdvwdadsfa24c",
"zone": "kr-west1-a",
"mount_path": "xxx.xx.xxx:/xxxxxxxx"
}
11.2 - 1.0
get /v1/volumes/{volume_id}
Description
Show volume
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | volume_id required | Volume ID Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VolumeShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/volumes/{volume_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = parallel-filestorage 1.0"
Example HTTP response
Response 200
{
"id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
"name": "my_volume",
"state": "available",
"created_at": "2024-07-30T04:54:33.219373",
"capacity_tb": 100,
"account_id": "rwww523320dfvwbbefefsdvwdadsfa24c",
"mount_path": "xxx.xx.xxx:/xxxxxxxx"
}