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

Storage

1: Archive Storage

1.1: APIs

1.1.1: CancelArchiving

1.1.1.1: 1.1
1.1.1.2: 1.0

1.1.2: CancelRecovery

1.1.2.1: 1.1
1.1.2.2: 1.0

1.1.3: CreateArchivingPolicy

1.1.3.1: 1.1
1.1.3.2: 1.0

1.1.4: CreateBucket

1.1.4.1: 1.1
1.1.4.2: 1.0

1.1.5: DeleteBucket

1.1.5.1: 1.1
1.1.5.2: 1.0

1.1.6: DeleteBucketObjects

1.1.6.1: 1.1
1.1.6.2: 1.0

1.1.7: DeleteBucketObjectVersions

1.1.7.1: 1.1

1.1.8: ListArchivingHistories

1.1.8.1: 1.1
1.1.8.2: 1.0

1.1.9: ListArchivingPolicies

1.1.9.1: 1.1
1.1.9.2: 1.0

1.1.10: ListBucketObjects

1.1.10.1: 1.1
1.1.10.2: 1.0

1.1.11: ListBucketObjectVersions

1.1.11.1: 1.1

1.1.12: ListBuckets

1.1.12.1: 1.1
1.1.12.2: 1.0

1.1.13: ListRecoveryHistories

1.1.13.1: 1.1
1.1.13.2: 1.0

1.1.14: RecoverObjects

1.1.14.1: 1.1
1.1.14.2: 1.0

1.1.15: RecoverObjectVersions

1.1.15.1: 1.1

1.1.16: SetArchivingPolicy

1.1.16.1: 1.1
1.1.16.2: 1.0

1.1.17: SetArchivingPolicyState

1.1.17.1: 1.1

1.1.18: SetBucketEncryption

1.1.18.1: 1.1
1.1.18.2: 1.0

1.1.19: SetBucketVersioning

1.1.19.1: 1.1

1.1.20: ShowArchivingHistory

1.1.20.1: 1.1
1.1.20.2: 1.0

1.1.21: ShowArchivingPolicy

1.1.21.1: 1.1
1.1.21.2: 1.0

1.1.22: ShowBucket

1.1.22.1: 1.1
1.1.22.2: 1.0

1.1.23: ShowBucketEncryption

1.1.23.1: 1.1
1.1.23.2: 1.0

1.1.24: ShowBucketVersioning

1.1.24.1: 1.1

1.1.25: ShowRecoveryHistory

1.1.25.1: 1.1
1.1.25.2: 1.0

1.2: Models

1.2.1: ArchivingHistory
1.2.2: ArchivingHistoryListResponse
1.2.3: ArchivingHistoryShowResponse
1.2.4: ArchivingInfo
1.2.5: ArchivingPolicies
1.2.6: ArchivingPolicyCreateRequest
1.2.7: ArchivingPolicyCreateResponse
1.2.8: ArchivingPolicyListResponse
1.2.9: ArchivingPolicyShowResponse
1.2.10: ArchivingPolicyStateUpdateRequest
1.2.11: ArchivingPolicyStateUpdateResponse
1.2.12: ArchivingPolicyUpdateRequest
1.2.13: ArchivingPolicyUpdateResponse
1.2.14: ArchivingSource
1.2.15: BucketCreateRequest
1.2.16: BucketCreateResponse
1.2.17: BucketEncryptionRequest
1.2.18: BucketEncryptionResponse
1.2.19: BucketListResponse
1.2.20: BucketShowResponse
1.2.21: BucketVersioningResponse
1.2.22: BucketVersionRequest
1.2.23: BucketWithName
1.2.24: Object
1.2.25: ObjectDeleteRequest
1.2.26: ObjectListResponse
1.2.27: ObjectRecoverRequest
1.2.28: ObjectRecoverResponse
1.2.29: ObjectRecoveryInfo
1.2.30: ObjectVersionListResponse
1.2.31: ObjectVersionRecoverRequest
1.2.32: ObjectVersionRecoverResponse
1.2.33: ObjectVersions
1.2.34: ObjectVersionsDeleteRequest
1.2.35: RecoveryHistory
1.2.36: RecoveryHistoryListResponse
1.2.37: RecoveryHistoryShowResponse
1.2.38: RecoveryInfo
1.2.39: Tag

2: Backup

2.1: APIs

2.1.1: Check Backup Master Connection State

2.1.1.1: 1.1
2.1.1.2: 1.0

2.1.2: Check Backup Name Duplicate

2.1.2.1: 1.1
2.1.2.2: 1.0

2.1.3: Check Backup Restore Server Name Duplicate

2.1.3.1: 1.1
2.1.3.2: 1.0

2.1.4: Check Filesystem Path Duplication

2.1.4.1: 1.1
2.1.4.2: 1.0

2.1.5: Create Backup

2.1.5.1: 1.1
2.1.5.2: 1.0

2.1.6: Create Backup Agent

2.1.6.1: 1.1
2.1.6.2: 1.0

2.1.7: Delete Backup

2.1.7.1: 1.1
2.1.7.2: 1.0

2.1.8: Delete Backup Agent

2.1.8.1: 1.1
2.1.8.2: 1.0

2.1.9: Delete Backup Restore Target

2.1.9.1: 1.1
2.1.9.2: 1.0

2.1.10: List Agent Backup Restore Target Servers

2.1.10.1: 1.1
2.1.10.2: 1.0

2.1.11: List Backup Agents

2.1.11.1: 1.1
2.1.11.2: 1.0

2.1.12: List Backup Histories

2.1.12.1: 1.1
2.1.12.2: 1.0

2.1.13: List Backup Region Relationship

2.1.13.1: 1.1
2.1.13.2: 1.0

2.1.14: List Backup Restore Histories

2.1.14.1: 1.1
2.1.14.2: 1.0

2.1.15: List Backup Restore Subnets

2.1.15.1: 1.1
2.1.15.2: 1.0

2.1.16: List Backup Restore Targets

2.1.16.1: 1.1
2.1.16.2: 1.0

2.1.17: List Backup Schedules

2.1.17.1: 1.1
2.1.17.2: 1.0

2.1.18: List Backup Targets

2.1.18.1: 1.1
2.1.18.2: 1.0

2.1.19: List Backups

2.1.19.1: 1.1
2.1.19.2: 1.0

2.1.20: List Targets of Backup Agent

2.1.20.1: 1.1
2.1.20.2: 1.0

2.1.21: Manual Backup

2.1.21.1: 1.1
2.1.21.2: 1.0

2.1.22: Restore Agent Backup

2.1.22.1: 1.1
2.1.22.2: 1.0

2.1.23: Restore Backup

2.1.23.1: 1.1
2.1.23.2: 1.0

2.1.24: Set Backup Schedule

2.1.24.1: 1.1
2.1.24.2: 1.0

2.1.25: Set Filesystem Path

2.1.25.1: 1.1
2.1.25.2: 1.0

2.1.26: Show Backup

2.1.26.1: 1.1
2.1.26.2: 1.0

2.1.27: Show Backup Agent

2.1.27.1: 1.1
2.1.27.2: 1.0

2.1.28: Show Backup Agent Install File Path

2.1.28.1: 1.1
2.1.28.2: 1.0

2.1.29: Update Replication Use

2.1.29.1: 1.1
2.1.29.2: 1.0

2.1.30: Update Retention Period

2.1.30.1: 1.1
2.1.30.2: 1.0

2.2: Models

2.2.1: AgentBackupRestoreRequest
2.2.2: AgentBackupRestoreTargetServerListResponse
2.2.3: AgentBackupRestoreTargetServerResponse
2.2.4: AsyncResponse
2.2.5: BackupAgentCreateRequest
2.2.6: BackupAgentDetailResponse
2.2.7: BackupAgentListResponse
2.2.8: BackupAgentResponse
2.2.9: BackupAgentTargetListResponse
2.2.10: BackupAgentTargetResponse
2.2.11: BackupCreateRequest
2.2.12: BackupCreateRequest1Dot1
2.2.13: BackupDetailResponse
2.2.14: BackupDetailResponse1Dot1
2.2.15: BackupHistoryListResponse
2.2.16: BackupHistoryResponse
2.2.17: BackupListRegionRelationshipResponse
2.2.18: BackupListResponse
2.2.19: BackupNameDuplicateResponse
2.2.20: BackupRegionRelationshipResponse
2.2.21: BackupReplicationUseUpdateBody
2.2.22: BackupResponse
2.2.23: BackupRestoreHistoryListResponse
2.2.24: BackupRestoreHistoryResponse
2.2.25: BackupRestoreRequest
2.2.26: BackupRestoreServerNameDuplicateResponse
2.2.27: BackupRestoreSubnetListResponse
2.2.28: BackupRestoreSubnetResponse
2.2.29: BackupRestoreTargetDeleteRequest
2.2.30: BackupRestoreTargetListResponse
2.2.31: BackupRestoreTargetResponse
2.2.32: BackupScheduleCreateRequest
2.2.33: BackupScheduleListResponse
2.2.34: BackupScheduleResponse
2.2.35: BackupTargetListResponse
2.2.36: BackupTargetResponse
2.2.37: CheckFileSystemDuplicationResponse
2.2.38: FileSystemPathUpdateRequest
2.2.39: InstallFilePathResponse
2.2.40: ModifyBackupSchedulesRequest
2.2.41: Network
2.2.42: ResourceInfo
2.2.43: RestoreFilesystemPath
2.2.44: RetentionPeriodUpdateBody
2.2.45: SyncResponse
2.2.46: Tag

3: Block Storage(BM)

3.1: APIs

3.1.1: Add Volume Group Member on Volume Group

3.1.1.1: 1.2
3.1.1.2: 1.1
3.1.1.3: 1.0

3.1.2: Attach Volume

3.1.2.1: 1.2
3.1.2.2: 1.1
3.1.2.3: 1.0

3.1.3: Create Volume

3.1.3.1: 1.2
3.1.3.2: 1.1
3.1.3.3: 1.0

3.1.4: Create Volume Group

3.1.4.1: 1.2
3.1.4.2: 1.1
3.1.4.3: 1.0

3.1.5: Create Volume Group Recovery

3.1.5.1: 1.2
3.1.5.2: 1.1

3.1.6: Create Volume Group Replication

3.1.6.1: 1.2
3.1.6.2: 1.1
3.1.6.3: 1.0

3.1.7: Create Volume Group Snapshot

3.1.7.1: 1.2
3.1.7.2: 1.1
3.1.7.3: 1.0

3.1.8: Create Volume Group Snapshot Schedule

3.1.8.1: 1.2
3.1.8.2: 1.1
3.1.8.3: 1.0

3.1.9: Create Volume Recovery

3.1.9.1: 1.2
3.1.9.2: 1.1

3.1.10: Create Volume Replication

3.1.10.1: 1.2
3.1.10.2: 1.1
3.1.10.3: 1.0

3.1.11: Create Volume Snapshot

3.1.11.1: 1.2
3.1.11.2: 1.1
3.1.11.3: 1.0

3.1.12: Create Volume Snapshot Rate

3.1.12.1: 1.2
3.1.12.2: 1.1
3.1.12.3: 1.0

3.1.13: Create Volume Snapshot Schedule

3.1.13.1: 1.2
3.1.13.2: 1.1
3.1.13.3: 1.0

3.1.14: Delete Volume

3.1.14.1: 1.2
3.1.14.2: 1.1
3.1.14.3: 1.0

3.1.15: Delete Volume Group Replication

3.1.15.1: 1.2
3.1.15.2: 1.1
3.1.15.3: 1.0

3.1.16: Delete Volume Group Snapshot

3.1.16.1: 1.2
3.1.16.2: 1.1
3.1.16.3: 1.0

3.1.17: Delete Volume Group Snapshot Schedule

3.1.17.1: 1.2
3.1.17.2: 1.1
3.1.17.3: 1.0

3.1.18: Delete Volume Replication

3.1.18.1: 1.2
3.1.18.2: 1.1
3.1.18.3: 1.0

3.1.19: Delete Volume Snapshot

3.1.19.1: 1.2
3.1.19.2: 1.1
3.1.19.3: 1.0

3.1.20: Delete Volume Snapshot Rate

3.1.20.1: 1.2
3.1.20.2: 1.1
3.1.20.3: 1.0

3.1.21: Delete Volume Snapshot Schedule

3.1.21.1: 1.2
3.1.21.2: 1.1
3.1.21.3: 1.0

3.1.22: Detach Volume

3.1.22.1: 1.2
3.1.22.2: 1.1
3.1.22.3: 1.0

3.1.23: List Volume Group Snapshots

3.1.23.1: 1.2
3.1.23.2: 1.1
3.1.23.3: 1.0

3.1.24: List Volume Groups

3.1.24.1: 1.2
3.1.24.2: 1.1
3.1.24.3: 1.0

3.1.25: List Volume Snapshots

3.1.25.1: 1.2
3.1.25.2: 1.1
3.1.25.3: 1.0

3.1.26: List Volumes

3.1.26.1: 1.2
3.1.26.2: 1.1
3.1.26.3: 1.0

3.1.27: Remove Volume Group Member on Volume Group

3.1.27.1: 1.2
3.1.27.2: 1.1
3.1.27.3: 1.0

3.1.28: Restore Volume Group Snapshot

3.1.28.1: 1.2
3.1.28.2: 1.1
3.1.28.3: 1.0

3.1.29: Restore Volume Snapshot

3.1.29.1: 1.2
3.1.29.2: 1.1
3.1.29.3: 1.0

3.1.30: Set Volume Group Replication Cycle

3.1.30.1: 1.2
3.1.30.2: 1.1
3.1.30.3: 1.0

3.1.31: Set Volume Group Replication Policy

3.1.31.1: 1.2
3.1.31.2: 1.1
3.1.31.3: 1.0

3.1.32: Set Volume Group Snapshot Schedule

3.1.32.1: 1.2
3.1.32.2: 1.1
3.1.32.3: 1.0

3.1.33: Set Volume QoS

3.1.33.1: 1.2

3.1.34: Set Volume Replication Cycle

3.1.34.1: 1.2
3.1.34.2: 1.1
3.1.34.3: 1.0

3.1.35: Set Volume Replication Policy

3.1.35.1: 1.2
3.1.35.2: 1.1
3.1.35.3: 1.0

3.1.36: Set Volume Snapshot Rate

3.1.36.1: 1.2
3.1.36.2: 1.1
3.1.36.3: 1.0

3.1.37: Set Volume Snapshot Schedule

3.1.37.1: 1.2
3.1.37.2: 1.1
3.1.37.3: 1.0

3.1.38: Show Volume

3.1.38.1: 1.2
3.1.38.2: 1.1
3.1.38.3: 1.0

3.1.39: Show Volume Group

3.1.39.1: 1.2
3.1.39.2: 1.1
3.1.39.3: 1.0

3.1.40: Show Volume Group Replication

3.1.40.1: 1.2
3.1.40.2: 1.1
3.1.40.3: 1.0

3.1.41: Show Volume Replication

3.1.41.1: 1.2
3.1.41.2: 1.1
3.1.41.3: 1.0

3.2: Models

3.2.1: AsyncResponse
3.2.2: AttachedServer
3.2.3: AttachmentListModel
3.2.4: ExternalError
3.2.5: MemberVolume
3.2.6: MemberVolumeWithRecoveryInfo
3.2.7: QoSModel
3.2.8: RecoveryInfo
3.2.9: RecoveryVolumeGroupInfo
3.2.10: RecoveryVolumeInfo
3.2.11: RelationVolumeGroupModel
3.2.12: RelationVolumeModel
3.2.13: SetVolumeQoSRequest
3.2.14: SetVolumeQoSResponse
3.2.15: SimpleAttachedServer
3.2.16: SimpleIdNameInfo
3.2.17: SnapshotSchedule
3.2.18: TagModel
3.2.19: VolumeAttachmentRequest
3.2.20: VolumeAttachmentResponse
3.2.21: VolumeCreateRequest
3.2.22: VolumeCreateRequestV1Dot2
3.2.23: VolumeDetachRequest
3.2.24: VolumeGroupCreationRequest
3.2.25: VolumeGroupInfo
3.2.26: VolumeGroupListModel
3.2.27: VolumeGroupListResponse
3.2.28: VolumeGroupMemberRequest
3.2.29: VolumeGroupMemberResponse
3.2.30: VolumeGroupModel
3.2.31: VolumeGroupRecoveryCreateRequest
3.2.32: VolumeGroupReplicationCreateRequest
3.2.33: VolumeGroupReplicationDeleteResponse
3.2.34: VolumeGroupReplicationSyncTabModel
3.2.35: VolumeGroupReplicationSyncTabResponse
3.2.36: VolumeGroupReplicationUpdateCycleRequest
3.2.37: VolumeGroupReplicationUpdateCycleResponse
3.2.38: VolumeGroupReplicationUpdatePolicyRequest
3.2.39: VolumeGroupReplicationUpdatePolicyResponse
3.2.40: VolumeGroupResponse
3.2.41: VolumeGroupSnapshotDeleteResponse
3.2.42: VolumeGroupSnapshotListModel
3.2.43: VolumeGroupSnapshotListResponse
3.2.44: VolumeGroupSnapshotResponse
3.2.45: VolumeGroupSnapshotRestoreResponse
3.2.46: VolumeGroupSnapshotScheduleRequest
3.2.47: VolumeGroupSnapshotScheduleResponse
3.2.48: VolumeListModel
3.2.49: VolumeListResponse
3.2.50: VolumeModel
3.2.51: VolumeModelV1Dot2
3.2.52: VolumeRecoveryCreateRequest
3.2.53: VolumeReplicationCreateRequest
3.2.54: VolumeReplicationCycleRequest
3.2.55: VolumeReplicationCycleResponse
3.2.56: VolumeReplicationModel
3.2.57: VolumeReplicationPolicyRequest
3.2.58: VolumeReplicationPolicyResponse
3.2.59: VolumeReplicationResponse
3.2.60: VolumeResponse
3.2.61: VolumeResponseV1Dot2
3.2.62: VolumeSnapshotDeleteResponse
3.2.63: VolumeSnapshotListModel
3.2.64: VolumeSnapshotListResponse
3.2.65: VolumeSnapshotRateRequest
3.2.66: VolumeSnapshotRateResponse
3.2.67: VolumeSnapshotResponse
3.2.68: VolumeSnapshotRestoreResponse
3.2.69: VolumeSnapshotScheduleRequest
3.2.70: VolumeSnapshotScheduleResponse

4: File Storage

4.1: APIs

4.1.1: CreateSnapshot

4.1.1.1: 1.1
4.1.1.2: 1.0

4.1.2: CreateSnapshotSchedule

4.1.2.1: 1.1
4.1.2.2: 1.0

4.1.3: CreateVolume

4.1.3.1: 1.1
4.1.3.2: 1.0

4.1.4: CreateVolumeReplication

4.1.4.1: 1.1
4.1.4.2: 1.0

4.1.5: DeleteSnapshot

4.1.5.1: 1.1
4.1.5.2: 1.0

4.1.6: DeleteSnapshotSchedule

4.1.6.1: 1.1
4.1.6.2: 1.0

4.1.7: DeleteVolume

4.1.7.1: 1.1
4.1.7.2: 1.0

4.1.8: DeleteVolumeReplication

4.1.8.1: 1.1
4.1.8.2: 1.0

4.1.9: ListAccessRules

4.1.9.1: 1.1
4.1.9.2: 1.0

4.1.10: ListSnapshots

4.1.10.1: 1.1
4.1.10.2: 1.0

4.1.11: ListSnapshotSchedule

4.1.11.1: 1.1
4.1.11.2: 1.0

4.1.12: ListVolumeReplicationRegion

4.1.12.1: 1.1
4.1.12.2: 1.0

4.1.13: ListVolumeReplications

4.1.13.1: 1.1
4.1.13.2: 1.0

4.1.14: ListVolumes

4.1.14.1: 1.1
4.1.14.2: 1.0

4.1.15: RestoreSnapshot

4.1.15.1: 1.1
4.1.15.2: 1.0

4.1.16: SetAccessRule

4.1.16.1: 1.1
4.1.16.2: 1.0

4.1.17: SetSnapshotSchedule

4.1.17.1: 1.1
4.1.17.2: 1.0

4.1.18: SetVolume

4.1.18.1: 1.1
4.1.18.2: 1.0

4.1.19: SetVolumeReplication

4.1.19.1: 1.1
4.1.19.2: 1.0

4.1.20: ShowVolume

4.1.20.1: 1.1
4.1.20.2: 1.0

4.1.21: ShowVolumeReplication

4.1.21.1: 1.1
4.1.21.2: 1.0

4.2: Models

4.2.1: AccessRuleRequest
4.2.2: AccessRuleResponse
4.2.3: Replication
4.2.4: ReplicationCreateRequest
4.2.5: ReplicationCreateResponse
4.2.6: ReplicationListResponse
4.2.7: ReplicationRegionListResponse
4.2.8: ReplicationShowResponse
4.2.9: ReplicationUpdateRequest
4.2.10: ReplicationUpdateResponse
4.2.11: Snapshot
4.2.12: SnapshotCreateRequest
4.2.13: SnapshotDetail
4.2.14: SnapshotListResponse
4.2.15: SnapshotRestoreResponse
4.2.16: SnapshotSchedule
4.2.17: SnapshotScheduleCreateRequest
4.2.18: SnapshotScheduleCreateResponse
4.2.19: SnapshotScheduleListResponse
4.2.20: SnapshotScheduleSetRequest
4.2.21: SnapshotScheduleSetResponse
4.2.22: SnapshotScheduleShow
4.2.23: SnapshotShowResponse
4.2.24: Tag
4.2.25: Volume
4.2.26: VolumeCreateRequest
4.2.27: VolumeCreateResponse
4.2.28: VolumeListResponse
4.2.29: VolumeObjectAccessRuleListBase
4.2.30: VolumeObjectAccessRuleListResponse
4.2.31: VolumeSetRequest
4.2.32: VolumeSetResponse
4.2.33: VolumeShowResponse

5: Parallel File Storage

5.1: APIs

5.1.1: CreateSnapshot

5.1.1.1: 1.0

5.1.2: CreateVolume

5.1.2.1: 1.0

5.1.3: DeleteSnapshot

5.1.3.1: 1.0

5.1.4: DeleteVolume

5.1.4.1: 1.0

5.1.5: ListAccessRule

5.1.5.1: 1.0

5.1.6: ListSnapshots

5.1.6.1: 1.0

5.1.7: ListVolumes

5.1.7.1: 1.0

5.1.8: SetAccessRule

5.1.8.1: 1.0

5.1.9: SetVolumeCapacity

5.1.9.1: 1.0

5.1.10: ShowVolume

5.1.10.1: 1.0

5.2: Models

5.2.1: AccessIp
5.2.2: AccessRule
5.2.3: AccessRuleListResponse
5.2.4: AccessRules
5.2.5: AccessRuleUpdateRequest
5.2.6: AccessRuleUpdateResponse
5.2.7: Snapshot
5.2.8: SnapshotCreateRequest
5.2.9: SnapshotCreateResponse
5.2.10: SnapshotListResponse
5.2.11: SnapshotResponse
5.2.12: Tag
5.2.13: Volume
5.2.14: VolumeCapacityRequest
5.2.15: VolumeCreateRequest
5.2.16: VolumeListResponse
5.2.17: VolumeShowResponse

1 - Archive Storage

Overview

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

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

Version

Version	Status	Supported Until
1.0	DEPRECATED	20251231
1.1	CURRENT	-

OpenAPI URL

https://archivestorage.{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.1 - APIs

1.1.1 - CancelArchiving

1.1.1.1 - 1.1

put /v1/archiving-histories/cancel-archiving

Description

아카이빙을 취소한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	id required	아카이빙 이력 아이디 Example : `EXE-8f35b491-a060-453b-b825-e78440ca46de`	string	None
query	bucket_id required	버킷 아이디 Example : `3d036efe-f576-48b0-8375-6d3704a95b63`	string	None

Responses

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

Example HTTP request

Request path

