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

File Storage

1: APIs

1.1: CreateSnapshot

1.1.1: 1.1
1.1.2: 1.0

1.2: CreateSnapshotSchedule

1.2.1: 1.1
1.2.2: 1.0

1.3: CreateVolume

1.3.1: 1.1
1.3.2: 1.0

1.4: CreateVolumeReplication

1.4.1: 1.1
1.4.2: 1.0

1.5: DeleteSnapshot

1.5.1: 1.1
1.5.2: 1.0

1.6: DeleteSnapshotSchedule

1.6.1: 1.1
1.6.2: 1.0

1.7: DeleteVolume

1.7.1: 1.1
1.7.2: 1.0

1.8: DeleteVolumeReplication

1.8.1: 1.1
1.8.2: 1.0

1.9: ListAccessRules

1.9.1: 1.1
1.9.2: 1.0

1.10: ListSnapshots

1.10.1: 1.1
1.10.2: 1.0

1.11: ListSnapshotSchedule

1.11.1: 1.1
1.11.2: 1.0

1.12: ListVolumeReplicationRegion

1.12.1: 1.1
1.12.2: 1.0

1.13: ListVolumeReplications

1.13.1: 1.1
1.13.2: 1.0

1.14: ListVolumes

1.14.1: 1.1
1.14.2: 1.0

1.15: RestoreSnapshot

1.15.1: 1.1
1.15.2: 1.0

1.16: SetAccessRule

1.16.1: 1.1
1.16.2: 1.0

1.17: SetSnapshotSchedule

1.17.1: 1.1
1.17.2: 1.0

1.18: SetVolume

1.18.1: 1.1
1.18.2: 1.0

1.19: SetVolumeReplication

1.19.1: 1.1
1.19.2: 1.0

1.20: ShowVolume

1.20.1: 1.1
1.20.2: 1.0

1.21: ShowVolumeReplication

1.21.1: 1.1
1.21.2: 1.0

2: Models

2.1: AccessRuleRequest
2.2: AccessRuleResponse
2.3: Replication
2.4: ReplicationCreateRequest
2.5: ReplicationCreateResponse
2.6: ReplicationListResponse
2.7: ReplicationRegionListResponse
2.8: ReplicationShowResponse
2.9: ReplicationUpdateRequest
2.10: ReplicationUpdateResponse
2.11: Snapshot
2.12: SnapshotCreateRequest
2.13: SnapshotDetail
2.14: SnapshotListResponse
2.15: SnapshotRestoreResponse
2.16: SnapshotSchedule
2.17: SnapshotScheduleCreateRequest
2.18: SnapshotScheduleCreateResponse
2.19: SnapshotScheduleListResponse
2.20: SnapshotScheduleSetRequest
2.21: SnapshotScheduleSetResponse
2.22: SnapshotScheduleShow
2.23: SnapshotShowResponse
2.24: Tag
2.25: Volume
2.26: VolumeCreateRequest
2.27: VolumeCreateResponse
2.28: VolumeListResponse
2.29: VolumeObjectAccessRuleListBase
2.30: VolumeObjectAccessRuleListResponse
2.31: VolumeSetRequest
2.32: VolumeSetResponse
2.33: VolumeShowResponse

Overview

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

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

Version

Version	Status	Supported Until
1.0	DEPRECATED	20251231
1.1	CURRENT	-

OpenAPI URL

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

Environment and Region List

environment	region
s	kr-west1
s	kr-east1
g	kr-south1
g	kr-south2
g	kr-south3
e	kr-west1
e	kr-east1

1 - APIs

1.1 - CreateSnapshot

1.1.1 - 1.1

post /v1/snapshots

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		SnapshotCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	SnapshotShowResponse
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 = ko-KR",
"Scp-Api-Version = 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": "my_volume.2024-10-01_14215",
        "state": "available",
        "size": 100,
        "created_at": "2024-07-30T04:54:33.219373",
        "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438"
    }
}

1.1.2 - 1.0

post /v1/snapshots

Description

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

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		SnapshotCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	SnapshotShowResponse
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 = ko-KR",
"Scp-Api-Version = 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": "my_volume.2024-10-01_14215",
        "state": "available",
        "size": 100,
        "created_at": "2024-07-30T04:54:33.219373",
        "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438"
    }
}

1.2 - CreateSnapshotSchedule

1.2.1 - 1.1

post /v1/snapshot-schedules

Description

파일스토리지 스냅샷 스케줄을 생성한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		SnapshotScheduleCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	SnapshotScheduleCreateResponse
400	Bad Request	None
403	Forbidden	None
401	Unauthorized	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/snapshot-schedules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = filestorage 1.1"

Request body

{
    "snapshot_retention_count": 10,
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "snapshot_schedule": {
        "frequency": "WEEKLY",
        "day_of_week": "MON",
        "hour": "23"
    }
}

Example HTTP response

Response 202

{
    "snapshot_retention_count": 10,
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "snapshot_schedule": {
        "frequency": "WEEKLY",
        "day_of_week": "MON",
        "hour": "23"
    }
}

1.2.2 - 1.0

post /v1/snapshot-schedules

Description

파일스토리지 스냅샷 스케줄을 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		SnapshotScheduleCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	SnapshotScheduleCreateResponse
400	Bad Request	None
403	Forbidden	None
401	Unauthorized	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/snapshot-schedules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = filestorage 1.0"

Request body

