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

Block Storage(BM)

1: APIs

1.1: Add Volume Group Member on Volume Group

1.1.1: 1.2
1.1.2: 1.1
1.1.3: 1.0

1.2: Attach Volume

1.2.1: 1.2
1.2.2: 1.1
1.2.3: 1.0

1.3: Create Volume

1.3.1: 1.2
1.3.2: 1.1
1.3.3: 1.0

1.4: Create Volume Group

1.4.1: 1.2
1.4.2: 1.1
1.4.3: 1.0

1.5: Create Volume Group Recovery

1.5.1: 1.2
1.5.2: 1.1

1.6: Create Volume Group Replication

1.6.1: 1.2
1.6.2: 1.1
1.6.3: 1.0

1.7: Create Volume Group Snapshot

1.7.1: 1.2
1.7.2: 1.1
1.7.3: 1.0

1.8: Create Volume Group Snapshot Schedule

1.8.1: 1.2
1.8.2: 1.1
1.8.3: 1.0

1.9: Create Volume Recovery

1.9.1: 1.2
1.9.2: 1.1

1.10: Create Volume Replication

1.10.1: 1.2
1.10.2: 1.1
1.10.3: 1.0

1.11: Create Volume Snapshot

1.11.1: 1.2
1.11.2: 1.1
1.11.3: 1.0

1.12: Create Volume Snapshot Rate

1.12.1: 1.2
1.12.2: 1.1
1.12.3: 1.0

1.13: Create Volume Snapshot Schedule

1.13.1: 1.2
1.13.2: 1.1
1.13.3: 1.0

1.14: Delete Volume

1.14.1: 1.2
1.14.2: 1.1
1.14.3: 1.0

1.15: Delete Volume Group Replication

1.15.1: 1.2
1.15.2: 1.1
1.15.3: 1.0

1.16: Delete Volume Group Snapshot

1.16.1: 1.2
1.16.2: 1.1
1.16.3: 1.0

1.17: Delete Volume Group Snapshot Schedule

1.17.1: 1.2
1.17.2: 1.1
1.17.3: 1.0

1.18: Delete Volume Replication

1.18.1: 1.2
1.18.2: 1.1
1.18.3: 1.0

1.19: Delete Volume Snapshot

1.19.1: 1.2
1.19.2: 1.1
1.19.3: 1.0

1.20: Delete Volume Snapshot Rate

1.20.1: 1.2
1.20.2: 1.1
1.20.3: 1.0

1.21: Delete Volume Snapshot Schedule

1.21.1: 1.2
1.21.2: 1.1
1.21.3: 1.0

1.22: Detach Volume

1.22.1: 1.2
1.22.2: 1.1
1.22.3: 1.0

1.23: List Volume Group Snapshots

1.23.1: 1.2
1.23.2: 1.1
1.23.3: 1.0

1.24: List Volume Groups

1.24.1: 1.2
1.24.2: 1.1
1.24.3: 1.0

1.25: List Volume Snapshots

1.25.1: 1.2
1.25.2: 1.1
1.25.3: 1.0

1.26: List Volumes

1.26.1: 1.2
1.26.2: 1.1
1.26.3: 1.0

1.27: Remove Volume Group Member on Volume Group

1.27.1: 1.2
1.27.2: 1.1
1.27.3: 1.0

1.28: Restore Volume Group Snapshot

1.28.1: 1.2
1.28.2: 1.1
1.28.3: 1.0

1.29: Restore Volume Snapshot

1.29.1: 1.2
1.29.2: 1.1
1.29.3: 1.0

1.30: Set Volume Group Replication Cycle

1.30.1: 1.2
1.30.2: 1.1
1.30.3: 1.0

1.31: Set Volume Group Replication Policy

1.31.1: 1.2
1.31.2: 1.1
1.31.3: 1.0

1.32: Set Volume Group Snapshot Schedule

1.32.1: 1.2
1.32.2: 1.1
1.32.3: 1.0

1.33: Set Volume QoS

1.33.1: 1.2

1.34: Set Volume Replication Cycle

1.34.1: 1.2
1.34.2: 1.1
1.34.3: 1.0

1.35: Set Volume Replication Policy

1.35.1: 1.2
1.35.2: 1.1
1.35.3: 1.0

1.36: Set Volume Snapshot Rate

1.36.1: 1.2
1.36.2: 1.1
1.36.3: 1.0

1.37: Set Volume Snapshot Schedule

1.37.1: 1.2
1.37.2: 1.1
1.37.3: 1.0

1.38: Show Volume

1.38.1: 1.2
1.38.2: 1.1
1.38.3: 1.0