/v1/archiving-histories/cancel-archiving?id={id}&bucket_id={bucket_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 = archivestorage 1.1"

Example HTTP response

Response 202

1.1.1.2 - 1.0

put /v1/archiving-histories/cancel-archiving

Description

아카이빙을 취소한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	id required	아카이빙 이력 아이디 Example : `EXE-8f35b491-a060-453b-b825-e78440ca46de`	string	None
query	bucket_id required	버킷 아이디 Example : `3d036efe-f576-48b0-8375-6d3704a95b63`	string	None

Responses

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

Example HTTP request

Request path

/v1/archiving-histories/cancel-archiving?id={id}&bucket_id={bucket_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 = archivestorage 1.0"

Example HTTP response

Response 202

1.1.2 - CancelRecovery

1.1.2.1 - 1.1

put /v1/recovery-histories/cancel-recovery

Description

복구를 취소한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	id required	복구 이력 아이디 Example : `EXE-9df439a5-9e6d-46a4-806e-1e9991520763`	string	None
query	bucket_id required	버킷 아이디 Example : `7d8d8c2b-d02a-421e-a6e3-5b981bfb507f`	string	None

Responses

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

Example HTTP request

Request path

/v1/recovery-histories/cancel-recovery?id={id}&bucket_id={bucket_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 = archivestorage 1.1"

Example HTTP response

Response 202

1.1.2.2 - 1.0

put /v1/recovery-histories/cancel-recovery

Description

복구를 취소한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	id required	복구 이력 아이디 Example : `EXE-9df439a5-9e6d-46a4-806e-1e9991520763`	string	None
query	bucket_id required	버킷 아이디 Example : `7d8d8c2b-d02a-421e-a6e3-5b981bfb507f`	string	None

Responses

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

Example HTTP request

Request path

/v1/recovery-histories/cancel-recovery?id={id}&bucket_id={bucket_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 = archivestorage 1.0"

Example HTTP response

Response 202

1.1.3 - CreateArchivingPolicy

1.1.3.1 - 1.1

post /v1/archiving-policies

Description

아카이빙 정책을 생성한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string	None
body	body required		ArchivingPolicyCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	ArchivingPolicyCreateResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/archiving-policies?bucket_id={bucket_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 = archivestorage 1.1"

Request body

{
    "archiving_source_bucket_name": "obs-bucket-name",
    "object_lifecycle": "1",
    "object_path": "/"
}

Example HTTP response

Response 201

{
    "id": "SCH-XXXXXXX",
    "bucket_id": "138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2",
    "archiving_source": {
        "bucket_name": "obs-bucket-name",
        "object_path": "/"
    },
    "object_lifecycle": "1",
    "state": "ACTIVE"
}

1.1.3.2 - 1.0

post /v1/archiving-policies

Description

아카이빙 정책을 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string	None
body	body required		ArchivingPolicyCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	ArchivingPolicyCreateResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/archiving-policies?bucket_id={bucket_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 = archivestorage 1.0"

Request body

{
    "archiving_source_bucket_name": "obs-bucket-name",
    "object_lifecycle": "1",
    "object_path": "/"
}

Example HTTP response

Response 201

{
    "id": "SCH-XXXXXXX",
    "bucket_id": "138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2",
    "archiving_source": {
        "bucket_name": "obs-bucket-name",
        "object_path": "/"
    },
    "object_lifecycle": "1",
    "state": "ACTIVE"
}

1.1.4 - CreateBucket

1.1.4.1 - 1.1

post /v1/buckets

Description

버킷을 생성한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		BucketCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	BucketCreateResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/buckets

Request header

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

Request body

{
    "name": "astest",
    "tags": [
        {
            "key": "key",
            "value": "value"
        }
    ]
}

Example HTTP response

Response 201

{
    "id": "138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2"
}

1.1.4.2 - 1.0

post /v1/buckets

Description

버킷을 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		BucketCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	BucketCreateResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/buckets

Request header

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

Request body

{
    "name": "astest",
    "tags": [
        {
            "key": "key",
            "value": "value"
        }
    ]
}

Example HTTP response

Response 201

{
    "id": "138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2"
}

1.1.5 - DeleteBucket

1.1.5.1 - 1.1

delete /v1/buckets/{bucket_id}

Description

버킷을 삭제한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string	None

Responses

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

Example HTTP request

Request path

/v1/buckets/{bucket_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 = archivestorage 1.1"

Example HTTP response

Response 202

1.1.5.2 - 1.0

delete /v1/buckets/{bucket_id}

Description

버킷을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string	None

Responses

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

Example HTTP request

Request path

/v1/buckets/{bucket_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 = archivestorage 1.0"

Example HTTP response

Response 202

1.1.6 - DeleteBucketObjects

1.1.6.1 - 1.1

delete /v1/buckets/{bucket_id}/objects

Description

버킷 오브젝트를 삭제한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string	None
body	body required		ObjectDeleteRequest

Responses

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

Example HTTP request

Request path

/v1/buckets/{bucket_id}/objects

Request header

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

Request body

{
    "paths": [
        "test/"
    ]
}

Example HTTP response

Response 202

1.1.6.2 - 1.0

delete /v1/buckets/{bucket_id}/objects

Description

버킷 오브젝트를 삭제한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string	None
body	body required		ObjectDeleteRequest

Responses

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

Example HTTP request

Request path

/v1/buckets/{bucket_id}/objects

Request header

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

Request body

{
    "paths": [
        "test/"
    ]
}

Example HTTP response

Response 202

1.1.7 - DeleteBucketObjectVersions

1.1.7.1 - 1.1

delete /v1/buckets/{bucket_id}/object-versions

Description

버킷 오브젝트 버전을 삭제한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string	None
body	body required		ObjectVersionsDeleteRequest

Responses

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

Example HTTP request

Request path

/v1/buckets/{bucket_id}/object-versions

Request header

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

Request body

{
    "path": "hello/my_file.txt",
    "versions": [
        "Oc9nEYWV.6VjzsIMXFZWM1zL8HcYvKl",
        "asSrZ.-K.cf67F0NhXR353JS7Kx6kmm"
    ]
}

Example HTTP response

Response 202

1.1.8 - ListArchivingHistories

1.1.8.1 - 1.1

get /v1/archiving-histories

Description

아카이빙 이력 목록을 검색한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	bucket_id required	버킷 아이디 Example : `3d036efe-f576-48b0-8375-6d3704a95b63`	string	None
query	start_at_from required	시작일부터 Example : `2025-04-01T00:00:00+09:00`	string (date-time)	None
query	start_at_to required	시작일까지 Example : `2025-04-30T23:59:59+09:00`	string (date-time)	None
query	state optional	상태 Example : `SUCCESS`	any of [string, null]	None
query	limit optional	조회 개수 Example : `20`	any of [integer, null]	20
query	offset optional	오프셋 Example : `0`	any of [integer, null]	0

Responses

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

Example HTTP request

Request path

/v1/archiving-histories?bucket_id={bucket_id}&start_at_from={start_at_from}&start_at_to={start_at_to}

Request header

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

Example HTTP response

Response 200

{
    "total_count": 10,
    "bucket_id": "3d036efe-f576-48b0-8375-6d3704a95b63",
    "contents": [
        {
            "archiving_id": "SCH-02d48456-0f35-47e2-8056-b00e09366cac",
            "id": "EXE-8f35b491-a060-453b-b825-e78440ca46de",
            "state": "SUCCESS",
            "archiving_policy_id": "SCH-02d48456-0f35-47e2-8056-b00e09366cac",
            "start_at": "2025-04-01T00:00:00+09:00",
            "end_at": "2025-04-30T23:59:59+09:00"
        }
    ]
}

1.1.8.2 - 1.0

get /v1/archiving-histories

Description

아카이빙 이력 목록을 검색한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	bucket_id required	버킷 아이디 Example : `3d036efe-f576-48b0-8375-6d3704a95b63`	string	None
query	start_at_from required	시작일부터 Example : `2025-04-01T00:00:00+09:00`	string (date-time)	None
query	start_at_to required	시작일까지 Example : `2025-04-30T23:59:59+09:00`	string (date-time)	None
query	state optional	상태 Example : `SUCCESS`	any of [string, null]	None
query	limit optional	조회 개수 Example : `20`	any of [integer, null]	20
query	offset optional	오프셋 Example : `0`	any of [integer, null]	0

Responses

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

Example HTTP request

Request path

/v1/archiving-histories?bucket_id={bucket_id}&start_at_from={start_at_from}&start_at_to={start_at_to}

Request header

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

Example HTTP response

Response 200

{
    "total_count": 10,
    "bucket_id": "3d036efe-f576-48b0-8375-6d3704a95b63",
    "contents": [
        {
            "archiving_id": "SCH-02d48456-0f35-47e2-8056-b00e09366cac",
            "id": "EXE-8f35b491-a060-453b-b825-e78440ca46de",
            "state": "SUCCESS",
            "archiving_policy_id": "SCH-02d48456-0f35-47e2-8056-b00e09366cac",
            "start_at": "2025-04-01T00:00:00+09:00",
            "end_at": "2025-04-30T23:59:59+09:00"
        }
    ]
}

1.1.9 - ListArchivingPolicies

1.1.9.1 - 1.1

get /v1/archiving-policies

Description

아카이빙 정책 목록을 검색한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string	None

Responses

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

Example HTTP request

Request path

/v1/archiving-policies?bucket_id={bucket_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 = archivestorage 1.1"

Example HTTP response

Response 200

{
    "count": 1,
    "bucket_id": "138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2",
    "archiving_source_bucket_name": "obs-bucket-name",
    "archiving_policies": [
        {
            "id": "SCH-XXXXXXX",
            "object_lifecycle": "1",
            "object_path": "/",
            "state": "ACTIVE"
        }
    ]
}

1.1.9.2 - 1.0

get /v1/archiving-policies

Description

아카이빙 정책 목록을 검색한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string	None

Responses

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

Example HTTP request

Request path

/v1/archiving-policies?bucket_id={bucket_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 = archivestorage 1.0"

Example HTTP response

Response 200

{
    "count": 1,
    "bucket_id": "138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2",
    "archiving_source_bucket_name": "obs-bucket-name",
    "archiving_policies": [
        {
            "id": "SCH-XXXXXXX",
            "object_lifecycle": "1",
            "object_path": "/",
            "state": "ACTIVE"
        }
    ]
}

1.1.10 - ListBucketObjects

1.1.10.1 - 1.1

get /v1/buckets/{bucket_id}/objects

Description

버킷 오브젝트 목록을 검색한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string	None
query	marker optional	마커 Example : `TODO.txt`	any of [string, null]	None
query	object_path optional	오브젝트 경로 Example : `/`	any of [string, null]	None
query	object_name optional	오브젝트 이름 Example : `hello/TODO.txt`	any of [string, null]	None
query	object_type optional	오브젝트 타입 Example : `FILE`	any of [string, null]	None
query	limit optional	조회 개수 Example : `20`	any of [integer, null]	200

Responses

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

Example HTTP request

Request path

/v1/buckets/{bucket_id}/objects

Request header

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

Example HTTP response

Response 200

{
    "count": 1,
    "marker": "TODO.txt",
    "is_truncated": true,
    "contents": [
        {
            "object_name": "hello/TODO.txt",
            "object_type": "FILE",
            "object_size": "3581",
            "modified_at": "2025-04-09T05:54:46.244000+00:00"
        }
    ]
}

1.1.10.2 - 1.0

get /v1/buckets/{bucket_id}/objects

Description

버킷 오브젝트 목록을 검색한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string	None
query	marker optional	마커 Example : `TODO.txt`	any of [string, null]	None
query	object_path optional	오브젝트 경로 Example : `/`	any of [string, null]	None
query	object_name optional	오브젝트 이름 Example : `hello/TODO.txt`	any of [string, null]	None
query	object_type optional	오브젝트 타입 Example : `FILE`	any of [string, null]	None
query	limit optional	조회 개수 Example : `20`	any of [integer, null]	200

Responses

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

Example HTTP request

Request path

/v1/buckets/{bucket_id}/objects

Request header

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

Example HTTP response

Response 200

{
    "count": 1,
    "marker": "TODO.txt",
    "is_truncated": true,
    "contents": [
        {
            "object_name": "hello/TODO.txt",
            "object_type": "FILE",
            "object_size": "3581",
            "modified_at": "2025-04-09T05:54:46.244000+00:00"
        }
    ]
}

1.1.11 - ListBucketObjectVersions

1.1.11.1 - 1.1

get /v1/buckets/{bucket_id}/object-versions

Description

버킷 오브젝트 버전 목록을 검색한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string	None
query	object_path required	오브젝트 경로 Example : `hello/my_file.txt`	string	None
query	offset optional	오프셋 Example : `0`	any of [integer, null]	0
query	limit optional	조회 개수 Example : `20`	any of [integer, null]	20

Responses

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

Example HTTP request

Request path

/v1/buckets/{bucket_id}/object-versions?object_path={object_path}

Request header

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

Example HTTP response

Response 200

{
    "count": 1,
    "contents": [
        {
            "object_path": "hello/my_file.txt",
            "object_version_id": "Oc9nEYWV.6VjzsIMXFZWM1zL8HcYvKl",
            "latest": true,
            "modified_at": "2025-04-09T05:54:46.244000+00:00",
            "etag": "4f6094f1e0619a6504efcb5e69e63bec",
            "size": "20"
        }
    ]
}

1.1.12 - ListBuckets

1.1.12.1 - 1.1

get /v1/buckets

Description

버킷 목록을 검색한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	name optional	버킷 이름 Example : `astest`	any of [string, null]	None
query	limit optional	조회 개수 Example : `20`	any of [integer, null]	20

Responses

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

Example HTTP request

Request path

/v1/buckets

Request header

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

Example HTTP response

Response 200

{
    "buckets": [
        {
            "id": "138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2",
            "name": "astest"
        }
    ]
}

1.1.12.2 - 1.0

get /v1/buckets

Description

버킷 목록을 검색한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	name optional	버킷 이름 Example : `astest`	any of [string, null]	None
query	limit optional	조회 개수 Example : `20`	any of [integer, null]	20

Responses

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

Example HTTP request

Request path

/v1/buckets

Request header

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

Example HTTP response

Response 200

{
    "buckets": [
        {
            "id": "138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2",
            "name": "astest"
        }
    ]
}

1.1.13 - ListRecoveryHistories

1.1.13.1 - 1.1

get /v1/recovery-histories

Description

복구 이력 목록을 검색한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	bucket_id required	버킷 아이디 Example : `7d8d8c2b-d02a-421e-a6e3-5b981bfb507f`	string	None
query	start_at_from required	시작일부터 Example : `2025-04-01T00:00:00+09:00`	string (date-time)	None
query	start_at_to required	시작일까지 Example : `2025-04-30T23:59:59+09:00`	string (date-time)	None
query	state optional	상태 Example : `SUCCESS`	any of [string, null]	None
query	limit optional	조회 개수 Example : `20`	any of [integer, null]	20
query	offset optional	오프셋 Example : `0`	any of [integer, null]	0

Responses

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

Example HTTP request

Request path

/v1/recovery-histories?bucket_id={bucket_id}&start_at_from={start_at_from}&start_at_to={start_at_to}

Request header

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

Example HTTP response

Response 200

{
    "total_count": 10,
    "bucket_id": "7d8d8c2b-d02a-421e-a6e3-5b981bfb507f",
    "contents": [
        {
            "recovery_id": "ARC-f9eab563-312b-4bbf-a4bf-d377448d66b5",
            "id": "EXE-9df439a5-9e6d-46a4-806e-1e9991520763",
            "state": "SUCCESS",
            "recovery_target_bucket_name": "test-obs-bucket",
            "start_at": "2025-04-01T00:00:00+09:00",
            "end_at": "2025-04-30T23:59:59+09:00"
        }
    ]
}

1.1.13.2 - 1.0

get /v1/recovery-histories

Description

복구 이력 목록을 검색한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	bucket_id required	버킷 아이디 Example : `7d8d8c2b-d02a-421e-a6e3-5b981bfb507f`	string	None
query	start_at_from required	시작일부터 Example : `2025-04-01T00:00:00+09:00`	string (date-time)	None
query	start_at_to required	시작일까지 Example : `2025-04-30T23:59:59+09:00`	string (date-time)	None
query	state optional	상태 Example : `SUCCESS`	any of [string, null]	None
query	limit optional	조회 개수 Example : `20`	any of [integer, null]	20
query	offset optional	오프셋 Example : `0`	any of [integer, null]	0

Responses

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

Example HTTP request

Request path

/v1/recovery-histories?bucket_id={bucket_id}&start_at_from={start_at_from}&start_at_to={start_at_to}

Request header

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

Example HTTP response

Response 200

{
    "total_count": 10,
    "bucket_id": "7d8d8c2b-d02a-421e-a6e3-5b981bfb507f",
    "contents": [
        {
            "recovery_id": "ARC-f9eab563-312b-4bbf-a4bf-d377448d66b5",
            "id": "EXE-9df439a5-9e6d-46a4-806e-1e9991520763",
            "state": "SUCCESS",
            "recovery_target_bucket_name": "test-obs-bucket",
            "start_at": "2025-04-01T00:00:00+09:00",
            "end_at": "2025-04-30T23:59:59+09:00"
        }
    ]
}

1.1.14 - RecoverObjects

1.1.14.1 - 1.1

put /v1/buckets/{bucket_id}/recover-objects

Description

오브젝트를 오브젝트 스토리지에 복구한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string	None
body	body required		ObjectRecoverRequest

Responses

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

Example HTTP request

Request path

/v1/buckets/{bucket_id}/recover-objects

Request header

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

Request body

{
    "recovery_target_bucket_name": "obs-bucket-name",
    "recovery_infos": [
        {
            "source_object_path": "/",
            "object_type": "FILE"
        }
    ],
    "overwrite": true
}

Example HTTP response

Response 202

{
    "id": "138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2",
    "recovery_target_bucket_name": "obs-bucket-name"
}

1.1.14.2 - 1.0

put /v1/buckets/{bucket_id}/recover-objects

Description

오브젝트를 오브젝트 스토리지에 복구한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string	None
body	body required		ObjectRecoverRequest

Responses

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

Example HTTP request

Request path

/v1/buckets/{bucket_id}/recover-objects

Request header

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

Request body

{
    "recovery_target_bucket_name": "obs-bucket-name",
    "recovery_infos": [
        {
            "source_object_path": "/",
            "object_type": "FILE"
        }
    ],
    "overwrite": true
}

Example HTTP response

Response 202

{
    "id": "138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2",
    "recovery_target_bucket_name": "obs-bucket-name"
}

1.1.15 - RecoverObjectVersions

1.1.15.1 - 1.1

put /v1/buckets/{bucket_id}/recover-object-versions

Description

오브젝트 버전을 오브젝트 스토리지에 복구한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string	None
body	body required		ObjectVersionRecoverRequest

Responses

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

Example HTTP request

Request path

/v1/buckets/{bucket_id}/recover-object-versions

Request header

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

Request body

{
    "recovery_target_bucket_name": "obs-bucket-name",
    "source_object_path": "/",
    "source_object_version": "Oc9nEYWV.6VjzsIMXFZWM1zL8HcYvKl",
    "overwrite": true
}

Example HTTP response

Response 202

{
    "id": "138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2",
    "recovery_target_bucket_name": "obs-bucket-name"
}

1.1.16 - SetArchivingPolicy

1.1.16.1 - 1.1

put /v1/archiving-policies/{archiving_policy_id}

Description

아카이빙 정책을 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	archiving_policy_id required	아카이빙 정책 아이디 Example : `SCH-XXXXXXX`	string	None
query	bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string	None
body	body required		ArchivingPolicyUpdateRequest

Responses

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

Example HTTP request

Request path

/v1/archiving-policies/{archiving_policy_id}?bucket_id={bucket_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 = archivestorage 1.1"

Request body

{
    "object_lifecycle": "1"
}

Example HTTP response

Response 200

{
    "id": "SCH-XXXXXXX",
    "bucket_id": "138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2",
    "archiving_source": {
        "bucket_name": "obs-bucket-name",
        "object_path": "/"
    },
    "object_lifecycle": "1",
    "state": "ACTIVE"
}

1.1.16.2 - 1.0

put /v1/archiving-policies/{archiving_policy_id}

Description

아카이빙 정책을 수정한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	archiving_policy_id required	아카이빙 정책 아이디 Example : `SCH-XXXXXXX`	string	None
query	bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string	None
body	body required		ArchivingPolicyUpdateRequest

Responses

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

Example HTTP request

Request path

/v1/archiving-policies/{archiving_policy_id}?bucket_id={bucket_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 = archivestorage 1.0"

Request body

{
    "object_lifecycle": "1"
}

Example HTTP response

Response 200

{
    "id": "SCH-XXXXXXX",
    "bucket_id": "138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2",
    "archiving_source": {
        "bucket_name": "obs-bucket-name",
        "object_path": "/"
    },
    "object_lifecycle": "1",
    "state": "ACTIVE"
}

1.1.17 - SetArchivingPolicyState

1.1.17.1 - 1.1

put /v1/archiving-policies/{archiving_policy_id}/state

Description

아카이빙 정책 상태를 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	archiving_policy_id required	아카이빙 정책 아이디 Example : `SCH-XXXXXXX`	string	None
query	bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string	None
body	body required		ArchivingPolicyStateUpdateRequest

Responses

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

Example HTTP request

Request path

/v1/archiving-policies/{archiving_policy_id}/state?bucket_id={bucket_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 = archivestorage 1.1"

Request body

{
    "state": "ACTIVE"
}

Example HTTP response

Response 200

{
    "id": "SCH-XXXXXXX",
    "bucket_id": "138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2",
    "state": "ACTIVE"
}

1.1.18 - SetBucketEncryption

1.1.18.1 - 1.1

put /v1/buckets/{bucket_id}/encryption

Description

버킷 암호화 정보를 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string	None
body	body required		BucketEncryptionRequest

Responses

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

Example HTTP request

Request path

/v1/buckets/{bucket_id}/encryption

Request header

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

Request body

{
    "enabled": true
}

Example HTTP response

Response 200

{
    "id": "138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2",
    "enabled": true
}

1.1.18.2 - 1.0

put /v1/buckets/{bucket_id}/encryption

Description

버킷 암호화 정보를 수정한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string	None
body	body required		BucketEncryptionRequest

Responses

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

Example HTTP request

Request path

/v1/buckets/{bucket_id}/encryption

Request header

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

Request body

{
    "enabled": true
}

Example HTTP response

Response 200

{
    "id": "138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2",
    "enabled": true
}

1.1.19 - SetBucketVersioning

1.1.19.1 - 1.1

put /v1/buckets/{bucket_id}/versioning

Description

버킷 버저닝을 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string	None
body	body required		BucketVersionRequest

Responses

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

Example HTTP request

Request path

/v1/buckets/{bucket_id}/versioning

Request header

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

Request body

{
    "enabled": true
}

Example HTTP response

Response 200

{
    "id": "138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2",
    "enabled": true
}

1.1.20 - ShowArchivingHistory

1.1.20.1 - 1.1

get /v1/archiving-histories/detail

Description

아카이빙 이력을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	id required	아카이빙 이력 아이디 Example : `EXE-8f35b491-a060-453b-b825-e78440ca46de`	string	None
query	bucket_id required	버킷 아이디 Example : `3d036efe-f576-48b0-8375-6d3704a95b63`	string	None

Responses

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

Example HTTP request

Request path

/v1/archiving-histories/detail?id={id}&bucket_id={bucket_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 = archivestorage 1.1"

Example HTTP response

Response 200

{
    "archiving_id": "SCH-02d48456-0f35-47e2-8056-b00e09366cac",
    "id": "EXE-8f35b491-a060-453b-b825-e78440ca46de",
    "state": "SUCCESS",
    "archiving_policy_id": "SCH-02d48456-0f35-47e2-8056-b00e09366cac",
    "start_at": "2025-04-01T00:00:00+09:00",
    "end_at": "2025-04-30T23:59:59+09:00",
    "bucket_id": "3d036efe-f576-48b0-8375-6d3704a95b63",
    "archiving_infos": [
        {
            "source_object_path": "example_source_object_path/",
            "usage": "1024",
            "total_object_count": 100,
            "archiving_object_count": 50,
            "archiving_rate": 100
        }
    ]
}

1.1.20.2 - 1.0

get /v1/archiving-histories/detail

Description

아카이빙 이력을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	id required	아카이빙 이력 아이디 Example : `EXE-8f35b491-a060-453b-b825-e78440ca46de`	string	None
query	bucket_id required	버킷 아이디 Example : `3d036efe-f576-48b0-8375-6d3704a95b63`	string	None

Responses

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

Example HTTP request

Request path

/v1/archiving-histories/detail?id={id}&bucket_id={bucket_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 = archivestorage 1.0"

Example HTTP response

Response 200

{
    "archiving_id": "SCH-02d48456-0f35-47e2-8056-b00e09366cac",
    "id": "EXE-8f35b491-a060-453b-b825-e78440ca46de",
    "state": "SUCCESS",
    "archiving_policy_id": "SCH-02d48456-0f35-47e2-8056-b00e09366cac",
    "start_at": "2025-04-01T00:00:00+09:00",
    "end_at": "2025-04-30T23:59:59+09:00",
    "bucket_id": "3d036efe-f576-48b0-8375-6d3704a95b63",
    "archiving_infos": [
        {
            "source_object_path": "example_source_object_path/",
            "usage": "1024",
            "total_object_count": 100,
            "archiving_object_count": 50,
            "archiving_rate": 100
        }
    ]
}

1.1.21 - ShowArchivingPolicy

1.1.21.1 - 1.1

get /v1/archiving-policies/{archiving_policy_id}

Description

아카이빙 정책을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	archiving_policy_id required	아카이빙 정책 아이디 Example : `SCH-XXXXXXX`	string	None
query	bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string	None

Responses

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

Example HTTP request

Request path

/v1/archiving-policies/{archiving_policy_id}?bucket_id={bucket_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 = archivestorage 1.1"

Example HTTP response

Response 200

{
    "id": "SCH-XXXXXXX",
    "bucket_id": "138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2",
    "archiving_source": {
        "bucket_name": "obs-bucket-name",
        "object_path": "/"
    },
    "object_lifecycle": "1",
    "state": "ACTIVE"
}

1.1.21.2 - 1.0

get /v1/archiving-policies/{archiving_policy_id}

Description

아카이빙 정책을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	archiving_policy_id required	아카이빙 정책 아이디 Example : `SCH-XXXXXXX`	string	None
query	bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string	None

Responses

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

Example HTTP request

Request path

/v1/archiving-policies/{archiving_policy_id}?bucket_id={bucket_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 = archivestorage 1.0"

Example HTTP response

Response 200

{
    "id": "SCH-XXXXXXX",
    "bucket_id": "138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2",
    "archiving_source": {
        "bucket_name": "obs-bucket-name",
        "object_path": "/"
    },
    "object_lifecycle": "1",
    "state": "ACTIVE"
}

1.1.22 - ShowBucket

1.1.22.1 - 1.1

get /v1/buckets/{bucket_id}

Description

버킷을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string	None

Responses

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

Example HTTP request

Request path

/v1/buckets/{bucket_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 = archivestorage 1.1"

Example HTTP response

Response 200

{
    "id": "138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2",
    "name": "astest",
    "state": "ACTIVE",
    "usage": "10",
    "archiving_source_bucket_name": "obstest"
}

1.1.22.2 - 1.0

get /v1/buckets/{bucket_id}

Description

버킷을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string	None

Responses

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

Example HTTP request

Request path

/v1/buckets/{bucket_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 = archivestorage 1.0"

Example HTTP response

Response 200

{
    "id": "138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2",
    "name": "astest",
    "state": "ACTIVE",
    "usage": "10",
    "archiving_source_bucket_name": "obstest"
}

1.1.23 - ShowBucketEncryption

1.1.23.1 - 1.1

get /v1/buckets/{bucket_id}/encryption

Description

버킷 암호화 정보를 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string	None

Responses

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

Example HTTP request

Request path

/v1/buckets/{bucket_id}/encryption

Request header

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

Example HTTP response

Response 200

{
    "id": "138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2",
    "enabled": true
}

1.1.23.2 - 1.0

get /v1/buckets/{bucket_id}/encryption

Description

버킷 암호화 정보를 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string	None

Responses

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

Example HTTP request

Request path

/v1/buckets/{bucket_id}/encryption

Request header

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

Example HTTP response

Response 200

{
    "id": "138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2",
    "enabled": true
}

1.1.24 - ShowBucketVersioning

1.1.24.1 - 1.1

get /v1/buckets/{bucket_id}/versioning

Description

버킷 버저닝 정보를 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string	None

Responses

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

Example HTTP request

Request path

/v1/buckets/{bucket_id}/versioning

Request header

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

Example HTTP response

Response 200

{
    "id": "138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2",
    "enabled": true
}

1.1.25 - ShowRecoveryHistory

1.1.25.1 - 1.1

get /v1/recovery-histories/detail

Description

복구 이력을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	id required	복구 이력 아이디 Example : `EXE-9df439a5-9e6d-46a4-806e-1e9991520763`	string	None
query	bucket_id required	버킷 아이디 Example : `7d8d8c2b-d02a-421e-a6e3-5b981bfb507f`	string	None

Responses

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

Example HTTP request

Request path

/v1/recovery-histories/detail?id={id}&bucket_id={bucket_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 = archivestorage 1.1"

Example HTTP response

Response 200

{
    "recovery_id": "ARC-f9eab563-312b-4bbf-a4bf-d377448d66b5",
    "id": "EXE-9df439a5-9e6d-46a4-806e-1e9991520763",
    "state": "SUCCESS",
    "recovery_target_bucket_name": "test-obs-bucket",
    "start_at": "2025-04-01T00:00:00+09:00",
    "end_at": "2025-04-30T23:59:59+09:00",
    "bucket_id": "7d8d8c2b-d02a-421e-a6e3-5b981bfb507f",
    "recovery_infos": [
        {
            "source_object_path": "example_source_object_path/",
            "usage": "1024",
            "total_object_count": 100,
            "recovery_object_count": 50,
            "recovery_rate": 50
        }
    ]
}

1.1.25.2 - 1.0

get /v1/recovery-histories/detail

Description

복구 이력을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	id required	복구 이력 아이디 Example : `EXE-9df439a5-9e6d-46a4-806e-1e9991520763`	string	None
query	bucket_id required	버킷 아이디 Example : `7d8d8c2b-d02a-421e-a6e3-5b981bfb507f`	string	None

Responses

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

Example HTTP request

Request path

/v1/recovery-histories/detail?id={id}&bucket_id={bucket_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 = archivestorage 1.0"

Example HTTP response

Response 200

{
    "recovery_id": "ARC-f9eab563-312b-4bbf-a4bf-d377448d66b5",
    "id": "EXE-9df439a5-9e6d-46a4-806e-1e9991520763",
    "state": "SUCCESS",
    "recovery_target_bucket_name": "test-obs-bucket",
    "start_at": "2025-04-01T00:00:00+09:00",
    "end_at": "2025-04-30T23:59:59+09:00",
    "bucket_id": "7d8d8c2b-d02a-421e-a6e3-5b981bfb507f",
    "recovery_infos": [
        {
            "source_object_path": "example_source_object_path/",
            "usage": "1024",
            "total_object_count": 100,
            "recovery_object_count": 50,
            "recovery_rate": 50
        }
    ]
}

1.2 - Models

1.2.1 - ArchivingHistory

Name	Description	Schema
archiving_id required	아카이빙 아이디 Example : `SCH-02d48456-0f35-47e2-8056-b00e09366cac`	any of [string, null]
id required	아카이빙 이력 아이디 Example : `EXE-8f35b491-a060-453b-b825-e78440ca46de`	any of [string, null]
state required	상태 Example : `SUCCESS`	any of [string, null]
archiving_policy_id required	아카이빙 정책 아이디 Example : `SCH-02d48456-0f35-47e2-8056-b00e09366cac`	any of [string, null]
start_at required	시작 일시 Example : `2025-04-01T00:00:00+09:00`	any of [string (date-time), null]
end_at required	종료 일시 Example : `2025-04-30T23:59:59+09:00`	any of [string (date-time), null]

1.2.2 - ArchivingHistoryListResponse

Name	Description	Schema
total_count required	총 개수 Example : `10`	any of [integer, null]
bucket_id required	버킷 아이디 Example : `3d036efe-f576-48b0-8375-6d3704a95b63`	any of [string, null]
contents required	이력 목록	array[ArchivingHistory]

1.2.3 - ArchivingHistoryShowResponse

Name	Description	Schema
archiving_id required	아카이빙 아이디 Example : `SCH-02d48456-0f35-47e2-8056-b00e09366cac`	any of [string, null]
id required	아카이빙 이력 아이디 Example : `EXE-8f35b491-a060-453b-b825-e78440ca46de`	any of [string, null]
state required	상태 Example : `SUCCESS`	any of [string, null]
archiving_policy_id required	아카이빙 정책 아이디 Example : `SCH-02d48456-0f35-47e2-8056-b00e09366cac`	any of [string, null]
start_at required	시작 일시 Example : `2025-04-01T00:00:00+09:00`	any of [string (date-time), null]
end_at required	종료 일시 Example : `2025-04-30T23:59:59+09:00`	any of [string (date-time), null]
bucket_id required	버킷 아이디 Example : `3d036efe-f576-48b0-8375-6d3704a95b63`	any of [string, null]
archiving_infos required	아카이빙 정보 목록	array[ArchivingInfo]

1.2.4 - ArchivingInfo

Name	Description	Schema
source_object_path required	소스 오브젝트 경로 Example : `example_source_object_path/`	any of [string, null]
usage required	사용량 Example : `1024`	any of [string, null]
total_object_count required	총 오브젝트 개수 Example : `100`	any of [integer, null]
archiving_object_count required	아카이빙 오브젝트 개수 Example : `50`	any of [integer, null]
archiving_rate required	아카이빙 진행률 Example : `100`	any of [integer, null]

1.2.5 - ArchivingPolicies

Name	Description	Schema
id required	아카이빙 정책 아이디 Example : `SCH-XXXXXXX`	string
object_lifecycle required	Object Storage에 저장된 각 오브젝트의 생성 후 경과 일수를 기준으로 아카이빙 조건을 설정하는 값 Example : `1`	any of [string, null]
object_path required	오브젝트 경로 Example : `/`	any of [string, null]
state required	아카이빙 정책 상태 Example : `ACTIVE`	string

1.2.6 - ArchivingPolicyCreateRequest

Name	Description	Schema
archiving_source_bucket_name required	아카이빙 소스 버킷 이름 Example : `obs-bucket-name`	string
object_lifecycle required	Object Storage에 저장된 각 오브젝트의 생성 후 경과 일수를 기준으로 아카이빙 조건을 설정하는 값 Example : `1`	string
object_path required	오브젝트 경로 Example : `/` Pattern : `^/$`	string

1.2.7 - ArchivingPolicyCreateResponse

Name	Description	Schema
id required	아카이빙 정책 아이디 Example : `SCH-XXXXXXX`	string
bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string
archiving_source required	아카이빙 소스	ArchivingSource
object_lifecycle required	Object Storage에 저장된 각 오브젝트의 생성 후 경과 일수를 기준으로 아카이빙 조건을 설정하는 값 Example : `1`	string
state required	아카이빙 정책 상태 Example : `ACTIVE`	string

1.2.8 - ArchivingPolicyListResponse

Name	Description	Schema
count required	count Example : `1`	integer
bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string
archiving_source_bucket_name required	아카이빙 소스 버킷 이름 Example : `obs-bucket-name`	any of [string, null]
archiving_policies required	아카이빙 정책 목록	any of [array[ArchivingPolicies], null]

1.2.9 - ArchivingPolicyShowResponse

Name	Description	Schema
id required	아카이빙 정책 아이디 Example : `SCH-XXXXXXX`	string
bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string
archiving_source required	아카이빙 소스	ArchivingSource
object_lifecycle required	Object Storage에 저장된 각 오브젝트의 생성 후 경과 일수를 기준으로 아카이빙 조건을 설정하는 값 Example : `1`	any of [string, null]
state required	아카이빙 정책 상태 Example : `ACTIVE`	any of [string, null]

1.2.10 - ArchivingPolicyStateUpdateRequest

Name	Description	Schema	Default
state required	아카이빙 정책 상태 Example : `ACTIVE` Pattern : `^(ACTIVE\|INACTIVE)$`	string

1.2.11 - ArchivingPolicyStateUpdateResponse

Name	Description	Schema
id required	아카이빙 정책 아이디 Example : `SCH-XXXXXXX`	string
bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string
state required	아카이빙 정책 상태 Example : `ACTIVE`	string

1.2.12 - ArchivingPolicyUpdateRequest

Name	Description	Schema	Default
object_lifecycle required	Object Storage에 저장된 각 오브젝트의 생성 후 경과 일수를 기준으로 아카이빙 조건을 설정하는 값 Example : `1`	string

1.2.13 - ArchivingPolicyUpdateResponse

Name	Description	Schema
id required	아카이빙 정책 아이디 Example : `SCH-XXXXXXX`	string
bucket_id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string
archiving_source required	아카이빙 소스	ArchivingSource
object_lifecycle required	Object Storage에 저장된 각 오브젝트의 생성 후 경과 일수를 기준으로 아카이빙 조건을 설정하는 값 Example : `1`	string
state required	아카이빙 정책 상태 Example : `ACTIVE`	string

1.2.14 - ArchivingSource

Name	Description	Schema	Default
bucket_name required	아카이빙 소스 버킷 이름 Example : `obs-bucket-name`	any of [string, null]
object_path required	오브젝트 경로 Example : `/`	any of [string, null]

1.2.15 - BucketCreateRequest

Name	Description	Schema	Default
name required	버킷 이름 Example : `astest`	string
tags optional	태그 목록	any of [array[Tag], null]

1.2.16 - BucketCreateResponse

Name	Description	Schema	Default
id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string

1.2.17 - BucketEncryptionRequest

Name	Description	Schema	Default
enabled required	암호화 여부 Example : `True`	boolean

1.2.18 - BucketEncryptionResponse

Name	Description	Schema	Default
id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string
enabled required	암호화 여부 Example : `True`	boolean

1.2.19 - BucketListResponse

Name	Description	Schema	Default
buckets required	버킷 목록	array[BucketWithName]

1.2.20 - BucketShowResponse

Name	Description	Schema
id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string
name required	버킷 이름 Example : `astest`	string
state required	버킷 상태 Example : `ACTIVE`	string
usage optional	버킷 사용량 Example : `10`	any of [string, null]
archiving_source_bucket_name optional	아카이빙 소스 버킷 이름 Example : `obstest`	any of [string, null]

1.2.21 - BucketVersioningResponse

Name	Description	Schema	Default
id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string
enabled required	암호화 여부 Example : `True`	boolean

1.2.22 - BucketVersionRequest

Name	Description	Schema	Default
enabled required	버저닝 여부 Example : `True`	boolean

1.2.23 - BucketWithName

Name	Description	Schema	Default
id required	버킷 아이디 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string
name required	버킷 이름 Example : `astest`	string

1.2.24 - Object

Name	Description	Schema
object_name required	오브젝트 이름 Example : `hello/TODO.txt`	string
object_type required	오브젝트 타입 Example : `FILE`	string
object_size optional	오브젝트 크기 Example : `3581`	any of [string, null]
modified_at optional	수정일 Example : `2025-04-09T05:54:46.244000+00:00`	any of [string, null]

1.2.25 - ObjectDeleteRequest

Name	Description	Schema	Default
paths required	오브젝트 경로 목록 Example : `['test/']`	array[string]

1.2.26 - ObjectListResponse

Name	Description	Schema
count required	count Example : `1`	integer
marker optional	마커 Example : `TODO.txt`	any of [string, null]
is_truncated required	is_truncated는 현재 결과가 모든 데이터를 포함하고 있는지, 아니면 일부만 포함하고 있는지를 나타냅니다. Example : `True`	boolean
contents required	오브젝트 목록	array[Object]

1.2.27 - ObjectRecoverRequest

Name	Description	Schema
recovery_target_bucket_name required	복구 대상 버킷 이름 Example : `obs-bucket-name`	string
recovery_infos required	오브젝트 복구 정보 목록	array[ObjectRecoveryInfo]
overwrite required	덮어쓰기 Example : `True`	boolean

1.2.28 - ObjectRecoverResponse

Name	Description	Schema	Default
id required	138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string
recovery_target_bucket_name required	복구 대상 버킷 이름 Example : `obs-bucket-name`	string

1.2.29 - ObjectRecoveryInfo

Name	Description	Schema	Default
source_object_path required	복구 소스 오브젝트 경로 Example : `/`	string
object_type required	오브젝트 타입 Example : `FILE` Pattern : `^(FILE\|FOLDER)$`	string

1.2.30 - ObjectVersionListResponse

Name	Description	Schema	Default
count required	count Example : `1`	integer
contents required		array[ObjectVersions]

1.2.31 - ObjectVersionRecoverRequest

Name	Description	Schema
recovery_target_bucket_name required	복구 대상 버킷 이름 Example : `obs-bucket-name`	string
source_object_path required	복구 소스 오브젝트 경로 Example : `/`	string
source_object_version required	복구 소스 오브젝트 버전 Example : `Oc9nEYWV.6VjzsIMXFZWM1zL8HcYvKl`	string
overwrite required	덮어쓰기 Example : `True`	boolean

1.2.32 - ObjectVersionRecoverResponse

Name	Description	Schema	Default
id required	138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2 Example : `138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`	string
recovery_target_bucket_name required	복구 대상 버킷 이름 Example : `obs-bucket-name`	string

1.2.33 - ObjectVersions

Name	Description	Schema
object_path required	오브젝트 경로 Example : `hello/my_file.txt`	string
object_version_id required	오브젝트 버전 아이디 Example : `Oc9nEYWV.6VjzsIMXFZWM1zL8HcYvKl`	string
latest required	오브젝트의 최신버전 Example : `True`	boolean
modified_at required	수정일 Example : `2025-04-09T05:54:46.244000+00:00`	string (date-time)
etag required	ETag Example : `4f6094f1e0619a6504efcb5e69e63bec`	string
size required	크기 Example : `20`	string

1.2.34 - ObjectVersionsDeleteRequest

Name	Description	Schema	Default
path required	오브젝트 경로 Example : `hello/my_file.txt`	string
versions required	오브젝트 버전 목록 Example : `['Oc9nEYWV.6VjzsIMXFZWM1zL8HcYvKl', 'asSrZ.-K.cf67F0NhXR353JS7Kx6kmm']`	array[object]

1.2.35 - RecoveryHistory

Name	Description	Schema
recovery_id required	복구 아이디 Example : `ARC-f9eab563-312b-4bbf-a4bf-d377448d66b5`	any of [string, null]
id required	복구 이력 아이디 Example : `EXE-9df439a5-9e6d-46a4-806e-1e9991520763`	any of [string, null]
state required	상태 Example : `SUCCESS`	any of [string, null]
recovery_target_bucket_name required	복구 대상 버킷 이름 Example : `test-obs-bucket`	any of [string, null]
start_at required	시작 일시 Example : `2025-04-01T00:00:00+09:00`	any of [string (date-time), null]
end_at required	종료 일시 Example : `2025-04-30T23:59:59+09:00`	any of [string (date-time), null]

1.2.36 - RecoveryHistoryListResponse

Name	Description	Schema
total_count required	총 개수 Example : `10`	any of [integer, null]
bucket_id required	버킷 아이디 Example : `7d8d8c2b-d02a-421e-a6e3-5b981bfb507f`	any of [string, null]
contents required	이력 목록	array[RecoveryHistory]

1.2.37 - RecoveryHistoryShowResponse

Name	Description	Schema
recovery_id required	복구 아이디 Example : `ARC-f9eab563-312b-4bbf-a4bf-d377448d66b5`	any of [string, null]
id required	복구 이력 아이디 Example : `EXE-9df439a5-9e6d-46a4-806e-1e9991520763`	any of [string, null]
state required	상태 Example : `SUCCESS`	any of [string, null]
recovery_target_bucket_name required	복구 대상 버킷 이름 Example : `test-obs-bucket`	any of [string, null]
start_at required	시작 일시 Example : `2025-04-01T00:00:00+09:00`	any of [string (date-time), null]
end_at required	종료 일시 Example : `2025-04-30T23:59:59+09:00`	any of [string (date-time), null]
bucket_id required	버킷 아이디 Example : `7d8d8c2b-d02a-421e-a6e3-5b981bfb507f`	any of [string, null]
recovery_infos required	복구 정보 목록	array[RecoveryInfo]

1.2.38 - RecoveryInfo

Name	Description	Schema
source_object_path required	소스 오브젝트 경로 Example : `example_source_object_path/`	any of [string, null]
usage required	사용량 Example : `1024`	any of [string, null]
total_object_count required	총 오브젝트 개수 Example : `100`	any of [integer, null]
recovery_object_count required	복구 오브젝트 개수 Example : `50`	any of [integer, null]
recovery_rate required	복구 진행률 Example : `50`	any of [integer, null]

1.2.39 - Tag

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

2 - Backup

Overview

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

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

Version

Version	Status	Supported Until
1.0	DEPRECATED	20260331
1.1	CURRENT	-

OpenAPI URL

https://backup.{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

2.1 - APIs

2.1.1 - Check Backup Master Connection State

2.1.1.1 - 1.1

get /v1/backup-agents/{backup_agent_id}/check-connection-state

Description

백업 마스터 연결 상태 확인

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_agent_id required	Backup Agent ID Example : `BACKUP_AGENT-abcd`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backup-agents/{backup_agent_id}/check-connection-state

Request header

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

Example HTTP response

Response 202

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

2.1.1.2 - 1.0

get /v1/backup-agents/{backup_agent_id}/check-connection-state

Description

백업 마스터 연결 상태 확인

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_agent_id required	Backup Agent ID Example : `BACKUP_AGENT-abcd`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backup-agents/{backup_agent_id}/check-connection-state

Request header

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

Example HTTP response

Response 202

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

2.1.2 - Check Backup Name Duplicate

2.1.2.1 - 1.1

get /v1/backups/check-name-duplication

Description

Backup명을 중복 체크한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	backup_name required	Backup명 Example : `backup-001`	string	None

Responses

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

Example HTTP request

Request path

/v1/backups/check-name-duplication?backup_name={backup_name}

Request header

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

Example HTTP response

Response 200

{
    "result": true
}

2.1.2.2 - 1.0

get /v1/backups/check-name-duplication

Description

Backup명을 중복 체크한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
query	backup_name required	Backup명 Example : `backup-001`	string	None

Responses

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

Example HTTP request

Request path

/v1/backups/check-name-duplication?backup_name={backup_name}

Request header

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

Example HTTP response

Response 200

{
    "result": true
}

2.1.3 - Check Backup Restore Server Name Duplicate

2.1.3.1 - 1.1

get /v1/backups/restore/check-name-duplication

Description

복구 서버명을 중복 체크한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	restore_server_name required	복구 서버명 Example : `restoretest1`	string	None

Responses

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

Example HTTP request

Request path

/v1/backups/restore/check-name-duplication?restore_server_name={restore_server_name}

Request header

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

Example HTTP response

Response 200

{
    "result": true
}

2.1.3.2 - 1.0

get /v1/backups/restore/check-name-duplication

Description

복구 서버명을 중복 체크한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
query	restore_server_name required	복구 서버명 Example : `restoretest1`	string	None

Responses

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

Example HTTP request

Request path

/v1/backups/restore/check-name-duplication?restore_server_name={restore_server_name}

Request header

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

Example HTTP response

Response 200

{
    "result": true
}

2.1.4 - Check Filesystem Path Duplication

2.1.4.1 - 1.1

get /v1/backups/check-filesystem-duplication

Description

Filesystem 경로 중복 체크

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	filesystem_path required	백업 대상 파일 시스템 경로 Example : `/aaa`	string	None
query	server_uuid required	Backup 서버 UUID Example : `89f5ef44-1021-4a5c-8e06-fbb289eac366`	string	None

Responses

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

Example HTTP request

Request path

/v1/backups/check-filesystem-duplication?filesystem_path={filesystem_path}&server_uuid={server_uuid}

Request header

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

Example HTTP response

Response 200

{
    "result": true
}

2.1.4.2 - 1.0

get /v1/backups/check-filesystem-duplication

Description

Filesystem 경로 중복 체크

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
query	filesystem_path required	백업 대상 파일 시스템 경로 Example : `/aaa`	string	None
query	server_uuid required	Backup 서버 UUID Example : `89f5ef44-1021-4a5c-8e06-fbb289eac366`	string	None

Responses

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

Example HTTP request

Request path

/v1/backups/check-filesystem-duplication?filesystem_path={filesystem_path}&server_uuid={server_uuid}

Request header

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

Example HTTP response

Response 200

{
    "result": true
}

2.1.5 - Create Backup

2.1.5.1 - 1.1

post /v1/backups

Description

Backup을 생성한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		BackupCreateRequest1Dot1

Responses

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

Example HTTP request

Request path

/v1/backups

Request header

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

Request body

{
    "dr_enabled": false,
    "encrypt_enabled": true,
    "filesystem_paths": [
        "/aaa",
        "/bbb"
    ],
    "name": "backup-001",
    "policy_category": "AGENTLESS",
    "policy_type": "VM_IMAGE",
    "region": "kr-west1",
    "retention_period": "WEEK_2",
    "schedules": [
        {
            "frequency": "DAILY",
            "start_day": "MON",
            "start_time": "09:00:00",
            "start_week": "WEEK_2",
            "type": "FULL"
        }
    ],
    "server_category": "VIRTUAL_SERVER | GPU_SERVER | BAREMETAL_SERVER",
    "server_guid": "9ab33c66-3dbd-46cd-b0af-abccd3eb3170",
    "server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366",
    "tags": [
        {
            "key": "",
            "value": ""
        }
    ]
}

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

2.1.5.2 - 1.0

post /v1/backups

Description

Backup을 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
body	body required		BackupCreateRequest

Responses

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

Example HTTP request

Request path

/v1/backups

Request header

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

Request body

{
    "encrypt_enabled": true,
    "filesystem_paths": [
        "/aaa",
        "/bbb"
    ],
    "name": "backup-001",
    "policy_category": "AGENTLESS",
    "policy_type": "VM_IMAGE",
    "region": "kr-west1",
    "retention_period": "WEEK_2",
    "schedules": [
        {
            "frequency": "DAILY",
            "start_day": "MON",
            "start_time": "09:00:00",
            "start_week": "WEEK_2",
            "type": "FULL"
        }
    ],
    "server_category": "VIRTUAL_SERVER | GPU_SERVER | BAREMETAL_SERVER",
    "server_guid": "9ab33c66-3dbd-46cd-b0af-abccd3eb3170",
    "server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366",
    "tags": [
        {
            "key": "",
            "value": ""
        }
    ]
}

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

2.1.6 - Create Backup Agent

2.1.6.1 - 1.1

post /v1/backup-agents

Description

Backup Agent을 생성한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		BackupAgentCreateRequest

Responses

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

Example HTTP request

Request path

/v1/backup-agents

Request header

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

Request body

{
    "server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366",
    "tags": [
        {
            "key": "",
            "value": ""
        }
    ]
}

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

2.1.6.2 - 1.0

post /v1/backup-agents

Description

Backup Agent을 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
body	body required		BackupAgentCreateRequest

Responses

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

Example HTTP request

Request path

/v1/backup-agents

Request header

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

Request body

{
    "server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366",
    "tags": [
        {
            "key": "",
            "value": ""
        }
    ]
}

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

2.1.7 - Delete Backup

2.1.7.1 - 1.1

delete /v1/backups/{backup_id}

Description

Backup을 해지한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None

Responses

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

Example HTTP request

Request path

/v1/backups/{backup_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 = backup 1.1"

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

2.1.7.2 - 1.0

delete /v1/backups/{backup_id}

Description

Backup을 해지한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None

Responses

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

Example HTTP request

Request path

/v1/backups/{backup_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 = backup 1.0"

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

2.1.8 - Delete Backup Agent

2.1.8.1 - 1.1

delete /v1/backup-agents/{backup_agent_id}

Description

Backup Agent를 해지한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_agent_id required	Backup Agent ID Example : `BACKUP_AGENT-abcd`	string	None

Responses

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

Example HTTP request

Request path

/v1/backup-agents/{backup_agent_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 = backup 1.1"

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

2.1.8.2 - 1.0

delete /v1/backup-agents/{backup_agent_id}

Description

Backup Agent를 해지한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_agent_id required	Backup Agent ID Example : `BACKUP_AGENT-abcd`	string	None

Responses

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

Example HTTP request

Request path

/v1/backup-agents/{backup_agent_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 = backup 1.0"

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

2.1.9 - Delete Backup Restore Target

2.1.9.1 - 1.1

delete /v1/backups/{backup_id}/restore-targets

Description

복구 대상을 삭제한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
body	body required		BackupRestoreTargetDeleteRequest

Responses

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

Example HTTP request

Request path

/v1/backups/{backup_id}/restore-targets

Request header

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

Request body

{
    "restore_target_ids": [
        "ca1a8e76-af49-40ea-93f8-a5989ffe138b"
    ]
}

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

2.1.9.2 - 1.0

delete /v1/backups/{backup_id}/restore-targets

Description

복구 대상을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
body	body required		BackupRestoreTargetDeleteRequest

Responses

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

Example HTTP request

Request path

/v1/backups/{backup_id}/restore-targets

Request header

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

Request body

{
    "restore_target_ids": [
        "ca1a8e76-af49-40ea-93f8-a5989ffe138b"
    ]
}

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

2.1.10 - List Agent Backup Restore Target Servers

2.1.10.1 - 1.1

get /v1/backups/{backup_id}/agent-backup-restore-targets

Description

복구 대상 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
query	server_name optional	Backup 서버명 Example : `server-001`	any of [string, null]	None
query	page optional	페이지 Example : `0`	any of [integer, null]	0
query	size optional	항목 수 Example : `20`	any of [integer, null]	5

Responses

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

Example HTTP request

Request path

/v1/backups/{backup_id}/agent-backup-restore-targets

Request header

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

Example HTTP response

Response 200

{
    "contents": [
        {
            "server_name": "server-001",
            "server_os_version": "UBUNTU 22.04",
            "server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366"
        }
    ],
    "count": 1
}

2.1.10.2 - 1.0

get /v1/backups/{backup_id}/agent-backup-restore-targets

Description

복구 대상 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
query	server_name optional	Backup 서버명 Example : `server-001`	any of [string, null]	None
query	page optional	페이지 Example : `0`	any of [integer, null]	0
query	size optional	항목 수 Example : `20`	any of [integer, null]	5

Responses

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

Example HTTP request

Request path

/v1/backups/{backup_id}/agent-backup-restore-targets

Request header

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

Example HTTP response

Response 200

{
    "contents": [
        {
            "server_name": "server-001",
            "server_os_version": "UBUNTU 22.04",
            "server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366"
        }
    ],
    "count": 1
}

2.1.11 - List Backup Agents

2.1.11.1 - 1.1

get /v1/backup-agents

Description

Backup 대상 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	Backup Agent명 Example : `agent_abcd12`	any of [string, null]	None
query	server_backup_agent_ip optional	대상 서버 Backup Agent IP Example : `11.22.33.44`	any of [string, null]	None
query	server_name optional	Backup Agent 대상 서버명 Example : `server-001`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/backup-agents

Request header

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

Example HTTP response

Response 200

{
    "contents": [
        {
            "account_id": "fnsd89fus0f9ds09f90dshf9dshfds09",
            "backup_policy_count": "3",
            "connection_state": "SUCCESS",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "BACKUP_AGENT-abcd",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "agent_abcd12",
            "server_backup_agent_ip": "11.22.33.44",
            "server_name": "server-001",
            "state": "AVAILABLE"
        }
    ],
    "count": 1
}

2.1.11.2 - 1.0

get /v1/backup-agents

Description

Backup 대상 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	Backup Agent명 Example : `agent_abcd12`	any of [string, null]	None
query	server_backup_agent_ip optional	대상 서버 Backup Agent IP Example : `11.22.33.44`	any of [string, null]	None
query	server_name optional	Backup Agent 대상 서버명 Example : `server-001`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/backup-agents

Request header

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

Example HTTP response

Response 200

{
    "contents": [
        {
            "account_id": "fnsd89fus0f9ds09f90dshf9dshfds09",
            "backup_policy_count": "3",
            "connection_state": "SUCCESS",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "BACKUP_AGENT-abcd",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "agent_abcd12",
            "server_backup_agent_ip": "11.22.33.44",
            "server_name": "server-001",
            "state": "AVAILABLE"
        }
    ],
    "count": 1
}

2.1.12 - List Backup Histories

2.1.12.1 - 1.1

get /v1/backups/{backup_id}/backup-histories

Description

Backup 이력을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
query	backup_start_time optional	시작 일시 Example : `2024-09-30T15:00:00Z`	any of [string (date-time), null]	None
query	backup_end_time optional	검색 종료 일시 Example : `2024-10-31T14:59:59Z`	any of [string (date-time), null]	None
query	backup_job_state optional	Backup 이력 상태 Example : `SUCCESS`	any of [enum (SUCCESS, PARTIAL_SUCCESS, FAILED, INPROGRESS, ALL), null]	None
query	page optional	페이지 Example : `0`	integer	0
query	size optional	항목 수 Example : `20`	integer	20
query	sort optional	정렬 조건 Example : `backup_start_time:desc`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/backups/{backup_id}/backup-histories

Request header

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

Example HTTP response

Response 200

{
    "contents": [
        {
            "backup_end_time": "2024-10-31T14:59:59Z",
            "backup_job_guid": "3b1da7ba-3f38-45cb-9538-e921826f80d7",
            "backup_job_state": "SUCCESS",
            "backup_start_time": "2024-09-30T15:00:00Z",
            "schedule_id": "f5b8e22b-0d88-4698-9996-fb44217c8227",
            "schedule_name": "INCREMENTAL_DAILY_15:00:00-chg4By"
        }
    ],
    "count": 1
}

2.1.12.2 - 1.0

get /v1/backups/{backup_id}/backup-histories

Description

Backup 이력을 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
query	backup_start_time optional	시작 일시 Example : `2024-09-30T15:00:00Z`	any of [string (date-time), null]	None
query	backup_end_time optional	검색 종료 일시 Example : `2024-10-31T14:59:59Z`	any of [string (date-time), null]	None
query	backup_job_state optional	Backup 이력 상태 Example : `SUCCESS`	any of [enum (SUCCESS, PARTIAL_SUCCESS, FAILED, INPROGRESS, ALL), null]	None
query	page optional	페이지 Example : `0`	integer	0
query	size optional	항목 수 Example : `20`	integer	20
query	sort optional	정렬 조건 Example : `backup_start_time:desc`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/backups/{backup_id}/backup-histories

Request header

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

Example HTTP response

Response 200

{
    "contents": [
        {
            "backup_end_time": "2024-10-31T14:59:59Z",
            "backup_job_guid": "3b1da7ba-3f38-45cb-9538-e921826f80d7",
            "backup_job_state": "SUCCESS",
            "backup_start_time": "2024-09-30T15:00:00Z",
            "schedule_id": "f5b8e22b-0d88-4698-9996-fb44217c8227",
            "schedule_name": "INCREMENTAL_DAILY_15:00:00-chg4By"
        }
    ],
    "count": 1
}

2.1.13 - List Backup Region Relationship

2.1.13.1 - 1.1

get /v1/backups/region-relationship

Description

List Backup Region Relationship.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	from_region optional	위치 Example : `kr-west1`	any of [string, null]	None
query	from_availability_zone optional	Availability Zone명 Example : `kr-west1`	any of [string, null]	None
query	to_region optional	위치 Example : `kr-west1`	any of [string, null]	None
query	to_availability_zone optional	Availability Zone명 Example : `kr-west1`	any of [string, null]	None
query	backup_master_type optional	Backup Master 유형 Example : `AGENTLESS`	any of [enum (AGENT, AGENTLESS, AGENT_SAP_INT, AGENT_SAP_EXT), null]	AGENTLESS

Responses

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

Example HTTP request

Request path

/v1/backups/region-relationship

Request header

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

Example HTTP response

Response 200

{
    "contents": [
        {
            "from_availability_zone": "kr-west1",
            "from_region": "kr-west1",
            "to_availability_zone": "kr-west1",
            "to_region": "kr-west1"
        }
    ],
    "count": ""
}

2.1.13.2 - 1.0

get /v1/backups/region-relationship

Description

List Backup Region Relationship.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
query	from_region optional	위치 Example : `kr-west1`	any of [string, null]	None
query	from_availability_zone optional	Availability Zone명 Example : `kr-west1`	any of [string, null]	None
query	to_region optional	위치 Example : `kr-west1`	any of [string, null]	None
query	to_availability_zone optional	Availability Zone명 Example : `kr-west1`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/backups/region-relationship

Request header

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

Example HTTP response

Response 200

{
    "contents": [
        {
            "from_availability_zone": "kr-west1",
            "from_region": "kr-west1",
            "to_availability_zone": "kr-west1",
            "to_region": "kr-west1"
        }
    ],
    "count": ""
}

2.1.14 - List Backup Restore Histories

2.1.14.1 - 1.1

get /v1/backups/{backup_id}/restore-histories

Description

복구 이력을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
query	page optional	페이지 Example : `0`	any of [integer, null]	0
query	size optional	항목 수 Example : `20`	any of [integer, null]	20
query	sort optional	정렬 조건 Example : `backup_start_time:desc`	any of [string, null]	created_at:desc
query	restore_state optional	복구 상태 Example : `COMPLETED`	any of [enum (COMPLETED, FAILED, INPROGRESS), null]	None
query	start_time optional	시작 일시 Example : `2024-09-30T15:00:00Z`	any of [string (date-time), null]	None
query	end_time optional	검색 종료 일시 Example : `2024-10-31T14:59:59Z`	any of [string (date-time), null]	None

Responses

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

Example HTTP request

Request path

/v1/backups/{backup_id}/restore-histories

Request header

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

Example HTTP response

Response 200

{
    "contents": [
        {
            "backup_id": "00cd2538fbf94d12b36aabbdd607e974",
            "backup_start_time": "2024-10-28T05:38:48",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "restore_end_time": "2024-10-28T05:52:47",
            "restore_server_id": "26895cb7-2059-49e7-b6fe-9c9c4b0d3db0",
            "restore_server_name": "restoretest1",
            "restore_start_time": "2024-10-28T05:52:47",
            "restore_state": "COMPLETED",
            "schedule_name": "INCREMENTAL_DAILY_15:00:00-chg4By"
        }
    ],
    "count": 1
}

2.1.14.2 - 1.0

get /v1/backups/{backup_id}/restore-histories

Description

복구 이력을 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
query	page optional	페이지 Example : `0`	any of [integer, null]	0
query	size optional	항목 수 Example : `20`	any of [integer, null]	20
query	sort optional	정렬 조건 Example : `backup_start_time:desc`	any of [string, null]	created_at:desc
query	restore_state optional	복구 상태 Example : `COMPLETED`	any of [enum (COMPLETED, FAILED, INPROGRESS), null]	None
query	start_time optional	시작 일시 Example : `2024-09-30T15:00:00Z`	any of [string (date-time), null]	None
query	end_time optional	검색 종료 일시 Example : `2024-10-31T14:59:59Z`	any of [string (date-time), null]	None

Responses

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

Example HTTP request

Request path

/v1/backups/{backup_id}/restore-histories

Request header

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

Example HTTP response

Response 200

{
    "contents": [
        {
            "backup_id": "00cd2538fbf94d12b36aabbdd607e974",
            "backup_start_time": "2024-10-28T05:38:48",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "restore_end_time": "2024-10-28T05:52:47",
            "restore_server_id": "26895cb7-2059-49e7-b6fe-9c9c4b0d3db0",
            "restore_server_name": "restoretest1",
            "restore_start_time": "2024-10-28T05:52:47",
            "restore_state": "COMPLETED",
            "schedule_name": "INCREMENTAL_DAILY_15:00:00-chg4By"
        }
    ],
    "count": 1
}

2.1.15 - List Backup Restore Subnets

2.1.15.1 - 1.1

get /v1/backups/{backup_id}/restore/restorable-subnets

Description

원본 서버와 다른 위치에 복구하기 위해 서브넷 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
query	vpc_id optional	VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	state optional	Subnet 상태 Example : `ACTIVE`	any of [string, null]	None
query	region required	서버를 복구할 리전 Example : `kr-west1`	string	None

Responses

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

Example HTTP request

Request path

/v1/backups/{backup_id}/restore/restorable-subnets?region={region}

Request header

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

Example HTTP response

Response 200

{
    "count": 1,
    "subnets": [
        {
            "account_id": "fnsd89fus0f9ds09f90dshf9dshfds09",
            "cidr": "192.167.1.0/24",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "gateway_ip_address": "192.167.1.1",
            "id": "023c57b14f11483689338d085e061492",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "subnetName",
            "state": "ACTIVE",
            "type": "GENERAL",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ]
}

2.1.15.2 - 1.0

get /v1/backups/{backup_id}/restore/restorable-subnets

Description

원본 서버와 다른 위치에 복구하기 위해 서브넷 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
query	vpc_id optional	VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	state optional	Subnet 상태 Example : `ACTIVE`	any of [string, null]	None
query	region required	서버를 복구할 리전 Example : `kr-west1`	string	None

Responses

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

Example HTTP request

Request path

/v1/backups/{backup_id}/restore/restorable-subnets?region={region}

Request header

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

Example HTTP response

Response 200

{
    "count": 1,
    "subnets": [
        {
            "account_id": "fnsd89fus0f9ds09f90dshf9dshfds09",
            "cidr": "192.167.1.0/24",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "gateway_ip_address": "192.167.1.1",
            "id": "023c57b14f11483689338d085e061492",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "subnetName",
            "state": "ACTIVE",
            "type": "GENERAL",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ]
}

2.1.16 - List Backup Restore Targets

2.1.16.1 - 1.1

get /v1/backups/{backup_id}/restore-targets

Description

복구 대상 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
query	backup_start_time optional	시작 일시 Example : `2024-09-30T15:00:00Z`	any of [string (date-time), null]	None
query	backup_end_time optional	검색 종료 일시 Example : `2024-10-31T14:59:59Z`	any of [string (date-time), null]	None
query	page optional	페이지 Example : `0`	integer	0
query	size optional	항목 수 Example : `20`	integer	20
query	sort optional	정렬 조건 Example : `backup_start_time:desc`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/backups/{backup_id}/restore-targets

Request header

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

Example HTTP response

Response 200

{
    "contents": [
        {
            "backup_start_time": "2024-09-30T15:00:00Z",
            "is_restore_available": "true",
            "restore_target_id": "ca1a8e76-af49-40ea-93f8-a5989ffe138b",
            "retention_period": "WEEK_2",
            "schedule_id": "f5b8e22b-0d88-4698-9996-fb44217c8227",
            "schedule_name": "INCREMENTAL_DAILY_15:00:00-chg4By",
            "usage_gb": "123.4"
        }
    ],
    "count": 1
}

2.1.16.2 - 1.0

get /v1/backups/{backup_id}/restore-targets

Description

복구 대상 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
query	backup_start_time optional	시작 일시 Example : `2024-09-30T15:00:00Z`	any of [string (date-time), null]	None
query	backup_end_time optional	검색 종료 일시 Example : `2024-10-31T14:59:59Z`	any of [string (date-time), null]	None
query	page optional	페이지 Example : `0`	integer	0
query	size optional	항목 수 Example : `20`	integer	20
query	sort optional	정렬 조건 Example : `backup_start_time:desc`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/backups/{backup_id}/restore-targets

Request header

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

Example HTTP response

Response 200

{
    "contents": [
        {
            "backup_start_time": "2024-09-30T15:00:00Z",
            "is_restore_available": "true",
            "restore_target_id": "ca1a8e76-af49-40ea-93f8-a5989ffe138b",
            "retention_period": "WEEK_2",
            "schedule_id": "f5b8e22b-0d88-4698-9996-fb44217c8227",
            "schedule_name": "INCREMENTAL_DAILY_15:00:00-chg4By",
            "usage_gb": "123.4"
        }
    ],
    "count": 1
}

2.1.17 - List Backup Schedules

2.1.17.1 - 1.1

get /v1/backups/{backup_id}/schedules

Description

스케줄 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None

Responses

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

Example HTTP request

Request path

/v1/backups/{backup_id}/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 = backup 1.1"

Example HTTP response

Response 200

{
    "contents": [
        {
            "backup_id": "00cd2538fbf94d12b36aabbdd607e974",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "frequency": "DAILY",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "INCREMENTAL_DAILY_15:00:00-chg4By",
            "start_day": "MON",
            "start_time": "14:00:00",
            "start_week": "WEEK_1",
            "state": "AVAILABLE",
            "type": "FULL"
        }
    ],
    "count": 1
}

2.1.17.2 - 1.0

get /v1/backups/{backup_id}/schedules

Description

스케줄 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None

Responses

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

Example HTTP request

Request path

/v1/backups/{backup_id}/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 = backup 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "backup_id": "00cd2538fbf94d12b36aabbdd607e974",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "frequency": "DAILY",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "INCREMENTAL_DAILY_15:00:00-chg4By",
            "start_day": "MON",
            "start_time": "14:00:00",
            "start_week": "WEEK_1",
            "state": "AVAILABLE",
            "type": "FULL"
        }
    ],
    "count": 1
}

2.1.18 - List Backup Targets

2.1.18.1 - 1.1

get /v1/backups/backup-targets

Description

Backup 대상 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	server_name optional	Backup 서버명 Example : `server-001`	any of [string, null]	None
query	server_category required	대상 서버 카테고리 Example : `VIRTUAL_SERVER \| GPU_SERVER \| BAREMETAL_SERVER`	enum (VIRTUAL_SERVER, GPU_SERVER, BAREMETAL_SERVER)	None
query	region optional	위치 Example : `kr-west1`	any of [string, null]	None
query	page optional	페이지 Example : `0`	any of [integer, null]	0
query	size optional	항목 수 Example : `20`	any of [integer, null]	5

Responses

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

Example HTTP request

Request path

/v1/backups/backup-targets?server_category={server_category}

Request header

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

Example HTTP response

Response 200

{
    "contents": [
        {
            "server_guid": "9ab33c66-3dbd-46cd-b0af-abccd3eb3170",
            "server_name": "server-001",
            "server_os_version": "UBUNTU 22.04",
            "server_type": "s1v1m2",
            "server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366"
        }
    ],
    "count": 1
}

2.1.18.2 - 1.0

get /v1/backups/backup-targets

Description

Backup 대상 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
query	server_name optional	Backup 서버명 Example : `server-001`	any of [string, null]	None
query	server_category required	대상 서버 카테고리 Example : `VIRTUAL_SERVER \| GPU_SERVER \| BAREMETAL_SERVER`	enum (VIRTUAL_SERVER, GPU_SERVER, BAREMETAL_SERVER)	None
query	region optional	위치 Example : `kr-west1`	any of [string, null]	None
query	page optional	페이지 Example : `0`	any of [integer, null]	0
query	size optional	항목 수 Example : `20`	any of [integer, null]	5

Responses

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

Example HTTP request

Request path

/v1/backups/backup-targets?server_category={server_category}

Request header

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

Example HTTP response

Response 200

{
    "contents": [
        {
            "server_guid": "9ab33c66-3dbd-46cd-b0af-abccd3eb3170",
            "server_name": "server-001",
            "server_os_version": "UBUNTU 22.04",
            "server_type": "s1v1m2",
            "server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366"
        }
    ],
    "count": 1
}

2.1.19 - List Backups

2.1.19.1 - 1.1

get /v1/backups

Description

Backup 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	Backup명 Example : `backup-001`	any of [string, null]	None
query	server_name optional	Backup 서버명 Example : `server-001`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/backups

Request header

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

Example HTTP response

Response 200

{
    "contents": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "backup-001",
            "policy_type": "VM_IMAGE",
            "retention_period": "WEEK_2",
            "role_type": "ORIGINAL",
            "server_name": "server-001",
            "state": "AVAILABLE"
        }
    ],
    "count": 1
}

2.1.19.2 - 1.0

get /v1/backups

Description

Backup 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	Backup명 Example : `backup-001`	any of [string, null]	None
query	server_name optional	Backup 서버명 Example : `server-001`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/backups

Request header

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

Example HTTP response

Response 200

{
    "contents": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "backup-001",
            "policy_type": "VM_IMAGE",
            "retention_period": "WEEK_2",
            "role_type": "ORIGINAL",
            "server_name": "server-001",
            "state": "AVAILABLE"
        }
    ],
    "count": 1
}

2.1.20 - List Targets of Backup Agent

2.1.20.1 - 1.1

get /v1/backup-agents/targets

Description

Backup Agent 대상 서버 목록

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	정렬 조건 Example : `server_name:asc`	any of [string, null]	server_name:asc
query	server_category required	대상 서버 카테고리 Example : `BAREMETAL_SERVER`	string	None
query	server_name optional	Backup 서버명 Example : `server-001`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/backup-agents/targets?server_category={server_category}

Request header

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

Example HTTP response

Response 200

{
    "contents": [
        {
            "server_backup_agent_ip": "11.22.33.44",
            "server_name": "server-001",
            "server_state": "RUNNING",
            "server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366"
        }
    ],
    "count": 1
}

2.1.20.2 - 1.0

get /v1/backup-agents/targets

Description

Backup Agent 대상 서버 목록

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	정렬 조건 Example : `server_name:asc`	any of [string, null]	server_name:asc
query	server_category required	대상 서버 카테고리 Example : `BAREMETAL_SERVER`	string	None
query	server_name optional	Backup 서버명 Example : `server-001`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/backup-agents/targets?server_category={server_category}

Request header

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

Example HTTP response

Response 200

{
    "contents": [
        {
            "server_backup_agent_ip": "11.22.33.44",
            "server_name": "server-001",
            "server_state": "RUNNING",
            "server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366"
        }
    ],
    "count": 1
}

2.1.21 - Manual Backup

2.1.21.1 - 1.1

post /v1/backups/{backup_id}/manual-backup

Description

즉시 Backup을 수행한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None

Responses

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

Example HTTP request

Request path

/v1/backups/{backup_id}/manual-backup

Request header

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

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

2.1.21.2 - 1.0

post /v1/backups/{backup_id}/manual-backup

Description

즉시 Backup을 수행한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None

Responses

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

Example HTTP request

Request path

/v1/backups/{backup_id}/manual-backup

Request header

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

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

2.1.22 - Restore Agent Backup

2.1.22.1 - 1.1

post /v1/backups/{backup_id}/restore-agent-backup

Description

백업을 복구한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
body	body required		AgentBackupRestoreRequest

Responses

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

Example HTTP request

Request path

/v1/backups/{backup_id}/restore-agent-backup

Request header

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

Request body

{
    "filesystem_paths": [
        {
            "destination": "/data",
            "source": "/data"
        }
    ],
    "overwrite": true,
    "restore_server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366",
    "restore_target_id": "ca1a8e76-af49-40ea-93f8-a5989ffe138b"
}

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

2.1.22.2 - 1.0

post /v1/backups/{backup_id}/restore-agent-backup

Description

백업을 복구한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
body	body required		AgentBackupRestoreRequest

Responses

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

Example HTTP request

Request path

/v1/backups/{backup_id}/restore-agent-backup

Request header

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

Request body

{
    "filesystem_paths": [
        {
            "destination": "/data",
            "source": "/data"
        }
    ],
    "overwrite": true,
    "restore_server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366",
    "restore_target_id": "ca1a8e76-af49-40ea-93f8-a5989ffe138b"
}

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

2.1.23 - Restore Backup

2.1.23.1 - 1.1

post /v1/backups/{backup_id}/restore

Description

백업을 복구한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
body	body required		BackupRestoreRequest

Responses

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

Example HTTP request

Request path

/v1/backups/{backup_id}/restore

Request header

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

Request body

{
    "networks": [
        {
            "subnet_id": "023c57b14f11483689338d085e061492"
        }
    ],
    "restore_region": "kr-west1",
    "restore_server_name": "restoretest1",
    "restore_target_id": "ca1a8e76-af49-40ea-93f8-a5989ffe138b",
    "security_groups": [
        "023c57b14f11483689338d085e061492"
    ],
    "server_type_id": "s1v1m2"
}

Example HTTP response

Response 202

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

2.1.23.2 - 1.0

post /v1/backups/{backup_id}/restore

Description

백업을 복구한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
body	body required		BackupRestoreRequest

Responses

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

Example HTTP request

Request path

/v1/backups/{backup_id}/restore

Request header

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

Request body

{
    "networks": [
        {
            "subnet_id": "023c57b14f11483689338d085e061492"
        }
    ],
    "restore_region": "kr-west1",
    "restore_server_name": "restoretest1",
    "restore_target_id": "ca1a8e76-af49-40ea-93f8-a5989ffe138b",
    "security_groups": [
        "023c57b14f11483689338d085e061492"
    ],
    "server_type_id": "s1v1m2"
}

Example HTTP response

Response 202

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

2.1.24 - Set Backup Schedule

2.1.24.1 - 1.1

put /v1/backups/{backup_id}/schedules

Description

스케줄 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
body	body required		ModifyBackupSchedulesRequest

Responses

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

Example HTTP request

Request path

/v1/backups/{backup_id}/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 = backup 1.1"

Request body

{
    "schedules": [
        {
            "frequency": "DAILY",
            "start_day": "MON",
            "start_time": "09:00:00",
            "start_week": "WEEK_2",
            "type": "FULL"
        }
    ]
}

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

2.1.24.2 - 1.0

put /v1/backups/{backup_id}/schedules

Description

스케줄 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
body	body required		ModifyBackupSchedulesRequest

Responses

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

Example HTTP request

Request path

/v1/backups/{backup_id}/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 = backup 1.0"

Request body

{
    "schedules": [
        {
            "frequency": "DAILY",
            "start_day": "MON",
            "start_time": "09:00:00",
            "start_week": "WEEK_2",
            "type": "FULL"
        }
    ]
}

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

2.1.25 - Set Filesystem Path

2.1.25.1 - 1.1

put /v1/backups/{backup_id}/filesystem-path

Description

파일 시스템 경로 설정

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
body	body required		FileSystemPathUpdateRequest

Responses

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

Example HTTP request

Request path

/v1/backups/{backup_id}/filesystem-path

Request header

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

Request body

{
    "backup_filesystem_paths": [
        "/aaa",
        "/bbb"
    ]
}

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

2.1.25.2 - 1.0

put /v1/backups/{backup_id}/filesystem-path

Description

파일 시스템 경로 설정

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
body	body required		FileSystemPathUpdateRequest

Responses

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

Example HTTP request

Request path

/v1/backups/{backup_id}/filesystem-path

Request header

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

Request body

{
    "backup_filesystem_paths": [
        "/aaa",
        "/bbb"
    ]
}

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

2.1.26 - Show Backup

2.1.26.1 - 1.1

get /v1/backups/{backup_id}

Description

Backup을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None

Responses

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

Example HTTP request

Request path

/v1/backups/{backup_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 = backup 1.1"

Example HTTP response

Response 200

{
    "backup_agent_id": "BACKUP_AGENT-abcd",
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "dr_enabled": false,
    "dr_region": "kr-west1",
    "encrypt_enabled": false,
    "filesystem_paths": [
        "/aaa",
        "/bbb"
    ],
    "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "backup-001",
    "origin_backup_id": "00cd2538fbf94d12b36aabbdd607e974",
    "policy_category": "AGENTLESS",
    "policy_type": "VM_IMAGE",
    "region": "kr-west1",
    "replica_backup_id": "00cd2538fbf94d12b36aabbdd607e974",
    "retention_period": "WEEK_2",
    "role_type": "ORIGINAL",
    "server_category": "VIRTUAL_SERVER | GPU_SERVER | BAREMETAL_SERVER",
    "server_name": "server-001",
    "server_os_type": "WINDOWS",
    "server_region": "kr-west1",
    "server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366",
    "state": "AVAILABLE"
}

2.1.26.2 - 1.0

get /v1/backups/{backup_id}

Description

Backup을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None

Responses

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

Example HTTP request

Request path

/v1/backups/{backup_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 = backup 1.0"

Example HTTP response

Response 200

{
    "backup_agent_id": "BACKUP_AGENT-abcd",
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "encrypt_enabled": false,
    "filesystem_paths": [
        "/aaa",
        "/bbb"
    ],
    "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "backup-001",
    "policy_category": "AGENTLESS",
    "policy_type": "VM_IMAGE",
    "region": "kr-west1",
    "retention_period": "WEEK_2",
    "role_type": "ORIGINAL",
    "server_category": "VIRTUAL_SERVER | GPU_SERVER | BAREMETAL_SERVER",
    "server_name": "server-001",
    "server_os_type": "WINDOWS",
    "server_region": "kr-west1",
    "server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366",
    "state": "AVAILABLE"
}

2.1.27 - Show Backup Agent

2.1.27.1 - 1.1

get /v1/backup-agents/{backup_agent_id}

Description

Backup Agent를 상세 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_agent_id required	Backup Agent ID Example : `BACKUP_AGENT-abcd`	string	None

Responses

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

Example HTTP request

Request path

/v1/backup-agents/{backup_agent_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 = backup 1.1"

Example HTTP response

Response 200

{
    "account_id": "fnsd89fus0f9ds09f90dshf9dshfds09",
    "backup_master_ip": "33.44.55.66",
    "backup_master_name": "backupmastertest",
    "backup_policy_count": "3",
    "connection_check_time": "2024-11-11T09:13:48Z",
    "connection_state": "SUCCESS",
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "id": "BACKUP_AGENT-abcd",
    "install_file_path": "http://linux-agent",
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "agent_abcd12",
    "server_backup_agent_ip": "11.22.33.44",
    "server_category": "VIRTUAL_SERVER | GPU_SERVER | BAREMETAL_SERVER",
    "server_gateway_ip": "22.33.44.55",
    "server_name": "server-001",
    "server_os_type": "WINDOWS",
    "server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366",
    "state": "AVAILABLE"
}

2.1.27.2 - 1.0

get /v1/backup-agents/{backup_agent_id}

Description

Backup Agent를 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_agent_id required	Backup Agent ID Example : `BACKUP_AGENT-abcd`	string	None

Responses

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

Example HTTP request

Request path

/v1/backup-agents/{backup_agent_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 = backup 1.0"

Example HTTP response

Response 200

{
    "account_id": "fnsd89fus0f9ds09f90dshf9dshfds09",
    "backup_master_ip": "33.44.55.66",
    "backup_master_name": "backupmastertest",
    "backup_policy_count": "3",
    "connection_check_time": "2024-11-11T09:13:48Z",
    "connection_state": "SUCCESS",
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "id": "BACKUP_AGENT-abcd",
    "install_file_path": "http://linux-agent",
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "agent_abcd12",
    "server_backup_agent_ip": "11.22.33.44",
    "server_category": "VIRTUAL_SERVER | GPU_SERVER | BAREMETAL_SERVER",
    "server_gateway_ip": "22.33.44.55",
    "server_name": "server-001",
    "server_os_type": "WINDOWS",
    "server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366",
    "state": "AVAILABLE"
}

2.1.28 - Show Backup Agent Install File Path

2.1.28.1 - 1.1

get /v1/backup-agents/agent-install-file-path

Description

Backup Agent 설치 파일 경로 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	os_type required	OS 유형 Example :	string	None

Responses

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

Example HTTP request

Request path

/v1/backup-agents/agent-install-file-path?os_type={os_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 = backup 1.1"

Example HTTP response

Response 200

{
    "install_file_path": "http://linux-agent"
}

2.1.28.2 - 1.0

get /v1/backup-agents/agent-install-file-path

Description

Backup Agent 설치 파일 경로 조회

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
query	os_type required	OS 유형 Example :	string	None

Responses

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

Example HTTP request

Request path

/v1/backup-agents/agent-install-file-path?os_type={os_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 = backup 1.0"

Example HTTP response

Response 200

{
    "install_file_path": "http://linux-agent"
}

2.1.29 - Update Replication Use

2.1.29.1 - 1.1

put /v1/backups/{backup_id}/replication

Description

복제 사용 여부를 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
body	body required		BackupReplicationUseUpdateBody

Responses

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

Example HTTP request

Request path

/v1/backups/{backup_id}/replication

Request header

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

Request body

{
    "dr_enabled": false
}

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

2.1.29.2 - 1.0

put /v1/backups/{backup_id}/replication

Description

복제 사용 여부를 수정한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
body	body required		BackupReplicationUseUpdateBody

Responses

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

Example HTTP request

Request path

/v1/backups/{backup_id}/replication

Request header

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

Request body

{
    "dr_enabled": false
}

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

2.1.30 - Update Retention Period

2.1.30.1 - 1.1

put /v1/backups/{backup_id}/retention-period

Description

보관 기간을 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
body	body required		RetentionPeriodUpdateBody

Responses

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

Example HTTP request

Request path

/v1/backups/{backup_id}/retention-period

Request header

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

Request body

{
    "retention_period": "WEEK_2"
}

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

2.1.30.2 - 1.0

put /v1/backups/{backup_id}/retention-period

Description

보관 기간을 수정한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
body	body required		RetentionPeriodUpdateBody

Responses

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

Example HTTP request

Request path

/v1/backups/{backup_id}/retention-period

Request header

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

Request body

{
    "retention_period": "WEEK_2"
}

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

2.2 - Models

2.2.1 - AgentBackupRestoreRequest

Name	Description	Schema
filesystem_paths required	백업 대상 파일 시스템 경로	array[RestoreFilesystemPath]
overwrite optional	덮어쓰기 Example : `True`	any of [boolean, null]
restore_server_uuid required	복구 서버 ID Example : `89f5ef44-1021-4a5c-8e06-fbb289eac366`	string
restore_target_id required	복구 대상 목록 Example : `ca1a8e76-af49-40ea-93f8-a5989ffe138b`	string

2.2.2 - AgentBackupRestoreTargetServerListResponse

Name	Description	Schema	Default
contents optional	복구 대상 목록	any of [array[AgentBackupRestoreTargetServerResponse], null]
count required	갯수 Example : `1`	integer

2.2.3 - AgentBackupRestoreTargetServerResponse

Name	Description	Schema
server_name required	Backup 서버명 Example : `server-001`	string
server_os_version required	서버의 OS Type 과 버전 Example : `UBUNTU 22.04`	string
server_uuid required	Backup 서버 UUID Example : `89f5ef44-1021-4a5c-8e06-fbb289eac366`	string

2.2.4 - AsyncResponse

Name	Description	Schema	Default
request_id required	요청 ID Example :	string
resource required	자원	ResourceInfo

2.2.5 - BackupAgentCreateRequest

Name	Description	Schema	Default
server_uuid required	Backup Agent 대상 서버 UUID Example : `89f5ef44-1021-4a5c-8e06-fbb289eac366`	string
tags optional		any of [array[Tag], null]

2.2.6 - BackupAgentDetailResponse

Name	Description	Schema
account_id required	Account ID Example : `fnsd89fus0f9ds09f90dshf9dshfds09`	any of [string, null]
backup_master_ip required	Backup Master IP Example : `33.44.55.66`	any of [string, null]
backup_master_name required	Backup Master명 Example : `backupmastertest`	any of [string, null]
backup_policy_count required	Backup 정책 수 Example : `3`	any of [integer, null]
connection_check_time required	Backup Agent 연결 확인 시간 Example : `2024-11-11T09:13:48Z`	any of [string (date-time), null]
connection_state required	Backup Agent 연결 상태 Example : `SUCCESS`	any of [string, null]
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
id required	Backup Agent ID Example : `BACKUP_AGENT-abcd`	any of [string, null]
install_file_path required	설치 파일 경로 Example : `http://linux-agent`	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Backup Agent명 Example : `agent_abcd12`	any of [string, null]
server_backup_agent_ip required	대상 서버 Backup Agent IP Example : `11.22.33.44`	any of [string, null]
server_category required	대상 서버 카테고리 Example : `VIRTUAL_SERVER \| GPU_SERVER \| BAREMETAL_SERVER`	any of [string, null]
server_gateway_ip required	서버 Gateway IP Example : `22.33.44.55`	any of [string, null]
server_name required	Backup Agent 대상 서버명 Example : `server-001`	any of [string, null]
server_os_type required	서버 OS Type Example : `WINDOWS`	any of [string, null]
server_uuid required	Backup Agent 대상 서버 UUID Example : `89f5ef44-1021-4a5c-8e06-fbb289eac366`	any of [string, null]
state required	Backup Agent 상태 Example : `AVAILABLE`	any of [string, null]

2.2.7 - BackupAgentListResponse

Name	Description	Schema	Default
contents required	Backup 대상 목록	any of [array[BackupAgentResponse], null]
count optional	갯수 Example : `1`	any of [integer, null]

2.2.8 - BackupAgentResponse

Name	Description	Schema
account_id required	Account ID Example : `fnsd89fus0f9ds09f90dshf9dshfds09`	any of [string, null]
backup_policy_count required	Backup 정책 수 Example : `3`	any of [integer, null]
connection_state required	Backup Agent 연결 상태 Example : `SUCCESS`	any of [string, null]
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
id required	Backup Agent ID Example : `BACKUP_AGENT-abcd`	any of [string, null]
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Backup Agent명 Example : `agent_abcd12`	any of [string, null]
server_backup_agent_ip required	대상 서버 Backup Agent IP Example : `11.22.33.44`	any of [string, null]
server_name required	Backup 서버명 Example : `server-001`	any of [string, null]
state required	Backup Agent 상태 Example : `AVAILABLE`	any of [string, null]

2.2.9 - BackupAgentTargetListResponse

Name	Description	Schema	Default
contents required	Backup 대상 목록	any of [array[BackupAgentTargetResponse], null]
count optional	갯수 Example : `1`	any of [integer, null]

2.2.10 - BackupAgentTargetResponse

Name	Description	Schema
server_backup_agent_ip required	대상 서버 Backup Agent IP Example : `11.22.33.44`	string
server_name required	Backup Agent 대상 서버명 Example : `server-001`	string
server_state required	Backup 서버 상태 Example : `RUNNING`	string
server_uuid required	Backup Agent 대상 서버 UUID Example : `89f5ef44-1021-4a5c-8e06-fbb289eac366`	string

2.2.11 - BackupCreateRequest

Name	Description	Schema	Default
encrypt_enabled optional	암호화 사용 여부 Example : `True`	boolean	True
filesystem_paths optional	백업 대상 파일 시스템 경로 Example : `['/aaa', '/bbb']`	any of [array[string], null]
name required	Backup명 Example : `backup-001`	string
policy_category required	Backup 정책 카테고리 Example : `AGENTLESS`	enum (AGENTLESS, AGENT)
policy_type required	Backup 정책 유형 Example : `VM_IMAGE`	enum (VM_IMAGE, FILESYSTEM)
region optional	위치 Example : `kr-west1`	any of [string, null]
retention_period optional	Backup 보관 기간 Example : `WEEK_2`	enum (WEEK_2, MONTH_1, MONTH_3, MONTH_6, YEAR_1)	WEEK_2
schedules required	스케줄 목록	array[BackupScheduleCreateRequest]
server_category required	대상 서버 카테고리 Example : `VIRTUAL_SERVER \| GPU_SERVER \| BAREMETAL_SERVER`	enum (VIRTUAL_SERVER, GPU_SERVER, BAREMETAL_SERVER)
server_guid optional	Backup 서버 GUID Example : `9ab33c66-3dbd-46cd-b0af-abccd3eb3170`	any of [string, null]
server_uuid required	Backup 서버 UUID Example : `89f5ef44-1021-4a5c-8e06-fbb289eac366`	string
tags optional		any of [array[Tag], null]

2.2.12 - BackupCreateRequest1Dot1

Name	Description	Schema	Default
dr_enabled optional	DR 사용 여부 Example : `False`	any of [boolean, null]
encrypt_enabled optional	암호화 사용 여부 Example : `True`	boolean	True
filesystem_paths optional	백업 대상 파일 시스템 경로 Example : `['/aaa', '/bbb']`	any of [array[string], null]
name required	Backup명 Example : `backup-001`	string
policy_category required	Backup 정책 카테고리 Example : `AGENTLESS`	enum (AGENTLESS, AGENT)
policy_type required	Backup 정책 유형 Example : `VM_IMAGE`	enum (VM_IMAGE, FILESYSTEM)
region optional	위치 Example : `kr-west1`	any of [string, null]
retention_period optional	Backup 보관 기간 Example : `WEEK_2`	enum (WEEK_2, MONTH_1, MONTH_3, MONTH_6, YEAR_1)	WEEK_2
schedules required	스케줄 목록	array[BackupScheduleCreateRequest]
server_category required	대상 서버 카테고리 Example : `VIRTUAL_SERVER \| GPU_SERVER \| BAREMETAL_SERVER`	enum (VIRTUAL_SERVER, GPU_SERVER, BAREMETAL_SERVER)
server_guid optional	Backup 서버 GUID Example : `9ab33c66-3dbd-46cd-b0af-abccd3eb3170`	any of [string, null]
server_uuid required	Backup 서버 UUID Example : `89f5ef44-1021-4a5c-8e06-fbb289eac366`	string
tags optional		any of [array[Tag], null]

2.2.13 - BackupDetailResponse

Name	Description	Schema
backup_agent_id optional	Backup Agent ID Example : `BACKUP_AGENT-abcd`	any of [string, null]
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
encrypt_enabled optional	암호화 사용 여부 Example : `False`	any of [boolean, null]
filesystem_paths optional	백업 대상 파일 시스템 경로 Example : `['/aaa', '/bbb']`	any of [array[string], null]
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Backup명 Example : `backup-001`	string
policy_category required	Backup 정책 카테고리 Example : `AGENTLESS`	string
policy_type required	Backup 정책 유형 Example : `VM_IMAGE`	string
region optional	위치 Example : `kr-west1`	any of [string, null]
retention_period required	Backup 보관 기간 Example : `WEEK_2`	string
role_type required	백업 역할 유형 Example : `ORIGINAL`	string
server_category required	대상 서버 카테고리 Example : `VIRTUAL_SERVER \| GPU_SERVER \| BAREMETAL_SERVER`	string
server_name required	Backup 서버명 Example : `server-001`	string
server_os_type optional	서버 OS Type Example : `WINDOWS`	any of [string, null]
server_region required	위치 Example : `kr-west1`	any of [string, null]
server_uuid required	Backup 서버 UUID Example : `89f5ef44-1021-4a5c-8e06-fbb289eac366`	string
state required	Backup 상태 Example : `AVAILABLE`	string

2.2.14 - BackupDetailResponse1Dot1

Name	Description	Schema
backup_agent_id optional	Backup Agent ID Example : `BACKUP_AGENT-abcd`	any of [string, null]
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
dr_enabled optional	DR 사용 여부 Example : `False`	any of [boolean, null]
dr_region optional	DR Region Example : `kr-west1`	any of [string, null]
encrypt_enabled optional	암호화 사용 여부 Example : `False`	any of [boolean, null]
filesystem_paths optional	백업 대상 파일 시스템 경로 Example : `['/aaa', '/bbb']`	any of [array[string], null]
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Backup명 Example : `backup-001`	string
origin_backup_id optional	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	any of [string, null]
policy_category required	Backup 정책 카테고리 Example : `AGENTLESS`	string
policy_type required	Backup 정책 유형 Example : `VM_IMAGE`	string
region optional	위치 Example : `kr-west1`	any of [string, null]
replica_backup_id optional	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	any of [string, null]
retention_period required	Backup 보관 기간 Example : `WEEK_2`	string
role_type required	백업 역할 유형 Example : `ORIGINAL`	string
server_category required	대상 서버 카테고리 Example : `VIRTUAL_SERVER \| GPU_SERVER \| BAREMETAL_SERVER`	string
server_name required	Backup 서버명 Example : `server-001`	string
server_os_type optional	서버 OS Type Example : `WINDOWS`	any of [string, null]
server_region required	위치 Example : `kr-west1`	any of [string, null]
server_uuid required	Backup 서버 UUID Example : `89f5ef44-1021-4a5c-8e06-fbb289eac366`	string
state required	Backup 상태 Example : `AVAILABLE`	string

2.2.15 - BackupHistoryListResponse

Name	Description	Schema	Default
contents required	Backup 이력 목록	any of [array[BackupHistoryResponse], null]
count required	갯수 Example : `1`	integer

2.2.16 - BackupHistoryResponse

Name	Description	Schema
backup_end_time required	검색 종료 일시 Example : `2024-10-31T14:59:59Z`	any of [string (date-time), null]
backup_job_guid required	Backup job GUID Example : `3b1da7ba-3f38-45cb-9538-e921826f80d7`	any of [string, null]
backup_job_state required	Backup 이력 상태 Example : `SUCCESS`	string
backup_start_time required	시작 일시 Example : `2024-09-30T15:00:00Z`	any of [string (date-time), null]
schedule_id required	스케줄 ID Example : `f5b8e22b-0d88-4698-9996-fb44217c8227`	string
schedule_name required	스케줄명 Example : `INCREMENTAL_DAILY_15:00:00-chg4By`	string

2.2.17 - BackupListRegionRelationshipResponse

Name	Description	Schema	Default
contents required	백업 Region 관계 목록	any of [array[BackupRegionRelationshipResponse], null]
count optional	전체 개수 Example :	any of [integer, null]

2.2.18 - BackupListResponse

Name	Description	Schema	Default
contents required	Backup 목록	any of [array[BackupResponse], null]
count optional	갯수 Example : `1`	any of [integer, null]

2.2.19 - BackupNameDuplicateResponse

Name	Description	Schema	Default
result required	결과 Example : `True`	boolean

2.2.20 - BackupRegionRelationshipResponse

Name	Description	Schema
from_availability_zone optional	Availability Zone명 Example : `kr-west1`	any of [string, null]
from_region optional	위치 Example : `kr-west1`	any of [string, null]
to_availability_zone optional	Availability Zone명 Example : `kr-west1`	any of [string, null]
to_region optional	위치 Example : `kr-west1`	any of [string, null]

2.2.21 - BackupReplicationUseUpdateBody

Name	Description	Schema	Default
dr_enabled required	DR 사용 여부 Example : `False`	boolean

2.2.22 - BackupResponse

Name	Description	Schema
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Backup명 Example : `backup-001`	string
policy_type required	Backup 정책 유형 Example : `VM_IMAGE`	string
retention_period required	Backup 보관 기간 Example : `WEEK_2`	string
role_type required	백업 역할 유형 Example : `ORIGINAL`	string
server_name required	Backup 서버명 Example : `server-001`	string
state required	Backup 상태 Example : `AVAILABLE`	string

2.2.23 - BackupRestoreHistoryListResponse

Name	Description	Schema	Default
contents required	Backup 복구 이력	any of [array[BackupRestoreHistoryResponse], null]
count required	갯수 Example : `1`	integer

2.2.24 - BackupRestoreHistoryResponse

Name	Description	Schema
backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string
backup_start_time required	Backup 일시 Example : `2024-10-28T05:38:48`	string (date-time)
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
restore_end_time required	복구 완료 일시 Example : `2024-10-28T05:52:47`	any of [string (date-time), null]
restore_server_id required	복구 서버 ID Example : `26895cb7-2059-49e7-b6fe-9c9c4b0d3db0`	any of [string, null]
restore_server_name required	복구 서버명 Example : `restoretest1`	string
restore_start_time required	복구 시작 일시 Example : `2024-10-28T05:52:47`	string (date-time)
restore_state required	복구 상태 Example : `COMPLETED`	enum (COMPLETED, FAILED, INPROGRESS)
schedule_name required	스케줄명 Example : `INCREMENTAL_DAILY_15:00:00-chg4By`	string

2.2.25 - BackupRestoreRequest

Name	Description	Schema
networks optional	복구용 네트워크 정보	any of [array[Network], null]
restore_region optional	서버를 복구할 리전 Example : `kr-west1`	any of [string, null]
restore_server_name required	복구 서버명 Example : `restoretest1` Pattern : `^[a-zA-Z0-9-_ ]$` Minimum length* : `1` Maximum length : `63`	string
restore_target_id required	복구 대상 목록 Example : `ca1a8e76-af49-40ea-93f8-a5989ffe138b`	string
security_groups optional	Security Group ID 목록 Example : `['023c57b14f11483689338d085e061492']`	any of [array[string], null]
server_type_id required	서버 유형 ID Example : `s1v1m2`	string

2.2.26 - BackupRestoreServerNameDuplicateResponse

Name	Description	Schema	Default
result required	결과 Example : `True`	boolean

2.2.27 - BackupRestoreSubnetListResponse

Name	Description	Schema	Default
count required	갯수 Example : `1`	integer
subnets optional	복구 시 선택 가능한 서브넷 목록	any of [array[BackupRestoreSubnetResponse], null]

2.2.28 - BackupRestoreSubnetResponse

Name	Description	Schema
account_id required	Account ID Example : `fnsd89fus0f9ds09f90dshf9dshfds09`	string
cidr required	Subnet Cidr Example : `192.167.1.0/24`	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
gateway_ip_address required	Gateway IP Example : `192.167.1.1`	any of [string, null]
id required	서브넷 ID Example : `023c57b14f11483689338d085e061492`	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Subnet명 Example : `subnetName`	string
state required	Subnet 상태 Example : `ACTIVE`	string
type required	Subnet 유형 Example : `GENERAL`	string
vpc_id required	VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	string
vpc_name required	VPC명 Example : `vpcName`	string

2.2.29 - BackupRestoreTargetDeleteRequest

Name	Description	Schema	Default
restore_target_ids required	복구 대상 목록 Example : `['ca1a8e76-af49-40ea-93f8-a5989ffe138b']`	array[string]

2.2.30 - BackupRestoreTargetListResponse

Name	Description	Schema	Default
contents required	복구 대상 목록	any of [array[BackupRestoreTargetResponse], null]
count required	갯수 Example : `1`	integer

2.2.31 - BackupRestoreTargetResponse

Name	Description	Schema
backup_start_time required	시작 일시 Example : `2024-09-30T15:00:00Z`	any of [string (date-time), null]
is_restore_available required	해당 백업 Image로 복구 가능 여부 Example : `true`	boolean
restore_target_id required	복구 대상 목록 Example : `ca1a8e76-af49-40ea-93f8-a5989ffe138b`	string
retention_period required	Backup 보관 기간 Example : `WEEK_2`	string
schedule_id required	스케줄 ID Example : `f5b8e22b-0d88-4698-9996-fb44217c8227`	string
schedule_name required	스케줄명 Example : `INCREMENTAL_DAILY_15:00:00-chg4By`	string
usage_gb required	백업 용량(GB) Example : `123.4`	object

2.2.32 - BackupScheduleCreateRequest

Name	Description	Schema
frequency required	스케줄 주기 유형 Example : `DAILY`	enum (MONTHLY, WEEKLY, DAILY)
start_day optional	Backup 스케줄 시작 요일 Example : `MON`	any of [enum (MON, TUE, WED, THU, FRI, SAT, SUN), null]
start_time required	스케줄 시작 시간 Example : `09:00:00`	string
start_week optional	Backup 스케줄 시작 주 Example : `WEEK_2`	any of [enum (WEEK_1, WEEK_2, WEEK_3, WEEK_4, WEEK_LAST), null]
type required	스케줄 유형 Example : `FULL`	enum (FULL, INCREMENTAL)

2.2.33 - BackupScheduleListResponse

Name	Description	Schema	Default
contents required	Backup 스케줄 목록	any of [array[BackupScheduleResponse], null]
count required	갯수 Example : `1`	integer

2.2.34 - BackupScheduleResponse

Name	Description	Schema
backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
frequency required	스케줄 주기 유형 Example : `DAILY`	enum (MONTHLY, WEEKLY, DAILY)
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	스케줄명 Example : `INCREMENTAL_DAILY_15:00:00-chg4By`	string
start_day required	스케줄 시작 요일 Example : `MON`	any of [string, null]
start_time required	스케줄 시작 시간 Example : `14:00:00`	any of [string, null]
start_week required	스케줄 시작 주 Example : `WEEK_1`	any of [string, null]
state required	Backup 스케줄 상태 Example : `AVAILABLE`	string
type required	스케줄 유형 Example : `FULL`	string

2.2.35 - BackupTargetListResponse

Name	Description	Schema	Default
contents optional	Backup 대상 목록	any of [array[BackupTargetResponse], null]
count required	갯수 Example : `1`	integer

2.2.36 - BackupTargetResponse

Name	Description	Schema
server_guid required	Backup 서버 GUID Example : `9ab33c66-3dbd-46cd-b0af-abccd3eb3170`	any of [string, null]
server_name required	Backup 서버명 Example : `server-001`	string
server_os_version required	서버의 OS Type 과 버전 Example : `UBUNTU 22.04`	any of [string, null]
server_type required	백업 서버 타입 Example : `s1v1m2`	any of [string, null]
server_uuid required	Backup 서버 UUID Example : `89f5ef44-1021-4a5c-8e06-fbb289eac366`	string

2.2.37 - CheckFileSystemDuplicationResponse

Name	Description	Schema	Default
result required	결과 Example : `True`	boolean

2.2.38 - FileSystemPathUpdateRequest

Name	Description	Schema	Default
backup_filesystem_paths required	백업 대상 파일 시스템 경로 Example : `['/aaa', '/bbb']`	any of [array[string], string]

2.2.39 - InstallFilePathResponse

Name	Description	Schema	Default
install_file_path required	설치 파일 경로 Example : `http://linux-agent`	string

2.2.40 - ModifyBackupSchedulesRequest

Name	Description	Schema	Default
schedules required	Backup 스케줄 목록	array[BackupScheduleCreateRequest]

2.2.41 - Network

Name	Description	Schema	Default
subnet_id required	서브넷 ID Example : `023c57b14f11483689338d085e061492`	string

2.2.42 - ResourceInfo

Name	Description	Schema	Default
id required	ID Example :	string
links optional	Links Example :	any of [array[object], null]

2.2.43 - RestoreFilesystemPath

Name	Description	Schema	Default
destination required	복구될 대상 파일 시스템 경로 Example : `/data`	string
source required	복구할 원본 파일 시스템 경로 Example : `/data`	string

2.2.44 - RetentionPeriodUpdateBody

Name	Description	Schema	Default
retention_period required	Backup 보관 기간 Example : `WEEK_2`	enum (WEEK_2, MONTH_1, MONTH_3, MONTH_6, YEAR_1)

2.2.45 - SyncResponse

Name	Description	Schema	Default
request_id required	요청 ID Example :	string
resource required	자원	ResourceInfo

2.2.46 - Tag

Name	Description	Schema	Default
key required	Example :	string
value required	Example :	string

3 - Block Storage(BM)

Overview

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

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

Version

Version	Status	Supported Until
1.0	DEPRECATED	20251231
1.1	DEPRECATED	20260331
1.2	CURRENT	-

OpenAPI URL

https://baremetal-blockstorage.{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

3.1 - APIs

3.1.1 - Add Volume Group Member on Volume Group

3.1.1.1 - 1.2

put /v1/volume-groups/{volume_group_id}/members/add

Description

볼륨 그룹에 볼륨 그룹 멤버를 추가한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupMemberRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/members/add

Request header

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

Request body

{
    "volume_ids": [
        "13666d6c32d4456e8421f7768d0bf225"
    ]
}

Example HTTP response

Response 200

{
    "id": "c9ecae8b973b425c81c3817893cd8063",
    "member_volumes": [
        {
            "disk_type": "SSD",
            "id": "92cd16fe8ebc4f73832513a172bf0000",
            "name": "volume-01",
            "purpose": "ORG",
            "size_gb": 10,
            "so_volume_id": "",
            "so_volume_name": ""
        }
    ]
}

3.1.1.2 - 1.1

put /v1/volume-groups/{volume_group_id}/members/add

Description

볼륨 그룹에 볼륨 그룹 멤버를 추가한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupMemberRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/members/add

Request header

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

Request body

{
    "volume_ids": [
        "13666d6c32d4456e8421f7768d0bf225"
    ]
}

Example HTTP response

Response 200

{
    "id": "c9ecae8b973b425c81c3817893cd8063",
    "member_volumes": [
        {
            "disk_type": "SSD",
            "id": "92cd16fe8ebc4f73832513a172bf0000",
            "name": "volume-01",
            "purpose": "ORG",
            "size_gb": 10,
            "so_volume_id": "",
            "so_volume_name": ""
        }
    ]
}

3.1.1.3 - 1.0

put /v1/volume-groups/{volume_group_id}/members/add

Description

볼륨 그룹에 볼륨 그룹 멤버를 추가한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupMemberRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/members/add

Request header

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

Request body

{
    "volume_ids": [
        "13666d6c32d4456e8421f7768d0bf225"
    ]
}

Example HTTP response

Response 200

{
    "id": "c9ecae8b973b425c81c3817893cd8063",
    "member_volumes": [
        {
            "disk_type": "SSD",
            "id": "92cd16fe8ebc4f73832513a172bf0000",
            "name": "volume-01",
            "purpose": "ORG",
            "size_gb": 10,
            "so_volume_id": "",
            "so_volume_name": ""
        }
    ]
}

3.1.2 - Attach Volume

3.1.2.1 - 1.2

post /v1/volumes/{volume_id}/attachments

Description

서버에 볼륨을 연결한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeAttachmentRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/attachments

Request header

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

Request body

{
    "attachments": [
        {
            "object_id": "83c3c73d457345e3829ee6d5557c0016",
            "object_type": "BM"
        }
    ]
}

Example HTTP response

Response 200

{
    "attachments": [
        {
            "object_id": "83c3c73d457345e3829ee6d5557c0016",
            "object_type": "BM"
        }
    ]
}

3.1.2.2 - 1.1

post /v1/volumes/{volume_id}/attachments

Description

서버에 볼륨을 연결한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeAttachmentRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/attachments

Request header

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

Request body

{
    "attachments": [
        {
            "object_id": "83c3c73d457345e3829ee6d5557c0016",
            "object_type": "BM"
        }
    ]
}

Example HTTP response

Response 200

{
    "result": {
        "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
        "attachments": [
            {
                "id": "83c3c73d457345e3829ee6d5557c0011",
                "image_name": "RHEL 8.8 for BM",
                "name": "baremetal-01",
                "srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
                "state": "RUNNING",
                "type": "BM"
            }
        ],
        "created_at": "2024-08-01T07:06:23.315Z",
        "created_by": "samsung-cloud-platform1@samsung.com",
        "disk_type": "SSD",
        "external_errors": [
            {
                "code": "Forbidden",
                "object_type": "BM",
                "status": 403
            }
        ],
        "has_origin": true,
        "has_replication": true,
        "id": "7239779c01e3405f82bb71c7f4b55fcd",
        "is_encryption": true,
        "iscsi_target_ips": [
            "172.30.4.3",
            "172.30.4.4"
        ],
        "modified_at": "2024-08-01T07:06:25.315Z",
        "modified_by": "samsung-cloud-platform2@samsung.com",
        "name": "bs-01",
        "previous_state": "CREATING",
        "purpose": "ORG",
        "recovery": {
            "origin_volume": {
                "attachments": [
                    {
                        "id": "83c3c73d457345e3829ee6d5557c0011",
                        "type": "BM"
                    }
                ],
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "bs-01"
            },
            "recovery_volume": {
                "attachments": [
                    {
                        "id": "83c3c73d457345e3829ee6d5557c0011",
                        "type": "BM"
                    }
                ],
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "bs-01"
            }
        },
        "size_gb": 10,
        "snapshot_rate": 100,
        "snapshot_schedule": {
            "day_of_week": "MON",
            "frequency": "DAILY",
            "hour": 18
        },
        "srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
        "state": "CREATING",
        "storage_volume_name": "vo202407310544da8aadc775f",
        "volume_group": {
            "id": "7239779c01e3405f82bb71c7f4b55fcd",
            "name": "vg-01"
        }
    }
}

3.1.2.3 - 1.0

post /v1/volumes/{volume_id}/attachments

Description

서버에 볼륨을 연결한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeAttachmentRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/attachments

Request header

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

Request body

{
    "attachments": [
        {
            "object_id": "83c3c73d457345e3829ee6d5557c0016",
            "object_type": "BM"
        }
    ]
}

Example HTTP response

Response 200

{
    "result": {
        "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
        "attachments": [
            {
                "id": "83c3c73d457345e3829ee6d5557c0011",
                "image_name": "RHEL 8.8 for BM",
                "name": "baremetal-01",
                "srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
                "state": "RUNNING",
                "type": "BM"
            }
        ],
        "created_at": "2024-08-01T07:06:23.315Z",
        "created_by": "samsung-cloud-platform1@samsung.com",
        "disk_type": "SSD",
        "external_errors": [
            {
                "code": "Forbidden",
                "object_type": "BM",
                "status": 403
            }
        ],
        "has_origin": true,
        "has_replication": true,
        "id": "7239779c01e3405f82bb71c7f4b55fcd",
        "is_encryption": true,
        "iscsi_target_ips": [
            "172.30.4.3",
            "172.30.4.4"
        ],
        "modified_at": "2024-08-01T07:06:25.315Z",
        "modified_by": "samsung-cloud-platform2@samsung.com",
        "name": "bs-01",
        "previous_state": "CREATING",
        "purpose": "ORG",
        "recovery": {
            "origin_volume": {
                "attachments": [
                    {
                        "id": "83c3c73d457345e3829ee6d5557c0011",
                        "type": "BM"
                    }
                ],
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "bs-01"
            },
            "recovery_volume": {
                "attachments": [
                    {
                        "id": "83c3c73d457345e3829ee6d5557c0011",
                        "type": "BM"
                    }
                ],
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "bs-01"
            }
        },
        "size_gb": 10,
        "snapshot_rate": 100,
        "snapshot_schedule": {
            "day_of_week": "MON",
            "frequency": "DAILY",
            "hour": 18
        },
        "srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
        "state": "CREATING",
        "storage_volume_name": "vo202407310544da8aadc775f",
        "volume_group": {
            "id": "7239779c01e3405f82bb71c7f4b55fcd",
            "name": "vg-01"
        }
    }
}

3.1.3 - Create Volume

3.1.3.1 - 1.2

post /v1/volumes

Description

볼륨을 생성한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		VolumeCreateRequestV1Dot2

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	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 = baremetal-blockstorage 1.2"

Request body

{
    "attachments": [
        {
            "object_id": "83c3c73d457345e3829ee6d5557c0016",
            "object_type": "BM"
        }
    ],
    "disk_type": "SSD",
    "name": "bs-01",
    "qos": {
        "iops": 3000,
        "throughput": 125
    },
    "size_gb": 10,
    "tags": [
        {
            "key": "my_tag_1",
            "value": "my_value_1"
        }
    ]
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

3.1.3.2 - 1.1

post /v1/volumes

Description

볼륨을 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
body	body required		VolumeCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	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 = baremetal-blockstorage 1.1"

Request body

{
    "attachments": [
        {
            "object_id": "83c3c73d457345e3829ee6d5557c0016",
            "object_type": "BM"
        }
    ],
    "disk_type": "SSD",
    "name": "bs-01",
    "size_gb": 10,
    "tags": [
        {
            "key": "my_tag_1",
            "value": "my_value_1"
        }
    ]
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

3.1.3.3 - 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	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	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 = baremetal-blockstorage 1.0"

Request body

{
    "attachments": [
        {
            "object_id": "83c3c73d457345e3829ee6d5557c0016",
            "object_type": "BM"
        }
    ],
    "disk_type": "SSD",
    "name": "bs-01",
    "size_gb": 10,
    "tags": [
        {
            "key": "my_tag_1",
            "value": "my_value_1"
        }
    ]
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

3.1.4 - Create Volume Group

3.1.4.1 - 1.2

post /v1/volume-groups

Description

볼륨 그룹을 생성한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		VolumeGroupCreationRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups

Request header

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

Request body

{
    "name": "vg-01",
    "tags": [
        {
            "key": "my_tag_1",
            "value": "my_value_1"
        }
    ],
    "volume_ids": [
        "17e0b4fd27784dfb843440ec08bdd148"
    ]
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

3.1.4.2 - 1.1

post /v1/volume-groups

Description

볼륨 그룹을 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
body	body required		VolumeGroupCreationRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups

Request header

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

Request body

{
    "name": "vg-01",
    "tags": [
        {
            "key": "my_tag_1",
            "value": "my_value_1"
        }
    ],
    "volume_ids": [
        "17e0b4fd27784dfb843440ec08bdd148"
    ]
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

3.1.4.3 - 1.0

post /v1/volume-groups

Description

볼륨 그룹을 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		VolumeGroupCreationRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups

Request header

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

Request body

{
    "name": "vg-01",
    "tags": [
        {
            "key": "my_tag_1",
            "value": "my_value_1"
        }
    ],
    "volume_ids": [
        "17e0b4fd27784dfb843440ec08bdd148"
    ]
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

3.1.5 - Create Volume Group Recovery

3.1.5.1 - 1.2

post /v1/volume-groups/{volume_group_id}/recoveries

Description

복구본 볼륨 그룹을 생성한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupRecoveryCreateRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/recoveries

Request header

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

Request body

{
    "block_storage_name_prefix": "prefix-",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501"
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

3.1.5.2 - 1.1

post /v1/volume-groups/{volume_group_id}/recoveries

Description

복구본 볼륨 그룹을 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupRecoveryCreateRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/recoveries

Request header

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

Request body

{
    "block_storage_name_prefix": "prefix-",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501"
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

3.1.6 - Create Volume Group Replication

3.1.6.1 - 1.2

post /v1/volume-groups/{volume_group_id}/replications

Description

복제본 볼륨 그룹을 생성한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupReplicationCreateRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.2"

Request body

{
    "cycle": "5MIN",
    "name": "replica-vg-01",
    "region": "kr-west1",
    "replication_volume_name_prefix": "dr"
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

3.1.6.2 - 1.1

post /v1/volume-groups/{volume_group_id}/replications

Description

복제본 볼륨 그룹을 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupReplicationCreateRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.1"

Request body

{
    "cycle": "5MIN",
    "name": "replica-vg-01",
    "region": "kr-west1",
    "replication_volume_name_prefix": "dr"
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

3.1.6.3 - 1.0

post /v1/volume-groups/{volume_group_id}/replications

Description

복제본 볼륨 그룹을 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupReplicationCreateRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.0"

Request body

{
    "cycle": "5MIN",
    "name": "replica-vg-01",
    "region": "kr-west1",
    "replication_volume_name_prefix": "dr"
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

3.1.7 - Create Volume Group Snapshot

3.1.7.1 - 1.2

post /v1/volume-groups/{volume_group_id}/snapshots

Description

볼륨 그룹 스냅샷을 생성한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.2"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "snapshot_name": "vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932",
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

3.1.7.2 - 1.1

post /v1/volume-groups/{volume_group_id}/snapshots

Description

볼륨 그룹 스냅샷을 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.1"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "snapshot_name": "vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932",
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

3.1.7.3 - 1.0

post /v1/volume-groups/{volume_group_id}/snapshots

Description

볼륨 그룹 스냅샷을 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.0"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "snapshot_name": "vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932",
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

3.1.8 - Create Volume Group Snapshot Schedule

3.1.8.1 - 1.2

post /v1/volume-groups/{volume_group_id}/snapshot-schedules

Description

볼륨 그룹 스냅샷 스케줄을 생성한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupSnapshotScheduleRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.2"

Request body

{
    "day_of_week": "SUN",
    "hour": 18
}

Example HTTP response

Response 200

{
    "day_of_week": "SUN",
    "frequency": "DAILY",
    "hour": 18,
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

3.1.8.2 - 1.1

post /v1/volume-groups/{volume_group_id}/snapshot-schedules

Description

볼륨 그룹 스냅샷 스케줄을 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupSnapshotScheduleRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.1"

Request body

{
    "day_of_week": "SUN",
    "hour": 18
}

Example HTTP response

Response 200

{
    "day_of_week": "SUN",
    "frequency": "DAILY",
    "hour": 18,
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

3.1.8.3 - 1.0

post /v1/volume-groups/{volume_group_id}/snapshot-schedules

Description

볼륨 그룹 스냅샷 스케줄을 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupSnapshotScheduleRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.0"

Request body

{
    "day_of_week": "SUN",
    "hour": 18
}

Example HTTP response

Response 200

{
    "day_of_week": "SUN",
    "frequency": "DAILY",
    "hour": 18,
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

3.1.9 - Create Volume Recovery

3.1.9.1 - 1.2

post /v1/volumes/{volume_id}/recoveries

Description

복구본 볼륨을 생성한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeRecoveryCreateRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/recoveries

Request header

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

Request body

{
    "name": "recovery-volume",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501"
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

3.1.9.2 - 1.1

post /v1/volumes/{volume_id}/recoveries

Description

복구본 볼륨을 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeRecoveryCreateRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/recoveries

Request header

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

Request body

{
    "name": "recovery-volume",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501"
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

3.1.10 - Create Volume Replication

3.1.10.1 - 1.2

post /v1/volumes/{volume_id}/replications

Description

복제본 볼륨을 생성한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeReplicationCreateRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.2"

Request body

{
    "cycle": "5MIN",
    "name": "replica-bs-01",
    "region": "kr-west1"
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

3.1.10.2 - 1.1

post /v1/volumes/{volume_id}/replications

Description

복제본 볼륨을 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeReplicationCreateRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.1"

Request body

{
    "cycle": "5MIN",
    "name": "replica-bs-01",
    "region": "kr-west1"
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

3.1.10.3 - 1.0

post /v1/volumes/{volume_id}/replications

Description

복제본 볼륨을 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeReplicationCreateRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.0"

Request body

{
    "cycle": "5MIN",
    "name": "replica-bs-01",
    "region": "kr-west1"
}

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

3.1.11 - Create Volume Snapshot

3.1.11.1 - 1.2

post /v1/volumes/{volume_id}/snapshots

Description

볼륨 스냅샷을 생성한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.2"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "snapshot_name": "vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932",
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.11.2 - 1.1

post /v1/volumes/{volume_id}/snapshots

Description

볼륨 스냅샷을 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.1"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "snapshot_name": "vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932",
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.11.3 - 1.0

post /v1/volumes/{volume_id}/snapshots

Description

볼륨 스냅샷을 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.0"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "snapshot_name": "vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932",
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.12 - Create Volume Snapshot Rate

3.1.12.1 - 1.2

post /v1/volumes/{volume_id}/snapshot-rates

Description

볼륨 스냅샷 용량을 생성한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeSnapshotRateRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-rates

Request header

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

Request body

{
    "snapshot_rate": 100
}

Example HTTP response

Response 200

{
    "is_snapshot_activated": true,
    "snapshot_rate": 100,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.12.2 - 1.1

post /v1/volumes/{volume_id}/snapshot-rates

Description

볼륨 스냅샷 용량을 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeSnapshotRateRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-rates

Request header

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

Request body

{
    "snapshot_rate": 100
}

Example HTTP response

Response 200

{
    "is_snapshot_activated": true,
    "snapshot_rate": 100,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.12.3 - 1.0

post /v1/volumes/{volume_id}/snapshot-rates

Description

볼륨 스냅샷 용량을 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeSnapshotRateRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-rates

Request header

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

Request body

{
    "snapshot_rate": 100
}

Example HTTP response

Response 200

{
    "is_snapshot_activated": true,
    "snapshot_rate": 100,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.13 - Create Volume Snapshot Schedule

3.1.13.1 - 1.2

post /v1/volumes/{volume_id}/snapshot-schedules

Description

볼륨 스냅샷 스케줄을 생성한다

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeSnapshotScheduleRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.2"

Request body

{
    "day_of_week": "SUN",
    "hour": 18
}

Example HTTP response

Response 200

{
    "day_of_week": "",
    "frequency": "DAILY",
    "hour": 18,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.13.2 - 1.1

post /v1/volumes/{volume_id}/snapshot-schedules

Description

볼륨 스냅샷 스케줄을 생성한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeSnapshotScheduleRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.1"

Request body

{
    "day_of_week": "SUN",
    "hour": 18
}

Example HTTP response

Response 200

{
    "day_of_week": "",
    "frequency": "DAILY",
    "hour": 18,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.13.3 - 1.0

post /v1/volumes/{volume_id}/snapshot-schedules

Description

볼륨 스냅샷 스케줄을 생성한다

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeSnapshotScheduleRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.0"

Request body

{
    "day_of_week": "SUN",
    "hour": 18
}

Example HTTP response

Response 200

{
    "day_of_week": "",
    "frequency": "DAILY",
    "hour": 18,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.14 - Delete Volume

3.1.14.1 - 1.2

delete /v1/volumes/{volume_id}

Description

볼륨을 삭제한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}

Request header

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

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

3.1.14.2 - 1.1

delete /v1/volumes/{volume_id}

Description

볼륨을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}

Request header

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

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

3.1.14.3 - 1.0

delete /v1/volumes/{volume_id}

Description

볼륨을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}

Request header

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

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

3.1.15 - Delete Volume Group Replication

3.1.15.1 - 1.2

delete /v1/volume-groups/{volume_group_id}/replications

Description

복제본 볼륨 그룹을 삭제한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.2"

Example HTTP response

Response 200

{
    "result": ""
}

3.1.15.2 - 1.1

delete /v1/volume-groups/{volume_group_id}/replications

Description

복제본 볼륨 그룹을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.1"

Example HTTP response

Response 200

{
    "result": ""
}

3.1.15.3 - 1.0

delete /v1/volume-groups/{volume_group_id}/replications

Description

복제본 볼륨 그룹을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.0"

Example HTTP response

Response 200

{
    "result": ""
}

3.1.16 - Delete Volume Group Snapshot

3.1.16.1 - 1.2

delete /v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}

Description

볼륩 그룹 스냅샷을 삭제한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
path	snapshot_id required	스냅샷 id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/snapshots/{snapshot_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 = baremetal-blockstorage 1.2"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

3.1.16.2 - 1.1

delete /v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}

Description

볼륩 그룹 스냅샷을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
path	snapshot_id required	스냅샷 id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/snapshots/{snapshot_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 = baremetal-blockstorage 1.1"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

3.1.16.3 - 1.0

delete /v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}

Description

볼륩 그룹 스냅샷을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
path	snapshot_id required	스냅샷 id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/snapshots/{snapshot_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 = baremetal-blockstorage 1.0"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

3.1.17 - Delete Volume Group Snapshot Schedule

3.1.17.1 - 1.2

delete /v1/volume-groups/{volume_group_id}/snapshot-schedules

Description

볼륨 그룹 스냅샷 스케줄을 삭제한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.2"

Example HTTP response

Response 200

{
    "day_of_week": "SUN",
    "frequency": "DAILY",
    "hour": 18,
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

3.1.17.2 - 1.1

delete /v1/volume-groups/{volume_group_id}/snapshot-schedules

Description

볼륨 그룹 스냅샷 스케줄을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.1"

Example HTTP response

Response 200

{
    "day_of_week": "SUN",
    "frequency": "DAILY",
    "hour": 18,
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

3.1.17.3 - 1.0

delete /v1/volume-groups/{volume_group_id}/snapshot-schedules

Description

볼륨 그룹 스냅샷 스케줄을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.0"

Example HTTP response

Response 200

{
    "day_of_week": "SUN",
    "frequency": "DAILY",
    "hour": 18,
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

3.1.18 - Delete Volume Replication

3.1.18.1 - 1.2

delete /v1/volumes/{volume_id}/replications

Description

복제본 볼륨을 삭제한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.2"

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

3.1.18.2 - 1.1

delete /v1/volumes/{volume_id}/replications

Description

복제본 볼륨을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.1"

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

3.1.18.3 - 1.0

delete /v1/volumes/{volume_id}/replications

Description

복제본 볼륨을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
    "resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}

3.1.19 - Delete Volume Snapshot

3.1.19.1 - 1.2

delete /v1/volumes/{volume_id}/snapshots/{snapshot_id}

Description

볼륨 스냅샷을 삭제한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
path	snapshot_id required	스냅샷 id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshots/{snapshot_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 = baremetal-blockstorage 1.2"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.19.2 - 1.1

delete /v1/volumes/{volume_id}/snapshots/{snapshot_id}

Description

볼륨 스냅샷을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
path	snapshot_id required	스냅샷 id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshots/{snapshot_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 = baremetal-blockstorage 1.1"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.19.3 - 1.0

delete /v1/volumes/{volume_id}/snapshots/{snapshot_id}

Description

볼륨 스냅샷을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
path	snapshot_id required	스냅샷 id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshots/{snapshot_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 = baremetal-blockstorage 1.0"

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.20 - Delete Volume Snapshot Rate

3.1.20.1 - 1.2

delete /v1/volumes/{volume_id}/snapshot-rates

Description

볼륨 스냅샷 용량을 삭제한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-rates

Request header

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

Example HTTP response

Response 200

{
    "is_snapshot_activated": true,
    "snapshot_rate": 100,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.20.2 - 1.1

delete /v1/volumes/{volume_id}/snapshot-rates

Description

볼륨 스냅샷 용량을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-rates

Request header

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

Example HTTP response

Response 200

{
    "is_snapshot_activated": true,
    "snapshot_rate": 100,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.20.3 - 1.0

delete /v1/volumes/{volume_id}/snapshot-rates

Description

볼륨 스냅샷 용량을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-rates

Request header

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

Example HTTP response

Response 200

{
    "is_snapshot_activated": true,
    "snapshot_rate": 100,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.21 - Delete Volume Snapshot Schedule

3.1.21.1 - 1.2

delete /v1/volumes/{volume_id}/snapshot-schedules

Description

볼륨 스냅샷 스케줄을 삭제한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.2"

Example HTTP response

Response 200

{
    "day_of_week": "",
    "frequency": "DAILY",
    "hour": 18,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.21.2 - 1.1

delete /v1/volumes/{volume_id}/snapshot-schedules

Description

볼륨 스냅샷 스케줄을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.1"

Example HTTP response

Response 200

{
    "day_of_week": "",
    "frequency": "DAILY",
    "hour": 18,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.21.3 - 1.0

delete /v1/volumes/{volume_id}/snapshot-schedules

Description

볼륨 스냅샷 스케줄을 삭제한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.0"

Example HTTP response

Response 200

{
    "day_of_week": "",
    "frequency": "DAILY",
    "hour": 18,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.22 - Detach Volume

3.1.22.1 - 1.2

delete /v1/volumes/{volume_id}/attachments

Description

서버에 연결된 볼륨을 분리한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeDetachRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/attachments

Request header

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

Request body

{
    "attachments": [
        ""
    ]
}

Example HTTP response

Response 200

{
    "attachments": [
        {
            "object_id": "83c3c73d457345e3829ee6d5557c0016",
            "object_type": "BM"
        }
    ]
}

3.1.22.2 - 1.1

delete /v1/volumes/{volume_id}/attachments

Description

서버에 연결된 볼륨을 분리한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeDetachRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/attachments

Request header

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

Request body

{
    "attachments": [
        ""
    ]
}

Example HTTP response

Response 200

{
    "result": {
        "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
        "attachments": [
            {
                "id": "83c3c73d457345e3829ee6d5557c0011",
                "image_name": "RHEL 8.8 for BM",
                "name": "baremetal-01",
                "srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
                "state": "RUNNING",
                "type": "BM"
            }
        ],
        "created_at": "2024-08-01T07:06:23.315Z",
        "created_by": "samsung-cloud-platform1@samsung.com",
        "disk_type": "SSD",
        "external_errors": [
            {
                "code": "Forbidden",
                "object_type": "BM",
                "status": 403
            }
        ],
        "has_origin": true,
        "has_replication": true,
        "id": "7239779c01e3405f82bb71c7f4b55fcd",
        "is_encryption": true,
        "iscsi_target_ips": [
            "172.30.4.3",
            "172.30.4.4"
        ],
        "modified_at": "2024-08-01T07:06:25.315Z",
        "modified_by": "samsung-cloud-platform2@samsung.com",
        "name": "bs-01",
        "previous_state": "CREATING",
        "purpose": "ORG",
        "recovery": {
            "origin_volume": {
                "attachments": [
                    {
                        "id": "83c3c73d457345e3829ee6d5557c0011",
                        "type": "BM"
                    }
                ],
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "bs-01"
            },
            "recovery_volume": {
                "attachments": [
                    {
                        "id": "83c3c73d457345e3829ee6d5557c0011",
                        "type": "BM"
                    }
                ],
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "bs-01"
            }
        },
        "size_gb": 10,
        "snapshot_rate": 100,
        "snapshot_schedule": {
            "day_of_week": "MON",
            "frequency": "DAILY",
            "hour": 18
        },
        "srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
        "state": "CREATING",
        "storage_volume_name": "vo202407310544da8aadc775f",
        "volume_group": {
            "id": "7239779c01e3405f82bb71c7f4b55fcd",
            "name": "vg-01"
        }
    }
}

3.1.22.3 - 1.0

delete /v1/volumes/{volume_id}/attachments

Description

서버에 연결된 볼륨을 분리한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeDetachRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/attachments

Request header

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

Request body

{
    "attachments": [
        ""
    ]
}

Example HTTP response

Response 200

{
    "result": {
        "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
        "attachments": [
            {
                "id": "83c3c73d457345e3829ee6d5557c0011",
                "image_name": "RHEL 8.8 for BM",
                "name": "baremetal-01",
                "srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
                "state": "RUNNING",
                "type": "BM"
            }
        ],
        "created_at": "2024-08-01T07:06:23.315Z",
        "created_by": "samsung-cloud-platform1@samsung.com",
        "disk_type": "SSD",
        "external_errors": [
            {
                "code": "Forbidden",
                "object_type": "BM",
                "status": 403
            }
        ],
        "has_origin": true,
        "has_replication": true,
        "id": "7239779c01e3405f82bb71c7f4b55fcd",
        "is_encryption": true,
        "iscsi_target_ips": [
            "172.30.4.3",
            "172.30.4.4"
        ],
        "modified_at": "2024-08-01T07:06:25.315Z",
        "modified_by": "samsung-cloud-platform2@samsung.com",
        "name": "bs-01",
        "previous_state": "CREATING",
        "purpose": "ORG",
        "recovery": {
            "origin_volume": {
                "attachments": [
                    {
                        "id": "83c3c73d457345e3829ee6d5557c0011",
                        "type": "BM"
                    }
                ],
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "bs-01"
            },
            "recovery_volume": {
                "attachments": [
                    {
                        "id": "83c3c73d457345e3829ee6d5557c0011",
                        "type": "BM"
                    }
                ],
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "bs-01"
            }
        },
        "size_gb": 10,
        "snapshot_rate": 100,
        "snapshot_schedule": {
            "day_of_week": "MON",
            "frequency": "DAILY",
            "hour": 18
        },
        "srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
        "state": "CREATING",
        "storage_volume_name": "vo202407310544da8aadc775f",
        "volume_group": {
            "id": "7239779c01e3405f82bb71c7f4b55fcd",
            "name": "vg-01"
        }
    }
}

3.1.23 - List Volume Group Snapshots

3.1.23.1 - 1.2

get /v1/volume-groups/{volume_group_id}/snapshots

Description

볼륨 그룹 스냅샷의 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.2"

Example HTTP response

Response 200

{
    "is_snapshot_policy": false,
    "snapshots": [],
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

3.1.23.2 - 1.1

get /v1/volume-groups/{volume_group_id}/snapshots

Description

볼륨 그룹 스냅샷의 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.1"

Example HTTP response

Response 200

{
    "is_snapshot_policy": false,
    "snapshots": [],
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

3.1.23.3 - 1.0

get /v1/volume-groups/{volume_group_id}/snapshots

Description

볼륨 그룹 스냅샷의 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.0"

Example HTTP response

Response 200

{
    "is_snapshot_policy": false,
    "snapshots": [],
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

3.1.24 - List Volume Groups

3.1.24.1 - 1.2

get /v1/volume-groups

Description

볼륨 그룹 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
query	limit optional	페이지에 표시될 번호 Example : `20`	integer	20
query	offset optional	Offset Example : `0`	integer	0
query	sort optional	정렬 Example : `column1:asc,column2:desc`	string	None
query	name optional	볼륨 그룹명 Example : `vg-01`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups

Request header

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

Example HTTP response

Response 200

{
    "total_count": 1,
    "volume_groups": [
        {
            "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
            "created_at": "2024-08-01T07:06:23.315Z",
            "created_by": "samsung-cloud-platform1@samsung.com",
            "id": "c9ecae8b973b425c81c3817893cd8063",
            "modified_at": "2024-08-01T07:06:25.315Z",
            "modified_by": "samsung-cloud-platform2@samsung.com",
            "name": "vg-01",
            "num_of_block_storages": 2,
            "purpose": "ORG",
            "state": "CREATING"
        }
    ]
}

3.1.24.2 - 1.1

get /v1/volume-groups

Description

볼륨 그룹 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
query	limit optional	페이지에 표시될 번호 Example : `20`	integer	20
query	offset optional	Offset Example : `0`	integer	0
query	sort optional	정렬 Example : `column1:asc,column2:desc`	string	None
query	name optional	볼륨 그룹명 Example : `vg-01`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups

Request header

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

Example HTTP response

Response 200

{
    "total_count": 1,
    "volume_groups": [
        {
            "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
            "created_at": "2024-08-01T07:06:23.315Z",
            "created_by": "samsung-cloud-platform1@samsung.com",
            "id": "c9ecae8b973b425c81c3817893cd8063",
            "modified_at": "2024-08-01T07:06:25.315Z",
            "modified_by": "samsung-cloud-platform2@samsung.com",
            "name": "vg-01",
            "num_of_block_storages": 2,
            "purpose": "ORG",
            "state": "CREATING"
        }
    ]
}

3.1.24.3 - 1.0

get /v1/volume-groups

Description

볼륨 그룹 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	limit optional	페이지에 표시될 번호 Example : `20`	integer	20
query	offset optional	Offset Example : `0`	integer	0
query	sort optional	정렬 Example : `column1:asc,column2:desc`	string	None
query	name optional	볼륨 그룹명 Example : `vg-01`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups

Request header

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

Example HTTP response

Response 200

{
    "total_count": 1,
    "volume_groups": [
        {
            "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
            "created_at": "2024-08-01T07:06:23.315Z",
            "created_by": "samsung-cloud-platform1@samsung.com",
            "id": "c9ecae8b973b425c81c3817893cd8063",
            "modified_at": "2024-08-01T07:06:25.315Z",
            "modified_by": "samsung-cloud-platform2@samsung.com",
            "name": "vg-01",
            "num_of_block_storages": 2,
            "purpose": "ORG",
            "state": "CREATING"
        }
    ]
}

3.1.25 - List Volume Snapshots

3.1.25.1 - 1.2

get /v1/volumes/{volume_id}/snapshots

Description

볼륨 스냅샷 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.2"

Example HTTP response

Response 200

{
    "is_snapshot_policy": false,
    "snapshot_capacity_mb": 0,
    "snapshot_capacity_rate": 0,
    "snapshot_total_usage": 0,
    "snapshots": [],
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.25.2 - 1.1

get /v1/volumes/{volume_id}/snapshots

Description

볼륨 스냅샷 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.1"

Example HTTP response

Response 200

{
    "is_snapshot_policy": false,
    "snapshot_capacity_mb": 0,
    "snapshot_capacity_rate": 0,
    "snapshot_total_usage": 0,
    "snapshots": [],
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.25.3 - 1.0

get /v1/volumes/{volume_id}/snapshots

Description

볼륨 스냅샷 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.0"

Example HTTP response

Response 200

{
    "is_snapshot_policy": false,
    "snapshot_capacity_mb": 0,
    "snapshot_capacity_rate": 0,
    "snapshot_total_usage": 0,
    "snapshots": [],
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.26 - List Volumes

3.1.26.1 - 1.2

get /v1/volumes

Description

볼륨 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
query	limit optional	페이지에 표시될 번호 Example : `20`	integer	20
query	offset optional	Offset Example : `0`	integer	0
query	sort optional	정렬 Example : `column1:asc,column2:desc`	string	None
query	name optional	볼륨명 Example : `bs-01`	string	None
query	object_name optional	연결 서버명 Example : `baremetal-server-name`	string	None
query	volume_group_name optional	볼륨 그룹명 Example : `vg-01`	string	None

Responses

HTTP Code	Description	Schema
200	OK	VolumeListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	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 = baremetal-blockstorage 1.2"

Example HTTP response

Response 200

{
    "total_count": 1,
    "volumes": [
        {
            "attachments": [
                {
                    "id": "d7682135392e42489948c189e29011cc",
                    "name": "baremetal-01"
                }
            ],
            "created_at": "2026-02-11T06:40:48.807Z",
            "created_by": "samsung-cloud-platform1@samsung.com",
            "disk_type": "SSD",
            "has_relation": false,
            "id": "7239779c01e3405f82bb71c7f4b55fcd",
            "is_in_volume_group": false,
            "is_snapshot_activated": true,
            "iscsi_target_ips": {
                "description": "List of iscsi ips",
                "example": [
                    "172.30.4.3",
                    "172.30.4.4"
                ]
            },
            "modified_at": "2026-02-11T06:40:48.814Z",
            "modified_by": "samsung-cloud-platform2@samsung.com",
            "name": "bs-01",
            "purpose": "ORG",
            "size_gb": 10,
            "state": "CREATING",
            "volume_group": ""
        }
    ]
}

3.1.26.2 - 1.1

get /v1/volumes

Description

볼륨 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
query	limit optional	페이지에 표시될 번호 Example : `20`	integer	20
query	offset optional	Offset Example : `0`	integer	0
query	sort optional	정렬 Example : `column1:asc,column2:desc`	string	None
query	name optional	볼륨명 Example : `bs-01`	string	None
query	object_name optional	연결 서버명 Example : `baremetal-server-name`	string	None
query	volume_group_name optional	볼륨 그룹명 Example : `vg-01`	string	None

Responses

HTTP Code	Description	Schema
200	OK	VolumeListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	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 = baremetal-blockstorage 1.1"

Example HTTP response

Response 200

{
    "total_count": 1,
    "volumes": [
        {
            "attachments": [
                {
                    "id": "d7682135392e42489948c189e29011cc",
                    "name": "baremetal-01"
                }
            ],
            "created_at": "2026-02-11T06:40:48.807Z",
            "created_by": "samsung-cloud-platform1@samsung.com",
            "disk_type": "SSD",
            "has_relation": false,
            "id": "7239779c01e3405f82bb71c7f4b55fcd",
            "is_in_volume_group": false,
            "is_snapshot_activated": true,
            "iscsi_target_ips": {
                "description": "List of iscsi ips",
                "example": [
                    "172.30.4.3",
                    "172.30.4.4"
                ]
            },
            "modified_at": "2026-02-11T06:40:48.814Z",
            "modified_by": "samsung-cloud-platform2@samsung.com",
            "name": "bs-01",
            "purpose": "ORG",
            "size_gb": 10,
            "state": "CREATING",
            "volume_group": ""
        }
    ]
}

3.1.26.3 - 1.0

get /v1/volumes

Description

볼륨 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	limit optional	페이지에 표시될 번호 Example : `20`	integer	20
query	offset optional	Offset Example : `0`	integer	0
query	sort optional	정렬 Example : `column1:asc,column2:desc`	string	None
query	name optional	볼륨명 Example : `bs-01`	string	None
query	object_name optional	연결 서버명 Example : `baremetal-server-name`	string	None
query	volume_group_name optional	볼륨 그룹명 Example : `vg-01`	string	None

Responses

HTTP Code	Description	Schema
200	OK	VolumeListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	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 = baremetal-blockstorage 1.0"

Example HTTP response

Response 200

{
    "total_count": 1,
    "volumes": [
        {
            "attachments": [
                {
                    "id": "d7682135392e42489948c189e29011cc",
                    "name": "baremetal-01"
                }
            ],
            "created_at": "2026-02-11T06:40:48.807Z",
            "created_by": "samsung-cloud-platform1@samsung.com",
            "disk_type": "SSD",
            "has_relation": false,
            "id": "7239779c01e3405f82bb71c7f4b55fcd",
            "is_in_volume_group": false,
            "is_snapshot_activated": true,
            "iscsi_target_ips": {
                "description": "List of iscsi ips",
                "example": [
                    "172.30.4.3",
                    "172.30.4.4"
                ]
            },
            "modified_at": "2026-02-11T06:40:48.814Z",
            "modified_by": "samsung-cloud-platform2@samsung.com",
            "name": "bs-01",
            "purpose": "ORG",
            "size_gb": 10,
            "state": "CREATING",
            "volume_group": ""
        }
    ]
}

3.1.27 - Remove Volume Group Member on Volume Group

3.1.27.1 - 1.2

put /v1/volume-groups/{volume_group_id}/members/remove

Description

볼륨 그룹에서 볼륨 그룹 멤버를 제거한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupMemberRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/members/remove

Request header

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

Request body

{
    "volume_ids": [
        "13666d6c32d4456e8421f7768d0bf225"
    ]
}

Example HTTP response

Response 200

{
    "id": "c9ecae8b973b425c81c3817893cd8063",
    "member_volumes": [
        {
            "disk_type": "SSD",
            "id": "92cd16fe8ebc4f73832513a172bf0000",
            "name": "volume-01",
            "purpose": "ORG",
            "size_gb": 10,
            "so_volume_id": "",
            "so_volume_name": ""
        }
    ]
}

3.1.27.2 - 1.1

put /v1/volume-groups/{volume_group_id}/members/remove

Description

볼륨 그룹에서 볼륨 그룹 멤버를 제거한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupMemberRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/members/remove

Request header

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

Request body

{
    "volume_ids": [
        "13666d6c32d4456e8421f7768d0bf225"
    ]
}

Example HTTP response

Response 200

{
    "id": "c9ecae8b973b425c81c3817893cd8063",
    "member_volumes": [
        {
            "disk_type": "SSD",
            "id": "92cd16fe8ebc4f73832513a172bf0000",
            "name": "volume-01",
            "purpose": "ORG",
            "size_gb": 10,
            "so_volume_id": "",
            "so_volume_name": ""
        }
    ]
}

3.1.27.3 - 1.0

put /v1/volume-groups/{volume_group_id}/members/remove

Description

볼륨 그룹에서 볼륨 그룹 멤버를 제거한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupMemberRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/members/remove

Request header

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

Request body

{
    "volume_ids": [
        "13666d6c32d4456e8421f7768d0bf225"
    ]
}

Example HTTP response

Response 200

{
    "id": "c9ecae8b973b425c81c3817893cd8063",
    "member_volumes": [
        {
            "disk_type": "SSD",
            "id": "92cd16fe8ebc4f73832513a172bf0000",
            "name": "volume-01",
            "purpose": "ORG",
            "size_gb": 10,
            "so_volume_id": "",
            "so_volume_name": ""
        }
    ]
}

3.1.28 - Restore Volume Group Snapshot

3.1.28.1 - 1.2

put /v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}/restore

Description

볼륨 그룹 스냅샷을 복원한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
path	snapshot_id required	스냅샷 id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}/restore

Request header

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

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

3.1.28.2 - 1.1

put /v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}/restore

Description

볼륨 그룹 스냅샷을 복원한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
path	snapshot_id required	스냅샷 id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}/restore

Request header

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

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

3.1.28.3 - 1.0

put /v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}/restore

Description

볼륨 그룹 스냅샷을 복원한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
path	snapshot_id required	스냅샷 id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}/restore

Request header

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

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

3.1.29 - Restore Volume Snapshot

3.1.29.1 - 1.2

put /v1/volumes/{volume_id}/snapshots/{snapshot_id}/restore

Description

스냅샷에서 볼륨을 복원한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
path	snapshot_id required	스냅샷 id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshots/{snapshot_id}/restore

Request header

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

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.29.2 - 1.1

put /v1/volumes/{volume_id}/snapshots/{snapshot_id}/restore

Description

스냅샷에서 볼륨을 복원한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
path	snapshot_id required	스냅샷 id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshots/{snapshot_id}/restore

Request header

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

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.29.3 - 1.0

put /v1/volumes/{volume_id}/snapshots/{snapshot_id}/restore

Description

스냅샷에서 볼륨을 복원한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
path	snapshot_id required	스냅샷 id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshots/{snapshot_id}/restore

Request header

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

Example HTTP response

Response 200

{
    "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
    "snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.30 - Set Volume Group Replication Cycle

3.1.30.1 - 1.2

put /v1/volume-groups/{volume_group_id}/replications/cycle

Description

볼륨 그룹 복제 주기를 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupReplicationUpdateCycleRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/replications/cycle

Request header

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

Request body

{
    "cycle": "5MIN"
}

Example HTTP response

Response 200

{
    "cycle": "5MIN",
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

3.1.30.2 - 1.1

put /v1/volume-groups/{volume_group_id}/replications/cycle

Description

볼륨 그룹 복제 주기를 수정한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupReplicationUpdateCycleRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/replications/cycle

Request header

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

Request body

{
    "cycle": "5MIN"
}

Example HTTP response

Response 200

{
    "cycle": "5MIN",
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

3.1.30.3 - 1.0

put /v1/volume-groups/{volume_group_id}/replications/cycle

Description

볼륨 그룹 복제 주기를 수정한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupReplicationUpdateCycleRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/replications/cycle

Request header

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

Request body

{
    "cycle": "5MIN"
}

Example HTTP response

Response 200

{
    "cycle": "5MIN",
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

3.1.31 - Set Volume Group Replication Policy

3.1.31.1 - 1.2

put /v1/volume-groups/{volume_group_id}/replications/policy

Description

볼륨 그룹 복제 정책을 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupReplicationUpdatePolicyRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/replications/policy

Request header

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

Request body

{
    "policy": "RESYNC"
}

Example HTTP response

Response 200

{
    "cycle": "5MIN",
    "sync_state": "SNAPMIRROED"
}

3.1.31.2 - 1.1

put /v1/volume-groups/{volume_group_id}/replications/policy

Description

볼륨 그룹 복제 정책을 수정한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupReplicationUpdatePolicyRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/replications/policy

Request header

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

Request body

{
    "policy": "RESYNC"
}

Example HTTP response

Response 200

{
    "cycle": "5MIN",
    "sync_state": "SNAPMIRROED"
}

3.1.31.3 - 1.0

put /v1/volume-groups/{volume_group_id}/replications/policy

Description

볼륨 그룹 복제 정책을 수정한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupReplicationUpdatePolicyRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/replications/policy

Request header

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

Request body

{
    "policy": "RESYNC"
}

Example HTTP response

Response 200

{
    "cycle": "5MIN",
    "sync_state": "SNAPMIRROED"
}

3.1.32 - Set Volume Group Snapshot Schedule

3.1.32.1 - 1.2

put /v1/volume-groups/{volume_group_id}/snapshot-schedules

Description

볼륨 그룹 스냅샷 스케줄을 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupSnapshotScheduleRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.2"

Request body

{
    "day_of_week": "SUN",
    "hour": 18
}

Example HTTP response

Response 200

{
    "day_of_week": "SUN",
    "frequency": "DAILY",
    "hour": 18,
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

3.1.32.2 - 1.1

put /v1/volume-groups/{volume_group_id}/snapshot-schedules

Description

볼륨 그룹 스냅샷 스케줄을 수정한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupSnapshotScheduleRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.1"

Request body

{
    "day_of_week": "SUN",
    "hour": 18
}

Example HTTP response

Response 200

{
    "day_of_week": "SUN",
    "frequency": "DAILY",
    "hour": 18,
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

3.1.32.3 - 1.0

put /v1/volume-groups/{volume_group_id}/snapshot-schedules

Description

볼륨 그룹 스냅샷 스케줄을 수정한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None
body	body required		VolumeGroupSnapshotScheduleRequest

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.0"

Request body

{
    "day_of_week": "SUN",
    "hour": 18
}

Example HTTP response

Response 200

{
    "day_of_week": "SUN",
    "frequency": "DAILY",
    "hour": 18,
    "volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}

3.1.33 - Set Volume QoS

3.1.33.1 - 1.2

put /v1/volumes/{volume_id}/qos

Description

볼륨 QoS를 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		SetVolumeQoSRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/qos

Request header

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

Request body

{
    "iops": 3000,
    "throughput": 125
}

Example HTTP response

Response 200

{
    "iops": 3000,
    "throughput": 125
}

3.1.34 - Set Volume Replication Cycle

3.1.34.1 - 1.2

put /v1/volumes/{volume_id}/replications/cycle

Description

복제본 볼륨 주기를 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeReplicationCycleRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/replications/cycle

Request header

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

Request body

{
    "cycle": "5MIN"
}

Example HTTP response

Response 200

{
    "cycle": "5MIN",
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.34.2 - 1.1

put /v1/volumes/{volume_id}/replications/cycle

Description

복제본 볼륨 주기를 수정한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeReplicationCycleRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/replications/cycle

Request header

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

Request body

{
    "cycle": "5MIN"
}

Example HTTP response

Response 200

{
    "cycle": "5MIN",
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.34.3 - 1.0

put /v1/volumes/{volume_id}/replications/cycle

Description

복제본 볼륨 주기를 수정한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeReplicationCycleRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/replications/cycle

Request header

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

Request body

{
    "cycle": "5MIN"
}

Example HTTP response

Response 200

{
    "cycle": "5MIN",
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.35 - Set Volume Replication Policy

3.1.35.1 - 1.2

put /v1/volumes/{volume_id}/replications/policy

Description

복제본 볼륨 정책을 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeReplicationPolicyRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/replications/policy

Request header

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

Request body

{
    "policy": "RESYNC"
}

Example HTTP response

Response 200

{
    "sync_cycle": "5MIN",
    "sync_state": "SNAPMIRROED"
}

3.1.35.2 - 1.1

put /v1/volumes/{volume_id}/replications/policy

Description

복제본 볼륨 정책을 수정한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeReplicationPolicyRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/replications/policy

Request header

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

Request body

{
    "policy": "RESYNC"
}

Example HTTP response

Response 200

{
    "sync_cycle": "5MIN",
    "sync_state": "SNAPMIRROED"
}

3.1.35.3 - 1.0

put /v1/volumes/{volume_id}/replications/policy

Description

복제본 볼륨 정책을 수정한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeReplicationPolicyRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/replications/policy

Request header

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

Request body

{
    "policy": "RESYNC"
}

Example HTTP response

Response 200

{
    "sync_cycle": "5MIN",
    "sync_state": "SNAPMIRROED"
}

3.1.36 - Set Volume Snapshot Rate

3.1.36.1 - 1.2

put /v1/volumes/{volume_id}/snapshot-rates

Description

볼륨 스냅샷 용량을 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeSnapshotRateRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-rates

Request header

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

Request body

{
    "snapshot_rate": 100
}

Example HTTP response

Response 200

{
    "is_snapshot_activated": true,
    "snapshot_rate": 100,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.36.2 - 1.1

put /v1/volumes/{volume_id}/snapshot-rates

Description

볼륨 스냅샷 용량을 수정한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeSnapshotRateRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-rates

Request header

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

Request body

{
    "snapshot_rate": 100
}

Example HTTP response

Response 200

{
    "is_snapshot_activated": true,
    "snapshot_rate": 100,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.36.3 - 1.0

put /v1/volumes/{volume_id}/snapshot-rates

Description

볼륨 스냅샷 용량을 수정한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeSnapshotRateRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/snapshot-rates

Request header

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

Request body

{
    "snapshot_rate": 100
}

Example HTTP response

Response 200

{
    "is_snapshot_activated": true,
    "snapshot_rate": 100,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.37 - Set Volume Snapshot Schedule

3.1.37.1 - 1.2

put /v1/volumes/{volume_id}/snapshot-schedules

Description

볼륨 스냅샷 스케줄을 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeSnapshotScheduleRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.2"

Request body

{
    "day_of_week": "SUN",
    "hour": 18
}

Example HTTP response

Response 200

{
    "day_of_week": "",
    "frequency": "DAILY",
    "hour": 18,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.37.2 - 1.1

put /v1/volumes/{volume_id}/snapshot-schedules

Description

볼륨 스냅샷 스케줄을 수정한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeSnapshotScheduleRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.1"

Request body

{
    "day_of_week": "SUN",
    "hour": 18
}

Example HTTP response

Response 200

{
    "day_of_week": "",
    "frequency": "DAILY",
    "hour": 18,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.37.3 - 1.0

put /v1/volumes/{volume_id}/snapshot-schedules

Description

볼륨 스냅샷 스케줄을 수정한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None
body	body required		VolumeSnapshotScheduleRequest

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.0"

Request body

{
    "day_of_week": "SUN",
    "hour": 18
}

Example HTTP response

Response 200

{
    "day_of_week": "",
    "frequency": "DAILY",
    "hour": 18,
    "volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}

3.1.38 - Show Volume

3.1.38.1 - 1.2

get /v1/volumes/{volume_id}

Description

볼륨을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}

Request header

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

Example HTTP response

Response 200

{
    "result": {
        "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
        "attachments": [
            {
                "id": "83c3c73d457345e3829ee6d5557c0011",
                "image_name": "RHEL 8.8 for BM",
                "name": "baremetal-01",
                "srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
                "state": "RUNNING",
                "type": "BM"
            }
        ],
        "created_at": "2024-08-01T07:06:23.315Z",
        "created_by": "samsung-cloud-platform1@samsung.com",
        "disk_type": "SSD",
        "external_errors": [
            {
                "code": "Forbidden",
                "object_type": "BM",
                "status": 403
            }
        ],
        "has_origin": true,
        "has_replication": true,
        "id": "7239779c01e3405f82bb71c7f4b55fcd",
        "is_encryption": true,
        "iscsi_target_ips": [
            "172.30.4.3",
            "172.30.4.4"
        ],
        "modified_at": "2024-08-01T07:06:25.315Z",
        "modified_by": "samsung-cloud-platform2@samsung.com",
        "name": "bs-01",
        "previous_state": "CREATING",
        "purpose": "ORG",
        "qos": {
            "iops": 3000,
            "throughput": 125
        },
        "recovery": {
            "origin_volume": {
                "attachments": [
                    {
                        "id": "83c3c73d457345e3829ee6d5557c0011",
                        "type": "BM"
                    }
                ],
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "bs-01"
            },
            "recovery_volume": {
                "attachments": [
                    {
                        "id": "83c3c73d457345e3829ee6d5557c0011",
                        "type": "BM"
                    }
                ],
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "bs-01"
            }
        },
        "size_gb": 10,
        "snapshot_rate": 100,
        "snapshot_schedule": {
            "day_of_week": "MON",
            "frequency": "DAILY",
            "hour": 18
        },
        "srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
        "state": "CREATING",
        "storage_volume_name": "vo202407310544da8aadc775f",
        "volume_group": {
            "id": "7239779c01e3405f82bb71c7f4b55fcd",
            "name": "vg-01"
        }
    }
}

3.1.38.2 - 1.1

get /v1/volumes/{volume_id}

Description

볼륨을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}

Request header

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

Example HTTP response

Response 200

{
    "result": {
        "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
        "attachments": [
            {
                "id": "83c3c73d457345e3829ee6d5557c0011",
                "image_name": "RHEL 8.8 for BM",
                "name": "baremetal-01",
                "srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
                "state": "RUNNING",
                "type": "BM"
            }
        ],
        "created_at": "2024-08-01T07:06:23.315Z",
        "created_by": "samsung-cloud-platform1@samsung.com",
        "disk_type": "SSD",
        "external_errors": [
            {
                "code": "Forbidden",
                "object_type": "BM",
                "status": 403
            }
        ],
        "has_origin": true,
        "has_replication": true,
        "id": "7239779c01e3405f82bb71c7f4b55fcd",
        "is_encryption": true,
        "iscsi_target_ips": [
            "172.30.4.3",
            "172.30.4.4"
        ],
        "modified_at": "2024-08-01T07:06:25.315Z",
        "modified_by": "samsung-cloud-platform2@samsung.com",
        "name": "bs-01",
        "previous_state": "CREATING",
        "purpose": "ORG",
        "recovery": {
            "origin_volume": {
                "attachments": [
                    {
                        "id": "83c3c73d457345e3829ee6d5557c0011",
                        "type": "BM"
                    }
                ],
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "bs-01"
            },
            "recovery_volume": {
                "attachments": [
                    {
                        "id": "83c3c73d457345e3829ee6d5557c0011",
                        "type": "BM"
                    }
                ],
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "bs-01"
            }
        },
        "size_gb": 10,
        "snapshot_rate": 100,
        "snapshot_schedule": {
            "day_of_week": "MON",
            "frequency": "DAILY",
            "hour": 18
        },
        "srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
        "state": "CREATING",
        "storage_volume_name": "vo202407310544da8aadc775f",
        "volume_group": {
            "id": "7239779c01e3405f82bb71c7f4b55fcd",
            "name": "vg-01"
        }
    }
}

3.1.38.3 - 1.0

get /v1/volumes/{volume_id}

Description

볼륨을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}

Request header

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

Example HTTP response

Response 200

{
    "result": {
        "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
        "attachments": [
            {
                "id": "83c3c73d457345e3829ee6d5557c0011",
                "image_name": "RHEL 8.8 for BM",
                "name": "baremetal-01",
                "srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
                "state": "RUNNING",
                "type": "BM"
            }
        ],
        "created_at": "2024-08-01T07:06:23.315Z",
        "created_by": "samsung-cloud-platform1@samsung.com",
        "disk_type": "SSD",
        "external_errors": [
            {
                "code": "Forbidden",
                "object_type": "BM",
                "status": 403
            }
        ],
        "has_origin": true,
        "has_replication": true,
        "id": "7239779c01e3405f82bb71c7f4b55fcd",
        "is_encryption": true,
        "iscsi_target_ips": [
            "172.30.4.3",
            "172.30.4.4"
        ],
        "modified_at": "2024-08-01T07:06:25.315Z",
        "modified_by": "samsung-cloud-platform2@samsung.com",
        "name": "bs-01",
        "previous_state": "CREATING",
        "purpose": "ORG",
        "recovery": {
            "origin_volume": {
                "attachments": [
                    {
                        "id": "83c3c73d457345e3829ee6d5557c0011",
                        "type": "BM"
                    }
                ],
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "bs-01"
            },
            "recovery_volume": {
                "attachments": [
                    {
                        "id": "83c3c73d457345e3829ee6d5557c0011",
                        "type": "BM"
                    }
                ],
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "bs-01"
            }
        },
        "size_gb": 10,
        "snapshot_rate": 100,
        "snapshot_schedule": {
            "day_of_week": "MON",
            "frequency": "DAILY",
            "hour": 18
        },
        "srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
        "state": "CREATING",
        "storage_volume_name": "vo202407310544da8aadc775f",
        "volume_group": {
            "id": "7239779c01e3405f82bb71c7f4b55fcd",
            "name": "vg-01"
        }
    }
}

3.1.39 - Show Volume Group

3.1.39.1 - 1.2

get /v1/volume-groups/{volume_group_id}

Description

볼륨 그룹을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_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 = baremetal-blockstorage 1.2"

Example HTTP response

Response 200

{
    "result": {
        "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
        "created_at": "2024-08-01T07:06:23.315Z",
        "created_by": "samsung-cloud-platform1@samsung.com",
        "has_origin": true,
        "has_replication": true,
        "id": "c9ecae8b973b425c81c3817893cd8063",
        "member_volumes": [
            {
                "disk_type": "SSD",
                "id": "92cd16fe8ebc4f73832513a172bf0000",
                "name": "bs-01",
                "origin_volume": {
                    "id": "7239779c01e3405f82bb71c7f4b55fcd",
                    "name": "my_name"
                },
                "recovery_volume": {
                    "id": "7239779c01e3405f82bb71c7f4b55fcd",
                    "name": "my_name"
                },
                "size_gb": 10,
                "snapshot_rate": 100,
                "state": "CREATING"
            }
        ],
        "modified_at": "2024-08-01T07:06:25.315Z",
        "modified_by": "samsung-cloud-platform2@samsung.com",
        "name": "vg-01",
        "purpose": "ORG",
        "recovery": {
            "origin_volume_group": {
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "my_name"
            },
            "recovery_volume_group": {
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "my_name"
            }
        },
        "snapshot_schedule": {
            "day_of_week": "MON",
            "frequency": "DAILY",
            "hour": 18
        },
        "so_storage_id": 200,
        "so_volume_pool_id": "bm-01",
        "state": "CREATING",
        "storage_volume_group_name": "go02407310544da8aadc775f"
    }
}

3.1.39.2 - 1.1

get /v1/volume-groups/{volume_group_id}

Description

볼륨 그룹을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_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 = baremetal-blockstorage 1.1"

Example HTTP response

Response 200

{
    "result": {
        "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
        "created_at": "2024-08-01T07:06:23.315Z",
        "created_by": "samsung-cloud-platform1@samsung.com",
        "has_origin": true,
        "has_replication": true,
        "id": "c9ecae8b973b425c81c3817893cd8063",
        "member_volumes": [
            {
                "disk_type": "SSD",
                "id": "92cd16fe8ebc4f73832513a172bf0000",
                "name": "bs-01",
                "origin_volume": {
                    "id": "7239779c01e3405f82bb71c7f4b55fcd",
                    "name": "my_name"
                },
                "recovery_volume": {
                    "id": "7239779c01e3405f82bb71c7f4b55fcd",
                    "name": "my_name"
                },
                "size_gb": 10,
                "snapshot_rate": 100,
                "state": "CREATING"
            }
        ],
        "modified_at": "2024-08-01T07:06:25.315Z",
        "modified_by": "samsung-cloud-platform2@samsung.com",
        "name": "vg-01",
        "purpose": "ORG",
        "recovery": {
            "origin_volume_group": {
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "my_name"
            },
            "recovery_volume_group": {
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "my_name"
            }
        },
        "snapshot_schedule": {
            "day_of_week": "MON",
            "frequency": "DAILY",
            "hour": 18
        },
        "so_storage_id": 200,
        "so_volume_pool_id": "bm-01",
        "state": "CREATING",
        "storage_volume_group_name": "go02407310544da8aadc775f"
    }
}

3.1.39.3 - 1.0

get /v1/volume-groups/{volume_group_id}

Description

볼륨 그룹을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_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 = baremetal-blockstorage 1.0"

Example HTTP response

Response 200

{
    "result": {
        "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
        "created_at": "2024-08-01T07:06:23.315Z",
        "created_by": "samsung-cloud-platform1@samsung.com",
        "has_origin": true,
        "has_replication": true,
        "id": "c9ecae8b973b425c81c3817893cd8063",
        "member_volumes": [
            {
                "disk_type": "SSD",
                "id": "92cd16fe8ebc4f73832513a172bf0000",
                "name": "bs-01",
                "origin_volume": {
                    "id": "7239779c01e3405f82bb71c7f4b55fcd",
                    "name": "my_name"
                },
                "recovery_volume": {
                    "id": "7239779c01e3405f82bb71c7f4b55fcd",
                    "name": "my_name"
                },
                "size_gb": 10,
                "snapshot_rate": 100,
                "state": "CREATING"
            }
        ],
        "modified_at": "2024-08-01T07:06:25.315Z",
        "modified_by": "samsung-cloud-platform2@samsung.com",
        "name": "vg-01",
        "purpose": "ORG",
        "recovery": {
            "origin_volume_group": {
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "my_name"
            },
            "recovery_volume_group": {
                "id": "7239779c01e3405f82bb71c7f4b55fcd",
                "name": "my_name"
            }
        },
        "snapshot_schedule": {
            "day_of_week": "MON",
            "frequency": "DAILY",
            "hour": 18
        },
        "so_storage_id": 200,
        "so_volume_pool_id": "bm-01",
        "state": "CREATING",
        "storage_volume_group_name": "go02407310544da8aadc775f"
    }
}

3.1.40 - Show Volume Group Replication

3.1.40.1 - 1.2

get /v1/volume-groups/{volume_group_id}/replications

Description

복제본 볼륨 그룹을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.2"

Example HTTP response

Response 200

{
    "result": {
        "related_volume_groups": [],
        "sync_cycle": "5MIN",
        "sync_state": "SNAPMIRROED"
    }
}

3.1.40.2 - 1.1

get /v1/volume-groups/{volume_group_id}/replications

Description

복제본 볼륨 그룹을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.1"

Example HTTP response

Response 200

{
    "result": {
        "related_volume_groups": [],
        "sync_cycle": "5MIN",
        "sync_state": "SNAPMIRROED"
    }
}

3.1.40.3 - 1.0

get /v1/volume-groups/{volume_group_id}/replications

Description

복제본 볼륨 그룹을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_group_id required	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups/{volume_group_id}/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 = baremetal-blockstorage 1.0"

Example HTTP response

Response 200

{
    "result": {
        "related_volume_groups": [],
        "sync_cycle": "5MIN",
        "sync_state": "SNAPMIRROED"
    }
}

3.1.41 - Show Volume Replication

3.1.41.1 - 1.2

get /v1/volumes/{volume_id}/replications

Description

복제본 볼륨을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.2"

Example HTTP response

Response 200

{
    "result": {
        "related_volumes": [],
        "sync_cycle": "5MIN",
        "sync_state": "SNAPMIRROED"
    }
}

3.1.41.2 - 1.1

get /v1/volumes/{volume_id}/replications

Description

복제본 볼륨을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.1"

Example HTTP response

Response 200

{
    "result": {
        "related_volumes": [],
        "sync_cycle": "5MIN",
        "sync_state": "SNAPMIRROED"
    }
}

3.1.41.3 - 1.0

get /v1/volumes/{volume_id}/replications

Description

복제본 볼륨을 상세 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	volume_id required	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string	None

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/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 = baremetal-blockstorage 1.0"

Example HTTP response

Response 200

{
    "result": {
        "related_volumes": [],
        "sync_cycle": "5MIN",
        "sync_state": "SNAPMIRROED"
    }
}

3.2 - Models

3.2.1 - AsyncResponse

Name	Description	Schema	Default
request_id optional	요청 id Example : `req-0006064c-c008-458c-8977-19671c6b32d4`	string
resource_id optional	자원 id Example : `8bf55e738d4e44b5a21dbe133a42ecbe`	string

3.2.2 - AttachedServer

Name	Description	Schema
id optional	서버 id Example : `83c3c73d457345e3829ee6d5557c0011`	string
image_name optional	이미지명 Example : `RHEL 8.8 for BM`	string
name optional	서버 명 Example : `baremetal-01`	string
srn optional	SRN Example : `srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0`	string
state optional	서버 상태 Example : `RUNNING`	string
type optional	서버 유형 Example : `BM`	enum (BM, MNGC)

3.2.3 - AttachmentListModel

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

3.2.4 - ExternalError

Name	Description	Schema
code optional	코드 Example : `Forbidden`	string
object_type optional	서버 유형 Example : `BM`	enum (BM, MNGC)
status optional	상태 Example : `403`	integer

3.2.5 - MemberVolume

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

3.2.6 - MemberVolumeWithRecoveryInfo

Name	Description	Schema
disk_type optional	디스크 유형 Example : `SSD`	enum (SSD, HDD)
id optional	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string
name optional	볼륨명 Example : `bs-01`	string
origin_volume optional	원본 볼륨 정보	SimpleIdNameInfo
recovery_volume optional	복구본 볼륨 정보	SimpleIdNameInfo
size_gb optional	볼륨 용량(GB) Example : `10`	integer
snapshot_rate optional	스냅샷 용량 Example : `100`	integer
state optional	현재 상태 Example : `CREATING`	enum (CREATING, IN_USE, EDITING, DELETING, DELETED, ATTACHING, DETACHING, AVAILABLE, ERROR_DELETING, ERROR_EDITING, ERROR)

3.2.7 - QoSModel

Name	Description	Schema	Default
iops required	최소 3,000 IOPS에서 최대 16,000 IOPS 사이의 값을 입력하세요. Example : `3000`	integer
throughput required	최소 125MB/s에서 최대 1,000MB/s 사이의 값을 입력하세요. Example : `125`	integer

3.2.8 - RecoveryInfo

Name	Description	Schema	Default
origin_volume optional	원본 볼륨 정보	RecoveryVolumeInfo
recovery_volume optional	복구본 볼륨 정보	RecoveryVolumeInfo

3.2.9 - RecoveryVolumeGroupInfo

Name	Description	Schema	Default
origin_volume_group optional	원본 볼륨 그룹 정보	SimpleIdNameInfo
recovery_volume_group optional	복제본 볼륨 그룹 정보	SimpleIdNameInfo

3.2.10 - RecoveryVolumeInfo

Name	Description	Schema
attachments optional	연결 서버	array[SimpleAttachedServer]
id optional	id Example : `7239779c01e3405f82bb71c7f4b55fcd`	string
name optional	볼륨명 Example : `bs-01`	string

3.2.11 - RelationVolumeGroupModel

Name	Description	Schema
auth optional	권한 Example : `READ`	enum (READ, READ_WRITE, UNKNOWN)
id optional	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string
name optional	볼륨명 Example : `bs-01`	string
purpose optional	볼륨 그룹 구분 Example : `ORG`	enum (ORG, REPL, RECOVERY)
region optional	리전 Example : `kr-west1`	string

3.2.12 - RelationVolumeModel

Name	Description	Schema
auth optional	권한 Example : `READ`	enum (READ, READ_WRITE, UNKNOWN)
id optional	id Example : `7239779c01e3405f82bb71c7f4b55fcd`	string
name optional	볼륨명 Example : `bs-01`	string
purpose optional	볼륨 구분 Example : `ORG`	enum (ORG, REPL, BACKUP, RECOVERY)
region optional	리전 Example : `kr-west1`	string

3.2.13 - SetVolumeQoSRequest

Name	Description	Schema	Default
iops optional	IOPS. 생략하면 기존 값이 유지됩니다. Example : `3000`	integer
throughput optional	Throughput. 생략하면 기존 값이 유지됩니다. Example : `125`	integer

3.2.14 - SetVolumeQoSResponse

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

3.2.15 - SimpleAttachedServer

Name	Description	Schema	Default
id optional	서버 id Example : `83c3c73d457345e3829ee6d5557c0011`	string
type optional	서버 유형 Example : `BM`	enum (BM, MNGC)

3.2.16 - SimpleIdNameInfo

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

3.2.17 - SnapshotSchedule

Name	Description	Schema	Default
day_of_week optional	요일 Example : `MON`	string	MON
frequency optional	주기 DAILY	WEEKLY	NONE Example : `DAILY`
hour optional	시간 Example : `18`	integer

3.2.18 - TagModel

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

3.2.19 - VolumeAttachmentRequest

Name	Description	Schema	Default
attachments required	서버 id, 유형 목록	array[AttachmentListModel]

3.2.20 - VolumeAttachmentResponse

Name	Description	Schema	Default
attachments optional	서버 id, 유형 목록	array[AttachmentListModel]

3.2.21 - VolumeCreateRequest

Name	Description	Schema
attachments required	서버 id, 유형 목록	array[AttachmentListModel]
disk_type required	디스크 유형 Example : `SSD`	enum (SSD, HDD)
name required	볼륨명 Example : `bs-01`	string
size_gb required	볼륨 용량(GB) Example : `10`	integer
tags optional	태그	any of [array[TagModel], null]

3.2.22 - VolumeCreateRequestV1Dot2

Name	Description	Schema
attachments required	서버 id, 유형 목록	array[AttachmentListModel]
disk_type required	디스크 유형 Example : `SSD`	enum (SSD, HDD)
name required	볼륨명 Example : `bs-01`	string
qos optional	볼륨 QoS	QoSModel
size_gb required	볼륨 용량(GB) Example : `10`	integer
tags optional	태그	any of [array[TagModel], null]

3.2.23 - VolumeDetachRequest

Name	Description	Schema	Default
attachments required	연결해지 object id 목록	array[string]

3.2.24 - VolumeGroupCreationRequest

Name	Description	Schema
name required	볼륨 그룹명 Example : `vg-01`	string
tags optional	태그	any of [array[TagModel], null]
volume_ids required	추가할 볼륨(Block Storage) id 목록 Example : `['17e0b4fd27784dfb843440ec08bdd148']`	array[string]

3.2.25 - VolumeGroupInfo

Name	Description	Schema	Default
id optional	id Example : `7239779c01e3405f82bb71c7f4b55fcd`	string
name optional	볼륨 그룹명 Example : `vg-01`	string

3.2.26 - VolumeGroupListModel

Name	Description	Schema	Default
account_id optional	계정 id Example : `36827d9b643f46c2ae6bb7e63d633bfe`	string
created_at optional	생성일시 Example : `2024-08-01T07:06:23.315Z`	string (date-time)
created_by optional	생성자 Example : `samsung-cloud-platform1@samsung.com`	string
id optional	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string
modified_at optional	수정일시 Example : `2024-08-01T07:06:25.315Z`	string (date-time)
modified_by optional	수정자 Example : `samsung-cloud-platform2@samsung.com`	string
name optional	볼륨 그룹명 Example : `vg-01`	string
num_of_block_storages optional	볼륨 수 Example : `2`	integer	1
purpose optional	볼륨 그룹 구분 Example : `ORG`	string
state optional	현재 상태 Example : `CREATING`	enum (CREATING, AVAILABLE, DELETING, EDITING, DELETED, ERROR_DELETING, ERROR_EDITING, ERROR)

3.2.27 - VolumeGroupListResponse

Name	Description	Schema	Default
total_count optional	총 개수 Example : `1`	integer
volume_groups optional	볼륨 그룹 목록	array[VolumeGroupListModel]

3.2.28 - VolumeGroupMemberRequest

Name	Description	Schema	Default
volume_ids required	볼륨(Block Storage) id 목록 Example : `['13666d6c32d4456e8421f7768d0bf225']`	array[string]

3.2.29 - VolumeGroupMemberResponse

Name	Description	Schema	Default
id optional	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string
member_volumes optional	멤버 볼륨 목록	array[MemberVolume]

3.2.30 - VolumeGroupModel

Name	Description	Schema
account_id optional	계정 id Example : `36827d9b643f46c2ae6bb7e63d633bfe`	string
created_at optional	생성일시 Example : `2024-08-01T07:06:23.315Z`	string
created_by optional	생성자 Example : `samsung-cloud-platform1@samsung.com`	string
has_origin optional	원본 관계 존재 여부 Example : `True`	boolean
has_replication optional	복제 관계 존재 여부 Example : `True`	boolean
id optional	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string
member_volumes optional	멤버 볼륨 목록	array[MemberVolumeWithRecoveryInfo]
modified_at optional	수정일시 Example : `2024-08-01T07:06:25.315Z`	string
modified_by optional	수정자 Example : `samsung-cloud-platform2@samsung.com`	string
name optional	볼륨 그룹명 Example : `vg-01`	string
purpose optional	볼륨 그룹 구분 Example : `ORG`	enum (ORG, REPL, RECOVERY)
recovery optional	복제본 볼륨 그룹 정보	RecoveryVolumeGroupInfo
snapshot_schedule optional	스냅샷 스케줄	SnapshotSchedule
so_storage_id optional	So 스토리지 id Example : `200`	integer
so_volume_pool_id optional	So 볼륨풀 id Example : `bm-01`	string
state optional	현재 상태 Example : `CREATING`	enum (CREATING, AVAILABLE, DELETING, EDITING, DELETED, ERROR_DELETING, ERROR_EDITING, ERROR)
storage_volume_group_name optional	So 볼륨 그룹명 Example : `go02407310544da8aadc775f`	string

3.2.31 - VolumeGroupRecoveryCreateRequest

Name	Description	Schema	Default
block_storage_name_prefix required	Block Storage명 접두사 Example : `prefix-`	string
snapshot_id required	스냅샷 id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string

3.2.32 - VolumeGroupReplicationCreateRequest

Name	Description	Schema
cycle required	복제 주기 Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)
name required	복제본 볼륨 그룹명 Example : `replica-vg-01`	string
region required	리전 Example : `kr-west1`	string
replication_volume_name_prefix required	복제본 볼륨명 접두사 Example : `dr`	string

3.2.33 - VolumeGroupReplicationDeleteResponse

Name	Description	Schema	Default
result optional	결과 Example :	boolean

3.2.34 - VolumeGroupReplicationSyncTabModel

Name	Description	Schema
related_volume_groups optional	연관 볼륨 그룹 목록	array[RelationVolumeGroupModel]
sync_cycle optional	복제 주기 Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)
sync_state optional	복제 상태 Example : `SNAPMIRROED`	string

3.2.35 - VolumeGroupReplicationSyncTabResponse

Name	Description	Schema	Default
result optional	볼륨 그룹 복제 정보	VolumeGroupReplicationSyncTabModel

3.2.36 - VolumeGroupReplicationUpdateCycleRequest

Name	Description	Schema	Default
cycle required	복제 주기 Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)

3.2.37 - VolumeGroupReplicationUpdateCycleResponse

Name	Description	Schema	Default
cycle optional	복제 주기 Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)
volume_group_id optional	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string

3.2.38 - VolumeGroupReplicationUpdatePolicyRequest

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

3.2.39 - VolumeGroupReplicationUpdatePolicyResponse

Name	Description	Schema	Default
cycle optional	복제 주기 Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)
sync_state optional	복제 상태 Example : `SNAPMIRROED`	string

3.2.40 - VolumeGroupResponse

Name	Description	Schema	Default
result optional	볼륨 그룹 상세 정보	VolumeGroupModel

3.2.41 - VolumeGroupSnapshotDeleteResponse

Name	Description	Schema
account_id optional	계정 id Example : `36827d9b643f46c2ae6bb7e63d633bfe`	string
snapshot_id optional	스냅샷 id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string
volume_group_id optional	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string

3.2.42 - VolumeGroupSnapshotListModel

Name	Description	Schema
created_dt optional	생성일시 Example : `2024-08-01T07:07:23.315Z`	string
snapshot_id optional	스냅샷 id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string
snapshot_name optional	스냅샷 이름 Example : `vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932`	string

3.2.43 - VolumeGroupSnapshotListResponse

Name	Description	Schema
is_snapshot_policy optional	스냅샷 활성화 여부 Example : `False`	boolean
snapshots optional	스냅샷 목록	array[VolumeGroupSnapshotListModel]
volume_group_id optional	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string

3.2.44 - VolumeGroupSnapshotResponse

Name	Description	Schema
account_id optional	계정 id Example : `36827d9b643f46c2ae6bb7e63d633bfe`	string
snapshot_id optional	스냅샷 id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string
snapshot_name optional	스냅샷 이름 Example : `vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932`	string
volume_group_id optional	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string

3.2.45 - VolumeGroupSnapshotRestoreResponse

Name	Description	Schema
account_id optional	계정 id Example : `36827d9b643f46c2ae6bb7e63d633bfe`	string
snapshot_id optional	스냅샷 id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string
volume_group_id optional	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string

3.2.46 - VolumeGroupSnapshotScheduleRequest

Name	Description	Schema	Default
day_of_week optional	요일(이 필드를 제외할 경우, 스케줄 주기가 DAILY로 설정됩니다.) Example : `SUN`	enum (SUN, MON, TUE, WED, THU, FRI, SAT)
hour required	시간 Example : `18`	integer

3.2.47 - VolumeGroupSnapshotScheduleResponse

Name	Description	Schema	Default
day_of_week optional	요일 Example : `SUN`	enum (SUN, MON, TUE, WED, THU, FRI, SAT)
frequency optional	주기 DAILY	WEEKLY	NONE Example : `DAILY`
hour optional	시간 Example : `18`	integer
volume_group_id optional	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string

3.2.48 - VolumeListModel

Name	Description	Schema
attachments optional	연결 서버 Example : `[{'id': 'd7682135392e42489948c189e29011cc', 'name': 'baremetal-01'}]`	array[object]
created_at optional	생성일시 Example : `2026-02-11T06:40:48.807Z`	string (date-time)
created_by optional	생성자 Example : `samsung-cloud-platform1@samsung.com`	string
disk_type optional	디스크 유형 Example : `SSD`	enum (SSD, HDD)
has_relation optional	관계 존재 여부 Example : `False`	boolean
id optional	id Example : `7239779c01e3405f82bb71c7f4b55fcd`	string
is_in_volume_group optional	볼륨 그룹 소속 여부 Example : `False`	boolean
is_snapshot_activated optional	스냅샷 활성화 여부 Example : `True`	boolean
iscsi_target_ips optional	iscsi ip 목록 Example : `{'description': 'List of iscsi ips', 'example': ['172.30.4.3', '172.30.4.4']}`	array[string]
modified_at optional	수정일시 Example : `2026-02-11T06:40:48.814Z`	string (date-time)
modified_by optional	수정자 Example : `samsung-cloud-platform2@samsung.com`	string
name optional	볼륨명 Example : `bs-01`	string
purpose optional	볼륨 구분 Example : `ORG`	enum (ORG, REPL, BACKUP, RECOVERY)
size_gb optional	볼륨 용량(GB) Example : `10`	integer
state optional	현재 상태 Example : `CREATING`	enum (CREATING, IN_USE, EDITING, DELETING, DELETED, ATTACHING, DETACHING, AVAILABLE, ERROR_DELETING, ERROR_EDITING, ERROR)
volume_group optional	볼륨 그룹 Example :	object

3.2.49 - VolumeListResponse

Name	Description	Schema	Default
total_count optional	총 개수 Example : `1`	integer
volumes optional	볼룸 목록	array[VolumeListModel]

3.2.50 - VolumeModel

Name	Description	Schema
account_id optional	계정 id Example : `36827d9b643f46c2ae6bb7e63d633bfe`	string
attachments optional	연결 서버	array[AttachedServer]
created_at optional	생성일시 Example : `2024-08-01T07:06:23.315Z`	string
created_by optional	생성자 Example : `samsung-cloud-platform1@samsung.com`	string
disk_type optional	디스크 유형 Example : `SSD`	enum (SSD, HDD)
external_errors optional	외부 호출 중 발생한 에러	array[ExternalError]
has_origin optional	원본 관계 존재 여부 Example : `True`	boolean
has_replication optional	복제 관계 존재 여부 Example : `True`	boolean
id optional	id Example : `7239779c01e3405f82bb71c7f4b55fcd`	string
is_encryption optional	암호화 적용 여부 Example : `True`	boolean
iscsi_target_ips optional	iscsi ip 목록 Example : `['172.30.4.3', '172.30.4.4']`	array[string]
modified_at optional	수정일시 Example : `2024-08-01T07:06:25.315Z`	string
modified_by optional	수정자 Example : `samsung-cloud-platform2@samsung.com`	string
name optional	볼륨명 Example : `bs-01`	string
previous_state optional	이전 상태 Example : `CREATING`	enum (CREATING, IN_USE, EDITING, DELETING, DELETED, ATTACHING, DETACHING, AVAILABLE, ERROR_DELETING, ERROR_EDITING, ERROR)
purpose optional	볼륨 구분 Example : `ORG`	enum (ORG, REPL, BACKUP, RECOVERY)
recovery optional	복구본 정보	RecoveryInfo
size_gb optional	볼륨 용량(GB) Example : `10`	integer
snapshot_rate optional	스냅샷 용량 Example : `100`	integer
snapshot_schedule optional	스냅샷 스케줄	SnapshotSchedule
srn optional	SRN Example : `srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0`	string
state optional	현재 상태 Example : `CREATING`	enum (CREATING, IN_USE, EDITING, DELETING, DELETED, ATTACHING, DETACHING, AVAILABLE, ERROR_DELETING, ERROR_EDITING, ERROR)
storage_volume_name optional	스토리지 볼륨명 Example : `vo202407310544da8aadc775f`	string
volume_group optional	볼륨 그룹	VolumeGroupInfo

3.2.51 - VolumeModelV1Dot2

Name	Description	Schema
account_id optional	계정 id Example : `36827d9b643f46c2ae6bb7e63d633bfe`	string
attachments optional	연결 서버	array[AttachedServer]
created_at optional	생성일시 Example : `2024-08-01T07:06:23.315Z`	string
created_by optional	생성자 Example : `samsung-cloud-platform1@samsung.com`	string
disk_type optional	디스크 유형 Example : `SSD`	enum (SSD, HDD)
external_errors optional	외부 호출 중 발생한 에러	array[ExternalError]
has_origin optional	원본 관계 존재 여부 Example : `True`	boolean
has_replication optional	복제 관계 존재 여부 Example : `True`	boolean
id optional	id Example : `7239779c01e3405f82bb71c7f4b55fcd`	string
is_encryption optional	암호화 적용 여부 Example : `True`	boolean
iscsi_target_ips optional	iscsi ip 목록 Example : `['172.30.4.3', '172.30.4.4']`	array[string]
modified_at optional	수정일시 Example : `2024-08-01T07:06:25.315Z`	string
modified_by optional	수정자 Example : `samsung-cloud-platform2@samsung.com`	string
name optional	볼륨명 Example : `bs-01`	string
previous_state optional	이전 상태 Example : `CREATING`	enum (CREATING, IN_USE, EDITING, DELETING, DELETED, ATTACHING, DETACHING, AVAILABLE, ERROR_DELETING, ERROR_EDITING, ERROR)
purpose optional	볼륨 구분 Example : `ORG`	enum (ORG, REPL, BACKUP, RECOVERY)
qos optional	볼륨 QoS	QoSModel
recovery optional	복구본 정보	RecoveryInfo
size_gb optional	볼륨 용량(GB) Example : `10`	integer
snapshot_rate optional	스냅샷 용량 Example : `100`	integer
snapshot_schedule optional	스냅샷 스케줄	SnapshotSchedule
srn optional	SRN Example : `srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0`	string
state optional	현재 상태 Example : `CREATING`	enum (CREATING, IN_USE, EDITING, DELETING, DELETED, ATTACHING, DETACHING, AVAILABLE, ERROR_DELETING, ERROR_EDITING, ERROR)
storage_volume_name optional	스토리지 볼륨명 Example : `vo202407310544da8aadc775f`	string
volume_group optional	볼륨 그룹	VolumeGroupInfo

3.2.52 - VolumeRecoveryCreateRequest

Name	Description	Schema	Default
name required	복구 볼륨명 Example : `recovery-volume`	string
snapshot_id required	스냅샷 id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string

3.2.53 - VolumeReplicationCreateRequest

Name	Description	Schema
cycle required	복제 주기 Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)
name required	복제본 볼륨 목록 Example : `replica-bs-01`	string
region required	리전 Example : `kr-west1`	string

3.2.54 - VolumeReplicationCycleRequest

Name	Description	Schema	Default
cycle required	복제 주기 Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)

3.2.55 - VolumeReplicationCycleResponse

Name	Description	Schema	Default
cycle optional	복제 주기 Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)
volume_id optional	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string

3.2.56 - VolumeReplicationModel

Name	Description	Schema
related_volumes optional	연관 볼륨 목록	array[RelationVolumeModel]
sync_cycle optional	복제 주기 Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)
sync_state optional	복제 상태 Example : `SNAPMIRROED`	string

3.2.57 - VolumeReplicationPolicyRequest

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

3.2.58 - VolumeReplicationPolicyResponse

Name	Description	Schema	Default
sync_cycle optional	복제 주기 Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)
sync_state optional	복제 상태 Example : `SNAPMIRROED`	string

3.2.59 - VolumeReplicationResponse

Name	Description	Schema	Default
result optional	볼륨 복제 정보	VolumeReplicationModel

3.2.60 - VolumeResponse

Name	Description	Schema	Default
result optional	볼륨 상세 정보	VolumeModel

3.2.61 - VolumeResponseV1Dot2

Name	Description	Schema	Default
result optional	볼륨 상세 정보	VolumeModelV1Dot2

3.2.62 - VolumeSnapshotDeleteResponse

Name	Description	Schema
account_id optional	계정 id Example : `36827d9b643f46c2ae6bb7e63d633bfe`	string
snapshot_id optional	스냅샷 id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string
volume_id optional	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string

3.2.63 - VolumeSnapshotListModel

Name	Description	Schema
created_dt optional	생성일시 Example : `2024-08-01T07:07:23.315Z`	string
snapshot_id optional	스냅샷 id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string
snapshot_name optional	스냅샷 이름 Example : `vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932`	string
snapshot_size_mb optional	스냅샷 크기(MB) Example : `0`	object

3.2.64 - VolumeSnapshotListResponse

Name	Description	Schema
is_snapshot_policy optional	스냅샷 활성화 여부 Example : `False`	boolean
snapshot_capacity_mb optional	스냅샷 크기(MB) Example : `0`	object
snapshot_capacity_rate optional	스냅샷 용량 비율 Example : `0`	object
snapshot_total_usage optional	스냅샷 총 사용량 Example : `0`	object
snapshots optional	스냅샷 목록	array[VolumeSnapshotListModel]
volume_id optional	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string

3.2.65 - VolumeSnapshotRateRequest

Name	Description	Schema	Default
snapshot_rate required	스냅샷 용량 Example : `100`	integer

3.2.66 - VolumeSnapshotRateResponse

Name	Description	Schema
is_snapshot_activated optional	스냅샷 활성화 여부 Example : `True`	boolean
snapshot_rate optional	스냅샷 용량 Example : `100`	integer
volume_id optional	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string

3.2.67 - VolumeSnapshotResponse

Name	Description	Schema
account_id optional	계정 id Example : `36827d9b643f46c2ae6bb7e63d633bfe`	string
snapshot_id optional	스냅샷 id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string
snapshot_name optional	스냅샷 이름 Example : `vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932`	string
volume_id optional	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string

3.2.68 - VolumeSnapshotRestoreResponse

Name	Description	Schema
account_id optional	계정 id Example : `36827d9b643f46c2ae6bb7e63d633bfe`	string
snapshot_id optional	스냅샷 id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string
volume_id optional	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string

3.2.69 - VolumeSnapshotScheduleRequest

Name	Description	Schema	Default
day_of_week optional	요일(이 필드를 제외할 경우, 스케줄 주기가 DAILY로 설정됩니다.) Example : `SUN`	enum (SUN, MON, TUE, WED, THU, FRI, SAT)
hour required	시간 Example : `18`	integer

3.2.70 - VolumeSnapshotScheduleResponse

Name	Description	Schema	Default
day_of_week optional	요일 Example : `SUN`	enum (SUN, MON, TUE, WED, THU, FRI, SAT)
frequency optional	주기 DAILY	WEEKLY	NONE Example : `DAILY`
hour optional	시간 Example : `18`	integer
volume_id optional	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string

4 - File Storage

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

4.1 - APIs

4.1.1 - CreateSnapshot

4.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"
    }
}

4.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"
    }
}

4.1.2 - CreateSnapshotSchedule

4.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"
    }
}

4.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"
    }
}

4.1.3 - CreateVolume

4.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"
}

4.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"
}

4.1.4 - CreateVolumeReplication

4.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"
}

4.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"
}

4.1.5 - DeleteSnapshot

4.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

4.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

4.1.6 - DeleteSnapshotSchedule

4.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

4.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

4.1.7 - DeleteVolume

4.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

4.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

4.1.8 - DeleteVolumeReplication

4.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

4.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

4.1.9 - ListAccessRules

4.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"
        }
    ]
}

4.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"
        }
    ]
}

4.1.10 - ListSnapshots

4.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
}

4.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
}

4.1.11 - ListSnapshotSchedule

4.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"
        }
    ]
}

4.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"
        }
    ]
}

4.1.12 - ListVolumeReplicationRegion

4.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']"
}

4.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']"
}

4.1.13 - ListVolumeReplications

4.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"
        }
    ]
}

4.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"
        }
    ]
}

4.1.14 - ListVolumes

4.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"
        }
    ]
}

4.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"
        }
    ]
}

4.1.15 - RestoreSnapshot

4.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"
    }
}

4.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"
    }
}

4.1.16 - SetAccessRule

4.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"
}

4.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"
}

4.1.17 - SetSnapshotSchedule

4.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"
    }
}

4.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"
    }
}

4.1.18 - SetVolume

4.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
}

4.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
}

4.1.19 - SetVolumeReplication

4.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
}

4.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
}

4.1.20 - ShowVolume

4.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"
}

4.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"
}

4.1.21 - ShowVolumeReplication

4.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
}

4.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
}

4.2 - Models

4.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

4.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

4.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

4.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

4.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

4.2.6 - ReplicationListResponse

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

4.2.7 - ReplicationRegionListResponse

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

4.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]

4.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

4.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]

4.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)

4.2.12 - SnapshotCreateRequest

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

4.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

4.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]

