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

이 페이지의 일반 화면으로 돌아가기.

File Storage

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface,API)를 제공합니다.

본 가이드는 File Storage 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

VersionStatusNot Before
1.2CURRENT-
1.1SUPPORTED20261130

OpenAPI URL

https://filestorage.{region}.{environment}.samsungsdscloud.com

Environment and Region List

environmentregion
skr-west1
skr-east1
gkr-south1
gkr-south2
gkr-south3
ekr-west1
ekr-east1

API Version History

1.2

File Storage가 1.2 버전으로 업데이트되었습니다.

변경사항

  • [신규] GET /replications/zones - List Volume Replication Zones API가 추가 되었습니다.
  • [변경] POST /volumes - 요청 시, 아래와 같은 필드가 추가되고 변경 됩니다.
    • 추가 zone - 필수 필드로 추가. 볼륨의 존.
    • 변경 type_name
      • 1.1 버전
        • ^(HDD|SSD|HighPerformanceSSD|SSD_SAP_E|SSD_SAP_S)$
      • 1.2 버전
        • 패턴 제거 (사전 정의된 값으로 제한되지 않음).
  • [변경] POST /volumes - 응답 시, 아래와 같은 필드가 추가 됩니다.
    • 추가 zone - 필수 필드. 생성된 볼륨의 존.
  • [변경] GET /volumes - 응답 시, 볼륨 객체의 필드가 변경 됩니다.
    • 추가 zone - 필수 필드. 볼륨의 존.
    • 추가 az_type - 필수 필드. 존 유형.
    • 제거 type_id - 타입 ID 필드가 제거 되었습니다.
  • [변경] GET /volumes/{volume_id} - 응답 시, 필드가 추가되고 제거 됩니다.
    • 추가 zone - 필수 필드. 볼륨의 존.
    • 추가 az_type - 필수 필드. 존 유형.
    • 제거 type_id - 유형 ID 필드가 제거 되었습니다.
  • [변경] POST /replications - 요청 시, 필드가 추가되고 제거 됩니다.
    • 추가 zone - 필수 필드로 추가. 복제 대상 존. 기존 region 필드를 대체합니다.
    • 제거 region - 리전은 필드가 제거 되었습니다. 대신 zone을 사용하십시오.
  • [변경] POST /replications - 응답 시, 아래와 같은 필드가 추가 됩니다.
    • 추가 replication_volume_zone - 필수 필드. 복제 볼륨의 존.
    • 추가 source_volume_zone - 필수 필드. 소스 볼륨의 존.
  • [변경] GET /replications - 응답 시, 복제 객체의 필드가 변경 됩니다.
    • 추가 replication_volume_zone - 필수 필드. 복제 볼륨의 존.
    • 추가 source_volume_zone - 필수 필드. 소스 볼륨의 존.
  • [변경] GET /replications/{replication_id} - 응답 시, 아래와 같은 필드가 추가 됩니다.
    • 추가 replication_volume_zone - 필수 필드. 복제 볼륨의 존.
    • 추가 source_volume_zone - 필수 필드. 소스 볼륨의 존.
  • [제거] GET /replications/regions - List Volume Replication Regions API가 제거 됩니다. GET /replications/zones 로 변경하여 사용해주시길 바랍니다.

1.1

File Storage가 1.1 버전으로 업데이트되었습니다.

변경사항

  • [변경] POST /volumes - 요청 시, 아래와 같은 필드가 변경 됩니다.
    • 변경 type_name
      • 1.0 버전
        • ^(HDD|SSD|HighPerformanceSSD)$
      • 1.1 버전
        • ^(HDD|SSD|HighPerformanceSSD|SSD_SAP_E|SSD_SAP_S)$
  • [변경] GET /volumes - 요청 시, 아래와 같은 필드가 변경 됩니다.
    • 변경 type_name
      • 기존 HDD, SSD, HighPerformanceSSD 외에 SSD_SAP_E, SSD_SAP_S 필터값이 추가로 허용 됩니다.

1.0

File Storage가 출시되었습니다.

변경사항

  • [신규] GET /replications - List Volume Replications API가 추가되었습니다.
  • [신규] POST /replications - Create Volume Replication API가 추가되었습니다.
  • [신규] GET /replications/regions - List Volume Replication Regions API가 추가되었습니다.
  • [신규] GET /replications/{replication_id} - Show Volume Replication API가 추가되었습니다.
  • [신규] PUT /replications/{replication_id} - Set Volume Replication API가 추가되었습니다.
  • [신규] DELETE /replications/{replication_id} - Delete Volume Replication API가 추가되었습니다.
  • [신규] GET /snapshot-schedules - List Snapshot Schedules API가 추가되었습니다.
  • [신규] POST /snapshot-schedules - Create Snapshot Schedule API가 추가되었습니다.
  • [신규] PUT /snapshot-schedules/{snapshot_schedule_id} - Set Snapshot Schedule API가 추가되었습니다.
  • [신규] DELETE /snapshot-schedules/{snapshot_schedule_id} - Delete Snapshot Schedule API가 추가되었습니다.
  • [신규] GET /snapshots - List Snapshots API가 추가되었습니다.
  • [신규] POST /snapshots - Create Snapshot API가 추가되었습니다.
  • [신규] DELETE /snapshots/{snapshot_id} - Delete Snapshot API가 추가되었습니다.
  • [신규] PUT /snapshots/{snapshot_id}/restore - Restore Snapshot API가 추가되었습니다.
  • [신규] GET /volumes - List Volumes API가 추가되었습니다.
  • [신규] POST /volumes - Create Volume API가 추가되었습니다.
  • [신규] GET /volumes/{volume_id} - Show Volume API가 추가되었습니다.
  • [신규] PUT /volumes/{volume_id} - Set Volume API가 추가되었습니다.
  • [신규] DELETE /volumes/{volume_id} - Delete Volume API가 추가되었습니다.
  • [신규] GET /volumes/{volume_id}/access-rules - List Access Rules API가 추가되었습니다.
  • [신규] PUT /volumes/{volume_id}/access-rules - Set Access Rule API가 추가되었습니다.

1 - APIs

1.1 - CreateSnapshot

1.1.1 - 1.2

post /v1/snapshots

Description

파일스토리지 스냅샷을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
SnapshotCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedSnapshotShowResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/snapshots

Request header

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

Request body

{
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438"
}

Example HTTP response

Response 202

{
    "snapshot": {
        "id": "40htrre5b-eww25-ff2b-a426-6afefas65a3b",
        "name": "my_volume.2024-10-01_14215",
        "state": "available",
        "size": "",
        "created_at": "2024-07-30T04:54:33.219373",
        "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438"
    }
}

1.1.2 - 1.1

post /v1/snapshots

Description

파일스토리지 스냅샷을 생성한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
SnapshotCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedSnapshotShowResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/snapshots

Request header

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

Request body

{
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438"
}

Example HTTP response

Response 202

{
    "snapshot": {
        "id": "40htrre5b-eww25-ff2b-a426-6afefas65a3b",
        "name": "my_volume.2024-10-01_14215",
        "state": "available",
        "size": "",
        "created_at": "2024-07-30T04:54:33.219373",
        "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438"
    }
}

