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

APIs

1: Add Volume Group Member on Volume Group

1.1: 1.2
1.2: 1.1
1.3: 1.0

2: Attach Volume

2.1: 1.2
2.2: 1.1
2.3: 1.0

3: Create Volume

3.1: 1.2
3.2: 1.1
3.3: 1.0

4: Create Volume Group

4.1: 1.2
4.2: 1.1
4.3: 1.0

5: Create Volume Group Recovery

5.1: 1.2
5.2: 1.1

6: Create Volume Group Replication

6.1: 1.2
6.2: 1.1
6.3: 1.0

7: Create Volume Group Snapshot

7.1: 1.2
7.2: 1.1
7.3: 1.0

8: Create Volume Group Snapshot Schedule

8.1: 1.2
8.2: 1.1
8.3: 1.0

9: Create Volume Recovery

9.1: 1.2
9.2: 1.1

10: Create Volume Replication

10.1: 1.2
10.2: 1.1
10.3: 1.0

11: Create Volume Snapshot

11.1: 1.2
11.2: 1.1
11.3: 1.0

12: Create Volume Snapshot Rate

12.1: 1.2
12.2: 1.1
12.3: 1.0

13: Create Volume Snapshot Schedule

13.1: 1.2
13.2: 1.1
13.3: 1.0

14: Delete Volume

14.1: 1.2
14.2: 1.1
14.3: 1.0

15: Delete Volume Group Replication

15.1: 1.2
15.2: 1.1
15.3: 1.0

16: Delete Volume Group Snapshot

16.1: 1.2
16.2: 1.1
16.3: 1.0

17: Delete Volume Group Snapshot Schedule

17.1: 1.2
17.2: 1.1
17.3: 1.0

18: Delete Volume Replication

18.1: 1.2
18.2: 1.1
18.3: 1.0

19: Delete Volume Snapshot

19.1: 1.2
19.2: 1.1
19.3: 1.0

20: Delete Volume Snapshot Rate

20.1: 1.2
20.2: 1.1
20.3: 1.0

21: Delete Volume Snapshot Schedule

21.1: 1.2
21.2: 1.1
21.3: 1.0

22: Detach Volume

22.1: 1.2
22.2: 1.1
22.3: 1.0

23: List Volume Group Snapshots

23.1: 1.2
23.2: 1.1
23.3: 1.0

24: List Volume Groups

24.1: 1.2
24.2: 1.1
24.3: 1.0

25: List Volume Snapshots

25.1: 1.2
25.2: 1.1
25.3: 1.0

26: List Volumes

26.1: 1.2
26.2: 1.1
26.3: 1.0

27: Remove Volume Group Member on Volume Group

27.1: 1.2
27.2: 1.1
27.3: 1.0

28: Restore Volume Group Snapshot

28.1: 1.2
28.2: 1.1
28.3: 1.0

29: Restore Volume Snapshot

29.1: 1.2
29.2: 1.1
29.3: 1.0

30: Set Volume Group Replication Cycle

30.1: 1.2
30.2: 1.1
30.3: 1.0

31: Set Volume Group Replication Policy

31.1: 1.2
31.2: 1.1
31.3: 1.0

32: Set Volume Group Snapshot Schedule

32.1: 1.2
32.2: 1.1
32.3: 1.0

33: Set Volume QoS

33.1: 1.2

34: Set Volume Replication Cycle

34.1: 1.2
34.2: 1.1
34.3: 1.0

35: Set Volume Replication Policy

35.1: 1.2
35.2: 1.1
35.3: 1.0

36: Set Volume Snapshot Rate

36.1: 1.2
36.2: 1.1
36.3: 1.0

37: Set Volume Snapshot Schedule

37.1: 1.2
37.2: 1.1
37.3: 1.0

38: Show Volume

38.1: 1.2
38.2: 1.1
38.3: 1.0

39: Show Volume Group

39.1: 1.2
39.2: 1.1
39.3: 1.0

40: Show Volume Group Replication

40.1: 1.2
40.2: 1.1
40.3: 1.0

41: Show Volume Replication

41.1: 1.2
41.2: 1.1
41.3: 1.0

1 - Add Volume Group Member on Volume Group

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

2 - Attach Volume

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

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

2.3 - 1.0

post /v1/volumes/{volume_id}/attachments

Description

서버에 볼륨을 연결한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/volumes/{volume_id}/attachments

Request header

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

Request body

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

Example HTTP response

Response 200

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

3 - Create Volume

3.1 - 1.2

post /v1/volumes

Description

볼륨을 생성한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		VolumeCreateRequestV1Dot2

Responses

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

Example HTTP request

Request path

/v1/volumes

Request header

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

Request body

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

Example HTTP response

Response 202

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

3.2 - 1.1

post /v1/volumes

Description

볼륨을 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
body	body required		VolumeCreateRequest

Responses

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

Example HTTP request

Request path

/v1/volumes

Request header

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

Request body

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

Example HTTP response

Response 202

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

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

4 - Create Volume Group

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

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

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

5 - Create Volume Group Recovery

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

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

6 - Create Volume Group Replication

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

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

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

7 - Create Volume Group Snapshot

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

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

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

8 - Create Volume Group Snapshot Schedule

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

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

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

9 - Create Volume Recovery

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

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

10 - Create Volume Replication

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

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

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

11 - Create Volume Snapshot

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

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

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

12 - Create Volume Snapshot Rate

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

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

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

13 - Create Volume Snapshot Schedule

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

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

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

14 - Delete Volume

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

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

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

15 - Delete Volume Group Replication

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

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

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

16 - Delete Volume Group Snapshot

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

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

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

17 - Delete Volume Group Snapshot Schedule

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

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

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

18 - Delete Volume Replication

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

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

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

19 - Delete Volume Snapshot

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

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

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

20 - Delete Volume Snapshot Rate

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

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

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

21 - Delete Volume Snapshot Schedule

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

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

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

22 - Detach Volume

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

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

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

23 - List Volume Group Snapshots

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

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

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

24 - List Volume Groups

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

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

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

25 - List Volume Snapshots

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

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

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

26 - List Volumes

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

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

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

27 - Remove Volume Group Member on Volume Group

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

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

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

28 - Restore Volume Group Snapshot

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

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

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

29 - Restore Volume Snapshot

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

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

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

30 - Set Volume Group Replication Cycle

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

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

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

31 - Set Volume Group Replication Policy

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

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

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

32 - Set Volume Group Snapshot Schedule

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

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

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

33 - Set Volume QoS

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
}

34 - Set Volume Replication Cycle

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

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

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

35 - Set Volume Replication Policy

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

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

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

36 - Set Volume Snapshot Rate

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

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

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

37 - Set Volume Snapshot Schedule

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

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

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

38 - Show Volume

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

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

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

39 - Show Volume Group

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

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

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

40 - Show Volume Group Replication

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

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

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

41 - Show Volume Replication

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

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

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