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

List Volume Groups

1: 1.2
2: 1.1
3: 1.0

1 - 1.2

get /v1/volume-groups

Description

볼륨 그룹 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.2	-

Parameters

Type	Name	Description	Schema	Default
query	limit optional	페이지에 표시될 번호 Example : `20`	integer	20
query	offset optional	Offset Example : `0`	integer	0
query	sort optional	정렬 Example : `column1:asc,column2:desc`	string	None
query	name optional	볼륨 그룹명 Example : `vg-01`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups

Request header

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

Example HTTP response

Response 200

{
    "total_count": 1,
    "volume_groups": [
        {
            "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
            "created_at": "2024-08-01T07:06:23.315Z",
            "created_by": "samsung-cloud-platform1@samsung.com",
            "id": "c9ecae8b973b425c81c3817893cd8063",
            "modified_at": "2024-08-01T07:06:25.315Z",
            "modified_by": "samsung-cloud-platform2@samsung.com",
            "name": "vg-01",
            "num_of_block_storages": 2,
            "purpose": "ORG",
            "state": "CREATING"
        }
    ]
}

2 - 1.1

get /v1/volume-groups

Description

볼륨 그룹 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
query	limit optional	페이지에 표시될 번호 Example : `20`	integer	20
query	offset optional	Offset Example : `0`	integer	0
query	sort optional	정렬 Example : `column1:asc,column2:desc`	string	None
query	name optional	볼륨 그룹명 Example : `vg-01`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups

Request header

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

Example HTTP response

Response 200

{
    "total_count": 1,
    "volume_groups": [
        {
            "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
            "created_at": "2024-08-01T07:06:23.315Z",
            "created_by": "samsung-cloud-platform1@samsung.com",
            "id": "c9ecae8b973b425c81c3817893cd8063",
            "modified_at": "2024-08-01T07:06:25.315Z",
            "modified_by": "samsung-cloud-platform2@samsung.com",
            "name": "vg-01",
            "num_of_block_storages": 2,
            "purpose": "ORG",
            "state": "CREATING"
        }
    ]
}

3 - 1.0

get /v1/volume-groups

Description

볼륨 그룹 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	limit optional	페이지에 표시될 번호 Example : `20`	integer	20
query	offset optional	Offset Example : `0`	integer	0
query	sort optional	정렬 Example : `column1:asc,column2:desc`	string	None
query	name optional	볼륨 그룹명 Example : `vg-01`	string	None

Responses

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

Example HTTP request

Request path

/v1/volume-groups

Request header

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

Example HTTP response

Response 200

{
    "total_count": 1,
    "volume_groups": [
        {
            "account_id": "36827d9b643f46c2ae6bb7e63d633bfe",
            "created_at": "2024-08-01T07:06:23.315Z",
            "created_by": "samsung-cloud-platform1@samsung.com",
            "id": "c9ecae8b973b425c81c3817893cd8063",
            "modified_at": "2024-08-01T07:06:25.315Z",
            "modified_by": "samsung-cloud-platform2@samsung.com",
            "name": "vg-01",
            "num_of_block_storages": 2,
            "purpose": "ORG",
            "state": "CREATING"
        }
    ]
}