1.2 - CreateSnapshotSchedule

1.2.1 - 1.2

post /v1/snapshot-schedules

Description

파일스토리지 스냅샷 스케줄을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
SnapshotScheduleCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedSnapshotScheduleCreateResponse
400Bad RequestNone
403ForbiddenNone
401UnauthorizedNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/snapshot-schedules

Request header

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

Request body

{
    "snapshot_retention_count": 10,
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "snapshot_schedule": {
        "frequency": "WEEKLY",
        "day_of_week": "MON",
        "hour": "23"
    }
}

Example HTTP response

Response 202

{
    "snapshot_retention_count": 10,
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "snapshot_schedule": {
        "frequency": "WEEKLY",
        "day_of_week": "MON",
        "hour": "23"
    }
}

1.2.2 - 1.1

post /v1/snapshot-schedules

Description

파일스토리지 스냅샷 스케줄을 생성한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
SnapshotScheduleCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedSnapshotScheduleCreateResponse
400Bad RequestNone
403ForbiddenNone
401UnauthorizedNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/snapshot-schedules

Request header

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

Request body

{
    "snapshot_retention_count": 10,
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "snapshot_schedule": {
        "frequency": "WEEKLY",
        "day_of_week": "MON",
        "hour": "23"
    }
}

Example HTTP response

Response 202

{
    "snapshot_retention_count": 10,
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "snapshot_schedule": {
        "frequency": "WEEKLY",
        "day_of_week": "MON",
        "hour": "23"
    }
}

1.3 - CreateVolume

1.3.1 - 1.2

post /v1/volumes

Description

파일스토리지를 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
VolumeCreateRequestV1Dot2

Responses

HTTP CodeDescriptionSchema
202AcceptedVolumeCreateResponseV1Dot2
403ForbiddenNone
401UnauthorizedNone
400Bad RequestNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/volumes

Request header

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

Request body

{
    "name": "my_volume",
    "protocol": "NFS",
    "type_name": "HDD",
    "snapshot_id": "40htrre5b-eww25-ff2b-a426-6afefas65a3b",
    "cifs_password": "cifspwd0!!",
    "tags": [
        {
            "key": "key",
            "value": "value"
        }
    ],
    "zone": "kr-west1-a"
}

Example HTTP response

Response 202

{
    "protocol": "NFS",
    "snapshot_id": "40htrre5b-eww25-ff2b-a426-6afefas65a3b",
    "type_name": "HDD",
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "volume_name": "my_volume",
    "zone": "kr-west1-a"
}

1.3.2 - 1.1

post /v1/volumes

Description

파일스토리지를 생성한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
VolumeCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedVolumeCreateResponse
403ForbiddenNone
401UnauthorizedNone
400Bad RequestNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/volumes

Request header

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

Request body

{
    "name": "my_volume",
    "protocol": "NFS",
    "type_name": "HDD",
    "snapshot_id": "40htrre5b-eww25-ff2b-a426-6afefas65a3b",
    "cifs_password": "cifspwd0!!",
    "tags": [
        {
            "key": "key",
            "value": "value"
        }
    ]
}

Example HTTP response

Response 202

{
    "protocol": "NFS",
    "snapshot_id": "40htrre5b-eww25-ff2b-a426-6afefas65a3b",
    "type_name": "HDD",
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "volume_name": "my_volume"
}

1.4 - CreateVolumeReplication

1.4.1 - 1.2

post /v1/replications

Description

파일스토리지 복제를 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
ReplicationCreateRequestV1Dot2

Responses

HTTP CodeDescriptionSchema
202AcceptedReplicationCreateResponseV1Dot2
401UnauthorizedNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/replications

Request header

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

Request body

{
    "name": "my_volume",
    "cifs_password": "cifspwd0!!",
    "replication_frequency": "5min",
    "zone": "kr-west1-a",
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "backup_retention_count": 2,
    "replication_type": "replication"
}

Example HTTP response

Response 202

{
    "replication_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "replication_status": "creating",
    "source_volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "source_volume_region": "kr-west1",
    "source_volume_zone": "kr-west1-a",
    "protocol": "NFS",
    "replication_volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "replication_volume_region": "kr-west1",
    "replication_volume_zone": "kr-west1-a"
}

1.4.2 - 1.1

post /v1/replications

Description

파일스토리지 복제를 생성한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
ReplicationCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedReplicationCreateResponse
401UnauthorizedNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/replications

Request header

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

Request body

{
    "name": "my_volume",
    "cifs_password": "cifspwd0!!",
    "replication_frequency": "5min",
    "region": "kr-west1",
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "backup_retention_count": 2,
    "replication_type": "replication"
}

Example HTTP response

Response 202

{
    "replication_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "replication_status": "creating",
    "source_volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "source_volume_region": "kr-west1",
    "protocol": "NFS",
    "replication_volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "replication_volume_region": "kr-west1"
}

1.5 - DeleteSnapshot

1.5.1 - 1.2

delete /v1/snapshots/{snapshot_id}

Description

파일스토리지 스냅샷을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

TypeNameDescriptionSchemaDefault
pathsnapshot_id
required		스냅샷 아이디
Example : 40htrre5b-eww25-ff2b-a426-6afefas65a3b
stringNone
queryvolume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
400Bad RequestNone
404Not FoundNone
403ForbiddenNone
401UnauthorizedNone
409ConflictNone

Example HTTP request

Request path

/v1/snapshots/{snapshot_id}?volume_id={volume_id}

Request header

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

Example HTTP response

Response 202

1.5.2 - 1.1

delete /v1/snapshots/{snapshot_id}

Description

파일스토리지 스냅샷을 삭제한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathsnapshot_id
required		스냅샷 아이디
Example : 40htrre5b-eww25-ff2b-a426-6afefas65a3b
stringNone
queryvolume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
400Bad RequestNone
404Not FoundNone
403ForbiddenNone
401UnauthorizedNone
409ConflictNone

Example HTTP request

Request path

/v1/snapshots/{snapshot_id}?volume_id={volume_id}

Request header

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

Example HTTP response

Response 202

1.6 - DeleteSnapshotSchedule

1.6.1 - 1.2

delete /v1/snapshot-schedules/{snapshot_schedule_id}

Description

파일스토리지 스냅샷 스케줄을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

TypeNameDescriptionSchemaDefault
pathsnapshot_schedule_id
required		스냅샷 스케줄 아이디
Example : d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31
stringNone
queryvolume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
400Bad RequestNone
404Not FoundNone
403ForbiddenNone
401UnauthorizedNone
409ConflictNone

Example HTTP request

Request path

/v1/snapshot-schedules/{snapshot_schedule_id}?volume_id={volume_id}

Request header

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

Example HTTP response

Response 202

1.6.2 - 1.1

delete /v1/snapshot-schedules/{snapshot_schedule_id}

Description

파일스토리지 스냅샷 스케줄을 삭제한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathsnapshot_schedule_id
required		스냅샷 스케줄 아이디
Example : d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31
stringNone
queryvolume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
400Bad RequestNone
404Not FoundNone
403ForbiddenNone
401UnauthorizedNone
409ConflictNone

