이 섹션의 다중 페이지 출력 화면임. 여기를 클릭하여 프린트.

이 페이지의 일반 화면으로 돌아가기.

Parallel File Storage

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface,API)를 제공합니다.

본 가이드는 Parallel File Storage 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

VersionStatusNot Before
1.1CURRENT-
1.0SUPPORTED20261130

OpenAPI URL

https://parallel-filestorage.{region}.{environment}.samsungsdscloud.com

Environment and Region List

environmentregion
skr-west1
skr-east1
gkr-south1
gkr-south2
gkr-south3
ekr-west1
ekr-east1

API Version History

1.1

Parallel File Storage가 1.1 버전으로 업데이트되었습니다.

변경사항

  • [변경] POST /volumes - 요청 시, 아래와 같은 필드가 추가 됩니다.
    • 추가 zone - 필수 필드로 추가. 볼륨의 존.
  • [변경] GET /volumes - 응답 시, 볼륨 객체에 필드가 추가 됩니다.
    • 추가 zone - 필수 필드. 볼륨의 존.
  • [변경] GET /volumes/{volume_id} - 응답 시, 필드가 추가 됩니다.
    • 추가 zone - 필수 필드. 볼륨의 존.
  • [변경] GET /snapshots - 응답 시, 스냅샷 객체의 필드가 변경 됩니다.
    • 변경 size - 필수 필드에서 선택 필드로 변경.
    • 추가 snapshot_size_total_byte - 최상위 응답 객체에 선택 필드로 추가. 스냅샷 총 크기 (format: int64).
  • [변경] POST /snapshots - 응답 시, 필드가 변경 됩니다.
    • 변경 size - 필수 필드에서 선택 필드로 변경 (format: int64).
  • [변경] GET /access-rules - volume_id 파라미터가 query에서 path로 이동했습니다. 경로는 /access-rules?volume_id={volume_id}에서 /volumes/{volume_id}/access-rules로 변경되었습니다.
  • [변경] PUT /access-rules - volume_id 파라미터가 query에서 path로 이동했습니다. 경로는 /access-rules?volume_id={volume_id}에서 /volumes/{volume_id}/access-rules로 변경되었습니다.
  • [신규] PUT /snapshots/{snapshot_id}/restore - Restore Snapshot API가 추가 되었습니다.

1.0

Parallel File Storage가 출시되었습니다.

변경사항

  • [신규] GET /volumes - List Volumes API가 추가되었습니다.
  • [신규] POST /volumes - Create Volume API가 추가되었습니다.
  • [신규] GET /volumes/{volume_id} - Show Volume API가 추가되었습니다.
  • [신규] DELETE /volumes/{volume_id} - Delete Volume API가 추가되었습니다.
  • [신규] PUT /volumes/{volume_id}/capacity - Set Volume Capacity API가 추가되었습니다.
  • [신규] GET /access-rules - List Access Rules API가 추가되었습니다.
  • [신규] PUT /access-rules - Set Access Rule API가 추가되었습니다.
  • [신규] GET /snapshots - List Snapshots API가 추가되었습니다.
  • [신규] POST /snapshots - Create Snapshot API가 추가되었습니다.
  • [신규] DELETE /snapshots/{snapshot_id} - Delete Snapshot API가 추가되었습니다.
  • [신규] GET /internal/check-access-rules - List Object Access Rules API가 추가되었습니다.
  • [신규] POST /mount-credentials - Show Mount Credential API가 추가되었습니다.
  • [신규] GET /internal/resources - List Resources API가 추가되었습니다.

1 - APIs

1.1 - CreateSnapshot

1.1.1 - 1.1

post /v1/snapshots

Description

병렬 파일스토리지 스냅샷을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
SnapshotCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedSnapshotCreateResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

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 = ko-KR",
"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.1.2 - 1.0

post /v1/snapshots

Description

병렬 파일스토리지 스냅샷을 생성한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020261130

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
SnapshotCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedSnapshotCreateResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

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 = ko-KR",
"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"
    }
}

1.2 - CreateVolume

1.2.1 - 1.1

post /v1/volumes

Description

병렬 파일스토리지를 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
VolumeCreateRequestV1Dot1

Responses

HTTP CodeDescriptionSchema
202AcceptedVolumeV1Dot1
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
409ConflictNone

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 = ko-KR",
"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"
}

1.2.2 - 1.0

post /v1/volumes

Description

병렬 파일스토리지를 생성한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020261130

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
VolumeCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedVolume
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
409ConflictNone

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 = ko-KR",
"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"
}

1.3 - DeleteSnapshot

1.3.1 - 1.1

delete /v1/snapshots/{snapshot_id}

Description