{
    "snapshot_retention_count": 10,
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "snapshot_schedule": {
        "frequency": "WEEKLY",
        "day_of_week": "MON",
        "hour": "23"
    }
}

Example HTTP response

Response 202

{
    "snapshot_retention_count": 10,
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "snapshot_schedule": {
        "frequency": "WEEKLY",
        "day_of_week": "MON",
        "hour": "23"
    }
}

1.3 - CreateVolume

1.3.1 - 1.1

post /v1/volumes

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		VolumeCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	VolumeCreateResponse
403	Forbidden	None
401	Unauthorized	None
400	Bad Request	None
404	Not Found	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 = ko-KR",
"Scp-Api-Version = filestorage 1.1"

Request body

{
    "name": "my_volume",
    "protocol": "NFS",
    "type_name": "HDD",
    "snapshot_id": "40htrre5b-eww25-ff2b-a426-6afefas65a3b",
    "cifs_password": "cifspwd0!!",
    "tags": [
        {
            "key": "key",
            "value": "value"
        }
    ]
}

Example HTTP response

Response 202

{
    "protocol": "NFS",
    "snapshot_id": "40htrre5b-eww25-ff2b-a426-6afefas65a3b",
    "type_name": "HDD",
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "volume_name": "my_volume"
}

1.3.2 - 1.0

post /v1/volumes

Description

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

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		VolumeCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	VolumeCreateResponse
403	Forbidden	None
401	Unauthorized	None
400	Bad Request	None
404	Not Found	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 = ko-KR",
"Scp-Api-Version = filestorage 1.0"

Request body

{
    "name": "my_volume",
    "protocol": "NFS",
    "type_name": "HDD",
    "snapshot_id": "40htrre5b-eww25-ff2b-a426-6afefas65a3b",
    "cifs_password": "cifspwd0!!",
    "tags": [
        {
            "key": "key",
            "value": "value"
        }
    ]
}

Example HTTP response

Response 202

{
    "protocol": "NFS",
    "snapshot_id": "40htrre5b-eww25-ff2b-a426-6afefas65a3b",
    "type_name": "HDD",
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "volume_name": "my_volume"
}

1.4 - CreateVolumeReplication

1.4.1 - 1.1

post /v1/replications

Description

파일스토리지 복제를 생성한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		ReplicationCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	ReplicationCreateResponse
401	Unauthorized	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/replications

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = filestorage 1.1"

Request body

{
    "name": "my_volume",
    "cifs_password": "cifspwd0!!",
    "replication_frequency": "5min",
    "region": "kr-west1",
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "backup_retention_count": 2,
    "replication_type": "replication"
}

Example HTTP response

Response 202

{
    "replication_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "replication_status": "creating",
    "source_volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "source_volume_region": "kr-west1",
    "protocol": "NFS",
    "replication_volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "replication_volume_region": "kr-west1"
}

1.4.2 - 1.0

post /v1/replications

Description

파일스토리지 복제를 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		ReplicationCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	ReplicationCreateResponse
401	Unauthorized	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/replications

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = filestorage 1.0"

Request body

{
    "name": "my_volume",
    "cifs_password": "cifspwd0!!",
    "replication_frequency": "5min",
    "region": "kr-west1",
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "backup_retention_count": 2,
    "replication_type": "replication"
}

Example HTTP response

Response 202

{
    "replication_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "replication_status": "creating",
    "source_volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "source_volume_region": "kr-west1",
    "protocol": "NFS",
    "replication_volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "replication_volume_region": "kr-west1"
}

1.5 - DeleteSnapshot

1.5.1 - 1.1

delete /v1/snapshots/{snapshot_id}

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	snapshot_id required	스냅샷 아이디 Example : `40htrre5b-eww25-ff2b-a426-6afefas65a3b`	string	None
query	volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
404	Not Found	None
403	Forbidden	None
401	Unauthorized	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 = ko-KR",
"Scp-Api-Version = filestorage 1.1"

Example HTTP response

Response 202

1.5.2 - 1.0

delete /v1/snapshots/{snapshot_id}

Description

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

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	snapshot_id required	스냅샷 아이디 Example : `40htrre5b-eww25-ff2b-a426-6afefas65a3b`	string	None
query	volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
404	Not Found	None
403	Forbidden	None
401	Unauthorized	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 = ko-KR",
"Scp-Api-Version = filestorage 1.0"

Example HTTP response

Response 202

1.6 - DeleteSnapshotSchedule

1.6.1 - 1.1

delete /v1/snapshot-schedules/{snapshot_schedule_id}

Description

파일스토리지 스냅샷 스케줄을 삭제한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	snapshot_schedule_id required	스냅샷 스케줄 아이디 Example : `d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31`	string	None
query	volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
404	Not Found	None
403	Forbidden	None
401	Unauthorized	None
409	Conflict	None

Example HTTP request

Request path