Example HTTP request

Request path

/v1/snapshot-schedules/{snapshot_schedule_id}?volume_id={volume_id}

Request header

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

Example HTTP response

Response 202

1.7 - DeleteVolume

1.7.1 - 1.2

delete /v1/volumes/{volume_id}

Description

파일스토리지를 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

TypeNameDescriptionSchemaDefault
pathvolume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
404Not FoundNone
403ForbiddenNone
401UnauthorizedNone
409ConflictNone

Example HTTP request

Request path

/v1/volumes/{volume_id}

Request header

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

Example HTTP response

Response 202

1.7.2 - 1.1

delete /v1/volumes/{volume_id}

Description

파일스토리지를 삭제한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathvolume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
404Not FoundNone
403ForbiddenNone
401UnauthorizedNone
409ConflictNone

Example HTTP request

Request path

/v1/volumes/{volume_id}

Request header

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

Example HTTP response

Response 202

1.8 - DeleteVolumeReplication

1.8.1 - 1.2

delete /v1/replications/{replication_id}

Description

파일스토리지 복제를 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

TypeNameDescriptionSchemaDefault
pathreplication_id
required		복제 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone
queryvolume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
401UnauthorizedNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/replications/{replication_id}?volume_id={volume_id}

Request header

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

Example HTTP response

Response 202

1.8.2 - 1.1

delete /v1/replications/{replication_id}

Description

파일스토리지 복제를 삭제한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathreplication_id
required		복제 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone
queryvolume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
401UnauthorizedNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/replications/{replication_id}?volume_id={volume_id}

Request header

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

Example HTTP response

Response 202

1.9 - ListAccessRules

1.9.1 - 1.2

get /v1/volumes/{volume_id}/access-rules

Description

접근제어 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

TypeNameDescriptionSchemaDefault
pathvolume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
200OKVolumeObjectAccessRuleListResponse
403ForbiddenNone
401UnauthorizedNone
404Not FoundNone

Example HTTP request

Request path

/v1/volumes/{volume_id}/access-rules

Request header

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

Example HTTP response

Response 200

{
    "count": 1,
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "access_rules": [
        {
            "access_rule_state": "active",
            "object_type": "VM",
            "object_id": "43fq3347-02q4-4aa8-ccf9-affe4917bb6f"
        }
    ]
}

1.9.2 - 1.1

get /v1/volumes/{volume_id}/access-rules

Description

접근제어 목록을 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathvolume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
200OKVolumeObjectAccessRuleListResponse
403ForbiddenNone
401UnauthorizedNone
404Not FoundNone

Example HTTP request

Request path

/v1/volumes/{volume_id}/access-rules

Request header

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

Example HTTP response

Response 200

{
    "count": 1,
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "access_rules": [
        {
            "access_rule_state": "active",
            "object_type": "VM",
            "object_id": "43fq3347-02q4-4aa8-ccf9-affe4917bb6f"
        }
    ]
}

1.10 - ListSnapshots

1.10.1 - 1.2

get /v1/snapshots

Description

파일스토리지 스냅샷 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

TypeNameDescriptionSchemaDefault
queryvolume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
200OKSnapshotListResponse
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/snapshots?volume_id={volume_id}

Request header

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

Example HTTP response

Response 200

{
    "count": 1,
    "snapshots": [
        {
            "id": "40htrre5b-eww25-ff2b-a426-6afefas65a3b",
            "name": "my_volume.2024-10-01_14215",
            "state": "available",
            "size": "",
            "created_at": "2024-07-30T04:54:33.219373"
        }
    ],
    "snapshot_size_total_byte": ""
}

1.10.2 - 1.1

get /v1/snapshots

Description

파일스토리지 스냅샷 목록을 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
queryvolume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
200OKSnapshotListResponse
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/snapshots?volume_id={volume_id}

Request header

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

Example HTTP response

Response 200

{
    "count": 1,
    "snapshots": [
        {
            "id": "40htrre5b-eww25-ff2b-a426-6afefas65a3b",
            "name": "my_volume.2024-10-01_14215",
            "state": "available",
            "size": "",
            "created_at": "2024-07-30T04:54:33.219373"
        }
    ],
    "snapshot_size_total_byte": ""
}

1.11 - ListSnapshotSchedule

1.11.1 - 1.2

get /v1/snapshot-schedules

Description

파일스토리지 스냅샷 스케줄 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

TypeNameDescriptionSchemaDefault
queryvolume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
200OKSnapshotScheduleListResponse
404Not FoundNone
403ForbiddenNone
401UnauthorizedNone

Example HTTP request

Request path

/v1/snapshot-schedules?volume_id={volume_id}

Request header

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

Example HTTP response

Response 200

{
    "snapshot_retention_count": 10,
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "snapshot_policy_enabled": "true",
    "snapshot_schedule": [
        {
            "frequency": "WEEKLY",
            "day_of_week": "MON",
            "hour": "23",
            "id": "d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31"
        }
    ]
}

1.11.2 - 1.1

get /v1/snapshot-schedules

Description

파일스토리지 스냅샷 스케줄 목록을 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
queryvolume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
200OKSnapshotScheduleListResponse
404Not FoundNone
403ForbiddenNone
401UnauthorizedNone

Example HTTP request

Request path

/v1/snapshot-schedules?volume_id={volume_id}

Request header

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

Example HTTP response

Response 200

{
    "snapshot_retention_count": 10,
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "snapshot_policy_enabled": "true",
    "snapshot_schedule": [
        {
            "frequency": "WEEKLY",
            "day_of_week": "MON",
            "hour": "23",
            "id": "d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31"
        }
    ]
}

1.12 - ListVolumeReplicationRegion

1.12.1 - 1.1

get /v1/replications/regions

Description

파일스토리지 복제 리전 목록을 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
querytype_name
required		볼륨 유형 이름
Example : HDD
stringNone
querysource_region_name
required		리전
Example : kr-west1
stringNone
queryreplication_type
required		복제 유형
Example : replication
stringNone

Responses

HTTP CodeDescriptionSchema
200OKReplicationRegionListResponse
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/replications/regions?type_name={type_name}&source_region_name={source_region_name}&replication_type={replication_type}

Request header

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

Example HTTP response

Response 200

{
    "regions": "['kr-west1']"
}

1.13 - ListVolumeReplications

1.13.1 - 1.2

get /v1/replications

Description

파일스토리지 복제 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

TypeNameDescriptionSchemaDefault
queryvolume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
200OKReplicationListResponseV1Dot2
401UnauthorizedNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/replications?volume_id={volume_id}

Request header

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

Example HTTP response

Response 200

{
    "count": 1,
    "replications": [
        {
            "replication_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
            "replication_frequency": "5min",
            "source_volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
            "source_volume_region": "kr-west1",
            "source_volume_zone": "kr-west1-a",
            "source_volume_access_level": "ro",
            "replication_volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
            "replication_volume_region": "kr-west1",
            "replication_volume_zone": "kr-west1-a",
            "replication_volume_access_level": "ro",
            "replication_type": "replication"
        }
    ]
}