1.39: Show Volume Group

1.39.1: 1.2
1.39.2: 1.1
1.39.3: 1.0

1.40: Show Volume Group Replication

1.40.1: 1.2
1.40.2: 1.1
1.40.3: 1.0

1.41: Show Volume Replication

1.41.1: 1.2
1.41.2: 1.1
1.41.3: 1.0

2: Models

2.1: AsyncResponse
2.2: AttachedServer
2.3: AttachmentListModel
2.4: ExternalError
2.5: MemberVolume
2.6: MemberVolumeWithRecoveryInfo
2.7: QoSModel
2.8: RecoveryInfo
2.9: RecoveryVolumeGroupInfo
2.10: RecoveryVolumeInfo
2.11: RelationVolumeGroupModel
2.12: RelationVolumeModel
2.13: SetVolumeQoSRequest
2.14: SetVolumeQoSResponse
2.15: SimpleAttachedServer
2.16: SimpleIdNameInfo
2.17: SnapshotSchedule
2.18: TagModel
2.19: VolumeAttachmentRequest
2.20: VolumeAttachmentResponse
2.21: VolumeCreateRequest
2.22: VolumeCreateRequestV1Dot2
2.23: VolumeDetachRequest
2.24: VolumeGroupCreationRequest
2.25: VolumeGroupInfo
2.26: VolumeGroupListModel
2.27: VolumeGroupListResponse
2.28: VolumeGroupMemberRequest
2.29: VolumeGroupMemberResponse
2.30: VolumeGroupModel
2.31: VolumeGroupRecoveryCreateRequest
2.32: VolumeGroupReplicationCreateRequest
2.33: VolumeGroupReplicationDeleteResponse
2.34: VolumeGroupReplicationSyncTabModel
2.35: VolumeGroupReplicationSyncTabResponse
2.36: VolumeGroupReplicationUpdateCycleRequest
2.37: VolumeGroupReplicationUpdateCycleResponse
2.38: VolumeGroupReplicationUpdatePolicyRequest
2.39: VolumeGroupReplicationUpdatePolicyResponse
2.40: VolumeGroupResponse
2.41: VolumeGroupSnapshotDeleteResponse
2.42: VolumeGroupSnapshotListModel
2.43: VolumeGroupSnapshotListResponse
2.44: VolumeGroupSnapshotResponse
2.45: VolumeGroupSnapshotRestoreResponse
2.46: VolumeGroupSnapshotScheduleRequest
2.47: VolumeGroupSnapshotScheduleResponse
2.48: VolumeListModel
2.49: VolumeListResponse
2.50: VolumeModel
2.51: VolumeModelV1Dot2
2.52: VolumeRecoveryCreateRequest
2.53: VolumeReplicationCreateRequest
2.54: VolumeReplicationCycleRequest
2.55: VolumeReplicationCycleResponse
2.56: VolumeReplicationModel
2.57: VolumeReplicationPolicyRequest
2.58: VolumeReplicationPolicyResponse
2.59: VolumeReplicationResponse
2.60: VolumeResponse
2.61: VolumeResponseV1Dot2
2.62: VolumeSnapshotDeleteResponse
2.63: VolumeSnapshotListModel
2.64: VolumeSnapshotListResponse
2.65: VolumeSnapshotRateRequest
2.66: VolumeSnapshotRateResponse
2.67: VolumeSnapshotResponse
2.68: VolumeSnapshotRestoreResponse
2.69: VolumeSnapshotScheduleRequest
2.70: VolumeSnapshotScheduleResponse

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

1 - APIs

1.1 - Add Volume Group Member on Volume Group

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": ""
        }
    ]
}

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": ""
        }
    ]
}

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": ""
        }
    ]
}

1.2 - Attach Volume

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"
        }
    ]
}

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"
        }
    }
}

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"
        }
    }
}

1.3 - Create Volume

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"
}

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"
}

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"
}

1.4 - Create Volume Group

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"
}

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"
}

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"
}

1.5 - Create Volume Group Recovery

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"
}

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"
}

1.6 - Create Volume Group Replication

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"
}

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"
}

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"
}

1.7 - Create Volume Group Snapshot

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"
}

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"
}

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"
}

1.8 - Create Volume Group Snapshot Schedule

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"
}

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"
}

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"
}

1.9 - Create Volume Recovery

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"
}

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"
}

1.10 - Create Volume Replication

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"
}

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"
}

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"
}

1.11 - Create Volume Snapshot

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"
}

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"
}

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"
}

1.12 - Create Volume Snapshot Rate

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"
}

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"
}

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"
}