4.2.15 - SnapshotRestoreResponse

Name	Description	Schema	Default
snapshot required		Snapshot

4.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

4.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

4.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

4.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]

4.2.20 - SnapshotScheduleSetRequest

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

4.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

4.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]

4.2.23 - SnapshotShowResponse

Name	Description	Schema	Default
snapshot required		SnapshotDetail

4.2.24 - Tag

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

4.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

4.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]

4.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

4.2.28 - VolumeListResponse

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

4.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

4.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]

4.2.31 - VolumeSetRequest

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

4.2.32 - VolumeSetResponse

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

4.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]

5 - Parallel File Storage

Overview

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

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

Version

Version	Status	Supported Until
1.0	CURRENT	-

OpenAPI URL

https://parallel-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

5.1 - APIs

5.1.1 - CreateSnapshot

5.1.1.1 - 1.0

post /v1/snapshots

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
body	body required		SnapshotCreateRequest

Responses

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

Example HTTP request

Request path

/v1/snapshots

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = 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": 100,
        "state": "available",
        "created_at": "2024-10-30T04:54:33.219373",
        "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438"
    }
}

5.1.2 - CreateVolume

5.1.2.1 - 1.0

post /v1/volumes

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
body	body required		VolumeCreateRequest

Responses

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

Example HTTP request