1.13.2 - 1.1

get /v1/replications

Description

파일스토리지 복제 목록을 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
queryvolume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
200OKReplicationListResponse
401UnauthorizedNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/replications?volume_id={volume_id}

Request header

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

Example HTTP response

Response 200

{
    "count": 1,
    "replications": [
        {
            "replication_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
            "replication_frequency": "5min",
            "source_volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
            "source_volume_region": "kr-west1",
            "source_volume_access_level": "ro",
            "replication_volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
            "replication_volume_region": "kr-west1",
            "replication_volume_access_level": "ro",
            "replication_type": "replication"
        }
    ]
}

1.14 - ListVolumeReplicationZones

1.14.1 - 1.2

get /v1/replications/zones

Description

파일스토리지 복제 존 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

TypeNameDescriptionSchemaDefault
querytype_name
required		볼륨 유형 이름
Example : HDD
stringNone
querysource_zone
required		존
Example : kr-west1-a
stringNone
queryreplication_type
required		복제 유형
Example : replication
stringNone

Responses

HTTP CodeDescriptionSchema
200OKReplicationZonesListResponse
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/replications/zones?type_name={type_name}&source_zone={source_zone}&replication_type={replication_type}

Request header

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

Example HTTP response

Response 200

{
    "zones": "['kr-west1']"
}

1.15 - ListVolumes

1.15.1 - 1.2

get /v1/volumes

Description

파일스토리지 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

TypeNameDescriptionSchemaDefault
queryoffset
optional		offset
Example : 0
integer0
querylimit
optional		limit
Example : 20
integer20
queryname
optional		볼륨 이름
Example : my_volume
any of [string, null]None
querytype_name
optional		볼륨 유형 이름
Example : HDD
any of [string, null]None
querysort
optional		정렬
Example :
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKVolumeListResponseV1Dot2
400Bad RequestNone
403ForbiddenNone
401UnauthorizedNone

Example HTTP request

Request path

/v1/volumes

Request header

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

Example HTTP response

Response 200

{
    "count": 1,
    "filestorages": [
        {
            "id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
            "name": "my_volume",
            "protocol": "NFS",
            "state": "available",
            "account_id": "rwww523320dfvwbbefefsdvwdadsfa24c",
            "created_at": "2024-07-30T04:54:33.219373",
            "type_id": "jef22f67-ee83-4gg2-2ab6-3lf774ekfjdu",
            "type_name": "HDD",
            "purpose": "replication",
            "zone": "kr-west1-a",
            "az_type": "single"
        }
    ]
}

1.15.2 - 1.1

get /v1/volumes

Description

파일스토리지 목록을 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
queryoffset
optional		offset
Example : 0
integer0
querylimit
optional		limit
Example : 20
integer20
queryname
optional		볼륨 이름
Example : my_volume
any of [string, null]None
querytype_name
optional		볼륨 유형 이름
Example : HDD
any of [string, null]None
querysort
optional		정렬
Example :
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKVolumeListResponse
400Bad RequestNone
403ForbiddenNone
401UnauthorizedNone

Example HTTP request

Request path

/v1/volumes

Request header

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

Example HTTP response

Response 200

{
    "count": 1,
    "filestorages": [
        {
            "id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
            "name": "my_volume",
            "protocol": "NFS",
            "state": "available",
            "account_id": "rwww523320dfvwbbefefsdvwdadsfa24c",
            "created_at": "2024-07-30T04:54:33.219373",
            "type_id": "jef22f67-ee83-4gg2-2ab6-3lf774ekfjdu",
            "type_name": "HDD",
            "purpose": "replication"
        }
    ]
}

1.16 - RestoreSnapshot

1.16.1 - 1.2

put /v1/snapshots/{snapshot_id}/restore

Description

파일스토리지 스냅샷을 복구한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

TypeNameDescriptionSchemaDefault
pathsnapshot_id
required		스냅샷 아이디
Example : 40htrre5b-eww25-ff2b-a426-6afefas65a3b
stringNone
queryvolume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedSnapshotRestoreResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/snapshots/{snapshot_id}/restore?volume_id={volume_id}

Request header

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

Example HTTP response

Response 202

{
    "snapshot": {
        "id": "40htrre5b-eww25-ff2b-a426-6afefas65a3b",
        "name": "my_volume.2024-10-01_14215",
        "state": "available",
        "size": "",
        "created_at": "2024-07-30T04:54:33.219373"
    }
}

1.16.2 - 1.1

put /v1/snapshots/{snapshot_id}/restore

Description

파일스토리지 스냅샷을 복구한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathsnapshot_id
required		스냅샷 아이디
Example : 40htrre5b-eww25-ff2b-a426-6afefas65a3b
stringNone
queryvolume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedSnapshotRestoreResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/snapshots/{snapshot_id}/restore?volume_id={volume_id}

Request header

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

Example HTTP response

Response 202

{
    "snapshot": {
        "id": "40htrre5b-eww25-ff2b-a426-6afefas65a3b",
        "name": "my_volume.2024-10-01_14215",
        "state": "available",
        "size": "",
        "created_at": "2024-07-30T04:54:33.219373"
    }
}

1.17 - SetAccessRule

1.17.1 - 1.2

put /v1/volumes/{volume_id}/access-rules

Description

파일스토리지 접근제어를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

TypeNameDescriptionSchemaDefault
pathvolume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone
bodybody
required
AccessRuleRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedAccessRuleResponse
400Bad RequestNone
403ForbiddenNone
401UnauthorizedNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/volumes/{volume_id}/access-rules

Request header

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

Request body

{
    "object_id": "43fq3347-02q4-4aa8-ccf9-affe4917bb6f",
    "object_type": "VM",
    "action": "add"
}

Example HTTP response

Response 202

{
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "object_type": "VM",
    "object_id": "43fq3347-02q4-4aa8-ccf9-affe4917bb6f",
    "action": "add"
}

1.17.2 - 1.1

put /v1/volumes/{volume_id}/access-rules

Description

파일스토리지 접근제어를 수정한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathvolume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone
bodybody
required
AccessRuleRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedAccessRuleResponse
400Bad RequestNone
403ForbiddenNone
401UnauthorizedNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/volumes/{volume_id}/access-rules

Request header

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

Request body

{
    "object_id": "43fq3347-02q4-4aa8-ccf9-affe4917bb6f",
    "object_type": "VM",
    "action": "add"
}

Example HTTP response

Response 202

{
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "object_type": "VM",
    "object_id": "43fq3347-02q4-4aa8-ccf9-affe4917bb6f",
    "action": "add"
}

1.18 - SetSnapshotSchedule

1.18.1 - 1.2

put /v1/snapshot-schedules/{snapshot_schedule_id}

Description

파일스토리지 스냅샷 스케줄을 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

TypeNameDescriptionSchemaDefault
pathsnapshot_schedule_id
required		스냅샷 스케줄 아이디
Example : d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31
stringNone
queryvolume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone
bodybody
required
SnapshotScheduleSetRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedSnapshotScheduleSetResponse
400Bad RequestNone
404Not FoundNone
403ForbiddenNone
401UnauthorizedNone
409ConflictNone