병렬 파일스토리지 스냅샷을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathsnapshot_id
required		스냅샷 ID
Example : 40htrre5b-eww25-ff2b-a426-6afefas65a3b
stringNone
queryvolume_id
required		볼륨 ID
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

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 = ko-KR",
"Scp-Api-Version = parallel-filestorage 1.1"

Example HTTP response

Response 202

1.3.2 - 1.0

delete /v1/snapshots/{snapshot_id}

Description

병렬 파일스토리지 스냅샷을 삭제한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020261130

Parameters

TypeNameDescriptionSchemaDefault
pathsnapshot_id
required		스냅샷 ID
Example : 40htrre5b-eww25-ff2b-a426-6afefas65a3b
stringNone
queryvolume_id
required		볼륨 ID
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

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 = ko-KR",
"Scp-Api-Version = parallel-filestorage 1.0"

Example HTTP response

Response 202

1.4 - DeleteVolume

1.4.1 - 1.1

delete /v1/volumes/{volume_id}

Description

병렬 파일스토리지를 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathvolume_id
required		볼륨 ID
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

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 = ko-KR",
"Scp-Api-Version = parallel-filestorage 1.1"

Example HTTP response

Response 202

1.4.2 - 1.0

delete /v1/volumes/{volume_id}

Description

병렬 파일스토리지를 삭제한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020261130

Parameters

TypeNameDescriptionSchemaDefault
pathvolume_id
required		볼륨 ID
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

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 = ko-KR",
"Scp-Api-Version = parallel-filestorage 1.0"

Example HTTP response

Response 202

1.5 - ListAccessRule

1.5.1 - 1.1

get /v1/volumes/{volume_id}/access-rules

Description

병렬 파일스토리지 접근제어 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathvolume_id
required		볼륨 ID
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
200OKAccessRuleListResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

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 = ko-KR",
"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"
                }
            ]
        }
    ]
}

1.5.2 - 1.0

get /v1/volumes/{volume_id}/access-rules

Description

병렬 파일스토리지 접근제어 목록을 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020261130

Parameters

TypeNameDescriptionSchemaDefault
pathvolume_id
required		볼륨 ID
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
200OKAccessRuleListResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

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 = ko-KR",
"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"
                }
            ]
        }
    ]
}

1.6 - ListSnapshots

1.6.1 - 1.1

get /v1/snapshots

Description

병렬 파일스토리지 스냅샷 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
queryvolume_id
required		볼륨 ID
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
200OKSnapshotListResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

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 = ko-KR",
"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"
        }
    ]
}

1.6.2 - 1.0

get /v1/snapshots

Description

병렬 파일스토리지 스냅샷 목록을 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020261130

Parameters

TypeNameDescriptionSchemaDefault
queryvolume_id
required		볼륨 ID
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
200OKSnapshotListResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

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 = ko-KR",
"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"
        }
    ]
}

1.7 - ListVolumes

1.7.1 - 1.1

get /v1/volumes

Description

병렬 파일스토리지 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
queryoffset
optional		offset
Example : 0
integer0
querylimit
optional		limit
Example : 20
integer20
queryname
optional		볼륨 이름
Example : my_volume
any of [string, null]None
querysort
optional		정렬
Example :
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKVolumeListResponseV1Dot1
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone

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 = ko-KR",
"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"
        }
    ]
}

1.7.2 - 1.0

get /v1/volumes

Description

병렬 파일스토리지 목록을 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020261130

Parameters

TypeNameDescriptionSchemaDefault
queryoffset
optional		offset
Example : 0
integer0
querylimit
optional		limit
Example : 20
integer20
queryname
optional		볼륨 이름
Example : my_volume
any of [string, null]None
querysort
optional		정렬
Example :
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKVolumeListResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone

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 = ko-KR",
"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"
        }
    ]
}

1.8 - RestoreSnapshot

1.8.1 - 1.1

put /v1/snapshots/{snapshot_id}/restore

Description

병렬 파일스토리지 스냅샷을 복구한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathsnapshot_id
required		스냅샷 ID
Example : 40htrre5b-eww25-ff2b-a426-6afefas65a3b
stringNone
queryvolume_id
required		볼륨 ID
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

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 = ko-KR",
"Scp-Api-Version = parallel-filestorage 1.1"

Example HTTP response

Response 202

1.8.2 - 1.0

put /v1/snapshots/{snapshot_id}/restore

Description

병렬 파일스토리지 스냅샷을 복구한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020261130

Parameters

TypeNameDescriptionSchemaDefault
pathsnapshot_id
required		스냅샷 ID
Example : 40htrre5b-eww25-ff2b-a426-6afefas65a3b
stringNone
queryvolume_id
required		볼륨 ID
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

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 = ko-KR",
"Scp-Api-Version = parallel-filestorage 1.0"