Request path

/v1/volumes

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = 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"
}

5.1.3 - DeleteSnapshot

5.1.3.1 - 1.0

delete /v1/snapshots/{snapshot_id}

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

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
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/snapshots/{snapshot_id}?volume_id={volume_id}

Request header

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

Example HTTP response

Response 202

5.1.4 - DeleteVolume

5.1.4.1 - 1.0

delete /v1/volumes/{volume_id}

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

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
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 = parallel-filestorage 1.0"

Example HTTP response

Response 202

5.1.5 - ListAccessRule

5.1.5.1 - 1.0

get /v1/access-rules

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

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	AccessRuleListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/access-rules?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,
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "access_rules": [
        {
            "object_id": "43fq3347-02q4-4aa8-ccf9-affe4917bb6f",
            "object_type": "GPU_NODE",
            "object_name": "objectname",
            "object_state": "RUNNING",
            "access_state": "all",
            "access_ip_list": [
                {
                    "access_ip": "xxx.xxx.xxx.xxx",
                    "access_ip_state": "active"
                }
            ]
        }
    ]
}

5.1.6 - ListSnapshots

5.1.6.1 - 1.0

get /v1/snapshots

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

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
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/snapshots?volume_id={volume_id}

Request header

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

Example HTTP response

Response 200

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