Example HTTP request

Request path

/v1/snapshot-schedules/{snapshot_schedule_id}?volume_id={volume_id}

Request header

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

Request body

{
    "snapshot_retention_count": 10,
    "snapshot_schedule": {
        "frequency": "WEEKLY",
        "day_of_week": "MON",
        "hour": "23"
    }
}

Example HTTP response

Response 202

{
    "snapshot_retention_count": 10,
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "snapshot_schedule": {
        "frequency": "WEEKLY",
        "day_of_week": "MON",
        "hour": "23"
    }
}

1.18.2 - 1.1

put /v1/snapshot-schedules/{snapshot_schedule_id}

Description

파일스토리지 스냅샷 스케줄을 수정한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathsnapshot_schedule_id
required		스냅샷 스케줄 아이디
Example : d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31
stringNone
queryvolume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone
bodybody
required
SnapshotScheduleSetRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedSnapshotScheduleSetResponse
400Bad RequestNone
404Not FoundNone
403ForbiddenNone
401UnauthorizedNone
409ConflictNone

Example HTTP request

Request path

/v1/snapshot-schedules/{snapshot_schedule_id}?volume_id={volume_id}

Request header

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

Request body

{
    "snapshot_retention_count": 10,
    "snapshot_schedule": {
        "frequency": "WEEKLY",
        "day_of_week": "MON",
        "hour": "23"
    }
}

Example HTTP response

Response 202

{
    "snapshot_retention_count": 10,
    "volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "snapshot_schedule": {
        "frequency": "WEEKLY",
        "day_of_week": "MON",
        "hour": "23"
    }
}

1.19 - SetVolume

1.19.1 - 1.2

put /v1/volumes/{volume_id}

Description

파일스토리지를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

TypeNameDescriptionSchemaDefault
pathvolume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone
bodybody
required
VolumeSetRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedVolumeSetResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/volumes/{volume_id}

Request header

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

Request body

{
    "file_unit_recovery_enabled": true
}

Example HTTP response

Response 202

{
    "file_unit_recovery_enabled": true
}

1.19.2 - 1.1

put /v1/volumes/{volume_id}

Description

파일스토리지를 수정한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathvolume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone
bodybody
required
VolumeSetRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedVolumeSetResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/volumes/{volume_id}

Request header

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

Request body

{
    "file_unit_recovery_enabled": true
}

Example HTTP response

Response 202

{
    "file_unit_recovery_enabled": true
}

1.20 - SetVolumeReplication

1.20.1 - 1.2

put /v1/replications/{replication_id}

Description

파일스토리지 복제를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

TypeNameDescriptionSchemaDefault
pathreplication_id
required		복제 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone
queryvolume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone
bodybody
required
ReplicationUpdateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedReplicationUpdateResponse
401UnauthorizedNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/replications/{replication_id}?volume_id={volume_id}

Request header

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

Request body

{
    "replication_policy": "use",
    "replication_frequency": "5min",
    "backup_retention_count": 2,
    "replication_update_type": "policy"
}

Example HTTP response

Response 202

{
    "replication_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "replication_frequency": "5min",
    "source_volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "source_volume_region": "kr-west1",
    "source_volume_access_level": "ro",
    "replication_volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "replication_volume_region": "kr-west1",
    "replication_volume_access_level": "ro",
    "replication_type": "replication",
    "backup_retention_count": 2
}

1.20.2 - 1.1

put /v1/replications/{replication_id}

Description

파일스토리지 복제를 수정한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathreplication_id
required		복제 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone
queryvolume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone
bodybody
required
ReplicationUpdateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedReplicationUpdateResponse
401UnauthorizedNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/replications/{replication_id}?volume_id={volume_id}

Request header

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

Request body

{
    "replication_policy": "use",
    "replication_frequency": "5min",
    "backup_retention_count": 2,
    "replication_update_type": "policy"
}

Example HTTP response

Response 202

{
    "replication_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "replication_frequency": "5min",
    "source_volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "source_volume_region": "kr-west1",
    "source_volume_access_level": "ro",
    "replication_volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "replication_volume_region": "kr-west1",
    "replication_volume_access_level": "ro",
    "replication_type": "replication",
    "backup_retention_count": 2
}

1.21 - ShowVolume

1.21.1 - 1.2

get /v1/volumes/{volume_id}

Description

파일스토리지를 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

TypeNameDescriptionSchemaDefault
pathvolume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
200OKVolumeShowResponseV1Dot2
403ForbiddenNone
401UnauthorizedNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/volumes/{volume_id}

Request header

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

Example HTTP response

Response 200

{
    "id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "name": "my_volume",
    "protocol": "NFS",
    "state": "available",
    "account_id": "rwww523320dfvwbbefefsdvwdadsfa24c",
    "created_at": "2024-07-30T04:54:33.219373",
    "type_name": "HDD",
    "purpose": "replication",
    "path": "xxx.xx.xxx:/xxxxxxxx",
    "usage": "",
    "encryption_enabled": true,
    "file_unit_recovery_enabled": true,
    "cifs_id": "cifsid",
    "endpoint_path": "xxx.xx.xxx.xxx",
    "zone": "kr-west1-a",
    "az_type": "single"
}

1.21.2 - 1.1

get /v1/volumes/{volume_id}

Description

파일스토리지를 상세 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathvolume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
200OKVolumeShowResponse
403ForbiddenNone
401UnauthorizedNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/volumes/{volume_id}

Request header

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

Example HTTP response

Response 200

{
    "id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "name": "my_volume",
    "protocol": "NFS",
    "state": "available",
    "account_id": "rwww523320dfvwbbefefsdvwdadsfa24c",
    "created_at": "2024-07-30T04:54:33.219373",
    "type_id": "jef22f67-ee83-4gg2-2ab6-3lf774ekfjdu",
    "type_name": "HDD",
    "purpose": "replication",
    "path": "xxx.xx.xxx:/xxxxxxxx",
    "usage": "",
    "encryption_enabled": true,
    "file_unit_recovery_enabled": true,
    "cifs_id": "cifsid",
    "endpoint_path": "xxx.xx.xxx.xxx"
}

1.22 - ShowVolumeReplication

1.22.1 - 1.2

get /v1/replications/{replication_id}

Description

파일스토리지 복제를 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

TypeNameDescriptionSchemaDefault
pathreplication_id
required		복제 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone
queryvolume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
200OKReplicationShowResponseV1Dot2
401UnauthorizedNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/replications/{replication_id}?volume_id={volume_id}

Request header

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

Example HTTP response

Response 200

{
    "replication_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "replication_frequency": "5min",
    "source_volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "source_volume_region": "kr-west1",
    "source_volume_zone": "kr-west1-a",
    "source_volume_access_level": "ro",
    "replication_volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "replication_volume_region": "kr-west1",
    "replication_volume_zone": "kr-west1-a",
    "replication_volume_access_level": "ro",
    "replication_type": "replication",
    "source_volume_name": "my_volume",
    "replication_policy": "use",
    "replication_status": "creating",
    "replication_volume_name": "my_volume",
    "backup_retention_count": 2
}