1.13 - Create Volume Snapshot Schedule

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"
}

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"
}

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"
}

1.14 - Delete Volume

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"
}

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"
}

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"
}

1.15 - Delete Volume Group Replication

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": ""
}

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": ""
}

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": ""
}

1.16 - Delete Volume Group Snapshot

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"
}

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"
}

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"
}

1.17 - Delete Volume Group Snapshot Schedule

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"
}

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"
}

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"
}

1.18 - Delete Volume Replication

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"
}

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"
}

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"
}

1.19 - Delete Volume Snapshot

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"
}

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"
}

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"
}

1.20 - Delete Volume Snapshot Rate

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"
}

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"
}

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"
}

1.21 - Delete Volume Snapshot Schedule

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"
}

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"
}

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"
}

1.22 - Detach Volume

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"
        }
    ]
}

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"
        }
    }
}

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"
        }
    }
}

1.23 - List Volume Group Snapshots

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"
}

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"
}

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"
}

1.24 - List Volume Groups

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"
        }
    ]
}

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"
        }
    ]
}

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"
        }
    ]
}

1.25 - List Volume Snapshots

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"
}

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"
}

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"
}

1.26 - List Volumes

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": ""
        }
    ]
}

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": ""
        }
    ]
}

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": ""
        }
    ]
}

1.27 - Remove Volume Group Member on Volume Group

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": ""
        }
    ]
}

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": ""
        }
    ]
}

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": ""
        }
    ]
}

1.28 - Restore Volume Group Snapshot

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"
}

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"
}

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"
}

1.29 - Restore Volume Snapshot

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"
}

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"
}

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"
}

1.30 - Set Volume Group Replication Cycle

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"
}

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"
}

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"
}

1.31 - Set Volume Group Replication Policy

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"
}

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"
}

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"
}

1.32 - Set Volume Group Snapshot Schedule

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"
}

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"
}

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"
}

1.33 - Set Volume QoS

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
}

1.34 - Set Volume Replication Cycle

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"
}

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"
}

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"
}

1.35 - Set Volume Replication Policy

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"
}

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"
}

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"
}

1.36 - Set Volume Snapshot Rate

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"
}

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"
}

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"
}

1.37 - Set Volume Snapshot Schedule

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"
}

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"
}

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"
}

1.38 - Show Volume

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"
        }
    }
}

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"
        }
    }
}

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"
        }
    }
}

1.39 - Show Volume Group

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"
    }
}

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"
    }
}

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"
    }
}

1.40 - Show Volume Group Replication

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"
    }
}

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"
    }
}

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"
    }
}

1.41 - Show Volume Replication

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"
    }
}

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"
    }
}

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"
    }
}

2 - Models

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

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)

2.3 - AttachmentListModel

Name	Description	Schema	Default
object_id optional	Object id Example : `83c3c73d457345e3829ee6d5557c0016`	string
object_type optional	Object 유형 Example : `BM`	enum (BM, MNGC)

2.4 - ExternalError

Name	Description	Schema
code optional	코드 Example : `Forbidden`	string
object_type optional	서버 유형 Example : `BM`	enum (BM, MNGC)
status optional	상태 Example : `403`	integer

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

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)

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

2.8 - RecoveryInfo

Name	Description	Schema	Default
origin_volume optional	원본 볼륨 정보	RecoveryVolumeInfo
recovery_volume optional	복구본 볼륨 정보	RecoveryVolumeInfo

2.9 - RecoveryVolumeGroupInfo

Name	Description	Schema	Default
origin_volume_group optional	원본 볼륨 그룹 정보	SimpleIdNameInfo
recovery_volume_group optional	복제본 볼륨 그룹 정보	SimpleIdNameInfo

2.10 - RecoveryVolumeInfo

Name	Description	Schema
attachments optional	연결 서버	array[SimpleAttachedServer]
id optional	id Example : `7239779c01e3405f82bb71c7f4b55fcd`	string
name optional	볼륨명 Example : `bs-01`	string

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

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

2.13 - SetVolumeQoSRequest

Name	Description	Schema	Default
iops optional	IOPS. 생략하면 기존 값이 유지됩니다. Example : `3000`	integer
throughput optional	Throughput. 생략하면 기존 값이 유지됩니다. Example : `125`	integer

2.14 - SetVolumeQoSResponse

Name	Description	Schema	Default
iops optional	IOPS Example : `3000`	integer
throughput optional	Throughput Example : `125`	integer

2.15 - SimpleAttachedServer

Name	Description	Schema	Default
id optional	서버 id Example : `83c3c73d457345e3829ee6d5557c0011`	string
type optional	서버 유형 Example : `BM`	enum (BM, MNGC)

