Block Storage(BM)
Overview
Provides an Application Programming Interface (API) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of Block Storage(BM) service and how to call API.
The API is provided as a RESTful API, and it responds in JSON format.
Version
| Version | Status | Supported Until |
|---|
| 1.0 | DEPRECATED | 20251231 |
| 1.1 | DEPRECATED | 20260331 |
| 1.2 | CURRENT | - |
OpenAPI URL
https://baremetal-blockstorage.{region}.{environment}.samsungsdscloud.com
Environment and Region List
| environment | region |
|---|
| s | kr-west1 |
| s | kr-east1 |
| g | kr-south1 |
| g | kr-south2 |
| g | kr-south3 |
| e | kr-west1 |
| e | kr-east1 |
1 - APIs
1.1 - Add Volume Group Member on Volume Group
1.1.1 - 1.2
put /v1/volume-groups/{volume_group_id}/members/add
Description
Add Volume Group Member on Volume Group.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group 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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Request body
{
"volume_ids": [
"13666d6c32d4456e8421f7768d0bf225"
]
}
Example HTTP response
Response 200
{
"id": "c9ecae8b973b425c81c3817893cd8063",
"member_volumes": [
{
"disk_type": "SSD",
"id": "92cd16fe8ebc4f73832513a172bf0000",
"name": "volume-01",
"purpose": "ORG",
"size_gb": 10,
"so_volume_id": "",
"so_volume_name": ""
}
]
}
1.1.2 - 1.1
put /v1/volume-groups/{volume_group_id}/members/add
Description
Add Volume Group Member on Volume Group.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group 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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Request body
{
"volume_ids": [
"13666d6c32d4456e8421f7768d0bf225"
]
}
Example HTTP response
Response 200
{
"id": "c9ecae8b973b425c81c3817893cd8063",
"member_volumes": [
{
"disk_type": "SSD",
"id": "92cd16fe8ebc4f73832513a172bf0000",
"name": "volume-01",
"purpose": "ORG",
"size_gb": 10,
"so_volume_id": "",
"so_volume_name": ""
}
]
}
1.1.3 - 1.0
put /v1/volume-groups/{volume_group_id}/members/add
Description
Add Volume Group Member on Volume Group.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group 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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Request body
{
"volume_ids": [
"13666d6c32d4456e8421f7768d0bf225"
]
}
Example HTTP response
Response 200
{
"id": "c9ecae8b973b425c81c3817893cd8063",
"member_volumes": [
{
"disk_type": "SSD",
"id": "92cd16fe8ebc4f73832513a172bf0000",
"name": "volume-01",
"purpose": "ORG",
"size_gb": 10,
"so_volume_id": "",
"so_volume_name": ""
}
]
}
1.2 - Attach Volume
1.2.1 - 1.2
post /v1/volumes/{volume_id}/attachments
Description
Attach Volume to servers.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume 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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Request body
{
"attachments": [
{
"object_id": "83c3c73d457345e3829ee6d5557c0016",
"object_type": "BM"
}
]
}
Example HTTP response
Response 200
{
"attachments": [
{
"object_id": "83c3c73d457345e3829ee6d5557c0016",
"object_type": "BM"
}
]
}
1.2.2 - 1.1
post /v1/volumes/{volume_id}/attachments
Description
Attach Volume to servers.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume 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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Request body
{
"attachments": [
{
"object_id": "83c3c73d457345e3829ee6d5557c0016",
"object_type": "BM"
}
]
}
Example HTTP response
Response 200
{
"result": {
"account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
"attachments": [
{
"id": "83c3c73d457345e3829ee6d5557c0011",
"image_name": "RHEL 8.8 for BM",
"name": "baremetal-01",
"srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
"state": "RUNNING",
"type": "BM"
}
],
"created_at": "2024-08-01T07:06:23.315Z",
"created_by": "samsung-cloud-platform1@samsung.com",
"disk_type": "SSD",
"external_errors": [
{
"code": "Forbidden",
"object_type": "BM",
"status": 403
}
],
"has_origin": true,
"has_replication": true,
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"is_encryption": true,
"iscsi_target_ips": [
"172.30.4.3",
"172.30.4.4"
],
"modified_at": "2024-08-01T07:06:25.315Z",
"modified_by": "samsung-cloud-platform2@samsung.com",
"name": "bs-01",
"previous_state": "CREATING",
"purpose": "ORG",
"recovery": {
"origin_volume": {
"attachments": [
{
"id": "83c3c73d457345e3829ee6d5557c0011",
"type": "BM"
}
],
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "bs-01"
},
"recovery_volume": {
"attachments": [
{
"id": "83c3c73d457345e3829ee6d5557c0011",
"type": "BM"
}
],
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "bs-01"
}
},
"size_gb": 10,
"snapshot_rate": 100,
"snapshot_schedule": {
"day_of_week": "MON",
"frequency": "DAILY",
"hour": 18
},
"srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
"state": "CREATING",
"storage_volume_name": "vo202407310544da8aadc775f",
"volume_group": {
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "vg-01"
}
}
}
1.2.3 - 1.0
post /v1/volumes/{volume_id}/attachments
Description
Attach Volume to servers.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume 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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Request body
{
"attachments": [
{
"object_id": "83c3c73d457345e3829ee6d5557c0016",
"object_type": "BM"
}
]
}
Example HTTP response
Response 200
{
"result": {
"account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
"attachments": [
{
"id": "83c3c73d457345e3829ee6d5557c0011",
"image_name": "RHEL 8.8 for BM",
"name": "baremetal-01",
"srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
"state": "RUNNING",
"type": "BM"
}
],
"created_at": "2024-08-01T07:06:23.315Z",
"created_by": "samsung-cloud-platform1@samsung.com",
"disk_type": "SSD",
"external_errors": [
{
"code": "Forbidden",
"object_type": "BM",
"status": 403
}
],
"has_origin": true,
"has_replication": true,
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"is_encryption": true,
"iscsi_target_ips": [
"172.30.4.3",
"172.30.4.4"
],
"modified_at": "2024-08-01T07:06:25.315Z",
"modified_by": "samsung-cloud-platform2@samsung.com",
"name": "bs-01",
"previous_state": "CREATING",
"purpose": "ORG",
"recovery": {
"origin_volume": {
"attachments": [
{
"id": "83c3c73d457345e3829ee6d5557c0011",
"type": "BM"
}
],
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "bs-01"
},
"recovery_volume": {
"attachments": [
{
"id": "83c3c73d457345e3829ee6d5557c0011",
"type": "BM"
}
],
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "bs-01"
}
},
"size_gb": 10,
"snapshot_rate": 100,
"snapshot_schedule": {
"day_of_week": "MON",
"frequency": "DAILY",
"hour": 18
},
"srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
"state": "CREATING",
"storage_volume_name": "vo202407310544da8aadc775f",
"volume_group": {
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "vg-01"
}
}
}
1.3 - Create Volume
1.3.1 - 1.2
post /v1/volumes
Description
Create Volume.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Request body
{
"attachments": [
{
"object_id": "83c3c73d457345e3829ee6d5557c0016",
"object_type": "BM"
}
],
"disk_type": "SSD",
"name": "bs-01",
"qos": {
"iops": 3000,
"throughput": 125
},
"size_gb": 10,
"tags": [
{
"key": "my_tag_1",
"value": "my_value_1"
}
]
}
Example HTTP response
Response 202
{
"request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
"resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}
1.3.2 - 1.1
post /v1/volumes
Description
Create Volume.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Request body
{
"attachments": [
{
"object_id": "83c3c73d457345e3829ee6d5557c0016",
"object_type": "BM"
}
],
"disk_type": "SSD",
"name": "bs-01",
"size_gb": 10,
"tags": [
{
"key": "my_tag_1",
"value": "my_value_1"
}
]
}
Example HTTP response
Response 202
{
"request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
"resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}
1.3.3 - 1.0
post /v1/volumes
Description
Create Volume.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Request body
{
"attachments": [
{
"object_id": "83c3c73d457345e3829ee6d5557c0016",
"object_type": "BM"
}
],
"disk_type": "SSD",
"name": "bs-01",
"size_gb": 10,
"tags": [
{
"key": "my_tag_1",
"value": "my_value_1"
}
]
}
Example HTTP response
Response 202
{
"request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
"resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}
1.4 - Create Volume Group
1.4.1 - 1.2
post /v1/volume-groups
Description
Create Volume Group
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Request body
{
"name": "vg-01",
"tags": [
{
"key": "my_tag_1",
"value": "my_value_1"
}
],
"volume_ids": [
"17e0b4fd27784dfb843440ec08bdd148"
]
}
Example HTTP response
Response 202
{
"request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
"resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}
1.4.2 - 1.1
post /v1/volume-groups
Description
Create Volume Group
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Request body
{
"name": "vg-01",
"tags": [
{
"key": "my_tag_1",
"value": "my_value_1"
}
],
"volume_ids": [
"17e0b4fd27784dfb843440ec08bdd148"
]
}
Example HTTP response
Response 202
{
"request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
"resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}
1.4.3 - 1.0
post /v1/volume-groups
Description
Create Volume Group
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Request body
{
"name": "vg-01",
"tags": [
{
"key": "my_tag_1",
"value": "my_value_1"
}
],
"volume_ids": [
"17e0b4fd27784dfb843440ec08bdd148"
]
}
Example HTTP response
Response 202
{
"request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
"resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}
1.5 - Create Volume Group Recovery
1.5.1 - 1.2
post /v1/volume-groups/{volume_group_id}/recoveries
Description
Create Volume Group Recovery.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group 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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Request body
{
"block_storage_name_prefix": "prefix-",
"snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501"
}
Example HTTP response
Response 202
{
"request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
"resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}
1.5.2 - 1.1
post /v1/volume-groups/{volume_group_id}/recoveries
Description
Create Volume Group Recovery.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group 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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Request body
{
"block_storage_name_prefix": "prefix-",
"snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501"
}
Example HTTP response
Response 202
{
"request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
"resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}
1.6 - Create Volume Group Replication
1.6.1 - 1.2
post /v1/volume-groups/{volume_group_id}/replications
Description
Create Volume Group Replication.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group 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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Request body
{
"cycle": "5MIN",
"name": "replica-vg-01",
"region": "kr-west1",
"replication_volume_name_prefix": "dr"
}
Example HTTP response
Response 202
{
"request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
"resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}
1.6.2 - 1.1
post /v1/volume-groups/{volume_group_id}/replications
Description
Create Volume Group Replication.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group 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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Request body
{
"cycle": "5MIN",
"name": "replica-vg-01",
"region": "kr-west1",
"replication_volume_name_prefix": "dr"
}
Example HTTP response
Response 202
{
"request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
"resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}
1.6.3 - 1.0
post /v1/volume-groups/{volume_group_id}/replications
Description
Create Volume Group Replication.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group 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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Request body
{
"cycle": "5MIN",
"name": "replica-vg-01",
"region": "kr-west1",
"replication_volume_name_prefix": "dr"
}
Example HTTP response
Response 202
{
"request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
"resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}
1.7 - Create Volume Group Snapshot
1.7.1 - 1.2
post /v1/volume-groups/{volume_group_id}/snapshots
Description
Create Volume Group Snapshot
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | None |
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/snapshots
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Example HTTP response
Response 200
{
"account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
"snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
"snapshot_name": "vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932",
"volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}
1.7.2 - 1.1
post /v1/volume-groups/{volume_group_id}/snapshots
Description
Create Volume Group Snapshot
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | None |
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/snapshots
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Example HTTP response
Response 200
{
"account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
"snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
"snapshot_name": "vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932",
"volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}
1.7.3 - 1.0
post /v1/volume-groups/{volume_group_id}/snapshots
Description
Create Volume Group Snapshot
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | None |
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/snapshots
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Example HTTP response
Response 200
{
"account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
"snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
"snapshot_name": "vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932",
"volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}
1.8 - Create Volume Group Snapshot Schedule
1.8.1 - 1.2
post /v1/volume-groups/{volume_group_id}/snapshot-schedules
Description
Create Volume Group Snapshot Schedule.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | None |
| body | body
required |
| VolumeGroupSnapshotScheduleRequest | |
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/snapshot-schedules
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Request body
{
"day_of_week": "SUN",
"hour": 18
}
Example HTTP response
Response 200
{
"day_of_week": "SUN",
"frequency": "DAILY",
"hour": 18,
"volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}
1.8.2 - 1.1
post /v1/volume-groups/{volume_group_id}/snapshot-schedules
Description
Create Volume Group Snapshot Schedule.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | None |
| body | body
required |
| VolumeGroupSnapshotScheduleRequest | |
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/snapshot-schedules
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Request body
{
"day_of_week": "SUN",
"hour": 18
}
Example HTTP response
Response 200
{
"day_of_week": "SUN",
"frequency": "DAILY",
"hour": 18,
"volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}
1.8.3 - 1.0
post /v1/volume-groups/{volume_group_id}/snapshot-schedules
Description
Create Volume Group Snapshot Schedule.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | None |
| body | body
required |
| VolumeGroupSnapshotScheduleRequest | |
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/snapshot-schedules
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Request body
{
"day_of_week": "SUN",
"hour": 18
}
Example HTTP response
Response 200
{
"day_of_week": "SUN",
"frequency": "DAILY",
"hour": 18,
"volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}
1.9 - Create Volume Recovery
1.9.1 - 1.2
post /v1/volumes/{volume_id}/recoveries
Description
Create Volume Recovery.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume 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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Request body
{
"name": "recovery-volume",
"snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501"
}
Example HTTP response
Response 202
{
"request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
"resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}
1.9.2 - 1.1
post /v1/volumes/{volume_id}/recoveries
Description
Create Volume Recovery.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume 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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Request body
{
"name": "recovery-volume",
"snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501"
}
Example HTTP response
Response 202
{
"request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
"resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}
1.10 - Create Volume Replication
1.10.1 - 1.2
post /v1/volumes/{volume_id}/replications
Description
Create Volume Replication.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume 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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Request body
{
"cycle": "5MIN",
"name": "replica-bs-01",
"region": "kr-west1"
}
Example HTTP response
Response 202
{
"request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
"resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}
1.10.2 - 1.1
post /v1/volumes/{volume_id}/replications
Description
Create Volume Replication.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume 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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Request body
{
"cycle": "5MIN",
"name": "replica-bs-01",
"region": "kr-west1"
}
Example HTTP response
Response 202
{
"request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
"resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}
1.10.3 - 1.0
post /v1/volumes/{volume_id}/replications
Description
Create Volume Replication.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume 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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Request body
{
"cycle": "5MIN",
"name": "replica-bs-01",
"region": "kr-west1"
}
Example HTTP response
Response 202
{
"request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
"resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}
1.11 - Create Volume Snapshot
1.11.1 - 1.2
post /v1/volumes/{volume_id}/snapshots
Description
Create Volume snapshot.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume 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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Example HTTP response
Response 200
{
"account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
"snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
"snapshot_name": "vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932",
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.11.2 - 1.1
post /v1/volumes/{volume_id}/snapshots
Description
Create Volume snapshot.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume 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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Example HTTP response
Response 200
{
"account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
"snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
"snapshot_name": "vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932",
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.11.3 - 1.0
post /v1/volumes/{volume_id}/snapshots
Description
Create Volume snapshot.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume 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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Example HTTP response
Response 200
{
"account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
"snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
"snapshot_name": "vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932",
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.12 - Create Volume Snapshot Rate
1.12.1 - 1.2
post /v1/volumes/{volume_id}/snapshot-rates
Description
Create Volume snapshot rate.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
| body | body
required |
| VolumeSnapshotRateRequest | |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/snapshot-rates
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Request body
Example HTTP response
Response 200
{
"is_snapshot_activated": true,
"snapshot_rate": 100,
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.12.2 - 1.1
post /v1/volumes/{volume_id}/snapshot-rates
Description
Create Volume snapshot rate.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
| body | body
required |
| VolumeSnapshotRateRequest | |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/snapshot-rates
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Request body
Example HTTP response
Response 200
{
"is_snapshot_activated": true,
"snapshot_rate": 100,
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.12.3 - 1.0
post /v1/volumes/{volume_id}/snapshot-rates
Description
Create Volume snapshot rate.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
| body | body
required |
| VolumeSnapshotRateRequest | |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/snapshot-rates
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Request body
Example HTTP response
Response 200
{
"is_snapshot_activated": true,
"snapshot_rate": 100,
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.13 - Create Volume Snapshot Schedule
1.13.1 - 1.2
post /v1/volumes/{volume_id}/snapshot-schedules
Description
Create Volume snapshot schedule.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
| body | body
required |
| VolumeSnapshotScheduleRequest | |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/snapshot-schedules
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Request body
{
"day_of_week": "SUN",
"hour": 18
}
Example HTTP response
Response 200
{
"day_of_week": "",
"frequency": "DAILY",
"hour": 18,
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.13.2 - 1.1
post /v1/volumes/{volume_id}/snapshot-schedules
Description
Create Volume snapshot schedule.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
| body | body
required |
| VolumeSnapshotScheduleRequest | |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/snapshot-schedules
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Request body
{
"day_of_week": "SUN",
"hour": 18
}
Example HTTP response
Response 200
{
"day_of_week": "",
"frequency": "DAILY",
"hour": 18,
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.13.3 - 1.0
post /v1/volumes/{volume_id}/snapshot-schedules
Description
Create Volume snapshot schedule.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
| body | body
required |
| VolumeSnapshotScheduleRequest | |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/snapshot-schedules
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Request body
{
"day_of_week": "SUN",
"hour": 18
}
Example HTTP response
Response 200
{
"day_of_week": "",
"frequency": "DAILY",
"hour": 18,
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.14 - Delete Volume
1.14.1 - 1.2
delete /v1/volumes/{volume_id}
Description
Delete Volume.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume 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}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Example HTTP response
Response 202
{
"request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
"resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}
1.14.2 - 1.1
delete /v1/volumes/{volume_id}
Description
Delete Volume.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume 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}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Example HTTP response
Response 202
{
"request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
"resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}
1.14.3 - 1.0
delete /v1/volumes/{volume_id}
Description
Delete Volume.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume 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}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Example HTTP response
Response 202
{
"request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
"resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}
1.15 - Delete Volume Group Replication
1.15.1 - 1.2
delete /v1/volume-groups/{volume_group_id}/replications
Description
Delete Volume Group Replication.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | None |
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/replications
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Example HTTP response
Response 200
1.15.2 - 1.1
delete /v1/volume-groups/{volume_group_id}/replications
Description
Delete Volume Group Replication.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | None |
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/replications
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Example HTTP response
Response 200
1.15.3 - 1.0
delete /v1/volume-groups/{volume_group_id}/replications
Description
Delete Volume Group Replication.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | None |
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/replications
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Example HTTP response
Response 200
1.16 - Delete Volume Group Snapshot
1.16.1 - 1.2
delete /v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}
Description
Delete Volume Group snapshot.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | None |
| path | snapshot_id
required | Snapshot id
Example : 05600123-6e78-11f0-a3f0-d039eab8d501
| string | None |
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Example HTTP response
Response 200
{
"account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
"snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
"volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}
1.16.2 - 1.1
delete /v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}
Description
Delete Volume Group snapshot.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | None |
| path | snapshot_id
required | Snapshot id
Example : 05600123-6e78-11f0-a3f0-d039eab8d501
| string | None |
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Example HTTP response
Response 200
{
"account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
"snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
"volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}
1.16.3 - 1.0
delete /v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}
Description
Delete Volume Group snapshot.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | None |
| path | snapshot_id
required | Snapshot id
Example : 05600123-6e78-11f0-a3f0-d039eab8d501
| string | None |
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Example HTTP response
Response 200
{
"account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
"snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
"volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}
1.17 - Delete Volume Group Snapshot Schedule
1.17.1 - 1.2
delete /v1/volume-groups/{volume_group_id}/snapshot-schedules
Description
Delete Volume Group Snapshot Schedule.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | None |
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/snapshot-schedules
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Example HTTP response
Response 200
{
"day_of_week": "SUN",
"frequency": "DAILY",
"hour": 18,
"volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}
1.17.2 - 1.1
delete /v1/volume-groups/{volume_group_id}/snapshot-schedules
Description
Delete Volume Group Snapshot Schedule.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | None |
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/snapshot-schedules
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Example HTTP response
Response 200
{
"day_of_week": "SUN",
"frequency": "DAILY",
"hour": 18,
"volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}
1.17.3 - 1.0
delete /v1/volume-groups/{volume_group_id}/snapshot-schedules
Description
Delete Volume Group Snapshot Schedule.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | None |
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/snapshot-schedules
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Example HTTP response
Response 200
{
"day_of_week": "SUN",
"frequency": "DAILY",
"hour": 18,
"volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}
1.18 - Delete Volume Replication
1.18.1 - 1.2
delete /v1/volumes/{volume_id}/replications
Description
Delete Volume Replication.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume 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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Example HTTP response
Response 202
{
"request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
"resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}
1.18.2 - 1.1
delete /v1/volumes/{volume_id}/replications
Description
Delete Volume Replication.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume 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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Example HTTP response
Response 202
{
"request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
"resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}
1.18.3 - 1.0
delete /v1/volumes/{volume_id}/replications
Description
Delete Volume Replication.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume 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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Example HTTP response
Response 202
{
"request_id": "req-0006064c-c008-458c-8977-19671c6b32d4",
"resource_id": "8bf55e738d4e44b5a21dbe133a42ecbe"
}
1.19 - Delete Volume Snapshot
1.19.1 - 1.2
delete /v1/volumes/{volume_id}/snapshots/{snapshot_id}
Description
Delete Volume snapshot.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
| path | snapshot_id
required | Snapshot id
Example : 05600123-6e78-11f0-a3f0-d039eab8d501
| string | None |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/snapshots/{snapshot_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Example HTTP response
Response 200
{
"account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
"snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.19.2 - 1.1
delete /v1/volumes/{volume_id}/snapshots/{snapshot_id}
Description
Delete Volume snapshot.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
| path | snapshot_id
required | Snapshot id
Example : 05600123-6e78-11f0-a3f0-d039eab8d501
| string | None |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/snapshots/{snapshot_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Example HTTP response
Response 200
{
"account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
"snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.19.3 - 1.0
delete /v1/volumes/{volume_id}/snapshots/{snapshot_id}
Description
Delete Volume snapshot.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
| path | snapshot_id
required | Snapshot id
Example : 05600123-6e78-11f0-a3f0-d039eab8d501
| string | None |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/snapshots/{snapshot_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Example HTTP response
Response 200
{
"account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
"snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.20 - Delete Volume Snapshot Rate
1.20.1 - 1.2
delete /v1/volumes/{volume_id}/snapshot-rates
Description
Delete Volume snapshot rate.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/snapshot-rates
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Example HTTP response
Response 200
{
"is_snapshot_activated": true,
"snapshot_rate": 100,
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.20.2 - 1.1
delete /v1/volumes/{volume_id}/snapshot-rates
Description
Delete Volume snapshot rate.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/snapshot-rates
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Example HTTP response
Response 200
{
"is_snapshot_activated": true,
"snapshot_rate": 100,
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.20.3 - 1.0
delete /v1/volumes/{volume_id}/snapshot-rates
Description
Delete Volume snapshot rate.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/snapshot-rates
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Example HTTP response
Response 200
{
"is_snapshot_activated": true,
"snapshot_rate": 100,
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.21 - Delete Volume Snapshot Schedule
1.21.1 - 1.2
delete /v1/volumes/{volume_id}/snapshot-schedules
Description
Delete Volume snapshot schedule.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/snapshot-schedules
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Example HTTP response
Response 200
{
"day_of_week": "",
"frequency": "DAILY",
"hour": 18,
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.21.2 - 1.1
delete /v1/volumes/{volume_id}/snapshot-schedules
Description
Delete Volume snapshot schedule.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/snapshot-schedules
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Example HTTP response
Response 200
{
"day_of_week": "",
"frequency": "DAILY",
"hour": 18,
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.21.3 - 1.0
delete /v1/volumes/{volume_id}/snapshot-schedules
Description
Delete Volume snapshot schedule.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/snapshot-schedules
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Example HTTP response
Response 200
{
"day_of_week": "",
"frequency": "DAILY",
"hour": 18,
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.22 - Detach Volume
1.22.1 - 1.2
delete /v1/volumes/{volume_id}/attachments
Description
Detach Volume from servers.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume 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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Request body
{
"attachments": [
""
]
}
Example HTTP response
Response 200
{
"attachments": [
{
"object_id": "83c3c73d457345e3829ee6d5557c0016",
"object_type": "BM"
}
]
}
1.22.2 - 1.1
delete /v1/volumes/{volume_id}/attachments
Description
Detach Volume from servers.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume 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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Request body
{
"attachments": [
""
]
}
Example HTTP response
Response 200
{
"result": {
"account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
"attachments": [
{
"id": "83c3c73d457345e3829ee6d5557c0011",
"image_name": "RHEL 8.8 for BM",
"name": "baremetal-01",
"srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
"state": "RUNNING",
"type": "BM"
}
],
"created_at": "2024-08-01T07:06:23.315Z",
"created_by": "samsung-cloud-platform1@samsung.com",
"disk_type": "SSD",
"external_errors": [
{
"code": "Forbidden",
"object_type": "BM",
"status": 403
}
],
"has_origin": true,
"has_replication": true,
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"is_encryption": true,
"iscsi_target_ips": [
"172.30.4.3",
"172.30.4.4"
],
"modified_at": "2024-08-01T07:06:25.315Z",
"modified_by": "samsung-cloud-platform2@samsung.com",
"name": "bs-01",
"previous_state": "CREATING",
"purpose": "ORG",
"recovery": {
"origin_volume": {
"attachments": [
{
"id": "83c3c73d457345e3829ee6d5557c0011",
"type": "BM"
}
],
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "bs-01"
},
"recovery_volume": {
"attachments": [
{
"id": "83c3c73d457345e3829ee6d5557c0011",
"type": "BM"
}
],
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "bs-01"
}
},
"size_gb": 10,
"snapshot_rate": 100,
"snapshot_schedule": {
"day_of_week": "MON",
"frequency": "DAILY",
"hour": 18
},
"srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
"state": "CREATING",
"storage_volume_name": "vo202407310544da8aadc775f",
"volume_group": {
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "vg-01"
}
}
}
1.22.3 - 1.0
delete /v1/volumes/{volume_id}/attachments
Description
Detach Volume from servers.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume 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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Request body
{
"attachments": [
""
]
}
Example HTTP response
Response 200
{
"result": {
"account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
"attachments": [
{
"id": "83c3c73d457345e3829ee6d5557c0011",
"image_name": "RHEL 8.8 for BM",
"name": "baremetal-01",
"srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
"state": "RUNNING",
"type": "BM"
}
],
"created_at": "2024-08-01T07:06:23.315Z",
"created_by": "samsung-cloud-platform1@samsung.com",
"disk_type": "SSD",
"external_errors": [
{
"code": "Forbidden",
"object_type": "BM",
"status": 403
}
],
"has_origin": true,
"has_replication": true,
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"is_encryption": true,
"iscsi_target_ips": [
"172.30.4.3",
"172.30.4.4"
],
"modified_at": "2024-08-01T07:06:25.315Z",
"modified_by": "samsung-cloud-platform2@samsung.com",
"name": "bs-01",
"previous_state": "CREATING",
"purpose": "ORG",
"recovery": {
"origin_volume": {
"attachments": [
{
"id": "83c3c73d457345e3829ee6d5557c0011",
"type": "BM"
}
],
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "bs-01"
},
"recovery_volume": {
"attachments": [
{
"id": "83c3c73d457345e3829ee6d5557c0011",
"type": "BM"
}
],
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "bs-01"
}
},
"size_gb": 10,
"snapshot_rate": 100,
"snapshot_schedule": {
"day_of_week": "MON",
"frequency": "DAILY",
"hour": 18
},
"srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
"state": "CREATING",
"storage_volume_name": "vo202407310544da8aadc775f",
"volume_group": {
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "vg-01"
}
}
}
1.23 - List Volume Group Snapshots
1.23.1 - 1.2
get /v1/volume-groups/{volume_group_id}/snapshots
Description
Get a list of Volume Group snapshots.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | None |
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/snapshots
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Example HTTP response
Response 200
{
"is_snapshot_policy": false,
"snapshots": [],
"volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}
1.23.2 - 1.1
get /v1/volume-groups/{volume_group_id}/snapshots
Description
Get a list of Volume Group snapshots.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | None |
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/snapshots
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Example HTTP response
Response 200
{
"is_snapshot_policy": false,
"snapshots": [],
"volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}
1.23.3 - 1.0
get /v1/volume-groups/{volume_group_id}/snapshots
Description
Get a list of Volume Group snapshots.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | None |
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/snapshots
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Example HTTP response
Response 200
{
"is_snapshot_policy": false,
"snapshots": [],
"volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}
1.24 - List Volume Groups
1.24.1 - 1.2
get /v1/volume-groups
Description
Get a list of Volume Groups.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | limit
optional | Number to be displayed on the page
Example : 20
| integer | 20 |
| query | offset
optional | Offset
Example : 0
| integer | 0 |
| query | sort
optional | Sort
Example : column1:asc,column2:desc
| string | None |
| query | name
optional | Volume group name
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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Example HTTP response
Response 200
{
"total_count": 1,
"volume_groups": [
{
"account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
"created_at": "2024-08-01T07:06:23.315Z",
"created_by": "samsung-cloud-platform1@samsung.com",
"id": "c9ecae8b973b425c81c3817893cd8063",
"modified_at": "2024-08-01T07:06:25.315Z",
"modified_by": "samsung-cloud-platform2@samsung.com",
"name": "vg-01",
"num_of_block_storages": 2,
"purpose": "ORG",
"state": "CREATING"
}
]
}
1.24.2 - 1.1
get /v1/volume-groups
Description
Get a list of Volume Groups.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | limit
optional | Number to be displayed on the page
Example : 20
| integer | 20 |
| query | offset
optional | Offset
Example : 0
| integer | 0 |
| query | sort
optional | Sort
Example : column1:asc,column2:desc
| string | None |
| query | name
optional | Volume group name
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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Example HTTP response
Response 200
{
"total_count": 1,
"volume_groups": [
{
"account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
"created_at": "2024-08-01T07:06:23.315Z",
"created_by": "samsung-cloud-platform1@samsung.com",
"id": "c9ecae8b973b425c81c3817893cd8063",
"modified_at": "2024-08-01T07:06:25.315Z",
"modified_by": "samsung-cloud-platform2@samsung.com",
"name": "vg-01",
"num_of_block_storages": 2,
"purpose": "ORG",
"state": "CREATING"
}
]
}
1.24.3 - 1.0
get /v1/volume-groups
Description
Get a list of Volume Groups.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | limit
optional | Number to be displayed on the page
Example : 20
| integer | 20 |
| query | offset
optional | Offset
Example : 0
| integer | 0 |
| query | sort
optional | Sort
Example : column1:asc,column2:desc
| string | None |
| query | name
optional | Volume group name
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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Example HTTP response
Response 200
{
"total_count": 1,
"volume_groups": [
{
"account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
"created_at": "2024-08-01T07:06:23.315Z",
"created_by": "samsung-cloud-platform1@samsung.com",
"id": "c9ecae8b973b425c81c3817893cd8063",
"modified_at": "2024-08-01T07:06:25.315Z",
"modified_by": "samsung-cloud-platform2@samsung.com",
"name": "vg-01",
"num_of_block_storages": 2,
"purpose": "ORG",
"state": "CREATING"
}
]
}
1.25 - List Volume Snapshots
1.25.1 - 1.2
get /v1/volumes/{volume_id}/snapshots
Description
Get a list of Volume snapshots.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/snapshots
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Example HTTP response
Response 200
{
"is_snapshot_policy": false,
"snapshot_capacity_mb": 0,
"snapshot_capacity_rate": 0,
"snapshot_total_usage": 0,
"snapshots": [],
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.25.2 - 1.1
get /v1/volumes/{volume_id}/snapshots
Description
Get a list of Volume snapshots.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/snapshots
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Example HTTP response
Response 200
{
"is_snapshot_policy": false,
"snapshot_capacity_mb": 0,
"snapshot_capacity_rate": 0,
"snapshot_total_usage": 0,
"snapshots": [],
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.25.3 - 1.0
get /v1/volumes/{volume_id}/snapshots
Description
Get a list of Volume snapshots.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/snapshots
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Example HTTP response
Response 200
{
"is_snapshot_policy": false,
"snapshot_capacity_mb": 0,
"snapshot_capacity_rate": 0,
"snapshot_total_usage": 0,
"snapshots": [],
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.26 - List Volumes
1.26.1 - 1.2
get /v1/volumes
Description
Get a list of Volumes.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | limit
optional | Number to be displayed on the page
Example : 20
| integer | 20 |
| query | offset
optional | Offset
Example : 0
| integer | 0 |
| query | sort
optional | Sort
Example : column1:asc,column2:desc
| string | None |
| query | name
optional | Volume name
Example : bs-01
| string | None |
| query | object_name
optional | Attached server name
Example : baremetal-server-name
| string | None |
| query | volume_group_name
optional | Volume group name
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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"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:47.633Z",
"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:47.633Z",
"modified_by": "samsung-cloud-platform2@samsung.com",
"name": "bs-01",
"purpose": "ORG",
"size_gb": 10,
"state": "CREATING",
"volume_group": ""
}
]
}
1.26.2 - 1.1
get /v1/volumes
Description
Get a list of Volumes.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | limit
optional | Number to be displayed on the page
Example : 20
| integer | 20 |
| query | offset
optional | Offset
Example : 0
| integer | 0 |
| query | sort
optional | Sort
Example : column1:asc,column2:desc
| string | None |
| query | name
optional | Volume name
Example : bs-01
| string | None |
| query | object_name
optional | Attached server name
Example : baremetal-server-name
| string | None |
| query | volume_group_name
optional | Volume group name
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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"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:46.871Z",
"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:46.871Z",
"modified_by": "samsung-cloud-platform2@samsung.com",
"name": "bs-01",
"purpose": "ORG",
"size_gb": 10,
"state": "CREATING",
"volume_group": ""
}
]
}
1.26.3 - 1.0
get /v1/volumes
Description
Get a list of Volumes.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | limit
optional | Number to be displayed on the page
Example : 20
| integer | 20 |
| query | offset
optional | Offset
Example : 0
| integer | 0 |
| query | sort
optional | Sort
Example : column1:asc,column2:desc
| string | None |
| query | name
optional | Volume name
Example : bs-01
| string | None |
| query | object_name
optional | Attached server name
Example : baremetal-server-name
| string | None |
| query | volume_group_name
optional | Volume group name
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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"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:46.157Z",
"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:46.157Z",
"modified_by": "samsung-cloud-platform2@samsung.com",
"name": "bs-01",
"purpose": "ORG",
"size_gb": 10,
"state": "CREATING",
"volume_group": ""
}
]
}
1.27 - Remove Volume Group Member on Volume Group
1.27.1 - 1.2
put /v1/volume-groups/{volume_group_id}/members/remove
Description
Remove Volume Group Member on Volume Group.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group 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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Request body
{
"volume_ids": [
"13666d6c32d4456e8421f7768d0bf225"
]
}
Example HTTP response
Response 200
{
"id": "c9ecae8b973b425c81c3817893cd8063",
"member_volumes": [
{
"disk_type": "SSD",
"id": "92cd16fe8ebc4f73832513a172bf0000",
"name": "volume-01",
"purpose": "ORG",
"size_gb": 10,
"so_volume_id": "",
"so_volume_name": ""
}
]
}
1.27.2 - 1.1
put /v1/volume-groups/{volume_group_id}/members/remove
Description
Remove Volume Group Member on Volume Group.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group 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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Request body
{
"volume_ids": [
"13666d6c32d4456e8421f7768d0bf225"
]
}
Example HTTP response
Response 200
{
"id": "c9ecae8b973b425c81c3817893cd8063",
"member_volumes": [
{
"disk_type": "SSD",
"id": "92cd16fe8ebc4f73832513a172bf0000",
"name": "volume-01",
"purpose": "ORG",
"size_gb": 10,
"so_volume_id": "",
"so_volume_name": ""
}
]
}
1.27.3 - 1.0
put /v1/volume-groups/{volume_group_id}/members/remove
Description
Remove Volume Group Member on Volume Group.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group 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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Request body
{
"volume_ids": [
"13666d6c32d4456e8421f7768d0bf225"
]
}
Example HTTP response
Response 200
{
"id": "c9ecae8b973b425c81c3817893cd8063",
"member_volumes": [
{
"disk_type": "SSD",
"id": "92cd16fe8ebc4f73832513a172bf0000",
"name": "volume-01",
"purpose": "ORG",
"size_gb": 10,
"so_volume_id": "",
"so_volume_name": ""
}
]
}
1.28 - Restore Volume Group Snapshot
1.28.1 - 1.2
put /v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}/restore
Description
Restore Volume Group snapshot.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | None |
| path | snapshot_id
required | Snapshot id
Example : 05600123-6e78-11f0-a3f0-d039eab8d501
| string | None |
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}/restore
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Example HTTP response
Response 200
{
"account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
"snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
"volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}
1.28.2 - 1.1
put /v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}/restore
Description
Restore Volume Group snapshot.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | None |
| path | snapshot_id
required | Snapshot id
Example : 05600123-6e78-11f0-a3f0-d039eab8d501
| string | None |
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}/restore
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Example HTTP response
Response 200
{
"account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
"snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
"volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}
1.28.3 - 1.0
put /v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}/restore
Description
Restore Volume Group snapshot.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | None |
| path | snapshot_id
required | Snapshot id
Example : 05600123-6e78-11f0-a3f0-d039eab8d501
| string | None |
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/snapshots/{snapshot_id}/restore
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Example HTTP response
Response 200
{
"account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
"snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
"volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}
1.29 - Restore Volume Snapshot
1.29.1 - 1.2
put /v1/volumes/{volume_id}/snapshots/{snapshot_id}/restore
Description
Restore Volume from snapshot.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
| path | snapshot_id
required | Snapshot id
Example : 05600123-6e78-11f0-a3f0-d039eab8d501
| string | None |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/snapshots/{snapshot_id}/restore
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Example HTTP response
Response 200
{
"account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
"snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.29.2 - 1.1
put /v1/volumes/{volume_id}/snapshots/{snapshot_id}/restore
Description
Restore Volume from snapshot.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
| path | snapshot_id
required | Snapshot id
Example : 05600123-6e78-11f0-a3f0-d039eab8d501
| string | None |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/snapshots/{snapshot_id}/restore
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Example HTTP response
Response 200
{
"account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
"snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.29.3 - 1.0
put /v1/volumes/{volume_id}/snapshots/{snapshot_id}/restore
Description
Restore Volume from snapshot.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
| path | snapshot_id
required | Snapshot id
Example : 05600123-6e78-11f0-a3f0-d039eab8d501
| string | None |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/snapshots/{snapshot_id}/restore
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Example HTTP response
Response 200
{
"account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
"snapshot_id": "05600123-6e78-11f0-a3f0-d039eab8d501",
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.30 - Set Volume Group Replication Cycle
1.30.1 - 1.2
put /v1/volume-groups/{volume_group_id}/replications/cycle
Description
Set Volume Group Replication Cycle.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/replications/cycle
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Request body
Example HTTP response
Response 200
{
"cycle": "5MIN",
"volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}
1.30.2 - 1.1
put /v1/volume-groups/{volume_group_id}/replications/cycle
Description
Set Volume Group Replication Cycle.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/replications/cycle
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Request body
Example HTTP response
Response 200
{
"cycle": "5MIN",
"volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}
1.30.3 - 1.0
put /v1/volume-groups/{volume_group_id}/replications/cycle
Description
Set Volume Group Replication Cycle.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/replications/cycle
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Request body
Example HTTP response
Response 200
{
"cycle": "5MIN",
"volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}
1.31 - Set Volume Group Replication Policy
1.31.1 - 1.2
put /v1/volume-groups/{volume_group_id}/replications/policy
Description
Set Volume Group Replication Policy.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/replications/policy
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Request body
Example HTTP response
Response 200
{
"cycle": "5MIN",
"sync_state": "SNAPMIRROED"
}
1.31.2 - 1.1
put /v1/volume-groups/{volume_group_id}/replications/policy
Description
Set Volume Group Replication Policy.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/replications/policy
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Request body
Example HTTP response
Response 200
{
"cycle": "5MIN",
"sync_state": "SNAPMIRROED"
}
1.31.3 - 1.0
put /v1/volume-groups/{volume_group_id}/replications/policy
Description
Set Volume Group Replication Policy.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/replications/policy
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Request body
Example HTTP response
Response 200
{
"cycle": "5MIN",
"sync_state": "SNAPMIRROED"
}
1.32 - Set Volume Group Snapshot Schedule
1.32.1 - 1.2
put /v1/volume-groups/{volume_group_id}/snapshot-schedules
Description
Set Volume Group Snapshot Schedule.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | None |
| body | body
required |
| VolumeGroupSnapshotScheduleRequest | |
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/snapshot-schedules
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Request body
{
"day_of_week": "SUN",
"hour": 18
}
Example HTTP response
Response 200
{
"day_of_week": "SUN",
"frequency": "DAILY",
"hour": 18,
"volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}
1.32.2 - 1.1
put /v1/volume-groups/{volume_group_id}/snapshot-schedules
Description
Set Volume Group Snapshot Schedule.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | None |
| body | body
required |
| VolumeGroupSnapshotScheduleRequest | |
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/snapshot-schedules
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Request body
{
"day_of_week": "SUN",
"hour": 18
}
Example HTTP response
Response 200
{
"day_of_week": "SUN",
"frequency": "DAILY",
"hour": 18,
"volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}
1.32.3 - 1.0
put /v1/volume-groups/{volume_group_id}/snapshot-schedules
Description
Set Volume Group Snapshot Schedule.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | None |
| body | body
required |
| VolumeGroupSnapshotScheduleRequest | |
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/snapshot-schedules
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Request body
{
"day_of_week": "SUN",
"hour": 18
}
Example HTTP response
Response 200
{
"day_of_week": "SUN",
"frequency": "DAILY",
"hour": 18,
"volume_group_id": "c9ecae8b973b425c81c3817893cd8063"
}
1.33 - Set Volume QoS
1.33.1 - 1.2
put /v1/volumes/{volume_id}/qos
Description
Change volume QoS
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume 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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Request body
{
"iops": 3000,
"throughput": 125
}
Example HTTP response
Response 200
{
"iops": 3000,
"throughput": 125
}
1.34 - Set Volume Replication Cycle
1.34.1 - 1.2
put /v1/volumes/{volume_id}/replications/cycle
Description
Set Volume Replication Cycle.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
| body | body
required |
| VolumeReplicationCycleRequest | |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/replications/cycle
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Request body
Example HTTP response
Response 200
{
"cycle": "5MIN",
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.34.2 - 1.1
put /v1/volumes/{volume_id}/replications/cycle
Description
Set Volume Replication Cycle.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
| body | body
required |
| VolumeReplicationCycleRequest | |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/replications/cycle
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Request body
Example HTTP response
Response 200
{
"cycle": "5MIN",
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.34.3 - 1.0
put /v1/volumes/{volume_id}/replications/cycle
Description
Set Volume Replication Cycle.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
| body | body
required |
| VolumeReplicationCycleRequest | |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/replications/cycle
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Request body
Example HTTP response
Response 200
{
"cycle": "5MIN",
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.35 - Set Volume Replication Policy
1.35.1 - 1.2
put /v1/volumes/{volume_id}/replications/policy
Description
Set Volume Replication Policy.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
| body | body
required |
| VolumeReplicationPolicyRequest | |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/replications/policy
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Request body
Example HTTP response
Response 200
{
"sync_cycle": "5MIN",
"sync_state": "SNAPMIRROED"
}
1.35.2 - 1.1
put /v1/volumes/{volume_id}/replications/policy
Description
Set Volume Replication Policy.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
| body | body
required |
| VolumeReplicationPolicyRequest | |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/replications/policy
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Request body
Example HTTP response
Response 200
{
"sync_cycle": "5MIN",
"sync_state": "SNAPMIRROED"
}
1.35.3 - 1.0
put /v1/volumes/{volume_id}/replications/policy
Description
Set Volume Replication Policy.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
| body | body
required |
| VolumeReplicationPolicyRequest | |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/replications/policy
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Request body
Example HTTP response
Response 200
{
"sync_cycle": "5MIN",
"sync_state": "SNAPMIRROED"
}
1.36 - Set Volume Snapshot Rate
1.36.1 - 1.2
put /v1/volumes/{volume_id}/snapshot-rates
Description
Set Volume snapshot rate.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
| body | body
required |
| VolumeSnapshotRateRequest | |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/snapshot-rates
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Request body
Example HTTP response
Response 200
{
"is_snapshot_activated": true,
"snapshot_rate": 100,
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.36.2 - 1.1
put /v1/volumes/{volume_id}/snapshot-rates
Description
Set Volume snapshot rate.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
| body | body
required |
| VolumeSnapshotRateRequest | |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/snapshot-rates
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Request body
Example HTTP response
Response 200
{
"is_snapshot_activated": true,
"snapshot_rate": 100,
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.36.3 - 1.0
put /v1/volumes/{volume_id}/snapshot-rates
Description
Set Volume snapshot rate.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
| body | body
required |
| VolumeSnapshotRateRequest | |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/snapshot-rates
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Request body
Example HTTP response
Response 200
{
"is_snapshot_activated": true,
"snapshot_rate": 100,
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.37 - Set Volume Snapshot Schedule
1.37.1 - 1.2
put /v1/volumes/{volume_id}/snapshot-schedules
Description
Set Volume snapshot schedule.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
| body | body
required |
| VolumeSnapshotScheduleRequest | |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/snapshot-schedules
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Request body
{
"day_of_week": "SUN",
"hour": 18
}
Example HTTP response
Response 200
{
"day_of_week": "",
"frequency": "DAILY",
"hour": 18,
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.37.2 - 1.1
put /v1/volumes/{volume_id}/snapshot-schedules
Description
Set Volume snapshot schedule.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
| body | body
required |
| VolumeSnapshotScheduleRequest | |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/snapshot-schedules
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Request body
{
"day_of_week": "SUN",
"hour": 18
}
Example HTTP response
Response 200
{
"day_of_week": "",
"frequency": "DAILY",
"hour": 18,
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.37.3 - 1.0
put /v1/volumes/{volume_id}/snapshot-schedules
Description
Set Volume snapshot schedule.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | None |
| body | body
required |
| VolumeSnapshotScheduleRequest | |
Responses
Example HTTP request
Request path
/v1/volumes/{volume_id}/snapshot-schedules
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Request body
{
"day_of_week": "SUN",
"hour": 18
}
Example HTTP response
Response 200
{
"day_of_week": "",
"frequency": "DAILY",
"hour": 18,
"volume_id": "92cd16fe8ebc4f73832513a172bf0000"
}
1.38 - Show Volume
1.38.1 - 1.2
get /v1/volumes/{volume_id}
Description
Show Volume.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume 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}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Example HTTP response
Response 200
{
"result": {
"account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
"attachments": [
{
"id": "83c3c73d457345e3829ee6d5557c0011",
"image_name": "RHEL 8.8 for BM",
"name": "baremetal-01",
"srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
"state": "RUNNING",
"type": "BM"
}
],
"created_at": "2024-08-01T07:06:23.315Z",
"created_by": "samsung-cloud-platform1@samsung.com",
"disk_type": "SSD",
"external_errors": [
{
"code": "Forbidden",
"object_type": "BM",
"status": 403
}
],
"has_origin": true,
"has_replication": true,
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"is_encryption": true,
"iscsi_target_ips": [
"172.30.4.3",
"172.30.4.4"
],
"modified_at": "2024-08-01T07:06:25.315Z",
"modified_by": "samsung-cloud-platform2@samsung.com",
"name": "bs-01",
"previous_state": "CREATING",
"purpose": "ORG",
"qos": {
"iops": 3000,
"throughput": 125
},
"recovery": {
"origin_volume": {
"attachments": [
{
"id": "83c3c73d457345e3829ee6d5557c0011",
"type": "BM"
}
],
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "bs-01"
},
"recovery_volume": {
"attachments": [
{
"id": "83c3c73d457345e3829ee6d5557c0011",
"type": "BM"
}
],
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "bs-01"
}
},
"size_gb": 10,
"snapshot_rate": 100,
"snapshot_schedule": {
"day_of_week": "MON",
"frequency": "DAILY",
"hour": 18
},
"srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
"state": "CREATING",
"storage_volume_name": "vo202407310544da8aadc775f",
"volume_group": {
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "vg-01"
}
}
}
1.38.2 - 1.1
get /v1/volumes/{volume_id}
Description
Show Volume.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume 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}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Example HTTP response
Response 200
{
"result": {
"account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
"attachments": [
{
"id": "83c3c73d457345e3829ee6d5557c0011",
"image_name": "RHEL 8.8 for BM",
"name": "baremetal-01",
"srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
"state": "RUNNING",
"type": "BM"
}
],
"created_at": "2024-08-01T07:06:23.315Z",
"created_by": "samsung-cloud-platform1@samsung.com",
"disk_type": "SSD",
"external_errors": [
{
"code": "Forbidden",
"object_type": "BM",
"status": 403
}
],
"has_origin": true,
"has_replication": true,
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"is_encryption": true,
"iscsi_target_ips": [
"172.30.4.3",
"172.30.4.4"
],
"modified_at": "2024-08-01T07:06:25.315Z",
"modified_by": "samsung-cloud-platform2@samsung.com",
"name": "bs-01",
"previous_state": "CREATING",
"purpose": "ORG",
"recovery": {
"origin_volume": {
"attachments": [
{
"id": "83c3c73d457345e3829ee6d5557c0011",
"type": "BM"
}
],
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "bs-01"
},
"recovery_volume": {
"attachments": [
{
"id": "83c3c73d457345e3829ee6d5557c0011",
"type": "BM"
}
],
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "bs-01"
}
},
"size_gb": 10,
"snapshot_rate": 100,
"snapshot_schedule": {
"day_of_week": "MON",
"frequency": "DAILY",
"hour": 18
},
"srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
"state": "CREATING",
"storage_volume_name": "vo202407310544da8aadc775f",
"volume_group": {
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "vg-01"
}
}
}
1.38.3 - 1.0
get /v1/volumes/{volume_id}
Description
Show Volume.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume 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}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Example HTTP response
Response 200
{
"result": {
"account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
"attachments": [
{
"id": "83c3c73d457345e3829ee6d5557c0011",
"image_name": "RHEL 8.8 for BM",
"name": "baremetal-01",
"srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
"state": "RUNNING",
"type": "BM"
}
],
"created_at": "2024-08-01T07:06:23.315Z",
"created_by": "samsung-cloud-platform1@samsung.com",
"disk_type": "SSD",
"external_errors": [
{
"code": "Forbidden",
"object_type": "BM",
"status": 403
}
],
"has_origin": true,
"has_replication": true,
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"is_encryption": true,
"iscsi_target_ips": [
"172.30.4.3",
"172.30.4.4"
],
"modified_at": "2024-08-01T07:06:25.315Z",
"modified_by": "samsung-cloud-platform2@samsung.com",
"name": "bs-01",
"previous_state": "CREATING",
"purpose": "ORG",
"recovery": {
"origin_volume": {
"attachments": [
{
"id": "83c3c73d457345e3829ee6d5557c0011",
"type": "BM"
}
],
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "bs-01"
},
"recovery_volume": {
"attachments": [
{
"id": "83c3c73d457345e3829ee6d5557c0011",
"type": "BM"
}
],
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "bs-01"
}
},
"size_gb": 10,
"snapshot_rate": 100,
"snapshot_schedule": {
"day_of_week": "MON",
"frequency": "DAILY",
"hour": 18
},
"srn": "srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0",
"state": "CREATING",
"storage_volume_name": "vo202407310544da8aadc775f",
"volume_group": {
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "vg-01"
}
}
}
1.39 - Show Volume Group
1.39.1 - 1.2
get /v1/volume-groups/{volume_group_id}
Description
Show Volume Group
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group 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}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Example HTTP response
Response 200
{
"result": {
"account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
"created_at": "2024-08-01T07:06:23.315Z",
"created_by": "samsung-cloud-platform1@samsung.com",
"has_origin": true,
"has_replication": true,
"id": "c9ecae8b973b425c81c3817893cd8063",
"member_volumes": [
{
"disk_type": "SSD",
"id": "92cd16fe8ebc4f73832513a172bf0000",
"name": "bs-01",
"origin_volume": {
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "my_name"
},
"recovery_volume": {
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "my_name"
},
"size_gb": 10,
"snapshot_rate": 100,
"state": "CREATING"
}
],
"modified_at": "2024-08-01T07:06:25.315Z",
"modified_by": "samsung-cloud-platform2@samsung.com",
"name": "vg-01",
"purpose": "ORG",
"recovery": {
"origin_volume_group": {
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "my_name"
},
"recovery_volume_group": {
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "my_name"
}
},
"snapshot_schedule": {
"day_of_week": "MON",
"frequency": "DAILY",
"hour": 18
},
"so_storage_id": 200,
"so_volume_pool_id": "bm-01",
"state": "CREATING",
"storage_volume_group_name": "go02407310544da8aadc775f"
}
}
1.39.2 - 1.1
get /v1/volume-groups/{volume_group_id}
Description
Show Volume Group
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group 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}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Example HTTP response
Response 200
{
"result": {
"account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
"created_at": "2024-08-01T07:06:23.315Z",
"created_by": "samsung-cloud-platform1@samsung.com",
"has_origin": true,
"has_replication": true,
"id": "c9ecae8b973b425c81c3817893cd8063",
"member_volumes": [
{
"disk_type": "SSD",
"id": "92cd16fe8ebc4f73832513a172bf0000",
"name": "bs-01",
"origin_volume": {
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "my_name"
},
"recovery_volume": {
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "my_name"
},
"size_gb": 10,
"snapshot_rate": 100,
"state": "CREATING"
}
],
"modified_at": "2024-08-01T07:06:25.315Z",
"modified_by": "samsung-cloud-platform2@samsung.com",
"name": "vg-01",
"purpose": "ORG",
"recovery": {
"origin_volume_group": {
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "my_name"
},
"recovery_volume_group": {
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "my_name"
}
},
"snapshot_schedule": {
"day_of_week": "MON",
"frequency": "DAILY",
"hour": 18
},
"so_storage_id": 200,
"so_volume_pool_id": "bm-01",
"state": "CREATING",
"storage_volume_group_name": "go02407310544da8aadc775f"
}
}
1.39.3 - 1.0
get /v1/volume-groups/{volume_group_id}
Description
Show Volume Group
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group 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}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Example HTTP response
Response 200
{
"result": {
"account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
"created_at": "2024-08-01T07:06:23.315Z",
"created_by": "samsung-cloud-platform1@samsung.com",
"has_origin": true,
"has_replication": true,
"id": "c9ecae8b973b425c81c3817893cd8063",
"member_volumes": [
{
"disk_type": "SSD",
"id": "92cd16fe8ebc4f73832513a172bf0000",
"name": "bs-01",
"origin_volume": {
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "my_name"
},
"recovery_volume": {
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "my_name"
},
"size_gb": 10,
"snapshot_rate": 100,
"state": "CREATING"
}
],
"modified_at": "2024-08-01T07:06:25.315Z",
"modified_by": "samsung-cloud-platform2@samsung.com",
"name": "vg-01",
"purpose": "ORG",
"recovery": {
"origin_volume_group": {
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "my_name"
},
"recovery_volume_group": {
"id": "7239779c01e3405f82bb71c7f4b55fcd",
"name": "my_name"
}
},
"snapshot_schedule": {
"day_of_week": "MON",
"frequency": "DAILY",
"hour": 18
},
"so_storage_id": 200,
"so_volume_pool_id": "bm-01",
"state": "CREATING",
"storage_volume_group_name": "go02407310544da8aadc775f"
}
}
1.40 - Show Volume Group Replication
1.40.1 - 1.2
get /v1/volume-groups/{volume_group_id}/replications
Description
Show Volume Group Replication
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | None |
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/replications
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Example HTTP response
Response 200
{
"result": {
"related_volume_groups": [],
"sync_cycle": "5MIN",
"sync_state": "SNAPMIRROED"
}
}
1.40.2 - 1.1
get /v1/volume-groups/{volume_group_id}/replications
Description
Show Volume Group Replication
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | None |
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/replications
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Example HTTP response
Response 200
{
"result": {
"related_volume_groups": [],
"sync_cycle": "5MIN",
"sync_state": "SNAPMIRROED"
}
}
1.40.3 - 1.0
get /v1/volume-groups/{volume_group_id}/replications
Description
Show Volume Group Replication
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_group_id
required | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | None |
Responses
Example HTTP request
Request path
/v1/volume-groups/{volume_group_id}/replications
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Example HTTP response
Response 200
{
"result": {
"related_volume_groups": [],
"sync_cycle": "5MIN",
"sync_state": "SNAPMIRROED"
}
}
1.41 - Show Volume Replication
1.41.1 - 1.2
get /v1/volumes/{volume_id}/replications
Description
Show Volume Replication.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume 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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.2"
Example HTTP response
Response 200
{
"result": {
"related_volumes": [],
"sync_cycle": "5MIN",
"sync_state": "SNAPMIRROED"
}
}
1.41.2 - 1.1
get /v1/volumes/{volume_id}/replications
Description
Show Volume Replication.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.1 | 20260331 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume 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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.1"
Example HTTP response
Response 200
{
"result": {
"related_volumes": [],
"sync_cycle": "5MIN",
"sync_state": "SNAPMIRROED"
}
}
1.41.3 - 1.0
get /v1/volumes/{volume_id}/replications
Description
Show Volume Replication.
State
ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | volume_id
required | Volume 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
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = baremetal-blockstorage 1.0"
Example HTTP response
Response 200
{
"result": {
"related_volumes": [],
"sync_cycle": "5MIN",
"sync_state": "SNAPMIRROED"
}
}
2 - Models
2.1 - AsyncResponse
| Name | Description | Schema | Default |
|---|
request_id
optional | Request id
Example : req-0006064c-c008-458c-8977-19671c6b32d4
| string | |
resource_id
optional | Resource id
Example : 8bf55e738d4e44b5a21dbe133a42ecbe
| string | |
2.2 - AttachedServer
| Name | Description | Schema | Default |
|---|
id
optional | Server id
Example : 83c3c73d457345e3829ee6d5557c0011
| string | |
image_name
optional | Image name
Example : RHEL 8.8 for BM
| string | |
name
optional | Server name
Example : baremetal-01
| string | |
srn
optional | SRN
Example : srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0
| string | |
state
optional | Server state
Example : RUNNING
| string | |
type
optional | Server type
Example : BM
| enum (BM, MNGC) | |
2.3 - AttachmentListModel
| Name | Description | Schema | Default |
|---|
object_id
optional | Object id
Example : 83c3c73d457345e3829ee6d5557c0016
| string | |
object_type
optional | Object type
Example : BM
| enum (BM, MNGC) | |
2.4 - ExternalError
| Name | Description | Schema | Default |
|---|
code
optional | Code
Example : Forbidden
| string | |
object_type
optional | Server type
Example : BM
| enum (BM, MNGC) | |
status
optional | Status
Example : 403
| integer | |
2.5 - MemberVolume
| Name | Description | Schema | Default |
|---|
disk_type
optional | disk_type
Example : SSD
| enum (SSD, HDD) | |
id
optional | volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | |
name
optional | volume name
Example : volume-01
| string | |
purpose
optional | volume purpose
Example : ORG
| enum (ORG, REPL, BACKUP, RECOVERY) | |
size_gb
optional | size_gb
Example : 10
| integer | |
so_volume_id
optional | so volume id
Example :
| string | |
so_volume_name
optional | so volume name
Example :
| string | |
2.6 - MemberVolumeWithRecoveryInfo
| Name | Description | Schema | Default |
|---|
disk_type
optional | Disk type
Example : SSD
| enum (SSD, HDD) | |
id
optional | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | |
name
optional | Volume name
Example : bs-01
| string | |
origin_volume
optional | origin volume information
| SimpleIdNameInfo | |
recovery_volume
optional | recovery volume information
| SimpleIdNameInfo | |
size_gb
optional | Volume capacity(GB)
Example : 10
| integer | |
snapshot_rate
optional | Snapshot rate
Example : 100
| integer | |
state
optional | Current state
Example : CREATING
| enum (CREATING, IN_USE, EDITING, DELETING, DELETED, ATTACHING, DETACHING, AVAILABLE, ERROR_DELETING, ERROR_EDITING, ERROR) | |
2.7 - QoSModel
| Name | Description | Schema | Default |
|---|
iops
required | Enter the value between at least 3,000 IOPS and up to 16,000 IOPS.
Example : 3000
| integer | |
throughput
required | Enter the value between at least 125MB/s and up to 1,000MB/s.
Example : 125
| integer | |
2.9 - RecoveryVolumeGroupInfo
| Name | Description | Schema | Default |
|---|
origin_volume_group
optional | Origin volume group information
| SimpleIdNameInfo | |
recovery_volume_group
optional | Recovery volume group information
| SimpleIdNameInfo | |
2.10 - RecoveryVolumeInfo
| Name | Description | Schema | Default |
|---|
attachments
optional | Attached server
| array[SimpleAttachedServer] | |
id
optional | id
Example : 7239779c01e3405f82bb71c7f4b55fcd
| string | |
name
optional | Volume name
Example : bs-01
| string | |
2.11 - RelationVolumeGroupModel
| Name | Description | Schema | Default |
|---|
auth
optional | Auth
Example : READ
| enum (READ, READ_WRITE, UNKNOWN) | |
id
optional | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | |
name
optional | Volume name
Example : bs-01
| string | |
purpose
optional | Volume group purpose
Example : ORG
| enum (ORG, REPL, RECOVERY) | |
region
optional | Region
Example : kr-west1
| string | |
2.12 - RelationVolumeModel
| Name | Description | Schema | Default |
|---|
auth
optional | Auth
Example : READ
| enum (READ, READ_WRITE, UNKNOWN) | |
id
optional | id
Example : 7239779c01e3405f82bb71c7f4b55fcd
| string | |
name
optional | Volume name
Example : bs-01
| string | |
purpose
optional | Volume purpose
Example : ORG
| enum (ORG, REPL, BACKUP, RECOVERY) | |
region
optional | Region
Example : kr-west1
| string | |
2.13 - SetVolumeQoSRequest
| Name | Description | Schema | Default |
|---|
iops
optional | IOPS. If omitted, the existing value will be retained.
Example : 3000
| integer | |
throughput
optional | Throughput. If omitted, the existing value will be retained.
Example : 125
| integer | |
2.14 - SetVolumeQoSResponse
| Name | Description | Schema | Default |
|---|
iops
optional | IOPS
Example : 3000
| integer | |
throughput
optional | Throughput
Example : 125
| integer | |
2.15 - SimpleAttachedServer
| Name | Description | Schema | Default |
|---|
id
optional | Server id
Example : 83c3c73d457345e3829ee6d5557c0011
| string | |
type
optional | Server type
Example : BM
| enum (BM, MNGC) | |
2.16 - SimpleIdNameInfo
| Name | Description | Schema | Default |
|---|
id
optional | id
Example : 7239779c01e3405f82bb71c7f4b55fcd
| string | |
name
optional | name
Example : my_name
| string | |
2.17 - SnapshotSchedule
| Name | Description | Schema | Default |
|---|
day_of_week
optional | Day of week
Example : MON
| string | MON |
frequency
optional | Frequency DAILY | WEEKLY | NONE
Example : DAILY
|
hour
optional | Hour
Example : 18
| integer | |
2.18 - TagModel
| Name | Description | Schema | Default |
|---|
key
optional | Tag key
Example : my_tag_1
| any of [string, null] | |
value
optional | Tag value
Example : my_value_1
| any of [string, null] | |
2.19 - VolumeAttachmentRequest
| Name | Description | Schema | Default |
|---|
attachments
required | List of server id and type
| array[AttachmentListModel] | |
2.20 - VolumeAttachmentResponse
| Name | Description | Schema | Default |
|---|
attachments
optional | List of server id and type
| array[AttachmentListModel] | |
2.21 - VolumeCreateRequest
| Name | Description | Schema | Default |
|---|
attachments
required | List of server id and type
| array[AttachmentListModel] | |
disk_type
required | Disk type
Example : SSD
| enum (SSD, HDD) | |
name
required | Volume name
Example : bs-01
| string | |
size_gb
required | Volume capacity(GB)
Example : 10
| integer | |
tags
optional | Tags
| any of [array[TagModel], null] | |
2.22 - VolumeCreateRequestV1Dot2
| Name | Description | Schema | Default |
|---|
attachments
required | List of server id and type
| array[AttachmentListModel] | |
disk_type
required | Disk type
Example : SSD
| enum (SSD, HDD) | |
name
required | Volume name
Example : bs-01
| string | |
qos
optional | Volume QoS
| QoSModel | |
size_gb
required | Volume capacity(GB)
Example : 10
| integer | |
tags
optional | Tags
| any of [array[TagModel], null] | |
2.23 - VolumeDetachRequest
| Name | Description | Schema | Default |
|---|
attachments
required | List of object id to detach
| array[string] | |
2.24 - VolumeGroupCreationRequest
| Name | Description | Schema | Default |
|---|
name
required | Volume group name
Example : vg-01
| string | |
tags
optional | Tags
| any of [array[TagModel], null] | |
volume_ids
required | List of volume(Block Storage) id to add
Example : ['17e0b4fd27784dfb843440ec08bdd148']
| array[string] | |
2.25 - VolumeGroupInfo
| Name | Description | Schema | Default |
|---|
id
optional | id
Example : 7239779c01e3405f82bb71c7f4b55fcd
| string | |
name
optional | Volume group name
Example : vg-01
| string | |
2.26 - VolumeGroupListModel
| Name | Description | Schema | Default |
|---|
account_id
optional | Account id
Example : 36827d9b643f46c2ae6bb7e63d633bfe
| string | |
created_at
optional | Created at
Example : 2024-08-01T07:06:23.315Z
| string (date-time) | |
created_by
optional | Created by
Example : samsung-cloud-platform1@samsung.com
| string | |
id
optional | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | |
modified_at
optional | Modified at
Example : 2024-08-01T07:06:25.315Z
| string (date-time) | |
modified_by
optional | Modified by
Example : samsung-cloud-platform2@samsung.com
| string | |
name
optional | Volume group name
Example : vg-01
| string | |
num_of_block_storages
optional | Number of volumes
Example : 2
| integer | 1 |
purpose
optional | Volume group purpose
Example : ORG
| string | |
state
optional | Current state
Example : CREATING
| enum (CREATING, AVAILABLE, DELETING, EDITING, DELETED, ERROR_DELETING, ERROR_EDITING, ERROR) | |
2.27 - VolumeGroupListResponse
| Name | Description | Schema | Default |
|---|
total_count
optional | Total count
Example : 1
| integer | |
volume_groups
optional | List of volume groups
| array[VolumeGroupListModel] | |
2.28 - VolumeGroupMemberRequest
| Name | Description | Schema | Default |
|---|
volume_ids
required | List of volume(Block Storage) id
Example : ['13666d6c32d4456e8421f7768d0bf225']
| array[string] | |
2.29 - VolumeGroupMemberResponse
| Name | Description | Schema | Default |
|---|
id
optional | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | |
member_volumes
optional | List of member volumes
| array[MemberVolume] | |
2.30 - VolumeGroupModel
| Name | Description | Schema | Default |
|---|
account_id
optional | Account id
Example : 36827d9b643f46c2ae6bb7e63d633bfe
| string | |
created_at
optional | Created at
Example : 2024-08-01T07:06:23.315Z
| string | |
created_by
optional | Created by
Example : samsung-cloud-platform1@samsung.com
| string | |
has_origin
optional | Whether origin relation exists
Example : True
| boolean | |
has_replication
optional | Whether replication relation exists
Example : True
| boolean | |
id
optional | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | |
member_volumes
optional | List of member volumes
| array[MemberVolumeWithRecoveryInfo] | |
modified_at
optional | Modified at
Example : 2024-08-01T07:06:25.315Z
| string | |
modified_by
optional | Modified by
Example : samsung-cloud-platform2@samsung.com
| string | |
name
optional | Volume group name
Example : vg-01
| string | |
purpose
optional | Volume group purpose
Example : ORG
| enum (ORG, REPL, RECOVERY) | |
recovery
optional | Recovery volume group information
| RecoveryVolumeGroupInfo | |
snapshot_schedule
optional | Snapshot schedule
| SnapshotSchedule | |
so_storage_id
optional | So Storage Id
Example : 200
| integer | |
so_volume_pool_id
optional | So Volume pool id
Example : bm-01
| string | |
state
optional | Current state
Example : CREATING
| enum (CREATING, AVAILABLE, DELETING, EDITING, DELETED, ERROR_DELETING, ERROR_EDITING, ERROR) | |
storage_volume_group_name
optional | So volume group name
Example : go02407310544da8aadc775f
| string | |
2.31 - VolumeGroupRecoveryCreateRequest
| Name | Description | Schema | Default |
|---|
block_storage_name_prefix
required | Block Storage name prefix
Example : prefix-
| string | |
snapshot_id
required | Snapshot id
Example : 05600123-6e78-11f0-a3f0-d039eab8d501
| string | |
2.32 - VolumeGroupReplicationCreateRequest
| Name | Description | Schema | Default |
|---|
cycle
required | Replication cycle
Example : 5MIN
| enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY) | |
name
required | Replication volume group name
Example : replica-vg-01
| string | |
region
required | Region
Example : kr-west1
| string | |
replication_volume_name_prefix
required | Replication volume name prefix
Example : dr
| string | |
2.33 - VolumeGroupReplicationDeleteResponse
| Name | Description | Schema | Default |
|---|
result
optional | Result
Example :
| boolean | |
2.34 - VolumeGroupReplicationSyncTabModel
| Name | Description | Schema | Default |
|---|
related_volume_groups
optional | List of related volume groups
| array[RelationVolumeGroupModel] | |
sync_cycle
optional | Replication cycle
Example : 5MIN
| enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY) | |
sync_state
optional | Replication state
Example : SNAPMIRROED
| string | |
2.35 - VolumeGroupReplicationSyncTabResponse
2.36 - VolumeGroupReplicationUpdateCycleRequest
| Name | Description | Schema | Default |
|---|
cycle
required | Replication cycle
Example : 5MIN
| enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY) | |
2.37 - VolumeGroupReplicationUpdateCycleResponse
| Name | Description | Schema | Default |
|---|
cycle
optional | Replication cycle
Example : 5MIN
| enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY) | |
volume_group_id
optional | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | |
2.38 - VolumeGroupReplicationUpdatePolicyRequest
| Name | Description | Schema | Default |
|---|
policy
required | Policy
Example : RESYNC
| enum (RESYNC, BREAK) | |
2.39 - VolumeGroupReplicationUpdatePolicyResponse
| Name | Description | Schema | Default |
|---|
cycle
optional | Replication cycle
Example : 5MIN
| enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY) | |
sync_state
optional | Replication state
Example : SNAPMIRROED
| string | |
2.40 - VolumeGroupResponse
2.41 - VolumeGroupSnapshotDeleteResponse
| Name | Description | Schema | Default |
|---|
account_id
optional | Account id
Example : 36827d9b643f46c2ae6bb7e63d633bfe
| string | |
snapshot_id
optional | Snapshot id
Example : 05600123-6e78-11f0-a3f0-d039eab8d501
| string | |
volume_group_id
optional | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | |
2.42 - VolumeGroupSnapshotListModel
| Name | Description | Schema | Default |
|---|
created_dt
optional | Created dt
Example : 2024-08-01T07:07:23.315Z
| string | |
snapshot_id
optional | Snapshot id
Example : 05600123-6e78-11f0-a3f0-d039eab8d501
| string | |
snapshot_name
optional | Snapshot name
Example : vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
| string | |
2.43 - VolumeGroupSnapshotListResponse
| Name | Description | Schema | Default |
|---|
is_snapshot_policy
optional | Whether to activate snapshot
Example : False
| boolean | |
snapshots
optional | List of snapshots
| array[VolumeGroupSnapshotListModel] | |
volume_group_id
optional | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | |
2.44 - VolumeGroupSnapshotResponse
| Name | Description | Schema | Default |
|---|
account_id
optional | Account id
Example : 36827d9b643f46c2ae6bb7e63d633bfe
| string | |
snapshot_id
optional | Snapshot id
Example : 05600123-6e78-11f0-a3f0-d039eab8d501
| string | |
snapshot_name
optional | Snapshot name
Example : vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
| string | |
volume_group_id
optional | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | |
2.45 - VolumeGroupSnapshotRestoreResponse
| Name | Description | Schema | Default |
|---|
account_id
optional | Account id
Example : 36827d9b643f46c2ae6bb7e63d633bfe
| string | |
snapshot_id
optional | Snapshot id
Example : 05600123-6e78-11f0-a3f0-d039eab8d501
| string | |
volume_group_id
optional | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | |
2.46 - VolumeGroupSnapshotScheduleRequest
| Name | Description | Schema | Default |
|---|
day_of_week
optional | Day of week(If this field is excluded, the schedule frequency is set to DAILY.)
Example : SUN
| enum (SUN, MON, TUE, WED, THU, FRI, SAT) | |
hour
required | Hour
Example : 18
| integer | |
2.47 - VolumeGroupSnapshotScheduleResponse
| Name | Description | Schema | Default |
|---|
day_of_week
optional | Day of week
Example : SUN
| enum (SUN, MON, TUE, WED, THU, FRI, SAT) | |
frequency
optional | Frequency DAILY | WEEKLY | NONE
Example : DAILY
|
hour
optional | Hour
Example : 18
| integer | |
volume_group_id
optional | Volume group id
Example : c9ecae8b973b425c81c3817893cd8063
| string | |
2.48 - VolumeListModel
| Name | Description | Schema | Default |
|---|
attachments
optional | Attached server
Example : [{'id': 'd7682135392e42489948c189e29011cc', 'name': 'baremetal-01'}]
| array[object] | |
created_at
optional | Created at
Example :
| string (date-time) | |
created_by
optional | Created by
Example : samsung-cloud-platform1@samsung.com
| string | |
disk_type
optional | Disk type
Example : SSD
| enum (SSD, HDD) | |
has_relation
optional | Whether relation exists
Example : False
| boolean | |
id
optional | id
Example : 7239779c01e3405f82bb71c7f4b55fcd
| string | |
is_in_volume_group
optional | Whether to belong to the volume group
Example : False
| boolean | |
is_snapshot_activated
optional | Whether to activate snapshot
Example : True
| boolean | |
iscsi_target_ips
optional | List of iscsi ips
Example : {'description': 'List of iscsi ips', 'example': ['172.30.4.3', '172.30.4.4']}
| array[string] | |
modified_at
optional | Modified at
Example :
| string (date-time) | |
modified_by
optional | Modified by
Example : samsung-cloud-platform2@samsung.com
| string | |
name
optional | Volume name
Example : bs-01
| string | |
purpose
optional | Volume purpose
Example : ORG
| enum (ORG, REPL, BACKUP, RECOVERY) | |
size_gb
optional | Volume capacity(GB)
Example : 10
| integer | |
state
optional | Current state
Example : CREATING
| enum (CREATING, IN_USE, EDITING, DELETING, DELETED, ATTACHING, DETACHING, AVAILABLE, ERROR_DELETING, ERROR_EDITING, ERROR) | |
volume_group
optional | Volume group
Example :
| object | |
2.49 - VolumeListResponse
| Name | Description | Schema | Default |
|---|
total_count
optional | Total count
Example : 1
| integer | |
volumes
optional | List of volumes
| array[VolumeListModel] | |
2.50 - VolumeModel
| Name | Description | Schema | Default |
|---|
account_id
optional | Account id
Example : 36827d9b643f46c2ae6bb7e63d633bfe
| string | |
attachments
optional | Attached server
| array[AttachedServer] | |
created_at
optional | Created at
Example : 2024-08-01T07:06:23.315Z
| string | |
created_by
optional | Created by
Example : samsung-cloud-platform1@samsung.com
| string | |
disk_type
optional | Disk type
Example : SSD
| enum (SSD, HDD) | |
external_errors
optional | Error during external call
| array[ExternalError] | |
has_origin
optional | Whether origin relation exists
Example : True
| boolean | |
has_replication
optional | Whether replication relation exists
Example : True
| boolean | |
id
optional | id
Example : 7239779c01e3405f82bb71c7f4b55fcd
| string | |
is_encryption
optional | Whether to apply encryption
Example : True
| boolean | |
iscsi_target_ips
optional | List of iscsi ips
Example : ['172.30.4.3', '172.30.4.4']
| array[string] | |
modified_at
optional | Modified at
Example : 2024-08-01T07:06:25.315Z
| string | |
modified_by
optional | Modified by
Example : samsung-cloud-platform2@samsung.com
| string | |
name
optional | Volume name
Example : bs-01
| string | |
previous_state
optional | Previous state
Example : CREATING
| enum (CREATING, IN_USE, EDITING, DELETING, DELETED, ATTACHING, DETACHING, AVAILABLE, ERROR_DELETING, ERROR_EDITING, ERROR) | |
purpose
optional | Volume purpose
Example : ORG
| enum (ORG, REPL, BACKUP, RECOVERY) | |
recovery
optional | Recovery information
| RecoveryInfo | |
size_gb
optional | Volume capacity(GB)
Example : 10
| integer | |
snapshot_rate
optional | Snapshot rate
Example : 100
| integer | |
snapshot_schedule
optional | Snapshot schedule
| SnapshotSchedule | |
srn
optional | SRN
Example : srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0
| string | |
state
optional | Current state
Example : CREATING
| enum (CREATING, IN_USE, EDITING, DELETING, DELETED, ATTACHING, DETACHING, AVAILABLE, ERROR_DELETING, ERROR_EDITING, ERROR) | |
storage_volume_name
optional | Storage volume name
Example : vo202407310544da8aadc775f
| string | |
volume_group
optional | Volume group
| VolumeGroupInfo | |
2.51 - VolumeModelV1Dot2
| Name | Description | Schema | Default |
|---|
account_id
optional | Account id
Example : 36827d9b643f46c2ae6bb7e63d633bfe
| string | |
attachments
optional | Attached server
| array[AttachedServer] | |
created_at
optional | Created at
Example : 2024-08-01T07:06:23.315Z
| string | |
created_by
optional | Created by
Example : samsung-cloud-platform1@samsung.com
| string | |
disk_type
optional | Disk type
Example : SSD
| enum (SSD, HDD) | |
external_errors
optional | Error during external call
| array[ExternalError] | |
has_origin
optional | Whether origin relation exists
Example : True
| boolean | |
has_replication
optional | Whether replication relation exists
Example : True
| boolean | |
id
optional | id
Example : 7239779c01e3405f82bb71c7f4b55fcd
| string | |
is_encryption
optional | Whether to apply encryption
Example : True
| boolean | |
iscsi_target_ips
optional | List of iscsi ips
Example : ['172.30.4.3', '172.30.4.4']
| array[string] | |
modified_at
optional | Modified at
Example : 2024-08-01T07:06:25.315Z
| string | |
modified_by
optional | Modified by
Example : samsung-cloud-platform2@samsung.com
| string | |
name
optional | Volume name
Example : bs-01
| string | |
previous_state
optional | Previous state
Example : CREATING
| enum (CREATING, IN_USE, EDITING, DELETING, DELETED, ATTACHING, DETACHING, AVAILABLE, ERROR_DELETING, ERROR_EDITING, ERROR) | |
purpose
optional | Volume purpose
Example : ORG
| enum (ORG, REPL, BACKUP, RECOVERY) | |
qos
optional | Volume QoS
| QoSModel | |
recovery
optional | Recovery information
| RecoveryInfo | |
size_gb
optional | Volume capacity(GB)
Example : 10
| integer | |
snapshot_rate
optional | Snapshot rate
Example : 100
| integer | |
snapshot_schedule
optional | Snapshot schedule
| SnapshotSchedule | |
srn
optional | SRN
Example : srn:dev2::36827d9b643f46c2ae6bb7e63d633bfe:kr-west1::baremetal-blockstorage:volume/97cd36e3c1984c8cad3ec193aeda25e0
| string | |
state
optional | Current state
Example : CREATING
| enum (CREATING, IN_USE, EDITING, DELETING, DELETED, ATTACHING, DETACHING, AVAILABLE, ERROR_DELETING, ERROR_EDITING, ERROR) | |
storage_volume_name
optional | Storage volume name
Example : vo202407310544da8aadc775f
| string | |
volume_group
optional | Volume group
| VolumeGroupInfo | |
2.52 - VolumeRecoveryCreateRequest
| Name | Description | Schema | Default |
|---|
name
required | Recovery volume name
Example : recovery-volume
| string | |
snapshot_id
required | Snapshot id
Example : 05600123-6e78-11f0-a3f0-d039eab8d501
| string | |
2.53 - VolumeReplicationCreateRequest
| Name | Description | Schema | Default |
|---|
cycle
required | Replication cycle
Example : 5MIN
| enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY) | |
name
required | Replication volume name
Example : replica-bs-01
| string | |
region
required | Region
Example : kr-west1
| string | |
2.54 - VolumeReplicationCycleRequest
| Name | Description | Schema | Default |
|---|
cycle
required | Replication cycle
Example : 5MIN
| enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY) | |
2.55 - VolumeReplicationCycleResponse
| Name | Description | Schema | Default |
|---|
cycle
optional | Replication cycle
Example : 5MIN
| enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY) | |
volume_id
optional | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | |
2.56 - VolumeReplicationModel
| Name | Description | Schema | Default |
|---|
related_volumes
optional | List of related volumes
| array[RelationVolumeModel] | |
sync_cycle
optional | Replication cycle
Example : 5MIN
| enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY) | |
sync_state
optional | Replication state
Example : SNAPMIRROED
| string | |
2.57 - VolumeReplicationPolicyRequest
| Name | Description | Schema | Default |
|---|
policy
required | Policy
Example : RESYNC
| enum (RESYNC, BREAK) | |
2.58 - VolumeReplicationPolicyResponse
| Name | Description | Schema | Default |
|---|
sync_cycle
optional | Replication cycle
Example : 5MIN
| enum (5MIN, HOURLY, DAILY, WEEKLY, MONTHLY) | |
sync_state
optional | Replication state
Example : SNAPMIRROED
| string | |
2.59 - VolumeReplicationResponse
2.60 - VolumeResponse
| Name | Description | Schema | Default |
|---|
result
optional | Volume detail
| VolumeModel | |
2.61 - VolumeResponseV1Dot2
2.62 - VolumeSnapshotDeleteResponse
| Name | Description | Schema | Default |
|---|
account_id
optional | Account id
Example : 36827d9b643f46c2ae6bb7e63d633bfe
| string | |
snapshot_id
optional | Snapshot id
Example : 05600123-6e78-11f0-a3f0-d039eab8d501
| string | |
volume_id
optional | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | |
2.63 - VolumeSnapshotListModel
| Name | Description | Schema | Default |
|---|
created_dt
optional | Created dt
Example : 2024-08-01T07:07:23.315Z
| string | |
snapshot_id
optional | Snapshot id
Example : 05600123-6e78-11f0-a3f0-d039eab8d501
| string | |
snapshot_name
optional | Snapshot name
Example : vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
| string | |
snapshot_size_mb
optional | Snapshot size(MB)
Example : 0
| object | |
2.64 - VolumeSnapshotListResponse
| Name | Description | Schema | Default |
|---|
is_snapshot_policy
optional | Whether to activate snapshot
Example : False
| boolean | |
snapshot_capacity_mb
optional | Snapshot size(MB)
Example : 0
| object | |
snapshot_capacity_rate
optional | Snapshot capacity rate
Example : 0
| object | |
snapshot_total_usage
optional | Snapshot total usage
Example : 0
| object | |
snapshots
optional | List of snapshots
| array[VolumeSnapshotListModel] | |
volume_id
optional | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | |
2.65 - VolumeSnapshotRateRequest
| Name | Description | Schema | Default |
|---|
snapshot_rate
required | Snapshot rate
Example : 100
| integer | |
2.66 - VolumeSnapshotRateResponse
| Name | Description | Schema | Default |
|---|
is_snapshot_activated
optional | Whether to activate snapshot
Example : True
| boolean | |
snapshot_rate
optional | Snapshot rate
Example : 100
| integer | |
volume_id
optional | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | |
2.67 - VolumeSnapshotResponse
| Name | Description | Schema | Default |
|---|
account_id
optional | Account id
Example : 36827d9b643f46c2ae6bb7e63d633bfe
| string | |
snapshot_id
optional | Snapshot id
Example : 05600123-6e78-11f0-a3f0-d039eab8d501
| string | |
snapshot_name
optional | Snapshot name
Example : vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
| string | |
volume_id
optional | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | |
2.68 - VolumeSnapshotRestoreResponse
| Name | Description | Schema | Default |
|---|
account_id
optional | Account id
Example : 36827d9b643f46c2ae6bb7e63d633bfe
| string | |
snapshot_id
optional | Snapshot id
Example : 05600123-6e78-11f0-a3f0-d039eab8d501
| string | |
volume_id
optional | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | |
2.69 - VolumeSnapshotScheduleRequest
| Name | Description | Schema | Default |
|---|
day_of_week
optional | Day of week(If this field is excluded, the schedule frequency is set to DAILY.)
Example : SUN
| enum (SUN, MON, TUE, WED, THU, FRI, SAT) | |
hour
required | Hour
Example : 18
| integer | |
2.70 - VolumeSnapshotScheduleResponse
| Name | Description | Schema | Default |
|---|
day_of_week
optional | Day of week
Example : SUN
| enum (SUN, MON, TUE, WED, THU, FRI, SAT) | |
frequency
optional | Frequency DAILY | WEEKLY | NONE
Example : DAILY
|
hour
optional | Hour
Example : 18
| integer | |
volume_id
optional | Volume id
Example : 92cd16fe8ebc4f73832513a172bf0000
| string | |