1.22.2 - 1.1

get /v1/replications/{replication_id}

Description

파일스토리지 복제를 상세 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathreplication_id
required		복제 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone
queryvolume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
stringNone

Responses

HTTP CodeDescriptionSchema
200OKReplicationShowResponse
401UnauthorizedNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/replications/{replication_id}?volume_id={volume_id}

Request header

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

Example HTTP response

Response 200

{
    "replication_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "replication_frequency": "5min",
    "source_volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "source_volume_region": "kr-west1",
    "source_volume_access_level": "ro",
    "replication_volume_id": "bfdbabf2-04d9-4e8b-a205-020f8e6da438",
    "replication_volume_region": "kr-west1",
    "replication_volume_access_level": "ro",
    "replication_type": "replication",
    "source_volume_name": "my_volume",
    "replication_policy": "use",
    "replication_status": "creating",
    "replication_volume_name": "my_volume",
    "backup_retention_count": 2
}

2 - Models

2.1 - AccessRuleRequest

NameDescriptionSchemaDefault
object_id
required		오브젝트 아이디
Example : 43fq3347-02q4-4aa8-ccf9-affe4917bb6f
string
object_type
required		오브젝트 유형
Example : VM
Pattern : ^(VM|BM|GPU|GPU_NODE|ENDPOINT)$
string
action
required		접근제어 액션
Example : add
Pattern : ^(add|remove)$
string

2.2 - AccessRuleResponse

NameDescriptionSchemaDefault
volume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
object_type
required		오브젝트 유형
Example : VM
string
object_id
required		오브젝트 아이디
Example : 43fq3347-02q4-4aa8-ccf9-affe4917bb6f
string
action
required		접근제어 액션
Example : add
string

2.3 - Replication

NameDescriptionSchemaDefault
replication_id
required		복제 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
replication_frequency
required		복제 주기
Example : 5min
string
source_volume_id
required		원본 볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
source_volume_region
required		원본 리전
Example : kr-west1
string
source_volume_access_level
required		원본 접근 레벨
Example : ro
string
replication_volume_id
required		복제본 볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
replication_volume_region
required		복제본 리전
Example : kr-west1
string
replication_volume_access_level
required		복제본 접근 레벨
Example : ro
string
replication_type
required		복제 유형
Example : replication
string

2.4 - ReplicationCreateRequest

NameDescriptionSchemaDefault
name
required		복제본 볼륨 이름
Example : my_volume
Pattern : ^[a-z]([a-z0-9_]){2,20}$
string
cifs_password
optional		CIFS 비밀번호
Example : cifspwd0!!
any of [string, null]
replication_frequency
required		복제 주기
Example : 5min
Pattern : ^(5min|hourly|daily|weekly|monthly)$
string
region
required		복제본 리전
Example : kr-west1
string
volume_id
required		원본 볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
backup_retention_count
optional		백업 보관 개수
Example : 2
any of [integer, null]
replication_type
required		복제 유형
Example : replication
Pattern : ^(replication|backup)$
string

2.5 - ReplicationCreateRequestV1Dot2

NameDescriptionSchemaDefault
name
required		복제본 볼륨 이름
Example : my_volume
Pattern : ^[a-z]([a-z0-9_]){2,20}$
string
cifs_password
optional		CIFS 비밀번호
Example : cifspwd0!!
any of [string, null]
replication_frequency
required		복제 주기
Example : 5min
Pattern : ^(5min|hourly|daily|weekly|monthly)$
string
zone
required		존
Example : kr-west1-a
string
volume_id
required		원본 볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
backup_retention_count
optional		백업 보관 개수
Example : 2
any of [integer, null]
replication_type
required		복제 유형
Example : replication
Pattern : ^(replication|backup)$
string

2.6 - ReplicationCreateResponse

NameDescriptionSchemaDefault
replication_id
required		복제 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
replication_status
required		복제 상태
Example : creating
string
source_volume_id
required		원본 볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
source_volume_region
required		원본 리전
Example : kr-west1
string
protocol
required		프로토콜
Example : NFS
string
replication_volume_id
required		복제본 볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
replication_volume_region
required		복제본 리전
Example : kr-west1
string

2.7 - ReplicationCreateResponseV1Dot2

NameDescriptionSchemaDefault
replication_id
required		복제 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
replication_status
required		복제 상태
Example : creating
string
source_volume_id
required		원본 볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
source_volume_region
required		원본 리전
Example : kr-west1
string
source_volume_zone
required		원본 존
Example : kr-west1-a
string
protocol
required		프로토콜
Example : NFS
string
replication_volume_id
required		복제본 볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
replication_volume_region
required		복제본 리전
Example : kr-west1
string
replication_volume_zone
required		복제본 존
Example : kr-west1-a
string

2.8 - ReplicationListResponse

NameDescriptionSchemaDefault
count
required		count
Example : 1
integer
replications
required
array[Replication]

2.9 - ReplicationListResponseV1Dot2

NameDescriptionSchemaDefault
count
required		count
Example : 1
integer
replications
required
array[ReplicationV1Dot2]

2.10 - ReplicationRegionListResponse

NameDescriptionSchemaDefault
regions
required		복제 리전 목록
Example : ['kr-west1']
array[string]

2.11 - ReplicationShowResponse

NameDescriptionSchemaDefault
replication_id
required		복제 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
replication_frequency
required		복제 주기
Example : 5min
string
source_volume_id
required		원본 볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
source_volume_region
required		원본 리전
Example : kr-west1
string
source_volume_access_level
required		원본 접근 레벨
Example : ro
string
replication_volume_id
required		복제본 볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
replication_volume_region
required		복제본 리전
Example : kr-west1
string
replication_volume_access_level
required		복제본 접근 레벨
Example : ro
string
replication_type
required		복제 유형
Example : replication
string
source_volume_name
required		원본 볼륨 이름
Example : my_volume
string
replication_policy
required		복제 정책
Example : use
string
replication_status
required		복제 상태
Example : creating
string
replication_volume_name
required		복제본 볼륨 이름
Example : my_volume
string
backup_retention_count
optional		백업 보관 개수
Example : 2
any of [integer, null]

2.12 - ReplicationShowResponseV1Dot2

NameDescriptionSchemaDefault
replication_id
required		복제 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
replication_frequency
required		복제 주기
Example : 5min
string
source_volume_id
required		원본 볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
source_volume_region
required		원본 리전
Example : kr-west1
string
source_volume_zone
required		원본 존
Example : kr-west1-a
string
source_volume_access_level
required		원본 접근 레벨
Example : ro
string
replication_volume_id
required		복제본 볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
replication_volume_region
required		복제본 리전
Example : kr-west1
string
replication_volume_zone
required		복제본 존
Example : kr-west1-a
string
replication_volume_access_level
required		복제본 접근 레벨
Example : ro
string
replication_type
required		복제 유형
Example : replication
string
source_volume_name
required		원본 볼륨 이름
Example : my_volume
string
replication_policy
required		복제 정책
Example : use
string
replication_status
required		복제 상태
Example : creating
string
replication_volume_name
required		복제본 볼륨 이름
Example : my_volume
string
backup_retention_count
optional		백업 보관 개수
Example : 2
any of [integer, null]

