This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

List Volumes

1: 1.4
2: 1.3
3: 1.2
4: 1.1
5: 1.0

1 - 1.4

get /v1/volumes

Description

Get a list of Volumes.

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

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	VolumeListResponseV1Dot4
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/volumes

Request header

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

Example HTTP response

Response 200

{
    "total_count": 1,
    "volumes": [
        {
            "attachments": [
                {
                    "id": "d7682135392e42489948c189e29011cc",
                    "name": "baremetal-01",
                    "srn": "srn:dev2::8461b55d9088408b8f3cf1f8f9c8bea6:kr-west1::baremetal:baremetal/92cd16fe8ebc4f73832513a172bf0000"
                }
            ],
            "created_at": "2024-01-15T10:30:00.000Z",
            "created_by": "f019b1007d9c4763997997622958fa96",
            "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": "2024-01-15T10:30:00.000Z",
            "modified_by": "f019b1007d9c4763997997622958fa96",
            "name": "bs-01",
            "purpose": "ORG",
            "size_gb": 10,
            "state": "CREATING",
            "volume_group": "",
            "zone": "kr-west1-a"
        }
    ]
}

2 - 1.3

get /v1/volumes

Description

Get a list of Volumes.

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20270131

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

Request header

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

Example HTTP response

Response 200

{
    "total_count": 1,
    "volumes": [
        {
            "attachments": [
                {
                    "id": "d7682135392e42489948c189e29011cc",
                    "name": "baremetal-01",
                    "srn": "srn:dev2::8461b55d9088408b8f3cf1f8f9c8bea6:kr-west1::baremetal:baremetal/92cd16fe8ebc4f73832513a172bf0000"
                }
            ],
            "created_at": "2024-01-15T10:30:00.000Z",
            "created_by": "f019b1007d9c4763997997622958fa96",
            "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": "2024-01-15T10:30:00.000Z",
            "modified_by": "f019b1007d9c4763997997622958fa96",
            "name": "bs-01",
            "purpose": "ORG",
            "size_gb": 10,
            "state": "CREATING",
            "volume_group": ""
        }
    ]
}

3 - 1.2

get /v1/volumes

Description

Get a list of Volumes.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.2	20260531

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

Request header

"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",
                    "srn": "srn:dev2::8461b55d9088408b8f3cf1f8f9c8bea6:kr-west1::baremetal:baremetal/92cd16fe8ebc4f73832513a172bf0000"
                }
            ],
            "created_at": "2024-01-15T10:30:00.000Z",
            "created_by": "f019b1007d9c4763997997622958fa96",
            "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": "2024-01-15T10:30:00.000Z",
            "modified_by": "f019b1007d9c4763997997622958fa96",
            "name": "bs-01",
            "purpose": "ORG",
            "size_gb": 10,
            "state": "CREATING",
            "volume_group": ""
        }
    ]
}

4 - 1.1

get /v1/volumes

Description

Get a list of Volumes.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
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

Request header

"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",
                    "srn": "srn:dev2::8461b55d9088408b8f3cf1f8f9c8bea6:kr-west1::baremetal:baremetal/92cd16fe8ebc4f73832513a172bf0000"
                }
            ],
            "created_at": "2024-01-15T10:30:00.000Z",
            "created_by": "f019b1007d9c4763997997622958fa96",
            "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": "2024-01-15T10:30:00.000Z",
            "modified_by": "f019b1007d9c4763997997622958fa96",
            "name": "bs-01",
            "purpose": "ORG",
            "size_gb": 10,
            "state": "CREATING",
            "volume_group": ""
        }
    ]
}

5 - 1.0

get /v1/volumes

Description

Get a list of Volumes.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
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

Request header

"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",
                    "srn": "srn:dev2::8461b55d9088408b8f3cf1f8f9c8bea6:kr-west1::baremetal:baremetal/92cd16fe8ebc4f73832513a172bf0000"
                }
            ],
            "created_at": "2024-01-15T10:30:00.000Z",
            "created_by": "f019b1007d9c4763997997622958fa96",
            "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": "2024-01-15T10:30:00.000Z",
            "modified_by": "f019b1007d9c4763997997622958fa96",
            "name": "bs-01",
            "purpose": "ORG",
            "size_gb": 10,
            "state": "CREATING",
            "volume_group": ""
        }
    ]
}