Example HTTP response

Response 202

1.9 - SetAccessRule

1.9.1 - 1.1

put /v1/volumes/{volume_id}/access-rules

Description

병렬 파일스토리지 접근제어를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathvolume_id
required		볼륨 ID
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone
bodybody
required
AccessRuleUpdateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedAccessRuleUpdateResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

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 = ko-KR",
"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"
}

1.9.2 - 1.0

put /v1/volumes/{volume_id}/access-rules

Description

병렬 파일스토리지 접근제어를 수정한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020261130

Parameters

TypeNameDescriptionSchemaDefault
pathvolume_id
required		볼륨 ID
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone
bodybody
required
AccessRuleUpdateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedAccessRuleUpdateResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

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 = ko-KR",
"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"
}

1.10 - SetVolumeCapacity

1.10.1 - 1.1

put /v1/volumes/{volume_id}/capacity

Description

병렬 파일스토리지 용량을 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathvolume_id
required		볼륨 ID
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone
bodybody
required
VolumeCapacityRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

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 = ko-KR",
"Scp-Api-Version = parallel-filestorage 1.1"

Request body

{
    "capacity_tb": 100
}

Example HTTP response

Response 202

1.10.2 - 1.0

put /v1/volumes/{volume_id}/capacity

Description

병렬 파일스토리지 용량을 수정한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020261130

Parameters

TypeNameDescriptionSchemaDefault
pathvolume_id
required		볼륨 ID
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone
bodybody
required
VolumeCapacityRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

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 = ko-KR",
"Scp-Api-Version = parallel-filestorage 1.0"

Request body

{
    "capacity_tb": 100
}

Example HTTP response

Response 202

1.11 - ShowVolume

1.11.1 - 1.1

get /v1/volumes/{volume_id}

Description

병렬 파일스토리지를 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathvolume_id
required		볼륨 ID
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
200OKVolumeShowResponseV1Dot1
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

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 = ko-KR",
"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"
}

1.11.2 - 1.0

get /v1/volumes/{volume_id}

Description

병렬 파일스토리지를 상세 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020261130

Parameters

TypeNameDescriptionSchemaDefault
pathvolume_id
required		볼륨 ID
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
200OKVolumeShowResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

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 = ko-KR",
"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"
}

2 - Models

2.1 - AccessIp

NameDescriptionSchemaDefault
access_ip
required		접근 IP
Example : xxx.xxx.xxx.xxx
string
access_ip_state
required		접근 IP 상태
Example : active
string

2.2 - AccessRule

NameDescriptionSchemaDefault
object_id
required		오브젝트 ID
Example : 43fq3347-02q4-4aa8-ccf9-affe4917bb6f
string
object_type
required		오브젝트 유형
Example : GPU_NODE
Pattern : ^(GPU_NODE)$
string

2.3 - AccessRuleListResponse

NameDescriptionSchemaDefault
count
required		count
Example : 1
integer
volume_id
required		볼륨 ID
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
access_rules
required
array[AccessRules]

2.4 - AccessRules

NameDescriptionSchemaDefault
object_id
required		오브젝트 ID
Example : 43fq3347-02q4-4aa8-ccf9-affe4917bb6f
string
object_type
required		오브젝트 유형
Example : GPU_NODE
string
object_name
required		오브젝트 이름
Example : objectname
string
object_state
required		오브젝트 상태
Example : RUNNING
string
access_state
required		접근제어 상태
Example : all
string
access_ip_list
required
array[AccessIp]

2.5 - AccessRuleUpdateRequest

NameDescriptionSchemaDefault
add_access_rules
required
array[AccessRule]
remove_access_rules
required
array[AccessRule]

2.6 - AccessRuleUpdateResponse

NameDescriptionSchemaDefault
add_access_rules
required
array[AccessRule]
remove_access_rules
required
array[AccessRule]
volume_id
required		볼륨 ID
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string

2.7 - Snapshot

NameDescriptionSchemaDefault
id
required		스냅샷 ID
Example : 40htrre5b-eww25-ff2b-a426-6afefas65a3b
string
name
required		스냅샷 이름
Example : snapshot.2025-10-30_121212
string
size
optional
Example :
any of [integer, null]
state
required		스냅샷 상태
Example : available
string
created_at
required		생성 시간
Example : 2024-10-30T04:54:33.219373
string (date-time)

2.8 - SnapshotCreateRequest

NameDescriptionSchemaDefault
volume_id
required		볼륨 ID
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string

2.9 - SnapshotCreateResponse

NameDescriptionSchemaDefault
snapshot
required		스냅샷
SnapshotResponse