2.16 - SimpleIdNameInfo

Name	Description	Schema	Default
id optional	id Example : `7239779c01e3405f82bb71c7f4b55fcd`	string
name optional	이름 Example : `my_name`	string

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

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]

2.19 - VolumeAttachmentRequest

Name	Description	Schema	Default
attachments required	서버 id, 유형 목록	array[AttachmentListModel]

2.20 - VolumeAttachmentResponse

Name	Description	Schema	Default
attachments optional	서버 id, 유형 목록	array[AttachmentListModel]

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]

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]

2.23 - VolumeDetachRequest

Name	Description	Schema	Default
attachments required	연결해지 object id 목록	array[string]

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]

2.25 - VolumeGroupInfo

Name	Description	Schema	Default
id optional	id Example : `7239779c01e3405f82bb71c7f4b55fcd`	string
name optional	볼륨 그룹명 Example : `vg-01`	string

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)

2.27 - VolumeGroupListResponse

Name	Description	Schema	Default
total_count optional	총 개수 Example : `1`	integer
volume_groups optional	볼륨 그룹 목록	array[VolumeGroupListModel]

2.28 - VolumeGroupMemberRequest

Name	Description	Schema	Default
volume_ids required	볼륨(Block Storage) id 목록 Example : `['13666d6c32d4456e8421f7768d0bf225']`	array[string]

2.29 - VolumeGroupMemberResponse

Name	Description	Schema	Default
id optional	볼륨 그룹 id Example : `c9ecae8b973b425c81c3817893cd8063`	string
member_volumes optional	멤버 볼륨 목록	array[MemberVolume]

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

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

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

2.33 - VolumeGroupReplicationDeleteResponse

Name	Description	Schema	Default
result optional	결과 Example :	boolean

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

2.35 - VolumeGroupReplicationSyncTabResponse

Name	Description	Schema	Default
result optional	볼륨 그룹 복제 정보	VolumeGroupReplicationSyncTabModel

2.36 - VolumeGroupReplicationUpdateCycleRequest

Name	Description	Schema	Default
cycle required	복제 주기 Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)

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

2.38 - VolumeGroupReplicationUpdatePolicyRequest

Name	Description	Schema	Default
policy required	정책 Example : `RESYNC`	enum (RESYNC, BREAK)

2.39 - VolumeGroupReplicationUpdatePolicyResponse

Name	Description	Schema	Default
cycle optional	복제 주기 Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)
sync_state optional	복제 상태 Example : `SNAPMIRROED`	string

2.40 - VolumeGroupResponse

Name	Description	Schema	Default
result optional	볼륨 그룹 상세 정보	VolumeGroupModel

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

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

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

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

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

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

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

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

2.49 - VolumeListResponse

Name	Description	Schema	Default
total_count optional	총 개수 Example : `1`	integer
volumes optional	볼룸 목록	array[VolumeListModel]

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

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

2.52 - VolumeRecoveryCreateRequest

Name	Description	Schema	Default
name required	복구 볼륨명 Example : `recovery-volume`	string
snapshot_id required	스냅샷 id Example : `05600123-6e78-11f0-a3f0-d039eab8d501`	string

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

2.54 - VolumeReplicationCycleRequest

Name	Description	Schema	Default
cycle required	복제 주기 Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)

2.55 - VolumeReplicationCycleResponse

Name	Description	Schema	Default
cycle optional	복제 주기 Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)
volume_id optional	볼륨 id Example : `92cd16fe8ebc4f73832513a172bf0000`	string

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

2.57 - VolumeReplicationPolicyRequest

Name	Description	Schema	Default
policy required	정책 Example : `RESYNC`	enum (RESYNC, BREAK)

2.58 - VolumeReplicationPolicyResponse

Name	Description	Schema	Default
sync_cycle optional	복제 주기 Example : `5MIN`	enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY)
sync_state optional	복제 상태 Example : `SNAPMIRROED`	string

2.59 - VolumeReplicationResponse

Name	Description	Schema	Default
result optional	볼륨 복제 정보	VolumeReplicationModel

2.60 - VolumeResponse

Name	Description	Schema	Default
result optional	볼륨 상세 정보	VolumeModel

2.61 - VolumeResponseV1Dot2

Name	Description	Schema	Default
result optional	볼륨 상세 정보	VolumeModelV1Dot2

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

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

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

2.65 - VolumeSnapshotRateRequest

Name	Description	Schema	Default
snapshot_rate required	스냅샷 용량 Example : `100`	integer

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

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

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

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

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