/v1/snapshot-schedules/{snapshot_schedule_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 = filestorage 1.1"

Example HTTP response

Response 202

1.6.2 - 1.0

delete /v1/snapshot-schedules/{snapshot_schedule_id}

Description

파일스토리지 스냅샷 스케줄을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	snapshot_schedule_id required	스냅샷 스케줄 아이디 Example : `d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31`	string	None
query	volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
404	Not Found	None
403	Forbidden	None
401	Unauthorized	None
409	Conflict	None

Example HTTP request

Request path

/v1/snapshot-schedules/{snapshot_schedule_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 = filestorage 1.0"

Example HTTP response

Response 202

1.7 - DeleteVolume

1.7.1 - 1.1

delete /v1/volumes/{volume_id}

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
404	Not Found	None
403	Forbidden	None
401	Unauthorized	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 = ko-KR",
"Scp-Api-Version = filestorage 1.1"

Example HTTP response

Response 202

1.7.2 - 1.0

delete /v1/volumes/{volume_id}

Description

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

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
404	Not Found	None
403	Forbidden	None
401	Unauthorized	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 = ko-KR",
"Scp-Api-Version = filestorage 1.0"

Example HTTP response

Response 202

1.8 - DeleteVolumeReplication

1.8.1 - 1.1

delete /v1/replications/{replication_id}

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	replication_id required	복제 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None
query	volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
401	Unauthorized	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/replications/{replication_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 = filestorage 1.1"

Example HTTP response

Response 202

1.8.2 - 1.0

delete /v1/replications/{replication_id}

Description

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

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	replication_id required	복제 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None
query	volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
401	Unauthorized	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/replications/{replication_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 = filestorage 1.0"

Example HTTP response

Response 202

1.9 - ListAccessRules

1.9.1 - 1.1

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

Description

접근제어 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None

Responses

HTTP Code	Description	Schema
200	OK	VolumeObjectAccessRuleListResponse
403	Forbidden	None
401	Unauthorized	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 = ko-KR",
"Scp-Api-Version = filestorage 1.1"

Example HTTP response

Response 200

{
    "count": 1,
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "access_rules": [
        {
            "access_rule_state": "active",
            "object_type": "VM",
            "object_id": "43fq3347-02q4-4aa8-ccf9-affe4917bb6f"
        }
    ]
}

1.9.2 - 1.0

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

Description

접근제어 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None

Responses

HTTP Code	Description	Schema
200	OK	VolumeObjectAccessRuleListResponse
403	Forbidden	None
401	Unauthorized	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 = ko-KR",
"Scp-Api-Version = filestorage 1.0"

Example HTTP response

Response 200

{
    "count": 1,
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "access_rules": [
        {
            "access_rule_state": "active",
            "object_type": "VM",
            "object_id": "43fq3347-02q4-4aa8-ccf9-affe4917bb6f"
        }
    ]
}

1.10 - ListSnapshots

1.10.1 - 1.1

get /v1/snapshots

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None

Responses

HTTP Code	Description	Schema
200	OK	SnapshotListResponse
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 = ko-KR",
"Scp-Api-Version = filestorage 1.1"

Example HTTP response

Response 200

{
    "count": 1,
    "snapshots": [
        {
            "id": "40htrre5b-eww25-ff2b-a426-6afefas65a3b",
            "name": "my_volume.2024-10-01_14215",
            "state": "available",
            "size": 100,
            "created_at": "2024-07-30T04:54:33.219373"
        }
    ],
    "snapshot_size_total_byte": 100
}

1.10.2 - 1.0

get /v1/snapshots

Description

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

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None

Responses

HTTP Code	Description	Schema
200	OK	SnapshotListResponse
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 = ko-KR",
"Scp-Api-Version = filestorage 1.0"

Example HTTP response

Response 200

{
    "count": 1,
    "snapshots": [
        {
            "id": "40htrre5b-eww25-ff2b-a426-6afefas65a3b",
            "name": "my_volume.2024-10-01_14215",
            "state": "available",
            "size": 100,
            "created_at": "2024-07-30T04:54:33.219373"
        }
    ],
    "snapshot_size_total_byte": 100
}

1.11 - ListSnapshotSchedule

1.11.1 - 1.1

get /v1/snapshot-schedules

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None

Responses

HTTP Code	Description	Schema
200	OK	SnapshotScheduleListResponse
404	Not Found	None
403	Forbidden	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/snapshot-schedules?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 = filestorage 1.1"

Example HTTP response

Response 200

{
    "snapshot_retention_count": 10,
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "snapshot_policy_enabled": "true",
    "snapshot_schedule": [
        {
            "frequency": "WEEKLY",
            "day_of_week": "MON",
            "hour": "23",
            "id": "d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31"
        }
    ]
}

1.11.2 - 1.0

get /v1/snapshot-schedules

Description

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

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None

Responses

HTTP Code	Description	Schema
200	OK	SnapshotScheduleListResponse
404	Not Found	None
403	Forbidden	None
401	Unauthorized	None

Example HTTP request

Request path

/v1/snapshot-schedules?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 = filestorage 1.0"

Example HTTP response

Response 200

{
    "snapshot_retention_count": 10,
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "snapshot_policy_enabled": "true",
    "snapshot_schedule": [
        {
            "frequency": "WEEKLY",
            "day_of_week": "MON",
            "hour": "23",
            "id": "d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31"
        }
    ]
}

1.12 - ListVolumeReplicationRegion

1.12.1 - 1.1

get /v1/replications/regions

Description

파일스토리지 복제 리전 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	type_name optional	볼륨 유형 이름 Example : `HDD`	any of [string, null]	None
query	source_region_name required	리전 Example : `kr-west1`	string	None
query	replication_type required	복제 유형 Example : `replication`	string	None

Responses

HTTP Code	Description	Schema
200	OK	ReplicationRegionListResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/replications/regions?source_region_name={source_region_name}&replication_type={replication_type}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = filestorage 1.1"

Example HTTP response

Response 200

{
    "regions": "['kr-west1']"
}

1.12.2 - 1.0

get /v1/replications/regions

Description

파일스토리지 복제 리전 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	type_name optional	볼륨 유형 이름 Example : `HDD`	any of [string, null]	None
query	source_region_name required	리전 Example : `kr-west1`	string	None
query	replication_type required	복제 유형 Example : `replication`	string	None

Responses

HTTP Code	Description	Schema
200	OK	ReplicationRegionListResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/replications/regions?source_region_name={source_region_name}&replication_type={replication_type}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = filestorage 1.0"

Example HTTP response

Response 200

{
    "regions": "['kr-west1']"
}

1.13 - ListVolumeReplications

1.13.1 - 1.1

get /v1/replications

Description

파일스토리지 복제 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None

Responses

HTTP Code	Description	Schema
200	OK	ReplicationListResponse
401	Unauthorized	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/replications?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 = filestorage 1.1"

Example HTTP response

Response 200

{
    "count": 1,
    "replications": [
        {
            "replication_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
            "replication_frequency": "5min",
            "source_volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
            "source_volume_region": "kr-west1",
            "source_volume_access_level": "ro",
            "replication_volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
            "replication_volume_region": "kr-west1",
            "replication_volume_access_level": "ro",
            "replication_type": "replication"
        }
    ]
}

1.13.2 - 1.0

get /v1/replications

Description

파일스토리지 복제 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None

Responses

HTTP Code	Description	Schema
200	OK	ReplicationListResponse
401	Unauthorized	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/replications?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 = filestorage 1.0"

Example HTTP response

Response 200

{
    "count": 1,
    "replications": [
        {
            "replication_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
            "replication_frequency": "5min",
            "source_volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
            "source_volume_region": "kr-west1",
            "source_volume_access_level": "ro",
            "replication_volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
            "replication_volume_region": "kr-west1",
            "replication_volume_access_level": "ro",
            "replication_type": "replication"
        }
    ]
}

1.14 - ListVolumes

1.14.1 - 1.1

get /v1/volumes

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
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	볼륨 이름 Example : `my_volume`	any of [string, null]	None
query	type_name optional	볼륨 유형 이름 Example : `HDD`	any of [string, null]	None
query	sort optional	정렬 Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	VolumeListResponse
400	Bad Request	None
403	Forbidden	None
401	Unauthorized	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 = ko-KR",
"Scp-Api-Version = filestorage 1.1"

Example HTTP response

Response 200

{
    "count": 1,
    "filestorages": [
        {
            "id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
            "name": "my_volume",
            "protocol": "NFS",
            "state": "available",
            "account_id": "rwww523320dfvwbbefefsdvwdadsfa24c",
            "created_at": "2024-07-30T04:54:33.219373",
            "type_id": "jef22f67-ee83-4gg2-2ab6-3lf774ekfjdu",
            "type_name": "HDD",
            "purpose": "replication"
        }
    ]
}

1.14.2 - 1.0

get /v1/volumes

Description

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

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

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	볼륨 이름 Example : `my_volume`	any of [string, null]	None
query	type_name optional	볼륨 유형 이름 Example : `HDD`	any of [string, null]	None
query	sort optional	정렬 Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	VolumeListResponse
400	Bad Request	None
403	Forbidden	None
401	Unauthorized	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 = ko-KR",
"Scp-Api-Version = filestorage 1.0"

Example HTTP response

Response 200

{
    "count": 1,
    "filestorages": [
        {
            "id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
            "name": "my_volume",
            "protocol": "NFS",
            "state": "available",
            "account_id": "rwww523320dfvwbbefefsdvwdadsfa24c",
            "created_at": "2024-07-30T04:54:33.219373",
            "type_id": "jef22f67-ee83-4gg2-2ab6-3lf774ekfjdu",
            "type_name": "HDD",
            "purpose": "replication"
        }
    ]
}

1.15 - RestoreSnapshot

1.15.1 - 1.1

put /v1/snapshots/{snapshot_id}/restore

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	snapshot_id required	스냅샷 아이디 Example : `40htrre5b-eww25-ff2b-a426-6afefas65a3b`	string	None
query	volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	SnapshotRestoreResponse
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 = ko-KR",
"Scp-Api-Version = filestorage 1.1"

Example HTTP response

Response 202

{
    "snapshot": {
        "id": "40htrre5b-eww25-ff2b-a426-6afefas65a3b",
        "name": "my_volume.2024-10-01_14215",
        "state": "available",
        "size": 100,
        "created_at": "2024-07-30T04:54:33.219373"
    }
}

1.15.2 - 1.0

put /v1/snapshots/{snapshot_id}/restore

Description

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

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	snapshot_id required	스냅샷 아이디 Example : `40htrre5b-eww25-ff2b-a426-6afefas65a3b`	string	None
query	volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	SnapshotRestoreResponse
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 = ko-KR",
"Scp-Api-Version = filestorage 1.0"

Example HTTP response

Response 202

{
    "snapshot": {
        "id": "40htrre5b-eww25-ff2b-a426-6afefas65a3b",
        "name": "my_volume.2024-10-01_14215",
        "state": "available",
        "size": 100,
        "created_at": "2024-07-30T04:54:33.219373"
    }
}

1.16 - SetAccessRule

1.16.1 - 1.1

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

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None
body	body required		AccessRuleRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AccessRuleResponse
400	Bad Request	None
403	Forbidden	None
401	Unauthorized	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 = ko-KR",
"Scp-Api-Version = filestorage 1.1"

Request body

{
    "object_id": "43fq3347-02q4-4aa8-ccf9-affe4917bb6f",
    "object_type": "VM",
    "action": "add"
}

Example HTTP response

Response 202

{
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "object_type": "VM",
    "object_id": "43fq3347-02q4-4aa8-ccf9-affe4917bb6f",
    "action": "add"
}

1.16.2 - 1.0

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

Description

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

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None
body	body required		AccessRuleRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AccessRuleResponse
400	Bad Request	None
403	Forbidden	None
401	Unauthorized	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 = ko-KR",
"Scp-Api-Version = filestorage 1.0"

Request body

{
    "object_id": "43fq3347-02q4-4aa8-ccf9-affe4917bb6f",
    "object_type": "VM",
    "action": "add"
}

Example HTTP response

Response 202

{
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "object_type": "VM",
    "object_id": "43fq3347-02q4-4aa8-ccf9-affe4917bb6f",
    "action": "add"
}

1.17 - SetSnapshotSchedule

1.17.1 - 1.1

put /v1/snapshot-schedules/{snapshot_schedule_id}

Description

파일스토리지 스냅샷 스케줄을 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	snapshot_schedule_id required	스냅샷 스케줄 아이디 Example : `d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31`	string	None
query	volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None
body	body required		SnapshotScheduleSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	SnapshotScheduleSetResponse
400	Bad Request	None
404	Not Found	None
403	Forbidden	None
401	Unauthorized	None
409	Conflict	None

Example HTTP request

Request path

/v1/snapshot-schedules/{snapshot_schedule_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 = filestorage 1.1"

Request body

{
    "snapshot_retention_count": 10,
    "snapshot_schedule": {
        "frequency": "WEEKLY",
        "day_of_week": "MON",
        "hour": "23"
    }
}

Example HTTP response

Response 202

{
    "snapshot_retention_count": 10,
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "snapshot_schedule": {
        "frequency": "WEEKLY",
        "day_of_week": "MON",
        "hour": "23"
    }
}

1.17.2 - 1.0

put /v1/snapshot-schedules/{snapshot_schedule_id}

Description

파일스토리지 스냅샷 스케줄을 수정한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	snapshot_schedule_id required	스냅샷 스케줄 아이디 Example : `d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31`	string	None
query	volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None
body	body required		SnapshotScheduleSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	SnapshotScheduleSetResponse
400	Bad Request	None
404	Not Found	None
403	Forbidden	None
401	Unauthorized	None
409	Conflict	None

Example HTTP request

Request path

/v1/snapshot-schedules/{snapshot_schedule_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 = filestorage 1.0"

Request body

{
    "snapshot_retention_count": 10,
    "snapshot_schedule": {
        "frequency": "WEEKLY",
        "day_of_week": "MON",
        "hour": "23"
    }
}

Example HTTP response

Response 202

{
    "snapshot_retention_count": 10,
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "snapshot_schedule": {
        "frequency": "WEEKLY",
        "day_of_week": "MON",
        "hour": "23"
    }
}

1.18 - SetVolume

1.18.1 - 1.1

put /v1/volumes/{volume_id}

Description

파일스토리지를 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None
body	body required		VolumeSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	VolumeSetResponse
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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = filestorage 1.1"

Request body

{
    "file_unit_recovery_enabled": true
}

Example HTTP response

Response 202

{
    "file_unit_recovery_enabled": true
}

1.18.2 - 1.0

put /v1/volumes/{volume_id}

Description

파일스토리지를 수정한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None
body	body required		VolumeSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	VolumeSetResponse
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}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = filestorage 1.0"

Request body

{
    "file_unit_recovery_enabled": true
}

Example HTTP response

Response 202

{
    "file_unit_recovery_enabled": true
}

1.19 - SetVolumeReplication

1.19.1 - 1.1

put /v1/replications/{replication_id}

Description

파일스토리지 복제를 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	replication_id required	복제 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None
query	volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None
body	body required		ReplicationUpdateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	ReplicationUpdateResponse
401	Unauthorized	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/replications/{replication_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 = filestorage 1.1"

Request body

{
    "replication_policy": "use",
    "replication_frequency": "5min",
    "backup_retention_count": 2,
    "replication_update_type": "policy"
}

Example HTTP response

Response 202

{
    "replication_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "replication_frequency": "5min",
    "source_volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "source_volume_region": "kr-west1",
    "source_volume_access_level": "ro",
    "replication_volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "replication_volume_region": "kr-west1",
    "replication_volume_access_level": "ro",
    "replication_type": "replication",
    "backup_retention_count": 2
}

1.19.2 - 1.0

put /v1/replications/{replication_id}

Description

파일스토리지 복제를 수정한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	replication_id required	복제 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None
query	volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None
body	body required		ReplicationUpdateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	ReplicationUpdateResponse
401	Unauthorized	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/replications/{replication_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 = filestorage 1.0"

Request body

{
    "replication_policy": "use",
    "replication_frequency": "5min",
    "backup_retention_count": 2,
    "replication_update_type": "policy"
}

Example HTTP response

Response 202

{
    "replication_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "replication_frequency": "5min",
    "source_volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "source_volume_region": "kr-west1",
    "source_volume_access_level": "ro",
    "replication_volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "replication_volume_region": "kr-west1",
    "replication_volume_access_level": "ro",
    "replication_type": "replication",
    "backup_retention_count": 2
}

1.20 - ShowVolume

1.20.1 - 1.1

get /v1/volumes/{volume_id}

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None

Responses

HTTP Code	Description	Schema
200	OK	VolumeShowResponse
403	Forbidden	None
401	Unauthorized	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 = ko-KR",
"Scp-Api-Version = filestorage 1.1"

Example HTTP response

Response 200

{
    "id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "name": "my_volume",
    "protocol": "NFS",
    "state": "available",
    "account_id": "rwww523320dfvwbbefefsdvwdadsfa24c",
    "created_at": "2024-07-30T04:54:33.219373",
    "type_id": "jef22f67-ee83-4gg2-2ab6-3lf774ekfjdu",
    "type_name": "HDD",
    "purpose": "replication",
    "path": "xxx.xx.xxx:/xxxxxxxx",
    "usage": 100000,
    "encryption_enabled": true,
    "file_unit_recovery_enabled": true,
    "cifs_id": "cifsid",
    "endpoint_path": "xxx.xx.xxx.xxx"
}

1.20.2 - 1.0

get /v1/volumes/{volume_id}

Description

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

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None

Responses

HTTP Code	Description	Schema
200	OK	VolumeShowResponse
403	Forbidden	None
401	Unauthorized	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 = ko-KR",
"Scp-Api-Version = filestorage 1.0"

Example HTTP response

Response 200

{
    "id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "name": "my_volume",
    "protocol": "NFS",
    "state": "available",
    "account_id": "rwww523320dfvwbbefefsdvwdadsfa24c",
    "created_at": "2024-07-30T04:54:33.219373",
    "type_id": "jef22f67-ee83-4gg2-2ab6-3lf774ekfjdu",
    "type_name": "HDD",
    "purpose": "replication",
    "path": "xxx.xx.xxx:/xxxxxxxx",
    "usage": 100000,
    "encryption_enabled": true,
    "file_unit_recovery_enabled": true,
    "cifs_id": "cifsid",
    "endpoint_path": "xxx.xx.xxx.xxx"
}

1.21 - ShowVolumeReplication

1.21.1 - 1.1

get /v1/replications/{replication_id}

Description

파일스토리지 복제를 상세 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	replication_id required	복제 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None
query	volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None

Responses

HTTP Code	Description	Schema
200	OK	ReplicationShowResponse
401	Unauthorized	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/replications/{replication_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 = filestorage 1.1"

Example HTTP response

Response 200

{
    "replication_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "replication_frequency": "5min",
    "source_volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "source_volume_region": "kr-west1",
    "source_volume_access_level": "ro",
    "replication_volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "replication_volume_region": "kr-west1",
    "replication_volume_access_level": "ro",
    "replication_type": "replication",
    "source_volume_name": "my_volume",
    "replication_policy": "use",
    "replication_status": "creating",
    "replication_volume_name": "my_volume",
    "backup_retention_count": 2
}

1.21.2 - 1.0

get /v1/replications/{replication_id}

Description

파일스토리지 복제를 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	replication_id required	복제 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None
query	volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string	None

Responses

HTTP Code	Description	Schema
200	OK	ReplicationShowResponse
401	Unauthorized	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/replications/{replication_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 = filestorage 1.0"

Example HTTP response

Response 200

{
    "replication_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "replication_frequency": "5min",
    "source_volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "source_volume_region": "kr-west1",
    "source_volume_access_level": "ro",
    "replication_volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "replication_volume_region": "kr-west1",
    "replication_volume_access_level": "ro",
    "replication_type": "replication",
    "source_volume_name": "my_volume",
    "replication_policy": "use",
    "replication_status": "creating",
    "replication_volume_name": "my_volume",
    "backup_retention_count": 2
}

2 - Models

2.1 - AccessRuleRequest

Name	Description	Schema
object_id required	오브젝트 아이디 Example : `43fq3347-02q4-4aa8-ccf9-affe4917bb6f`	string
object_type required	오브젝트 유형 Example : `VM` Pattern : `^(VM\|BM\|GPU\|GPU_NODE\|ENDPOINT)$`	string
action required	접근제어 액션 Example : `add` Pattern : `^(add\|remove)$`	string

2.2 - AccessRuleResponse

Name	Description	Schema
volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
object_type required	오브젝트 유형 Example : `VM`	string
object_id required	오브젝트 아이디 Example : `43fq3347-02q4-4aa8-ccf9-affe4917bb6f`	string
action required	접근제어 액션 Example : `add`	string

2.3 - Replication

Name	Description	Schema
replication_id required	복제 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
replication_frequency required	복제 주기 Example : `5min`	string
source_volume_id required	원본 볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
source_volume_region required	원본 리전 Example : `kr-west1`	string
source_volume_access_level required	원본 접근 레벨 Example : `ro`	string
replication_volume_id required	복제본 볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
replication_volume_region required	복제본 리전 Example : `kr-west1`	string
replication_volume_access_level required	복제본 접근 레벨 Example : `ro`	string
replication_type required	복제 유형 Example : `replication`	string

2.4 - ReplicationCreateRequest

Name	Description	Schema
name required	복제본 볼륨 이름 Example : `my_volume` Pattern : `^[a-z]([a-z0-9_]){2,20}$`	string
cifs_password optional	CIFS 비밀번호 Example : `cifspwd0!!`	any of [string, null]
replication_frequency required	복제 주기 Example : `5min` Pattern : `^(5min\|hourly\|daily\|weekly\|monthly)$`	string
region required	복제본 리전 Example : `kr-west1`	string
volume_id required	원본 볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
backup_retention_count optional	백업 보관 개수 Example : `2`	any of [integer, null]
replication_type required	복제 유형 Example : `replication` Pattern : `^(replication\|backup)$`	string

2.5 - ReplicationCreateResponse

Name	Description	Schema
replication_id required	복제 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
replication_status required	복제 상태 Example : `creating`	string
source_volume_id required	원본 볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
source_volume_region required	원본 리전 Example : `kr-west1`	string
protocol required	프로토콜 Example : `NFS`	string
replication_volume_id required	복제본 볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
replication_volume_region required	복제본 리전 Example : `kr-west1`	string

2.6 - ReplicationListResponse

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

2.7 - ReplicationRegionListResponse

Name	Description	Schema	Default
regions required	복제 리전 목록 Example : `['kr-west1']`	array[string]

2.8 - ReplicationShowResponse

Name	Description	Schema
replication_id required	복제 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
replication_frequency required	복제 주기 Example : `5min`	string
source_volume_id required	원본 볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
source_volume_region required	원본 리전 Example : `kr-west1`	string
source_volume_access_level required	원본 접근 레벨 Example : `ro`	string
replication_volume_id required	복제본 볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
replication_volume_region required	복제본 리전 Example : `kr-west1`	string
replication_volume_access_level required	복제본 접근 레벨 Example : `ro`	string
replication_type required	복제 유형 Example : `replication`	string
source_volume_name required	원본 볼륨 이름 Example : `my_volume`	string
replication_policy required	복제 정책 Example : `use`	string
replication_status required	복제 상태 Example : `creating`	string
replication_volume_name required	복제본 볼륨 이름 Example : `my_volume`	string
backup_retention_count optional	백업 보관 개수 Example : `2`	any of [integer, null]

2.9 - ReplicationUpdateRequest

Name	Description	Schema
replication_policy optional	복제 정책 Example : `use`	any of [enum (use, paused), null]
replication_frequency optional	복제 주기 Example : `5min`	any of [enum (5min, hourly, daily, weekly, monthly), null]
backup_retention_count optional	백업 보관 개수 Example : `2`	any of [integer, null]
replication_update_type required	복제 수정 유형 Example : `policy` Pattern : `^(policy\|modify_schedule)$`	string

2.10 - ReplicationUpdateResponse

Name	Description	Schema
replication_id required	복제 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
replication_frequency required	복제 주기 Example : `5min`	string
source_volume_id required	원본 볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
source_volume_region required	원본 리전 Example : `kr-west1`	string
source_volume_access_level required	원본 접근 레벨 Example : `ro`	string
replication_volume_id required	복제본 볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
replication_volume_region required	복제본 리전 Example : `kr-west1`	string
replication_volume_access_level required	복제본 접근 레벨 Example : `ro`	string
replication_type required	복제 유형 Example : `replication`	string
backup_retention_count optional	백업 보관 개수 Example : `2`	any of [integer, null]

2.11 - Snapshot

Name	Description	Schema
id required	스냅샷 아이디 Example : `40htrre5b-eww25-ff2b-a426-6afefas65a3b`	string
name required	스냅샷 이름 Example : `my_volume.2024-10-01_14215`	string
state required	스냅샷 상태 Example : `available`	string
size required	스냅샷 크기 Example : `100`	integer
created_at required	생성 시간 Example : `2024-07-30T04:54:33.219373`	string (date-time)

2.12 - SnapshotCreateRequest

Name	Description	Schema	Default
volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string

2.13 - SnapshotDetail

Name	Description	Schema
id required	스냅샷 아이디 Example : `40htrre5b-eww25-ff2b-a426-6afefas65a3b`	string
name required	스냅샷 이름 Example : `my_volume.2024-10-01_14215`	string
state required	스냅샷 상태 Example : `available`	string
size required	스냅샷 크기 Example : `100`	integer
created_at required	생성 시간 Example : `2024-07-30T04:54:33.219373`	string (date-time)
volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string

2.14 - SnapshotListResponse

Name	Description	Schema
count required	count Example : `1`	integer
snapshots required		array[Snapshot]
snapshot_size_total_byte optional	스냅샷 총 크기 Example : `100`	any of [integer, null]

2.15 - SnapshotRestoreResponse

Name	Description	Schema	Default
snapshot required		Snapshot

2.16 - SnapshotSchedule

Name	Description	Schema
frequency required	스냅샷 주기 Example : `WEEKLY` Pattern : `^(WEEKLY\|DAILY)$`	string
day_of_week optional	스냅샷 스케줄 설정 요일 Example : `MON` Pattern : `^(SUN\|MON\|TUE\|WED\|THU\|FRI\|SAT)$`	any of [string, null]
hour required	스냅샷 스케줄 시간 Example : `23` Pattern : `^([0-9]\|1[0-9]\|2[0-3])$`	string

2.17 - SnapshotScheduleCreateRequest

Name	Description	Schema
snapshot_retention_count optional	보관 개수 Example : `10`	any of [integer, null]
volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
snapshot_schedule required		SnapshotSchedule

2.18 - SnapshotScheduleCreateResponse

Name	Description	Schema
snapshot_retention_count optional	보관 개수 Example : `10`	integer
volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	any of [string, null]
snapshot_schedule required		SnapshotSchedule

2.19 - SnapshotScheduleListResponse

Name	Description	Schema
snapshot_retention_count optional	보관 개수 Example : `10`	integer
volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
snapshot_policy_enabled optional	스냅샷 스케줄 정책 사용 여부 Example : `true`	any of [boolean, null]
snapshot_schedule required		array[SnapshotScheduleShow]

2.20 - SnapshotScheduleSetRequest

Name	Description	Schema	Default
snapshot_retention_count optional	보관 개수 Example : `10`	any of [integer, null]
snapshot_schedule required		SnapshotSchedule

2.21 - SnapshotScheduleSetResponse

Name	Description	Schema
snapshot_retention_count optional	보관 개수 Example : `10`	integer
volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	any of [string, null]
snapshot_schedule required		SnapshotSchedule

2.22 - SnapshotScheduleShow

Name	Description	Schema
frequency required	스냅샷 주기 Example : `WEEKLY` Pattern : `^(WEEKLY\|DAILY)$`	string
day_of_week optional	스냅샷 스케줄 설정 요일 Example : `MON` Pattern : `^(SUN\|MON\|TUE\|WED\|THU\|FRI\|SAT)$`	any of [string, null]
hour required	스냅샷 스케줄 시간 Example : `23` Pattern : `^([0-9]\|1[0-9]\|2[0-3])$`	string
id optional	스냅샷 스케줄 아이디 Example : `d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31`	any of [string, null]

2.23 - SnapshotShowResponse

Name	Description	Schema	Default
snapshot required		SnapshotDetail

2.24 - Tag

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

2.25 - Volume

Name	Description	Schema
id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
name required	볼륨 이름 Example : `my_volume`	string
protocol required	프로토콜 Example : `NFS`	string
state required	볼륨 상태 Example : `available`	string
account_id required	Account 아이디 Example : `rwww523320dfvwbbefefsdvwdadsfa24c`	string
created_at required	생성 시간 Example : `2024-07-30T04:54:33.219373`	string (date-time)
type_id required	볼륨 유형 아이디 Example : `jef22f67-ee83-4gg2-2ab6-3lf774ekfjdu`	string
type_name required	볼륨 유형 이름 Example : `HDD`	string
purpose required	볼륨 용도 Example : `replication`	string

2.26 - VolumeCreateRequest

Name	Description	Schema
name required	볼륨 이름 Example : `my_volume` Pattern : `^[a-z]([a-z0-9_]){2,20}$`	string
protocol required	프로토콜 Example : `NFS` Pattern : `^(NFS\|CIFS)$`	string
type_name required	볼륨 유형 이름 Example : `HDD`	string
snapshot_id optional	스냅샷 아이디 Example : `40htrre5b-eww25-ff2b-a426-6afefas65a3b`	any of [string, null]
cifs_password optional	CIFS 비밀번호 Example : `cifspwd0!!`	any of [string, null]
tags optional		any of [array[Tag], null]

2.27 - VolumeCreateResponse

Name	Description	Schema
protocol required	프로토콜 Example : `NFS`	string
snapshot_id optional	스냅샷 아이디 Example : `40htrre5b-eww25-ff2b-a426-6afefas65a3b`	any of [string, null]
type_name required	볼륨 유형 이름 Example : `HDD`	string
volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
volume_name required	볼륨 이름 Example : `my_volume`	string

2.28 - VolumeListResponse

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

2.29 - VolumeObjectAccessRuleListBase

Name	Description	Schema
access_rule_state required	접근제어 상태 Example : `active`	string
object_type required	오브젝트 유형 Example : `VM`	string
object_id required	오브젝트 아이디 Example : `43fq3347-02q4-4aa8-ccf9-affe4917bb6f`	string

2.30 - VolumeObjectAccessRuleListResponse

Name	Description	Schema
count required	count Example : `1`	integer
volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
access_rules required		array[VolumeObjectAccessRuleListBase]

2.31 - VolumeSetRequest

Name	Description	Schema	Default
file_unit_recovery_enabled required	볼륨 파일 단위 복구 사용 여부 Example : `True`	boolean

2.32 - VolumeSetResponse

Name	Description	Schema	Default
file_unit_recovery_enabled required	볼륨 파일 단위 복구 사용 여부 Example : `True`	boolean

2.33 - VolumeShowResponse

Name	Description	Schema
id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string
name required	볼륨 이름 Example : `my_volume`	string
protocol required	프로토콜 Example : `NFS`	string
state required	볼륨 상태 Example : `available`	string
account_id required	Account 아이디 Example : `rwww523320dfvwbbefefsdvwdadsfa24c`	string
created_at required	생성 시간 Example : `2024-07-30T04:54:33.219373`	string (date-time)
type_id required	볼륨 유형 아이디 Example : `jef22f67-ee83-4gg2-2ab6-3lf774ekfjdu`	string
type_name required	볼륨 유형 이름 Example : `HDD`	string
purpose required	볼륨 용도 Example : `replication`	string
path optional	볼륨 마운트 경로 Example : `xxx.xx.xxx:/xxxxxxxx`	any of [string, null]
usage optional	볼륨 사용량 Example : `100000`	any of [integer, null]
encryption_enabled required	볼륨 암호화 사용 여부 Example : `True`	boolean
file_unit_recovery_enabled optional	볼륨 파일 단위 복구 사용 여부 Example : `True`	any of [boolean, null]
cifs_id optional	CIFS 아이디 Example : `cifsid`	any of [string, null]
endpoint_path optional	볼륨 엔드포인트 경로 Example : `xxx.xx.xxx.xxx`	any of [string, null]