2.13 - ReplicationUpdateRequest

NameDescriptionSchemaDefault
replication_policy
optional		복제 정책
Example : use
any of [enum (use, paused), null]
replication_frequency
optional		복제 주기
Example : 5min
any of [enum (5min, hourly, daily, weekly, monthly), null]
backup_retention_count
optional		백업 보관 개수
Example : 2
any of [integer, null]
replication_update_type
required		복제 수정 유형
Example : policy
Pattern : ^(policy|modify_schedule)$
string

2.14 - ReplicationUpdateResponse

NameDescriptionSchemaDefault
replication_id
required		복제 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
replication_frequency
required		복제 주기
Example : 5min
string
source_volume_id
required		원본 볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
source_volume_region
required		원본 리전
Example : kr-west1
string
source_volume_access_level
required		원본 접근 레벨
Example : ro
string
replication_volume_id
required		복제본 볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
replication_volume_region
required		복제본 리전
Example : kr-west1
string
replication_volume_access_level
required		복제본 접근 레벨
Example : ro
string
replication_type
required		복제 유형
Example : replication
string
backup_retention_count
optional		백업 보관 개수
Example : 2
any of [integer, null]

2.15 - ReplicationV1Dot2

NameDescriptionSchemaDefault
replication_id
required		복제 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
replication_frequency
required		복제 주기
Example : 5min
string
source_volume_id
required		원본 볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
source_volume_region
required		원본 리전
Example : kr-west1
string
source_volume_zone
required		원본 존
Example : kr-west1-a
string
source_volume_access_level
required		원본 접근 레벨
Example : ro
string
replication_volume_id
required		복제본 볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
replication_volume_region
required		복제본 리전
Example : kr-west1
string
replication_volume_zone
required		복제본 존
Example : kr-west1-a
string
replication_volume_access_level
required		복제본 접근 레벨
Example : ro
string
replication_type
required		복제 유형
Example : replication
string

2.16 - ReplicationZonesListResponse

NameDescriptionSchemaDefault
zones
required		복제 리전 목록
Example : ['kr-west1']
array[string]

2.17 - Snapshot

NameDescriptionSchemaDefault
id
required		스냅샷 아이디
Example : 40htrre5b-eww25-ff2b-a426-6afefas65a3b
string
name
required		스냅샷 이름
Example : my_volume.2024-10-01_14215
string
state
required		스냅샷 상태
Example : available
string
size
optional
Example :
any of [integer, null]
created_at
required		생성 시간
Example : 2024-07-30T04:54:33.219373
string (date-time)

2.18 - SnapshotCreateRequest

NameDescriptionSchemaDefault
volume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string

2.19 - SnapshotDetail

NameDescriptionSchemaDefault
id
required		스냅샷 아이디
Example : 40htrre5b-eww25-ff2b-a426-6afefas65a3b
string
name
required		스냅샷 이름
Example : my_volume.2024-10-01_14215
string
state
required		스냅샷 상태
Example : available
string
size
optional
Example :
any of [integer, null]
created_at
required		생성 시간
Example : 2024-07-30T04:54:33.219373
string (date-time)
volume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string

2.20 - SnapshotListResponse

NameDescriptionSchemaDefault
count
required		count
Example : 1
integer
snapshots
required
array[Snapshot]
snapshot_size_total_byte
optional
Example :
any of [integer, null]

2.21 - SnapshotRestoreResponse

NameDescriptionSchemaDefault
snapshot
required
Snapshot

2.22 - SnapshotSchedule

NameDescriptionSchemaDefault
frequency
required		스냅샷 주기
Example : WEEKLY
Pattern : ^(WEEKLY|DAILY)$
string
day_of_week
optional		스냅샷 스케줄 설정 요일
Example : MON
Pattern : ^(SUN|MON|TUE|WED|THU|FRI|SAT)$
any of [string, null]
hour
required		스냅샷 스케줄 시간
Example : 23
Pattern : ^([0-9]|1[0-9]|2[0-3])$
string

2.23 - SnapshotScheduleCreateRequest

NameDescriptionSchemaDefault
snapshot_retention_count
optional		보관 개수
Example : 10
any of [integer, null]
volume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
snapshot_schedule
required
SnapshotSchedule

2.24 - SnapshotScheduleCreateResponse

NameDescriptionSchemaDefault
snapshot_retention_count
optional		보관 개수
Example : 10
integer
volume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
any of [string, null]
snapshot_schedule
required
SnapshotSchedule

2.25 - SnapshotScheduleListResponse

NameDescriptionSchemaDefault
snapshot_retention_count
optional		보관 개수
Example : 10
integer
volume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
snapshot_policy_enabled
optional		스냅샷 스케줄 정책 사용 여부
Example : true
any of [boolean, null]
snapshot_schedule
required
array[SnapshotScheduleShow]

2.26 - SnapshotScheduleSetRequest

NameDescriptionSchemaDefault
snapshot_retention_count
optional		보관 개수
Example : 10
any of [integer, null]
snapshot_schedule
required
SnapshotSchedule

2.27 - SnapshotScheduleSetResponse

NameDescriptionSchemaDefault
snapshot_retention_count
optional		보관 개수
Example : 10
integer
volume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
any of [string, null]
snapshot_schedule
required
SnapshotSchedule

2.28 - SnapshotScheduleShow

NameDescriptionSchemaDefault
frequency
required		스냅샷 주기
Example : WEEKLY
Pattern : ^(WEEKLY|DAILY)$
string
day_of_week
optional		스냅샷 스케줄 설정 요일
Example : MON
Pattern : ^(SUN|MON|TUE|WED|THU|FRI|SAT)$
any of [string, null]
hour
required		스냅샷 스케줄 시간
Example : 23
Pattern : ^([0-9]|1[0-9]|2[0-3])$
string
id
optional		스냅샷 스케줄 아이디
Example : d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31
any of [string, null]

2.29 - SnapshotShowResponse

NameDescriptionSchemaDefault
snapshot
required
SnapshotDetail

2.30 - Tag

NameDescriptionSchemaDefault
key
required		키
Example : key
Maximum length : 128
string
value
optional		값
Example : value
any of [string, null]

2.31 - Volume

NameDescriptionSchemaDefault
id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
name
required		볼륨 이름
Example : my_volume
string
protocol
required		프로토콜
Example : NFS
string
state
required		볼륨 상태
Example : available
string
account_id
required		Account 아이디
Example : rwww523320dfvwbbefefsdvwdadsfa24c
string
created_at
required		생성 시간
Example : 2024-07-30T04:54:33.219373
string (date-time)
type_id
required		볼륨 유형 아이디
Example : jef22f67-ee83-4gg2-2ab6-3lf774ekfjdu
string
type_name
required		볼륨 유형 이름
Example : HDD
string
purpose
required		볼륨 용도
Example : replication
string