5.1.7 - ListVolumes

5.1.7.1 - 1.0

get /v1/volumes

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

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	sort optional	정렬 Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	VolumeListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/volumes

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = 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"
        }
    ]
}

5.1.8 - SetAccessRule

5.1.8.1 - 1.0

put /v1/access-rules

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/access-rules?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"

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"
}

5.1.9 - SetVolumeCapacity

5.1.9.1 - 1.0

put /v1/volumes/{volume_id}/capacity

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/capacity

Request header

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

Request body

{
    "capacity_tb": 100
}

Example HTTP response

Response 202

5.1.10 - ShowVolume

5.1.10.1 - 1.0

get /v1/volumes/{volume_id}

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

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
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/volumes/{volume_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = 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"
}

5.2 - Models

5.2.1 - AccessIp

Name	Description	Schema	Default
access_ip required	접근 아이피 Example : `xxx.xxx.xxx.xxx`	string
access_ip_state required	접근아이피 상태 Example : `active`	string

5.2.2 - AccessRule

Name	Description	Schema	Default
object_id required	오브젝트 아이디 Example : `43fq3347-02q4-4aa8-ccf9-affe4917bb6f`	string
object_type required	오브젝트 유형 Example : `GPU_NODE` Pattern : `^(GPU_NODE)$`	string