2.10 - SnapshotListResponse

NameDescriptionSchemaDefault
count
required		count
Example : 1
integer
snapshot_size_total_byte
optional
Example :
any of [integer, null]
snapshots
required
array[Snapshot]

2.11 - SnapshotResponse

NameDescriptionSchemaDefault
id
required		스냅샷 ID
Example : 40htrre5b-eww25-ff2b-a426-6afefas65a3b
string
name
required		스냅샷 이름
Example : snapshot.2025-10-30_121212
string
size
optional
Example :
any of [integer, null]
state
required		스냅샷 상태
Example : available
string
created_at
required		생성 시간
Example : 2024-10-30T04:54:33.219373
string (date-time)
volume_id
required		볼륨 ID
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string

2.12 - Tag

NameDescriptionSchemaDefault
key
required		키
Example : key
Maximum length : 128
string
value
optional		값
Example : value
any of [string, null]

2.13 - Volume

NameDescriptionSchemaDefault
id
required		볼륨 ID
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
name
required		볼륨 이름
Example : my_volume
string
state
required		볼륨 상태
Example : available
string
created_at
required		생성 시간
Example : 2024-07-30T04:54:33.219373
string (date-time)
capacity_tb
required		볼륨 용량
Example : 100
Minimum : 1
Maximum : 1000
integer
account_id
required		계정 ID
Example : rwww523320dfvwbbefefsdvwdadsfa24c
string

2.14 - VolumeCapacityRequest

NameDescriptionSchemaDefault
capacity_tb
required		볼륨 용량
Example : 100
Minimum : 1
Maximum : 1000
integer

2.15 - VolumeCreateRequest

NameDescriptionSchemaDefault
name
required		볼륨 이름
Example : my_volume
Pattern : ^[a-z]([a-z0-9_]){2,20}$
string
capacity_tb
required		볼륨 용량
Example : 100
Minimum : 1
Maximum : 1000
integer
tags
optional
any of [array[Tag], null]

2.16 - VolumeCreateRequestV1Dot1

NameDescriptionSchemaDefault
name
required		볼륨 이름
Example : my_volume
Pattern : ^[a-z]([a-z0-9_]){2,20}$
string
capacity_tb
required		볼륨 용량
Example : 100
Minimum : 1
Maximum : 1000
integer
tags
optional
any of [array[Tag], null]
zone
required		존
Example : kr-west1-a
string

2.17 - VolumeListResponse

NameDescriptionSchemaDefault
count
required		count
Example : 1
integer
parallel_filestorages
required
array[Volume]

2.18 - VolumeListResponseV1Dot1

NameDescriptionSchemaDefault
count
required		count
Example : 1
integer
parallel_filestorages
required
array[VolumeV1Dot1]

2.19 - VolumeShowResponse

NameDescriptionSchemaDefault
id
required		볼륨 ID
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
name
required		볼륨 이름
Example : my_volume
string
state
required		볼륨 상태
Example : available
string
created_at
required		생성 시간
Example : 2024-07-30T04:54:33.219373
string (date-time)
capacity_tb
required		볼륨 용량
Example : 100
Minimum : 1
Maximum : 1000
integer
account_id
required		계정 ID
Example : rwww523320dfvwbbefefsdvwdadsfa24c
string
mount_path
optional		볼륨 마운트 경로
Example : xxx.xx.xxx:/xxxxxxxx
any of [string, null]

2.20 - VolumeShowResponseV1Dot1

NameDescriptionSchemaDefault
id
required		볼륨 ID
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
name
required		볼륨 이름
Example : my_volume
string
state
required		볼륨 상태
Example : available
string
created_at
required		생성 시간
Example : 2024-07-30T04:54:33.219373
string (date-time)
capacity_tb
required		볼륨 용량
Example : 100
Minimum : 1
Maximum : 1000
integer
account_id
required		계정 ID
Example : rwww523320dfvwbbefefsdvwdadsfa24c
string
zone
required		존
Example : kr-west1-a
string
mount_path
optional		볼륨 마운트 경로
Example : xxx.xx.xxx:/xxxxxxxx
any of [string, null]

2.21 - VolumeV1Dot1

NameDescriptionSchemaDefault
id
required		볼륨 ID
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
name
required		볼륨 이름
Example : my_volume
string
state
required		볼륨 상태
Example : available
string
created_at
required		생성 시간
Example : 2024-07-30T04:54:33.219373
string (date-time)
capacity_tb
required		볼륨 용량
Example : 100
Minimum : 1
Maximum : 1000
integer
account_id
required		계정 ID
Example : rwww523320dfvwbbefefsdvwdadsfa24c
string
zone
required		존
Example : kr-west1-a
string