File Storage
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 File Storage 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.
| Version | Status | Not Before |
|---|
| 1.1 | CURRENT | - |
| 1.0 | DEPRECATED | 20251231 |
1 - CLIs
1.1 - CreateSnapshot
1.1.1 - 1.1
scpcli filestorage volume snapshot create
--volume_id <value>
Description
파일스토리지 스냅샷을 생성한다.
상태
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
Responses
| Name | Description | Example |
|---|
| 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.0
scpcli filestorage volume snapshot create
--volume_id <value>
Description
파일스토리지 스냅샷을 생성한다.
상태
ACTIVE (DEPRECATED)
Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
Responses
| Name | Description | Example |
|---|
| 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.1
scpcli filestorage volume snapshot schedule create
--hour <value>
--frequency <value>
--volume_id <value>
[--snapshot_retention_count <value>]
[--day_of_week <value>]
Description
파일스토리지 스냅샷 스케줄을 생성한다.
상태
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
hour required | string | 스냅샷 스케줄 시간 | 23 |
frequency required | string | 스냅샷 주기 | WEEKLY |
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
snapshot_retention_count optional | integer | 보관 개수 | 10 |
day_of_week optional | string | 스냅샷 스케줄 설정 요일 | MON |
Responses
| Name | Description | Example |
|---|
| frequency | 스냅샷 주기 | WEEKLY |
| day_of_week | 스냅샷 스케줄 설정 요일 | MON |
| hour | 스냅샷 스케줄 시간 | 23 |
1.2.2 - 1.0
scpcli filestorage volume snapshot schedule create
--hour <value>
--frequency <value>
--volume_id <value>
[--snapshot_retention_count <value>]
[--day_of_week <value>]
Description
파일스토리지 스냅샷 스케줄을 생성한다.
상태
ACTIVE (DEPRECATED)
Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.
Parameters
| Name | Type | Description | Example |
|---|
hour required | string | 스냅샷 스케줄 시간 | 23 |
frequency required | string | 스냅샷 주기 | WEEKLY |
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
snapshot_retention_count optional | integer | 보관 개수 | 10 |
day_of_week optional | string | 스냅샷 스케줄 설정 요일 | MON |
Responses
| Name | Description | Example |
|---|
| frequency | 스냅샷 주기 | WEEKLY |
| day_of_week | 스냅샷 스케줄 설정 요일 | MON |
| hour | 스냅샷 스케줄 시간 | 23 |
1.3 - CreateVolume
1.3.1 - 1.1
scpcli filestorage volume create
--type_name <value>
--protocol <value>
--name <value>
[--snapshot_id <value>]
[--cifs_password <value>]
[--tags <value>]
Description
파일스토리지를 생성한다.
상태
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
type_name required | string | 볼륨 유형 이름 | HDD |
protocol required | string | 프로토콜 | NFS |
name required | string | 볼륨 이름 | my_volume |
snapshot_id optional | string | 스냅샷 아이디 | 40htrre5b-eww25-ff2b-a426-6afefas65a3b |
cifs_password optional | string | CIFS 비밀번호 | cifspwd0!! |
tags optional | array | | '{"key": "key", "value": "value"}' |
Responses
| Name | Description | Example |
|---|
| protocol | 프로토콜 | NFS |
| snapshot_id | 스냅샷 아이디 | 40htrre5b-eww25-ff2b-a426-6afefas65a3b |
| type_name | 볼륨 유형 이름 | HDD |
| volume_id | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| volume_name | 볼륨 이름 | my_volume |
1.3.2 - 1.0
scpcli filestorage volume create
--type_name <value>
--protocol <value>
--name <value>
[--snapshot_id <value>]
[--cifs_password <value>]
[--tags <value>]
Description
파일스토리지를 생성한다.
상태
ACTIVE (DEPRECATED)
Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.
Parameters
| Name | Type | Description | Example |
|---|
type_name required | string | 볼륨 유형 이름 | HDD |
protocol required | string | 프로토콜 | NFS |
name required | string | 볼륨 이름 | my_volume |
snapshot_id optional | string | 스냅샷 아이디 | 40htrre5b-eww25-ff2b-a426-6afefas65a3b |
cifs_password optional | string | CIFS 비밀번호 | cifspwd0!! |
tags optional | array | | '{"key": "key", "value": "value"}' |
Responses
| Name | Description | Example |
|---|
| 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.1
scpcli filestorage volume replication create
--replication_type <value>
--volume_id <value>
--region <value>
--replication_frequency <value>
--name <value>
[--cifs_password <value>]
[--backup_retention_count <value>]
Description
파일스토리지 복제를 생성한다.
상태
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
replication_type required | string | 복제 유형 | replication |
volume_id required | string | 원본 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
region required | string | 복제본 리전 | kr-west1 |
replication_frequency required | string | 복제 주기 | 5min |
name required | string | 복제본 볼륨 이름 | my_volume |
cifs_password optional | string | CIFS 비밀번호 | cifspwd0!! |
backup_retention_count optional | integer | 백업 보관 개수 | 2 |
Responses
| Name | Description | Example |
|---|
| 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.4.2 - 1.0
scpcli filestorage volume replication create
--replication_type <value>
--volume_id <value>
--region <value>
--replication_frequency <value>
--name <value>
[--cifs_password <value>]
[--backup_retention_count <value>]
Description
파일스토리지 복제를 생성한다.
상태
ACTIVE (DEPRECATED)
Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.
Parameters
| Name | Type | Description | Example |
|---|
replication_type required | string | 복제 유형 | replication |
volume_id required | string | 원본 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
region required | string | 복제본 리전 | kr-west1 |
replication_frequency required | string | 복제 주기 | 5min |
name required | string | 복제본 볼륨 이름 | my_volume |
cifs_password optional | string | CIFS 비밀번호 | cifspwd0!! |
backup_retention_count optional | integer | 백업 보관 개수 | 2 |
Responses
| Name | Description | Example |
|---|
| 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.1
scpcli filestorage volume snapshot delete
--snapshot_id <value>
--volume_id <value>
Description
파일스토리지 스냅샷을 삭제한다.
상태
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
snapshot_id required | string | 스냅샷 아이디 | 40htrre5b-eww25-ff2b-a426-6afefas65a3b |
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
1.5.2 - 1.0
scpcli filestorage volume snapshot delete
--snapshot_id <value>
--volume_id <value>
Description
파일스토리지 스냅샷을 삭제한다.
상태
ACTIVE (DEPRECATED)
Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.
Parameters
| Name | Type | Description | Example |
|---|
snapshot_id required | string | 스냅샷 아이디 | 40htrre5b-eww25-ff2b-a426-6afefas65a3b |
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
1.6 - DeleteSnapshotSchedule
1.6.1 - 1.1
scpcli filestorage volume snapshot schedule delete
--snapshot_schedule_id <value>
--volume_id <value>
Description
파일스토리지 스냅샷 스케줄을 삭제한다.
상태
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
snapshot_schedule_id required | string | 스냅샷 스케줄 아이디 | d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31 |
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
1.6.2 - 1.0
scpcli filestorage volume snapshot schedule delete
--snapshot_schedule_id <value>
--volume_id <value>
Description
파일스토리지 스냅샷 스케줄을 삭제한다.
상태
ACTIVE (DEPRECATED)
Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.
Parameters
| Name | Type | Description | Example |
|---|
snapshot_schedule_id required | string | 스냅샷 스케줄 아이디 | d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31 |
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
1.7 - DeleteVolume
1.7.1 - 1.1
scpcli filestorage volume delete
--volume_id <value>
Description
파일스토리지를 삭제한다.
상태
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
1.7.2 - 1.0
scpcli filestorage volume delete
--volume_id <value>
Description
파일스토리지를 삭제한다.
상태
ACTIVE (DEPRECATED)
Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
1.8 - DeleteVolumeReplication
1.8.1 - 1.1
scpcli filestorage volume replication delete
--replication_id <value>
--volume_id <value>
Description
파일스토리지 복제를 삭제한다.
상태
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
replication_id required | string | 복제 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
1.8.2 - 1.0
scpcli filestorage volume replication delete
--replication_id <value>
--volume_id <value>
Description
파일스토리지 복제를 삭제한다.
상태
ACTIVE (DEPRECATED)
Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.
Parameters
| Name | Type | Description | Example |
|---|
replication_id required | string | 복제 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
1.9 - ListAccessRules
1.9.1 - 1.1
scpcli filestorage volume access rule list
--volume_id <value>
Description
접근제어 목록을 조회한다.
상태
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
Responses
| Name | Description | Example |
|---|
| access_rule_state | 접근제어 상태 | active |
| object_type | 오브젝트 유형 | VM |
| object_id | 오브젝트 아이디 | 43fq3347-02q4-4aa8-ccf9-affe4917bb6f |
1.9.2 - 1.0
scpcli filestorage volume access rule list
--volume_id <value>
Description
접근제어 목록을 조회한다.
상태
ACTIVE (DEPRECATED)
Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
Responses
| Name | Description | Example |
|---|
| access_rule_state | 접근제어 상태 | active |
| object_type | 오브젝트 유형 | VM |
| object_id | 오브젝트 아이디 | 43fq3347-02q4-4aa8-ccf9-affe4917bb6f |
1.10 - ListSnapshots
1.10.1 - 1.1
scpcli filestorage volume snapshot list
--volume_id <value>
Description
파일스토리지 스냅샷 목록을 조회한다.
상태
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
Responses
| Name | Description | Example |
|---|
| 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.10.2 - 1.0
scpcli filestorage volume snapshot list
--volume_id <value>
Description
파일스토리지 스냅샷 목록을 조회한다.
상태
ACTIVE (DEPRECATED)
Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
Responses
| Name | Description | Example |
|---|
| 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.11 - ListSnapshotSchedule
1.11.1 - 1.1
scpcli filestorage volume snapshot schedule list
--volume_id <value>
Description
파일스토리지 스냅샷 스케줄 목록을 조회한다.
상태
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
Responses
| Name | Description | Example |
|---|
| id | 스냅샷 스케줄 아이디 | d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31 |
| frequency | 스냅샷 주기 | WEEKLY |
| day_of_week | 스냅샷 스케줄 설정 요일 | MON |
| hour | 스냅샷 스케줄 시간 | 23 |
1.11.2 - 1.0
scpcli filestorage volume snapshot schedule list
--volume_id <value>
Description
파일스토리지 스냅샷 스케줄 목록을 조회한다.
상태
ACTIVE (DEPRECATED)
Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
Responses
| Name | Description | Example |
|---|
| id | 스냅샷 스케줄 아이디 | d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31 |
| frequency | 스냅샷 주기 | WEEKLY |
| day_of_week | 스냅샷 스케줄 설정 요일 | MON |
| hour | 스냅샷 스케줄 시간 | 23 |
1.12 - ListVolumeReplicationRegion
1.12.1 - 1.1
scpcli filestorage volume replication region list
--replication_type <value>
--source_region_name <value>
--type_name <value>
Description
파일스토리지 복제 리전 목록을 조회한다.
상태
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
replication_type required | string | 복제 유형 | replication |
source_region_name required | string | 리전 | kr-west1 |
type_name required | string | 볼륨 유형 이름 | HDD |
Responses
| Name | Description | Example |
|---|
| regions | 복제 리전 목록 | [‘kr-west1’] |
1.12.2 - 1.0
scpcli filestorage volume replication region list
--replication_type <value>
--source_region_name <value>
--type_name <value>
Description
파일스토리지 복제 리전 목록을 조회한다.
상태
ACTIVE (DEPRECATED)
Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.
Parameters
| Name | Type | Description | Example |
|---|
replication_type required | string | 복제 유형 | replication |
source_region_name required | string | 리전 | kr-west1 |
type_name required | string | 볼륨 유형 이름 | HDD |
Responses
| Name | Description | Example |
|---|
| regions | 복제 리전 목록 | [‘kr-west1’] |
1.13 - ListVolumeReplications
1.13.1 - 1.1
scpcli filestorage volume replication list
--volume_id <value>
Description
파일스토리지 복제 목록을 조회한다.
상태
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
Responses
| Name | Description | Example |
|---|
| 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.13.2 - 1.0
scpcli filestorage volume replication list
--volume_id <value>
Description
파일스토리지 복제 목록을 조회한다.
상태
ACTIVE (DEPRECATED)
Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
Responses
| Name | Description | Example |
|---|
| 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 - ListVolumes
1.14.1 - 1.1
scpcli filestorage volume list
[--offset <value>]
[--limit <value>]
[--name <value>]
[--type_name <value>]
[--sort <value>]
Description
파일스토리지 목록을 조회한다.
상태
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
offset optional | integer | offset | - |
limit optional | integer | limit | - |
name optional | string | 볼륨 이름 | my_volume |
type_name optional | string | 볼륨 유형 이름 | HDD |
sort optional | string | 정렬 | - |
Responses
| Name | Description | Example |
|---|
| id | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| name | 볼륨 이름 | my_volume |
| protocol | 프로토콜 | NFS |
| state | 볼륨 상태 | available |
| account_id | Account 아이디 | rwww523320dfvwbbefefsdvwdadsfa24c |
| created_at | 생성 시간 | 2024-07-30T04:54:33.219373 |
| type_id | 볼륨 유형 아이디 | jef22f67-ee83-4gg2-2ab6-3lf774ekfjdu |
| type_name | 볼륨 유형 이름 | HDD |
| purpose | 볼륨 용도 | replication |
1.14.2 - 1.0
scpcli filestorage volume list
[--offset <value>]
[--limit <value>]
[--name <value>]
[--type_name <value>]
[--sort <value>]
Description
파일스토리지 목록을 조회한다.
상태
ACTIVE (DEPRECATED)
Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.
Parameters
| Name | Type | Description | Example |
|---|
offset optional | integer | offset | - |
limit optional | integer | limit | - |
name optional | string | 볼륨 이름 | my_volume |
type_name optional | string | 볼륨 유형 이름 | HDD |
sort optional | string | 정렬 | - |
Responses
| Name | Description | Example |
|---|
| id | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| name | 볼륨 이름 | my_volume |
| protocol | 프로토콜 | NFS |
| state | 볼륨 상태 | available |
| account_id | Account 아이디 | rwww523320dfvwbbefefsdvwdadsfa24c |
| created_at | 생성 시간 | 2024-07-30T04:54:33.219373 |
| type_id | 볼륨 유형 아이디 | jef22f67-ee83-4gg2-2ab6-3lf774ekfjdu |
| type_name | 볼륨 유형 이름 | HDD |
| purpose | 볼륨 용도 | replication |
1.15 - RestoreSnapshot
1.15.1 - 1.1
scpcli filestorage volume snapshot set
--snapshot_id <value>
--volume_id <value>
Description
파일스토리지 스냅샷을 복구한다.
상태
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
snapshot_id required | string | 스냅샷 아이디 | 40htrre5b-eww25-ff2b-a426-6afefas65a3b |
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
1.15.2 - 1.0
scpcli filestorage volume snapshot set
--snapshot_id <value>
--volume_id <value>
Description
파일스토리지 스냅샷을 복구한다.
상태
ACTIVE (DEPRECATED)
Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.
Parameters
| Name | Type | Description | Example |
|---|
snapshot_id required | string | 스냅샷 아이디 | 40htrre5b-eww25-ff2b-a426-6afefas65a3b |
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
1.16 - SetAccessRule
1.16.1 - 1.1
scpcli filestorage volume access rule set
--volume_id <value>
--action <value>
--object_type <value>
--object_id <value>
Description
파일스토리지 접근제어를 수정한다.
상태
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
action required | string | 접근제어 액션 | add |
object_type required | string | 오브젝트 유형 | VM |
object_id required | string | 오브젝트 아이디 | 43fq3347-02q4-4aa8-ccf9-affe4917bb6f |
1.16.2 - 1.0
scpcli filestorage volume access rule set
--volume_id <value>
--action <value>
--object_type <value>
--object_id <value>
Description
파일스토리지 접근제어를 수정한다.
상태
ACTIVE (DEPRECATED)
Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
action required | string | 접근제어 액션 | add |
object_type required | string | 오브젝트 유형 | VM |
object_id required | string | 오브젝트 아이디 | 43fq3347-02q4-4aa8-ccf9-affe4917bb6f |
1.17 - SetSnapshotSchedule
1.17.1 - 1.1
scpcli filestorage volume snapshot schedule set
--snapshot_schedule_id <value>
--volume_id <value>
--hour <value>
--frequency <value>
[--snapshot_retention_count <value>]
[--day_of_week <value>]
Description
파일스토리지 스냅샷 스케줄을 수정한다.
상태
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
snapshot_schedule_id required | string | 스냅샷 스케줄 아이디 | d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31 |
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
hour required | string | 스냅샷 스케줄 시간 | 23 |
frequency required | string | 스냅샷 주기 | WEEKLY |
snapshot_retention_count optional | integer | 보관 개수 | 10 |
day_of_week optional | string | 스냅샷 스케줄 설정 요일 | MON |
1.17.2 - 1.0
scpcli filestorage volume snapshot schedule set
--snapshot_schedule_id <value>
--volume_id <value>
--hour <value>
--frequency <value>
[--snapshot_retention_count <value>]
[--day_of_week <value>]
Description
파일스토리지 스냅샷 스케줄을 수정한다.
상태
ACTIVE (DEPRECATED)
Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.
Parameters
| Name | Type | Description | Example |
|---|
snapshot_schedule_id required | string | 스냅샷 스케줄 아이디 | d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31 |
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
hour required | string | 스냅샷 스케줄 시간 | 23 |
frequency required | string | 스냅샷 주기 | WEEKLY |
snapshot_retention_count optional | integer | 보관 개수 | 10 |
day_of_week optional | string | 스냅샷 스케줄 설정 요일 | MON |
1.18 - SetVolume
1.18.1 - 1.1
scpcli filestorage volume set
--volume_id <value>
--file_unit_recovery_enabled <value>
Description
파일스토리지를 수정한다.
상태
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
file_unit_recovery_enabled required | boolean | 볼륨 파일 단위 복구 사용 여부 | True |
1.18.2 - 1.0
scpcli filestorage volume set
--volume_id <value>
--file_unit_recovery_enabled <value>
Description
파일스토리지를 수정한다.
상태
ACTIVE (DEPRECATED)
Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
file_unit_recovery_enabled required | boolean | 볼륨 파일 단위 복구 사용 여부 | True |
1.19 - SetVolumeReplication
1.19.1 - 1.1
scpcli filestorage volume replication set
--replication_id <value>
--volume_id <value>
--replication_update_type <value>
[--replication_policy <value>]
[--replication_frequency <value>]
[--backup_retention_count <value>]
Description
파일스토리지 복제를 수정한다.
상태
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
replication_id required | string | 복제 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
replication_update_type required | string | 복제 수정 유형 | policy |
replication_policy optional | **** | 복제 정책 | use |
replication_frequency optional | **** | 복제 주기 | 5min |
backup_retention_count optional | integer | 백업 보관 개수 | 2 |
1.19.2 - 1.0
scpcli filestorage volume replication set
--replication_id <value>
--volume_id <value>
--replication_update_type <value>
[--replication_policy <value>]
[--replication_frequency <value>]
[--backup_retention_count <value>]
Description
파일스토리지 복제를 수정한다.
상태
ACTIVE (DEPRECATED)
Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.
Parameters
| Name | Type | Description | Example |
|---|
replication_id required | string | 복제 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
replication_update_type required | string | 복제 수정 유형 | policy |
replication_policy optional | **** | 복제 정책 | use |
replication_frequency optional | **** | 복제 주기 | 5min |
backup_retention_count optional | integer | 백업 보관 개수 | 2 |
1.20 - ShowVolume
1.20.1 - 1.1
scpcli filestorage volume show
--volume_id <value>
Description
파일스토리지를 상세 조회한다.
상태
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
Responses
| Name | Description | Example |
|---|
| id | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| name | 볼륨 이름 | my_volume |
| protocol | 프로토콜 | NFS |
| state | 볼륨 상태 | available |
| account_id | Account 아이디 | 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 | CIFS 아이디 | cifsid |
| endpoint_path | 볼륨 엔드포인트 경로 | xxx.xx.xxx.xxx |
1.20.2 - 1.0
scpcli filestorage volume show
--volume_id <value>
Description
파일스토리지를 상세 조회한다.
상태
ACTIVE (DEPRECATED)
Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
Responses
| Name | Description | Example |
|---|
| id | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
| name | 볼륨 이름 | my_volume |
| protocol | 프로토콜 | NFS |
| state | 볼륨 상태 | available |
| account_id | Account 아이디 | 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 | CIFS 아이디 | cifsid |
| endpoint_path | 볼륨 엔드포인트 경로 | xxx.xx.xxx.xxx |
1.21 - ShowVolumeReplication
1.21.1 - 1.1
scpcli filestorage volume replication show
--replication_id <value>
--volume_id <value>
Description
파일스토리지 복제를 상세 조회한다.
상태
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
replication_id required | string | 복제 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
Responses
| Name | Description | Example |
|---|
| 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 |
1.21.2 - 1.0
scpcli filestorage volume replication show
--replication_id <value>
--volume_id <value>
Description
파일스토리지 복제를 상세 조회한다.
상태
ACTIVE (DEPRECATED)
Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.
Parameters
| Name | Type | Description | Example |
|---|
replication_id required | string | 복제 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
volume_id required | string | 볼륨 아이디 | bfdbabf2-04d9-4e8b-a205-020f8e6da438 |
Responses
| Name | Description | Example |
|---|
| 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 |