5.2.3 - AccessRuleListResponse

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

5.2.4 - AccessRules

Name	Description	Schema
object_id required	오브젝트 아이디 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]

5.2.5 - AccessRuleUpdateRequest

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

5.2.6 - AccessRuleUpdateResponse

Name	Description	Schema
add_access_rules required		array[AccessRule]
remove_access_rules required		array[AccessRule]
volume_id required	볼륨 아이디 Example : `bfdbabf2-04d9-4e8b-a205-020f8e6da438`	string

5.2.7 - Snapshot

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

5.2.8 - SnapshotCreateRequest

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

5.2.9 - SnapshotCreateResponse

Name	Description	Schema	Default
snapshot required	스냅샷	SnapshotResponse

5.2.10 - SnapshotListResponse

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

5.2.11 - SnapshotResponse

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

5.2.12 - Tag

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

5.2.13 - Volume

Name	Description	Schema
id required	볼륨 아이디 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	어카운트 아이디 Example : `rwww523320dfvwbbefefsdvwdadsfa24c`	string

5.2.14 - VolumeCapacityRequest

Name	Description	Schema	Default
capacity_tb required	볼륨 용량 Example : `100` Minimum : `1` Maximum : `1000`	integer

5.2.15 - VolumeCreateRequest

Name	Description	Schema
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]

5.2.16 - VolumeListResponse

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

5.2.17 - VolumeShowResponse

Name	Description	Schema
id required	볼륨 아이디 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	어카운트 아이디 Example : `rwww523320dfvwbbefefsdvwdadsfa24c`	string
mount_path optional	볼륨 마운트 경로 Example : `xxx.xx.xxx:/xxxxxxxx`	any of [string, null]