2.32 - VolumeCreateRequest

NameDescriptionSchemaDefault
name
required		볼륨 이름
Example : my_volume
Pattern : ^[a-z]([a-z0-9_]){2,20}$
string
protocol
required		프로토콜
Example : NFS
Pattern : ^(NFS|CIFS)$
string
type_name
required		볼륨 유형 이름
Example : HDD
string
snapshot_id
optional		스냅샷 아이디
Example : 40htrre5b-eww25-ff2b-a426-6afefas65a3b
any of [string, null]
cifs_password
optional		CIFS 비밀번호
Example : cifspwd0!!
any of [string, null]
tags
optional
any of [array[Tag], null]

2.33 - VolumeCreateRequestV1Dot2

NameDescriptionSchemaDefault
name
required		볼륨 이름
Example : my_volume
Pattern : ^[a-z]([a-z0-9_]){2,20}$
string
protocol
required		프로토콜
Example : NFS
Pattern : ^(NFS|CIFS)$
string
type_name
required		볼륨 유형 이름
Example : HDD
string
snapshot_id
optional		스냅샷 아이디
Example : 40htrre5b-eww25-ff2b-a426-6afefas65a3b
any of [string, null]
cifs_password
optional		CIFS 비밀번호
Example : cifspwd0!!
any of [string, null]
tags
optional
any of [array[Tag], null]
zone
required		존
Example : kr-west1-a
string

2.34 - VolumeCreateResponse

NameDescriptionSchemaDefault
protocol
required		프로토콜
Example : NFS
string
snapshot_id
optional		스냅샷 아이디
Example : 40htrre5b-eww25-ff2b-a426-6afefas65a3b
any of [string, null]
type_name
required		볼륨 유형 이름
Example : HDD
string
volume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
volume_name
required		볼륨 이름
Example : my_volume
string

2.35 - VolumeCreateResponseV1Dot2

NameDescriptionSchemaDefault
protocol
required		프로토콜
Example : NFS
string
snapshot_id
optional		스냅샷 아이디
Example : 40htrre5b-eww25-ff2b-a426-6afefas65a3b
any of [string, null]
type_name
required		볼륨 유형 이름
Example : HDD
string
volume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
volume_name
required		볼륨 이름
Example : my_volume
string
zone
required		존
Example : kr-west1-a
string

2.36 - VolumeListResponse

NameDescriptionSchemaDefault
count
required		count
Example : 1
integer
filestorages
required
array[Volume]

2.37 - VolumeListResponseV1Dot2

NameDescriptionSchemaDefault
count
required		count
Example : 1
integer
filestorages
required
array[VolumeV1Dot2]

2.38 - VolumeObjectAccessRuleListBase

NameDescriptionSchemaDefault
access_rule_state
required		접근제어 상태
Example : active
string
object_type
required		오브젝트 유형
Example : VM
string
object_id
required		오브젝트 아이디
Example : 43fq3347-02q4-4aa8-ccf9-affe4917bb6f
string

2.39 - VolumeObjectAccessRuleListResponse

NameDescriptionSchemaDefault
count
required		count
Example : 1
integer
volume_id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
access_rules
required
array[VolumeObjectAccessRuleListBase]

2.40 - VolumeSetRequest

NameDescriptionSchemaDefault
file_unit_recovery_enabled
required		볼륨 파일 단위 복구 사용 여부
Example : True
boolean

2.41 - VolumeSetResponse

NameDescriptionSchemaDefault
file_unit_recovery_enabled
required		볼륨 파일 단위 복구 사용 여부
Example : True
boolean

2.42 - VolumeShowResponse

NameDescriptionSchemaDefault
id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
name
required		볼륨 이름
Example : my_volume
string
protocol
required		프로토콜
Example : NFS
string
state
required		볼륨 상태
Example : available
string
account_id
required		Account 아이디
Example : rwww523320dfvwbbefefsdvwdadsfa24c
string
created_at
required		생성 시간
Example : 2024-07-30T04:54:33.219373
string (date-time)
type_id
required		볼륨 유형 아이디
Example : jef22f67-ee83-4gg2-2ab6-3lf774ekfjdu
string
type_name
required		볼륨 유형 이름
Example : HDD
string
purpose
required		볼륨 용도
Example : replication
string
path
optional		볼륨 마운트 경로
Example : xxx.xx.xxx:/xxxxxxxx
any of [string, null]
usage
optional
Example :
any of [integer, null]
encryption_enabled
required		볼륨 암호화 사용 여부
Example : True
boolean
file_unit_recovery_enabled
optional		볼륨 파일 단위 복구 사용 여부
Example : True
any of [boolean, null]
cifs_id
optional		CIFS 아이디
Example : cifsid
any of [string, null]
endpoint_path
optional		볼륨 엔드포인트 경로
Example : xxx.xx.xxx.xxx
any of [string, null]

2.43 - VolumeShowResponseV1Dot2

NameDescriptionSchemaDefault
id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
name
required		볼륨 이름
Example : my_volume
string
protocol
required		프로토콜
Example : NFS
string
state
required		볼륨 상태
Example : available
string
account_id
required		Account 아이디
Example : rwww523320dfvwbbefefsdvwdadsfa24c
string
created_at
required		생성 시간
Example : 2024-07-30T04:54:33.219373
string (date-time)
type_name
required		볼륨 유형 이름
Example : HDD
string
purpose
required		볼륨 용도
Example : replication
string
path
optional		볼륨 마운트 경로
Example : xxx.xx.xxx:/xxxxxxxx
any of [string, null]
usage
optional
Example :
any of [integer, null]
encryption_enabled
required		볼륨 암호화 사용 여부
Example : True
boolean
file_unit_recovery_enabled
optional		볼륨 파일 단위 복구 사용 여부
Example : True
any of [boolean, null]
cifs_id
optional		CIFS 아이디
Example : cifsid
any of [string, null]
endpoint_path
optional		볼륨 엔드포인트 경로
Example : xxx.xx.xxx.xxx
any of [string, null]
zone
required		존
Example : kr-west1-a
string
az_type
required		사용 가능한 존 유형
Example : single
any of [string, null]

2.44 - VolumeV1Dot2

NameDescriptionSchemaDefault
id
required		볼륨 아이디
Example : bfdbabf2-04d9-4e8b-a205-020f8e6da438
string
name
required		볼륨 이름
Example : my_volume
string
protocol
required		프로토콜
Example : NFS
string
state
required		볼륨 상태
Example : available
string
account_id
required		Account 아이디
Example : rwww523320dfvwbbefefsdvwdadsfa24c
string
created_at
required		생성 시간
Example : 2024-07-30T04:54:33.219373
string (date-time)
type_id
required		볼륨 유형 아이디
Example : jef22f67-ee83-4gg2-2ab6-3lf774ekfjdu
string
type_name
required		볼륨 유형 이름
Example : HDD
string
purpose
required		볼륨 용도
Example : replication
string
zone
required		존
Example : kr-west1-a
string
az_type
required		사용 가능한 존 유형
Example : single
any of [string, null]