이 섹션의 다중 페이지 출력 화면임. 여기를 클릭하여 프린트.
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.
본 가이드는 Backup 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | DEPRECATED | 20260331 |
| 1.1 | CURRENT | - |
https://backup.{region}.{environment}.samsungsdscloud.com
| environment | region |
|---|---|
| s | kr-west1 |
| s | kr-east1 |
| g | kr-south1 |
| g | kr-south2 |
| g | kr-south3 |
| e | kr-west1 |
| e | kr-east1 |
get /v1/backup-agents/{backup_agent_id}/check-connection-state
백업 마스터 연결 상태 확인
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_agent_id required | Backup Agent ID Example : BACKUP_AGENT-abcd | string | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backup-agents/{backup_agent_id}/check-connection-state
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.1"
{
"request_id": "",
"resource": {
"id": "",
"links": [
""
]
}
}
get /v1/backup-agents/{backup_agent_id}/check-connection-state
백업 마스터 연결 상태 확인
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_agent_id required | Backup Agent ID Example : BACKUP_AGENT-abcd | string | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backup-agents/{backup_agent_id}/check-connection-state
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.0"
{
"request_id": "",
"resource": {
"id": "",
"links": [
""
]
}
}
get /v1/backups/check-name-duplication
Backup명을 중복 체크한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | backup_name required | Backup명 Example : backup-001 | string | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BackupNameDuplicateResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/check-name-duplication?backup_name={backup_name}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.1"
{
"result": true
}
get /v1/backups/check-name-duplication
Backup명을 중복 체크한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | backup_name required | Backup명 Example : backup-001 | string | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BackupNameDuplicateResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/check-name-duplication?backup_name={backup_name}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.0"
{
"result": true
}
get /v1/backups/restore/check-name-duplication
복구 서버명을 중복 체크한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | restore_server_name required | 복구 서버명 Example : restoretest1 | string | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BackupRestoreServerNameDuplicateResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/restore/check-name-duplication?restore_server_name={restore_server_name}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.1"
{
"result": true
}
get /v1/backups/restore/check-name-duplication
복구 서버명을 중복 체크한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | restore_server_name required | 복구 서버명 Example : restoretest1 | string | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BackupRestoreServerNameDuplicateResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/restore/check-name-duplication?restore_server_name={restore_server_name}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.0"
{
"result": true
}
get /v1/backups/check-filesystem-duplication
Filesystem 경로 중복 체크
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | filesystem_path required | 백업 대상 파일 시스템 경로 Example : /aaa | string | None |
| query | server_uuid required | Backup 서버 UUID Example : 89f5ef44-1021-4a5c-8e06-fbb289eac366 | string | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | CheckFileSystemDuplicationResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/check-filesystem-duplication?filesystem_path={filesystem_path}&server_uuid={server_uuid}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.1"
{
"result": true
}
get /v1/backups/check-filesystem-duplication
Filesystem 경로 중복 체크
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | filesystem_path required | 백업 대상 파일 시스템 경로 Example : /aaa | string | None |
| query | server_uuid required | Backup 서버 UUID Example : 89f5ef44-1021-4a5c-8e06-fbb289eac366 | string | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | CheckFileSystemDuplicationResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/check-filesystem-duplication?filesystem_path={filesystem_path}&server_uuid={server_uuid}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.0"
{
"result": true
}
post /v1/backups
Backup을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | BackupCreateRequest1Dot1 |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SyncResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.1"
{
"dr_enabled": false,
"encrypt_enabled": true,
"filesystem_paths": [
"/aaa",
"/bbb"
],
"name": "backup-001",
"policy_category": "AGENTLESS",
"policy_type": "VM_IMAGE",
"region": "kr-west1",
"retention_period": "WEEK_2",
"schedules": [
{
"frequency": "DAILY",
"start_day": "MON",
"start_time": "09:00:00",
"start_week": "WEEK_2",
"type": "FULL"
}
],
"server_category": "VIRTUAL_SERVER | GPU_SERVER | BAREMETAL_SERVER",
"server_guid": "9ab33c66-3dbd-46cd-b0af-abccd3eb3170",
"server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366",
"tags": [
{
"key": "",
"value": ""
}
]
}
{
"request_id": "",
"resource": {
"id": "",
"links": [
""
]
}
}
post /v1/backups
Backup을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | BackupCreateRequest |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SyncResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.0"
{
"encrypt_enabled": true,
"filesystem_paths": [
"/aaa",
"/bbb"
],
"name": "backup-001",
"policy_category": "AGENTLESS",
"policy_type": "VM_IMAGE",
"region": "kr-west1",
"retention_period": "WEEK_2",
"schedules": [
{
"frequency": "DAILY",
"start_day": "MON",
"start_time": "09:00:00",
"start_week": "WEEK_2",
"type": "FULL"
}
],
"server_category": "VIRTUAL_SERVER | GPU_SERVER | BAREMETAL_SERVER",
"server_guid": "9ab33c66-3dbd-46cd-b0af-abccd3eb3170",
"server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366",
"tags": [
{
"key": "",
"value": ""
}
]
}
{
"request_id": "",
"resource": {
"id": "",
"links": [
""
]
}
}
post /v1/backup-agents
Backup Agent을 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | BackupAgentCreateRequest |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SyncResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backup-agents
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.1"
{
"server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366",
"tags": [
{
"key": "",
"value": ""
}
]
}
{
"request_id": "",
"resource": {
"id": "",
"links": [
""
]
}
}
post /v1/backup-agents
Backup Agent을 생성한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | BackupAgentCreateRequest |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SyncResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backup-agents
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.0"
{
"server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366",
"tags": [
{
"key": "",
"value": ""
}
]
}
{
"request_id": "",
"resource": {
"id": "",
"links": [
""
]
}
}
delete /v1/backups/{backup_id}
Backup을 해지한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SyncResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/{backup_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.1"
{
"request_id": "",
"resource": {
"id": "",
"links": [
""
]
}
}
delete /v1/backups/{backup_id}
Backup을 해지한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SyncResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/{backup_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.0"
{
"request_id": "",
"resource": {
"id": "",
"links": [
""
]
}
}
delete /v1/backup-agents/{backup_agent_id}
Backup Agent를 해지한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_agent_id required | Backup Agent ID Example : BACKUP_AGENT-abcd | string | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SyncResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backup-agents/{backup_agent_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.1"
{
"request_id": "",
"resource": {
"id": "",
"links": [
""
]
}
}
delete /v1/backup-agents/{backup_agent_id}
Backup Agent를 해지한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_agent_id required | Backup Agent ID Example : BACKUP_AGENT-abcd | string | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SyncResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backup-agents/{backup_agent_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.0"
{
"request_id": "",
"resource": {
"id": "",
"links": [
""
]
}
}
delete /v1/backups/{backup_id}/restore-targets
복구 대상을 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | None |
| body | body required | BackupRestoreTargetDeleteRequest |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SyncResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/{backup_id}/restore-targets
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.1"
{
"restore_target_ids": [
"ca1a8e76-af49-40ea-93f8-a5989ffe138b"
]
}
{
"request_id": "",
"resource": {
"id": "",
"links": [
""
]
}
}
delete /v1/backups/{backup_id}/restore-targets
복구 대상을 삭제한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | None |
| body | body required | BackupRestoreTargetDeleteRequest |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SyncResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/{backup_id}/restore-targets
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.0"
{
"restore_target_ids": [
"ca1a8e76-af49-40ea-93f8-a5989ffe138b"
]
}
{
"request_id": "",
"resource": {
"id": "",
"links": [
""
]
}
}
get /v1/backups/{backup_id}/agent-backup-restore-targets
복구 대상 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | None |
| query | server_name optional | Backup 서버명 Example : server-001 | any of [string, null] | None |
| query | page optional | 페이지 Example : 0 | any of [integer, null] | 0 |
| query | size optional | 항목 수 Example : 20 | any of [integer, null] | 5 |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AgentBackupRestoreTargetServerListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/{backup_id}/agent-backup-restore-targets
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.1"
{
"contents": [
{
"server_name": "server-001",
"server_os_version": "UBUNTU 22.04",
"server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366"
}
],
"count": 1
}
get /v1/backups/{backup_id}/agent-backup-restore-targets
복구 대상 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | None |
| query | server_name optional | Backup 서버명 Example : server-001 | any of [string, null] | None |
| query | page optional | 페이지 Example : 0 | any of [integer, null] | 0 |
| query | size optional | 항목 수 Example : 20 | any of [integer, null] | 5 |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AgentBackupRestoreTargetServerListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/{backup_id}/agent-backup-restore-targets
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.0"
{
"contents": [
{
"server_name": "server-001",
"server_os_version": "UBUNTU 22.04",
"server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366"
}
],
"count": 1
}
get /v1/backup-agents
Backup 대상 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | name optional | Backup Agent명 Example : agent_abcd12 | any of [string, null] | None |
| query | server_backup_agent_ip optional | 대상 서버 Backup Agent IP Example : 11.22.33.44 | any of [string, null] | None |
| query | server_name optional | Backup Agent 대상 서버명 Example : server-001 | any of [string, null] | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BackupAgentListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backup-agents
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.1"
{
"contents": [
{
"account_id": "fnsd89fus0f9ds09f90dshf9dshfds09",
"backup_policy_count": "3",
"connection_state": "SUCCESS",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "BACKUP_AGENT-abcd",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "agent_abcd12",
"server_backup_agent_ip": "11.22.33.44",
"server_name": "server-001",
"state": "AVAILABLE"
}
],
"count": 1
}
get /v1/backup-agents
Backup 대상 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | name optional | Backup Agent명 Example : agent_abcd12 | any of [string, null] | None |
| query | server_backup_agent_ip optional | 대상 서버 Backup Agent IP Example : 11.22.33.44 | any of [string, null] | None |
| query | server_name optional | Backup Agent 대상 서버명 Example : server-001 | any of [string, null] | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BackupAgentListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backup-agents
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.0"
{
"contents": [
{
"account_id": "fnsd89fus0f9ds09f90dshf9dshfds09",
"backup_policy_count": "3",
"connection_state": "SUCCESS",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "BACKUP_AGENT-abcd",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "agent_abcd12",
"server_backup_agent_ip": "11.22.33.44",
"server_name": "server-001",
"state": "AVAILABLE"
}
],
"count": 1
}
get /v1/backups/{backup_id}/backup-histories
Backup 이력을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | None |
| query | backup_start_time optional | 시작 일시 Example : 2024-09-30T15:00:00Z | any of [string (date-time), null] | None |
| query | backup_end_time optional | 검색 종료 일시 Example : 2024-10-31T14:59:59Z | any of [string (date-time), null] | None |
| query | backup_job_state optional | Backup 이력 상태 Example : SUCCESS | any of [enum (SUCCESS, PARTIAL_SUCCESS, FAILED, INPROGRESS, ALL), null] | None |
| query | page optional | 페이지 Example : 0 | integer | 0 |
| query | size optional | 항목 수 Example : 20 | integer | 20 |
| query | sort optional | 정렬 조건 Example : backup_start_time:desc | any of [string, null] | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BackupHistoryListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/{backup_id}/backup-histories
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.1"
{
"contents": [
{
"backup_end_time": "2024-10-31T14:59:59Z",
"backup_job_guid": "3b1da7ba-3f38-45cb-9538-e921826f80d7",
"backup_job_state": "SUCCESS",
"backup_start_time": "2024-09-30T15:00:00Z",
"schedule_id": "f5b8e22b-0d88-4698-9996-fb44217c8227",
"schedule_name": "INCREMENTAL_DAILY_15:00:00-chg4By"
}
],
"count": 1
}
get /v1/backups/{backup_id}/backup-histories
Backup 이력을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | None |
| query | backup_start_time optional | 시작 일시 Example : 2024-09-30T15:00:00Z | any of [string (date-time), null] | None |
| query | backup_end_time optional | 검색 종료 일시 Example : 2024-10-31T14:59:59Z | any of [string (date-time), null] | None |
| query | backup_job_state optional | Backup 이력 상태 Example : SUCCESS | any of [enum (SUCCESS, PARTIAL_SUCCESS, FAILED, INPROGRESS, ALL), null] | None |
| query | page optional | 페이지 Example : 0 | integer | 0 |
| query | size optional | 항목 수 Example : 20 | integer | 20 |
| query | sort optional | 정렬 조건 Example : backup_start_time:desc | any of [string, null] | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BackupHistoryListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/{backup_id}/backup-histories
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.0"
{
"contents": [
{
"backup_end_time": "2024-10-31T14:59:59Z",
"backup_job_guid": "3b1da7ba-3f38-45cb-9538-e921826f80d7",
"backup_job_state": "SUCCESS",
"backup_start_time": "2024-09-30T15:00:00Z",
"schedule_id": "f5b8e22b-0d88-4698-9996-fb44217c8227",
"schedule_name": "INCREMENTAL_DAILY_15:00:00-chg4By"
}
],
"count": 1
}
get /v1/backups/region-relationship
List Backup Region Relationship.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | from_region optional | 위치 Example : kr-west1 | any of [string, null] | None |
| query | from_availability_zone optional | Availability Zone명 Example : kr-west1 | any of [string, null] | None |
| query | to_region optional | 위치 Example : kr-west1 | any of [string, null] | None |
| query | to_availability_zone optional | Availability Zone명 Example : kr-west1 | any of [string, null] | None |
| query | backup_master_type optional | Backup Master 유형 Example : AGENTLESS | any of [enum (AGENT, AGENTLESS, AGENT_SAP_INT, AGENT_SAP_EXT), null] | AGENTLESS |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BackupListRegionRelationshipResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/region-relationship
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.1"
{
"contents": [
{
"from_availability_zone": "kr-west1",
"from_region": "kr-west1",
"to_availability_zone": "kr-west1",
"to_region": "kr-west1"
}
],
"count": ""
}
get /v1/backups/region-relationship
List Backup Region Relationship.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | from_region optional | 위치 Example : kr-west1 | any of [string, null] | None |
| query | from_availability_zone optional | Availability Zone명 Example : kr-west1 | any of [string, null] | None |
| query | to_region optional | 위치 Example : kr-west1 | any of [string, null] | None |
| query | to_availability_zone optional | Availability Zone명 Example : kr-west1 | any of [string, null] | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BackupListRegionRelationshipResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/region-relationship
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.0"
{
"contents": [
{
"from_availability_zone": "kr-west1",
"from_region": "kr-west1",
"to_availability_zone": "kr-west1",
"to_region": "kr-west1"
}
],
"count": ""
}
get /v1/backups/{backup_id}/restore-histories
복구 이력을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | None |
| query | page optional | 페이지 Example : 0 | any of [integer, null] | 0 |
| query | size optional | 항목 수 Example : 20 | any of [integer, null] | 20 |
| query | sort optional | 정렬 조건 Example : backup_start_time:desc | any of [string, null] | created_at:desc |
| query | restore_state optional | 복구 상태 Example : COMPLETED | any of [enum (COMPLETED, FAILED, INPROGRESS), null] | None |
| query | start_time optional | 시작 일시 Example : 2024-09-30T15:00:00Z | any of [string (date-time), null] | None |
| query | end_time optional | 검색 종료 일시 Example : 2024-10-31T14:59:59Z | any of [string (date-time), null] | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BackupRestoreHistoryListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/{backup_id}/restore-histories
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.1"
{
"contents": [
{
"backup_id": "00cd2538fbf94d12b36aabbdd607e974",
"backup_start_time": "2024-10-28T05:38:48",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"restore_end_time": "2024-10-28T05:52:47",
"restore_server_id": "26895cb7-2059-49e7-b6fe-9c9c4b0d3db0",
"restore_server_name": "restoretest1",
"restore_start_time": "2024-10-28T05:52:47",
"restore_state": "COMPLETED",
"schedule_name": "INCREMENTAL_DAILY_15:00:00-chg4By"
}
],
"count": 1
}
get /v1/backups/{backup_id}/restore-histories
복구 이력을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | None |
| query | page optional | 페이지 Example : 0 | any of [integer, null] | 0 |
| query | size optional | 항목 수 Example : 20 | any of [integer, null] | 20 |
| query | sort optional | 정렬 조건 Example : backup_start_time:desc | any of [string, null] | created_at:desc |
| query | restore_state optional | 복구 상태 Example : COMPLETED | any of [enum (COMPLETED, FAILED, INPROGRESS), null] | None |
| query | start_time optional | 시작 일시 Example : 2024-09-30T15:00:00Z | any of [string (date-time), null] | None |
| query | end_time optional | 검색 종료 일시 Example : 2024-10-31T14:59:59Z | any of [string (date-time), null] | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BackupRestoreHistoryListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/{backup_id}/restore-histories
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.0"
{
"contents": [
{
"backup_id": "00cd2538fbf94d12b36aabbdd607e974",
"backup_start_time": "2024-10-28T05:38:48",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"restore_end_time": "2024-10-28T05:52:47",
"restore_server_id": "26895cb7-2059-49e7-b6fe-9c9c4b0d3db0",
"restore_server_name": "restoretest1",
"restore_start_time": "2024-10-28T05:52:47",
"restore_state": "COMPLETED",
"schedule_name": "INCREMENTAL_DAILY_15:00:00-chg4By"
}
],
"count": 1
}
get /v1/backups/{backup_id}/restore/restorable-subnets
원본 서버와 다른 위치에 복구하기 위해 서브넷 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | None |
| query | vpc_id optional | VPC ID Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | state optional | Subnet 상태 Example : ACTIVE | any of [string, null] | None |
| query | region required | 서버를 복구할 리전 Example : kr-west1 | string | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BackupRestoreSubnetListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/{backup_id}/restore/restorable-subnets?region={region}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.1"
{
"count": 1,
"subnets": [
{
"account_id": "fnsd89fus0f9ds09f90dshf9dshfds09",
"cidr": "192.167.1.0/24",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"gateway_ip_address": "192.167.1.1",
"id": "023c57b14f11483689338d085e061492",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "subnetName",
"state": "ACTIVE",
"type": "GENERAL",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
]
}
get /v1/backups/{backup_id}/restore/restorable-subnets
원본 서버와 다른 위치에 복구하기 위해 서브넷 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | None |
| query | vpc_id optional | VPC ID Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | state optional | Subnet 상태 Example : ACTIVE | any of [string, null] | None |
| query | region required | 서버를 복구할 리전 Example : kr-west1 | string | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BackupRestoreSubnetListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/{backup_id}/restore/restorable-subnets?region={region}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.0"
{
"count": 1,
"subnets": [
{
"account_id": "fnsd89fus0f9ds09f90dshf9dshfds09",
"cidr": "192.167.1.0/24",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"gateway_ip_address": "192.167.1.1",
"id": "023c57b14f11483689338d085e061492",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "subnetName",
"state": "ACTIVE",
"type": "GENERAL",
"vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
"vpc_name": "vpcName"
}
]
}
get /v1/backups/{backup_id}/restore-targets
복구 대상 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | None |
| query | backup_start_time optional | 시작 일시 Example : 2024-09-30T15:00:00Z | any of [string (date-time), null] | None |
| query | backup_end_time optional | 검색 종료 일시 Example : 2024-10-31T14:59:59Z | any of [string (date-time), null] | None |
| query | page optional | 페이지 Example : 0 | integer | 0 |
| query | size optional | 항목 수 Example : 20 | integer | 20 |
| query | sort optional | 정렬 조건 Example : backup_start_time:desc | any of [string, null] | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BackupRestoreTargetListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/{backup_id}/restore-targets
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.1"
{
"contents": [
{
"backup_start_time": "2024-09-30T15:00:00Z",
"is_restore_available": "true",
"restore_target_id": "ca1a8e76-af49-40ea-93f8-a5989ffe138b",
"retention_period": "WEEK_2",
"schedule_id": "f5b8e22b-0d88-4698-9996-fb44217c8227",
"schedule_name": "INCREMENTAL_DAILY_15:00:00-chg4By",
"usage_gb": "123.4"
}
],
"count": 1
}
get /v1/backups/{backup_id}/restore-targets
복구 대상 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | None |
| query | backup_start_time optional | 시작 일시 Example : 2024-09-30T15:00:00Z | any of [string (date-time), null] | None |
| query | backup_end_time optional | 검색 종료 일시 Example : 2024-10-31T14:59:59Z | any of [string (date-time), null] | None |
| query | page optional | 페이지 Example : 0 | integer | 0 |
| query | size optional | 항목 수 Example : 20 | integer | 20 |
| query | sort optional | 정렬 조건 Example : backup_start_time:desc | any of [string, null] | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BackupRestoreTargetListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/{backup_id}/restore-targets
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.0"
{
"contents": [
{
"backup_start_time": "2024-09-30T15:00:00Z",
"is_restore_available": "true",
"restore_target_id": "ca1a8e76-af49-40ea-93f8-a5989ffe138b",
"retention_period": "WEEK_2",
"schedule_id": "f5b8e22b-0d88-4698-9996-fb44217c8227",
"schedule_name": "INCREMENTAL_DAILY_15:00:00-chg4By",
"usage_gb": "123.4"
}
],
"count": 1
}
get /v1/backups/{backup_id}/schedules
스케줄 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BackupScheduleListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/{backup_id}/schedules
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.1"
{
"contents": [
{
"backup_id": "00cd2538fbf94d12b36aabbdd607e974",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"frequency": "DAILY",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "INCREMENTAL_DAILY_15:00:00-chg4By",
"start_day": "MON",
"start_time": "14:00:00",
"start_week": "WEEK_1",
"state": "AVAILABLE",
"type": "FULL"
}
],
"count": 1
}
get /v1/backups/{backup_id}/schedules
스케줄 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BackupScheduleListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/{backup_id}/schedules
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.0"
{
"contents": [
{
"backup_id": "00cd2538fbf94d12b36aabbdd607e974",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"frequency": "DAILY",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "INCREMENTAL_DAILY_15:00:00-chg4By",
"start_day": "MON",
"start_time": "14:00:00",
"start_week": "WEEK_1",
"state": "AVAILABLE",
"type": "FULL"
}
],
"count": 1
}
get /v1/backups/backup-targets
Backup 대상 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | server_name optional | Backup 서버명 Example : server-001 | any of [string, null] | None |
| query | server_category required | 대상 서버 카테고리 Example : VIRTUAL_SERVER | GPU_SERVER | BAREMETAL_SERVER | enum (VIRTUAL_SERVER, GPU_SERVER, BAREMETAL_SERVER) | None |
| query | region optional | 위치 Example : kr-west1 | any of [string, null] | None |
| query | page optional | 페이지 Example : 0 | any of [integer, null] | 0 |
| query | size optional | 항목 수 Example : 20 | any of [integer, null] | 5 |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BackupTargetListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/backup-targets?server_category={server_category}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.1"
{
"contents": [
{
"server_guid": "9ab33c66-3dbd-46cd-b0af-abccd3eb3170",
"server_name": "server-001",
"server_os_version": "UBUNTU 22.04",
"server_type": "s1v1m2",
"server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366"
}
],
"count": 1
}
get /v1/backups/backup-targets
Backup 대상 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | server_name optional | Backup 서버명 Example : server-001 | any of [string, null] | None |
| query | server_category required | 대상 서버 카테고리 Example : VIRTUAL_SERVER | GPU_SERVER | BAREMETAL_SERVER | enum (VIRTUAL_SERVER, GPU_SERVER, BAREMETAL_SERVER) | None |
| query | region optional | 위치 Example : kr-west1 | any of [string, null] | None |
| query | page optional | 페이지 Example : 0 | any of [integer, null] | 0 |
| query | size optional | 항목 수 Example : 20 | any of [integer, null] | 5 |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BackupTargetListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/backup-targets?server_category={server_category}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.0"
{
"contents": [
{
"server_guid": "9ab33c66-3dbd-46cd-b0af-abccd3eb3170",
"server_name": "server-001",
"server_os_version": "UBUNTU 22.04",
"server_type": "s1v1m2",
"server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366"
}
],
"count": 1
}
get /v1/backups
Backup 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | name optional | Backup명 Example : backup-001 | any of [string, null] | None |
| query | server_name optional | Backup 서버명 Example : server-001 | any of [string, null] | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BackupListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.1"
{
"contents": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "backup-001",
"policy_type": "VM_IMAGE",
"retention_period": "WEEK_2",
"role_type": "ORIGINAL",
"server_name": "server-001",
"state": "AVAILABLE"
}
],
"count": 1
}
get /v1/backups
Backup 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | name optional | Backup명 Example : backup-001 | any of [string, null] | None |
| query | server_name optional | Backup 서버명 Example : server-001 | any of [string, null] | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BackupListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.0"
{
"contents": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "backup-001",
"policy_type": "VM_IMAGE",
"retention_period": "WEEK_2",
"role_type": "ORIGINAL",
"server_name": "server-001",
"state": "AVAILABLE"
}
],
"count": 1
}
get /v1/backup-agents/targets
Backup Agent 대상 서버 목록
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | 정렬 조건 Example : server_name:asc | any of [string, null] | server_name:asc |
| query | server_category required | 대상 서버 카테고리 Example : BAREMETAL_SERVER | string | None |
| query | server_name optional | Backup 서버명 Example : server-001 | any of [string, null] | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BackupAgentTargetListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backup-agents/targets?server_category={server_category}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.1"
{
"contents": [
{
"server_backup_agent_ip": "11.22.33.44",
"server_name": "server-001",
"server_state": "RUNNING",
"server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366"
}
],
"count": 1
}
get /v1/backup-agents/targets
Backup Agent 대상 서버 목록
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | 정렬 조건 Example : server_name:asc | any of [string, null] | server_name:asc |
| query | server_category required | 대상 서버 카테고리 Example : BAREMETAL_SERVER | string | None |
| query | server_name optional | Backup 서버명 Example : server-001 | any of [string, null] | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BackupAgentTargetListResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backup-agents/targets?server_category={server_category}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.0"
{
"contents": [
{
"server_backup_agent_ip": "11.22.33.44",
"server_name": "server-001",
"server_state": "RUNNING",
"server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366"
}
],
"count": 1
}
post /v1/backups/{backup_id}/manual-backup
즉시 Backup을 수행한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SyncResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/{backup_id}/manual-backup
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.1"
{
"request_id": "",
"resource": {
"id": "",
"links": [
""
]
}
}
post /v1/backups/{backup_id}/manual-backup
즉시 Backup을 수행한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SyncResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/{backup_id}/manual-backup
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.0"
{
"request_id": "",
"resource": {
"id": "",
"links": [
""
]
}
}
post /v1/backups/{backup_id}/restore-agent-backup
백업을 복구한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | None |
| body | body required | AgentBackupRestoreRequest |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SyncResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/{backup_id}/restore-agent-backup
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.1"
{
"filesystem_paths": [
{
"destination": "/data",
"source": "/data"
}
],
"overwrite": true,
"restore_server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366",
"restore_target_id": "ca1a8e76-af49-40ea-93f8-a5989ffe138b"
}
{
"request_id": "",
"resource": {
"id": "",
"links": [
""
]
}
}
post /v1/backups/{backup_id}/restore-agent-backup
백업을 복구한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | None |
| body | body required | AgentBackupRestoreRequest |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SyncResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/{backup_id}/restore-agent-backup
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.0"
{
"filesystem_paths": [
{
"destination": "/data",
"source": "/data"
}
],
"overwrite": true,
"restore_server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366",
"restore_target_id": "ca1a8e76-af49-40ea-93f8-a5989ffe138b"
}
{
"request_id": "",
"resource": {
"id": "",
"links": [
""
]
}
}
post /v1/backups/{backup_id}/restore
백업을 복구한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | None |
| body | body required | BackupRestoreRequest |
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
/v1/backups/{backup_id}/restore
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.1"
{
"networks": [
{
"subnet_id": "023c57b14f11483689338d085e061492"
}
],
"restore_region": "kr-west1",
"restore_server_name": "restoretest1",
"restore_target_id": "ca1a8e76-af49-40ea-93f8-a5989ffe138b",
"security_groups": [
"023c57b14f11483689338d085e061492"
],
"server_type_id": "s1v1m2"
}
{
"request_id": "",
"resource": {
"id": "",
"links": [
""
]
}
}
post /v1/backups/{backup_id}/restore
백업을 복구한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | None |
| body | body required | BackupRestoreRequest |
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | AsyncResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
/v1/backups/{backup_id}/restore
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.0"
{
"networks": [
{
"subnet_id": "023c57b14f11483689338d085e061492"
}
],
"restore_region": "kr-west1",
"restore_server_name": "restoretest1",
"restore_target_id": "ca1a8e76-af49-40ea-93f8-a5989ffe138b",
"security_groups": [
"023c57b14f11483689338d085e061492"
],
"server_type_id": "s1v1m2"
}
{
"request_id": "",
"resource": {
"id": "",
"links": [
""
]
}
}
put /v1/backups/{backup_id}/schedules
스케줄 목록을 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | None |
| body | body required | ModifyBackupSchedulesRequest |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SyncResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/{backup_id}/schedules
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.1"
{
"schedules": [
{
"frequency": "DAILY",
"start_day": "MON",
"start_time": "09:00:00",
"start_week": "WEEK_2",
"type": "FULL"
}
]
}
{
"request_id": "",
"resource": {
"id": "",
"links": [
""
]
}
}
put /v1/backups/{backup_id}/schedules
스케줄 목록을 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | None |
| body | body required | ModifyBackupSchedulesRequest |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SyncResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/{backup_id}/schedules
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.0"
{
"schedules": [
{
"frequency": "DAILY",
"start_day": "MON",
"start_time": "09:00:00",
"start_week": "WEEK_2",
"type": "FULL"
}
]
}
{
"request_id": "",
"resource": {
"id": "",
"links": [
""
]
}
}
put /v1/backups/{backup_id}/filesystem-path
파일 시스템 경로 설정
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | None |
| body | body required | FileSystemPathUpdateRequest |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SyncResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/{backup_id}/filesystem-path
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.1"
{
"backup_filesystem_paths": [
"/aaa",
"/bbb"
]
}
{
"request_id": "",
"resource": {
"id": "",
"links": [
""
]
}
}
put /v1/backups/{backup_id}/filesystem-path
파일 시스템 경로 설정
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | None |
| body | body required | FileSystemPathUpdateRequest |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SyncResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/{backup_id}/filesystem-path
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.0"
{
"backup_filesystem_paths": [
"/aaa",
"/bbb"
]
}
{
"request_id": "",
"resource": {
"id": "",
"links": [
""
]
}
}
get /v1/backups/{backup_id}
Backup을 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BackupDetailResponse1Dot1 |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/{backup_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.1"
{
"backup_agent_id": "BACKUP_AGENT-abcd",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"dr_enabled": false,
"dr_region": "kr-west1",
"encrypt_enabled": false,
"filesystem_paths": [
"/aaa",
"/bbb"
],
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "backup-001",
"origin_backup_id": "00cd2538fbf94d12b36aabbdd607e974",
"policy_category": "AGENTLESS",
"policy_type": "VM_IMAGE",
"region": "kr-west1",
"replica_backup_id": "00cd2538fbf94d12b36aabbdd607e974",
"retention_period": "WEEK_2",
"role_type": "ORIGINAL",
"server_category": "VIRTUAL_SERVER | GPU_SERVER | BAREMETAL_SERVER",
"server_name": "server-001",
"server_os_type": "WINDOWS",
"server_region": "kr-west1",
"server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366",
"state": "AVAILABLE"
}
get /v1/backups/{backup_id}
Backup을 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BackupDetailResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/{backup_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.0"
{
"backup_agent_id": "BACKUP_AGENT-abcd",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"encrypt_enabled": false,
"filesystem_paths": [
"/aaa",
"/bbb"
],
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "backup-001",
"policy_category": "AGENTLESS",
"policy_type": "VM_IMAGE",
"region": "kr-west1",
"retention_period": "WEEK_2",
"role_type": "ORIGINAL",
"server_category": "VIRTUAL_SERVER | GPU_SERVER | BAREMETAL_SERVER",
"server_name": "server-001",
"server_os_type": "WINDOWS",
"server_region": "kr-west1",
"server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366",
"state": "AVAILABLE"
}
get /v1/backup-agents/{backup_agent_id}
Backup Agent를 상세 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_agent_id required | Backup Agent ID Example : BACKUP_AGENT-abcd | string | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BackupAgentDetailResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backup-agents/{backup_agent_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.1"
{
"account_id": "fnsd89fus0f9ds09f90dshf9dshfds09",
"backup_master_ip": "33.44.55.66",
"backup_master_name": "backupmastertest",
"backup_policy_count": "3",
"connection_check_time": "2024-11-11T09:13:48Z",
"connection_state": "SUCCESS",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "BACKUP_AGENT-abcd",
"install_file_path": "http://linux-agent",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "agent_abcd12",
"server_backup_agent_ip": "11.22.33.44",
"server_category": "VIRTUAL_SERVER | GPU_SERVER | BAREMETAL_SERVER",
"server_gateway_ip": "22.33.44.55",
"server_name": "server-001",
"server_os_type": "WINDOWS",
"server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366",
"state": "AVAILABLE"
}
get /v1/backup-agents/{backup_agent_id}
Backup Agent를 상세 조회한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_agent_id required | Backup Agent ID Example : BACKUP_AGENT-abcd | string | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BackupAgentDetailResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backup-agents/{backup_agent_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.0"
{
"account_id": "fnsd89fus0f9ds09f90dshf9dshfds09",
"backup_master_ip": "33.44.55.66",
"backup_master_name": "backupmastertest",
"backup_policy_count": "3",
"connection_check_time": "2024-11-11T09:13:48Z",
"connection_state": "SUCCESS",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "BACKUP_AGENT-abcd",
"install_file_path": "http://linux-agent",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "agent_abcd12",
"server_backup_agent_ip": "11.22.33.44",
"server_category": "VIRTUAL_SERVER | GPU_SERVER | BAREMETAL_SERVER",
"server_gateway_ip": "22.33.44.55",
"server_name": "server-001",
"server_os_type": "WINDOWS",
"server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366",
"state": "AVAILABLE"
}
get /v1/backup-agents/agent-install-file-path
Backup Agent 설치 파일 경로 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | os_type required | OS 유형 Example : | string | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | InstallFilePathResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backup-agents/agent-install-file-path?os_type={os_type}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.1"
{
"install_file_path": "http://linux-agent"
}
get /v1/backup-agents/agent-install-file-path
Backup Agent 설치 파일 경로 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | os_type required | OS 유형 Example : | string | None |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | InstallFilePathResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backup-agents/agent-install-file-path?os_type={os_type}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.0"
{
"install_file_path": "http://linux-agent"
}
put /v1/backups/{backup_id}/replication
복제 사용 여부를 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | None |
| body | body required | BackupReplicationUseUpdateBody |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SyncResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/{backup_id}/replication
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.1"
{
"dr_enabled": false
}
{
"request_id": "",
"resource": {
"id": "",
"links": [
""
]
}
}
put /v1/backups/{backup_id}/replication
복제 사용 여부를 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | None |
| body | body required | BackupReplicationUseUpdateBody |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SyncResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/{backup_id}/replication
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.0"
{
"dr_enabled": false
}
{
"request_id": "",
"resource": {
"id": "",
"links": [
""
]
}
}
put /v1/backups/{backup_id}/retention-period
보관 기간을 수정한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | None |
| body | body required | RetentionPeriodUpdateBody |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SyncResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/{backup_id}/retention-period
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.1"
{
"retention_period": "WEEK_2"
}
{
"request_id": "",
"resource": {
"id": "",
"links": [
""
]
}
}
put /v1/backups/{backup_id}/retention-period
보관 기간을 수정한다.
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260331 |
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | None |
| body | body required | RetentionPeriodUpdateBody |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SyncResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
/v1/backups/{backup_id}/retention-period
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = backup 1.0"
{
"retention_period": "WEEK_2"
}
{
"request_id": "",
"resource": {
"id": "",
"links": [
""
]
}
}
| Name | Description | Schema | Default |
|---|---|---|---|
| filesystem_paths required | 백업 대상 파일 시스템 경로 | array[RestoreFilesystemPath] | |
| overwrite optional | 덮어쓰기 Example : True | any of [boolean, null] | |
| restore_server_uuid required | 복구 서버 ID Example : 89f5ef44-1021-4a5c-8e06-fbb289eac366 | string | |
| restore_target_id required | 복구 대상 목록 Example : ca1a8e76-af49-40ea-93f8-a5989ffe138b | string |
| Name | Description | Schema | Default |
|---|---|---|---|
| contents optional | 복구 대상 목록 | any of [array[AgentBackupRestoreTargetServerResponse], null] | |
| count required | 갯수 Example : 1 | integer |
| Name | Description | Schema | Default |
|---|---|---|---|
| server_name required | Backup 서버명 Example : server-001 | string | |
| server_os_version required | 서버의 OS Type 과 버전 Example : UBUNTU 22.04 | string | |
| server_uuid required | Backup 서버 UUID Example : 89f5ef44-1021-4a5c-8e06-fbb289eac366 | string |
| Name | Description | Schema | Default |
|---|---|---|---|
| request_id required | 요청 ID Example : | string | |
| resource required | 자원 | ResourceInfo |
| Name | Description | Schema | Default |
|---|---|---|---|
| server_uuid required | Backup Agent 대상 서버 UUID Example : 89f5ef44-1021-4a5c-8e06-fbb289eac366 | string | |
| tags optional | any of [array[Tag], null] |
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : fnsd89fus0f9ds09f90dshf9dshfds09 | any of [string, null] | |
| backup_master_ip required | Backup Master IP Example : 33.44.55.66 | any of [string, null] | |
| backup_master_name required | Backup Master명 Example : backupmastertest | any of [string, null] | |
| backup_policy_count required | Backup 정책 수 Example : 3 | any of [integer, null] | |
| connection_check_time required | Backup Agent 연결 확인 시간 Example : 2024-11-11T09:13:48Z | any of [string (date-time), null] | |
| connection_state required | Backup Agent 연결 상태 Example : SUCCESS | any of [string, null] | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| id required | Backup Agent ID Example : BACKUP_AGENT-abcd | any of [string, null] | |
| install_file_path required | 설치 파일 경로 Example : http://linux-agent | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | Backup Agent명 Example : agent_abcd12 | any of [string, null] | |
| server_backup_agent_ip required | 대상 서버 Backup Agent IP Example : 11.22.33.44 | any of [string, null] | |
| server_category required | 대상 서버 카테고리 Example : VIRTUAL_SERVER | GPU_SERVER | BAREMETAL_SERVER | any of [string, null] | |
| server_gateway_ip required | 서버 Gateway IP Example : 22.33.44.55 | any of [string, null] | |
| server_name required | Backup Agent 대상 서버명 Example : server-001 | any of [string, null] | |
| server_os_type required | 서버 OS Type Example : WINDOWS | any of [string, null] | |
| server_uuid required | Backup Agent 대상 서버 UUID Example : 89f5ef44-1021-4a5c-8e06-fbb289eac366 | any of [string, null] | |
| state required | Backup Agent 상태 Example : AVAILABLE | any of [string, null] |
| Name | Description | Schema | Default |
|---|---|---|---|
| contents required | Backup 대상 목록 | any of [array[BackupAgentResponse], null] | |
| count optional | 갯수 Example : 1 | any of [integer, null] |
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : fnsd89fus0f9ds09f90dshf9dshfds09 | any of [string, null] | |
| backup_policy_count required | Backup 정책 수 Example : 3 | any of [integer, null] | |
| connection_state required | Backup Agent 연결 상태 Example : SUCCESS | any of [string, null] | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| id required | Backup Agent ID Example : BACKUP_AGENT-abcd | any of [string, null] | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | Backup Agent명 Example : agent_abcd12 | any of [string, null] | |
| server_backup_agent_ip required | 대상 서버 Backup Agent IP Example : 11.22.33.44 | any of [string, null] | |
| server_name required | Backup 서버명 Example : server-001 | any of [string, null] | |
| state required | Backup Agent 상태 Example : AVAILABLE | any of [string, null] |
| Name | Description | Schema | Default |
|---|---|---|---|
| contents required | Backup 대상 목록 | any of [array[BackupAgentTargetResponse], null] | |
| count optional | 갯수 Example : 1 | any of [integer, null] |
| Name | Description | Schema | Default |
|---|---|---|---|
| server_backup_agent_ip required | 대상 서버 Backup Agent IP Example : 11.22.33.44 | string | |
| server_name required | Backup Agent 대상 서버명 Example : server-001 | string | |
| server_state required | Backup 서버 상태 Example : RUNNING | string | |
| server_uuid required | Backup Agent 대상 서버 UUID Example : 89f5ef44-1021-4a5c-8e06-fbb289eac366 | string |
| Name | Description | Schema | Default |
|---|---|---|---|
| encrypt_enabled optional | 암호화 사용 여부 Example : True | boolean | True |
| filesystem_paths optional | 백업 대상 파일 시스템 경로 Example : ['/aaa', '/bbb'] | any of [array[string], null] | |
| name required | Backup명 Example : backup-001 | string | |
| policy_category required | Backup 정책 카테고리 Example : AGENTLESS | enum (AGENTLESS, AGENT) | |
| policy_type required | Backup 정책 유형 Example : VM_IMAGE | enum (VM_IMAGE, FILESYSTEM) | |
| region optional | 위치 Example : kr-west1 | any of [string, null] | |
| retention_period optional | Backup 보관 기간 Example : WEEK_2 | enum (WEEK_2, MONTH_1, MONTH_3, MONTH_6, YEAR_1) | WEEK_2 |
| schedules required | 스케줄 목록 | array[BackupScheduleCreateRequest] | |
| server_category required | 대상 서버 카테고리 Example : VIRTUAL_SERVER | GPU_SERVER | BAREMETAL_SERVER | enum (VIRTUAL_SERVER, GPU_SERVER, BAREMETAL_SERVER) | |
| server_guid optional | Backup 서버 GUID Example : 9ab33c66-3dbd-46cd-b0af-abccd3eb3170 | any of [string, null] | |
| server_uuid required | Backup 서버 UUID Example : 89f5ef44-1021-4a5c-8e06-fbb289eac366 | string | |
| tags optional | any of [array[Tag], null] |
| Name | Description | Schema | Default |
|---|---|---|---|
| dr_enabled optional | DR 사용 여부 Example : False | any of [boolean, null] | |
| encrypt_enabled optional | 암호화 사용 여부 Example : True | boolean | True |
| filesystem_paths optional | 백업 대상 파일 시스템 경로 Example : ['/aaa', '/bbb'] | any of [array[string], null] | |
| name required | Backup명 Example : backup-001 | string | |
| policy_category required | Backup 정책 카테고리 Example : AGENTLESS | enum (AGENTLESS, AGENT) | |
| policy_type required | Backup 정책 유형 Example : VM_IMAGE | enum (VM_IMAGE, FILESYSTEM) | |
| region optional | 위치 Example : kr-west1 | any of [string, null] | |
| retention_period optional | Backup 보관 기간 Example : WEEK_2 | enum (WEEK_2, MONTH_1, MONTH_3, MONTH_6, YEAR_1) | WEEK_2 |
| schedules required | 스케줄 목록 | array[BackupScheduleCreateRequest] | |
| server_category required | 대상 서버 카테고리 Example : VIRTUAL_SERVER | GPU_SERVER | BAREMETAL_SERVER | enum (VIRTUAL_SERVER, GPU_SERVER, BAREMETAL_SERVER) | |
| server_guid optional | Backup 서버 GUID Example : 9ab33c66-3dbd-46cd-b0af-abccd3eb3170 | any of [string, null] | |
| server_uuid required | Backup 서버 UUID Example : 89f5ef44-1021-4a5c-8e06-fbb289eac366 | string | |
| tags optional | any of [array[Tag], null] |
| Name | Description | Schema | Default |
|---|---|---|---|
| backup_agent_id optional | Backup Agent ID Example : BACKUP_AGENT-abcd | any of [string, null] | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| encrypt_enabled optional | 암호화 사용 여부 Example : False | any of [boolean, null] | |
| filesystem_paths optional | 백업 대상 파일 시스템 경로 Example : ['/aaa', '/bbb'] | any of [array[string], null] | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | Backup명 Example : backup-001 | string | |
| policy_category required | Backup 정책 카테고리 Example : AGENTLESS | string | |
| policy_type required | Backup 정책 유형 Example : VM_IMAGE | string | |
| region optional | 위치 Example : kr-west1 | any of [string, null] | |
| retention_period required | Backup 보관 기간 Example : WEEK_2 | string | |
| role_type required | 백업 역할 유형 Example : ORIGINAL | string | |
| server_category required | 대상 서버 카테고리 Example : VIRTUAL_SERVER | GPU_SERVER | BAREMETAL_SERVER | string | |
| server_name required | Backup 서버명 Example : server-001 | string | |
| server_os_type optional | 서버 OS Type Example : WINDOWS | any of [string, null] | |
| server_region required | 위치 Example : kr-west1 | any of [string, null] | |
| server_uuid required | Backup 서버 UUID Example : 89f5ef44-1021-4a5c-8e06-fbb289eac366 | string | |
| state required | Backup 상태 Example : AVAILABLE | string |
| Name | Description | Schema | Default |
|---|---|---|---|
| backup_agent_id optional | Backup Agent ID Example : BACKUP_AGENT-abcd | any of [string, null] | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| dr_enabled optional | DR 사용 여부 Example : False | any of [boolean, null] | |
| dr_region optional | DR Region Example : kr-west1 | any of [string, null] | |
| encrypt_enabled optional | 암호화 사용 여부 Example : False | any of [boolean, null] | |
| filesystem_paths optional | 백업 대상 파일 시스템 경로 Example : ['/aaa', '/bbb'] | any of [array[string], null] | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | Backup명 Example : backup-001 | string | |
| origin_backup_id optional | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | any of [string, null] | |
| policy_category required | Backup 정책 카테고리 Example : AGENTLESS | string | |
| policy_type required | Backup 정책 유형 Example : VM_IMAGE | string | |
| region optional | 위치 Example : kr-west1 | any of [string, null] | |
| replica_backup_id optional | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | any of [string, null] | |
| retention_period required | Backup 보관 기간 Example : WEEK_2 | string | |
| role_type required | 백업 역할 유형 Example : ORIGINAL | string | |
| server_category required | 대상 서버 카테고리 Example : VIRTUAL_SERVER | GPU_SERVER | BAREMETAL_SERVER | string | |
| server_name required | Backup 서버명 Example : server-001 | string | |
| server_os_type optional | 서버 OS Type Example : WINDOWS | any of [string, null] | |
| server_region required | 위치 Example : kr-west1 | any of [string, null] | |
| server_uuid required | Backup 서버 UUID Example : 89f5ef44-1021-4a5c-8e06-fbb289eac366 | string | |
| state required | Backup 상태 Example : AVAILABLE | string |
| Name | Description | Schema | Default |
|---|---|---|---|
| contents required | Backup 이력 목록 | any of [array[BackupHistoryResponse], null] | |
| count required | 갯수 Example : 1 | integer |
| Name | Description | Schema | Default |
|---|---|---|---|
| backup_end_time required | 검색 종료 일시 Example : 2024-10-31T14:59:59Z | any of [string (date-time), null] | |
| backup_job_guid required | Backup job GUID Example : 3b1da7ba-3f38-45cb-9538-e921826f80d7 | any of [string, null] | |
| backup_job_state required | Backup 이력 상태 Example : SUCCESS | string | |
| backup_start_time required | 시작 일시 Example : 2024-09-30T15:00:00Z | any of [string (date-time), null] | |
| schedule_id required | 스케줄 ID Example : f5b8e22b-0d88-4698-9996-fb44217c8227 | string | |
| schedule_name required | 스케줄명 Example : INCREMENTAL_DAILY_15:00:00-chg4By | string |
| Name | Description | Schema | Default |
|---|---|---|---|
| contents required | 백업 Region 관계 목록 | any of [array[BackupRegionRelationshipResponse], null] | |
| count optional | 전체 개수 Example : | any of [integer, null] |
| Name | Description | Schema | Default |
|---|---|---|---|
| contents required | Backup 목록 | any of [array[BackupResponse], null] | |
| count optional | 갯수 Example : 1 | any of [integer, null] |
| Name | Description | Schema | Default |
|---|---|---|---|
| result required | 결과 Example : True | boolean |
| Name | Description | Schema | Default |
|---|---|---|---|
| from_availability_zone optional | Availability Zone명 Example : kr-west1 | any of [string, null] | |
| from_region optional | 위치 Example : kr-west1 | any of [string, null] | |
| to_availability_zone optional | Availability Zone명 Example : kr-west1 | any of [string, null] | |
| to_region optional | 위치 Example : kr-west1 | any of [string, null] |
| Name | Description | Schema | Default |
|---|---|---|---|
| dr_enabled required | DR 사용 여부 Example : False | boolean |
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | Backup명 Example : backup-001 | string | |
| policy_type required | Backup 정책 유형 Example : VM_IMAGE | string | |
| retention_period required | Backup 보관 기간 Example : WEEK_2 | string | |
| role_type required | 백업 역할 유형 Example : ORIGINAL | string | |
| server_name required | Backup 서버명 Example : server-001 | string | |
| state required | Backup 상태 Example : AVAILABLE | string |
| Name | Description | Schema | Default |
|---|---|---|---|
| contents required | Backup 복구 이력 | any of [array[BackupRestoreHistoryResponse], null] | |
| count required | 갯수 Example : 1 | integer |
| Name | Description | Schema | Default |
|---|---|---|---|
| backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | |
| backup_start_time required | Backup 일시 Example : 2024-10-28T05:38:48 | string (date-time) | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| restore_end_time required | 복구 완료 일시 Example : 2024-10-28T05:52:47 | any of [string (date-time), null] | |
| restore_server_id required | 복구 서버 ID Example : 26895cb7-2059-49e7-b6fe-9c9c4b0d3db0 | any of [string, null] | |
| restore_server_name required | 복구 서버명 Example : restoretest1 | string | |
| restore_start_time required | 복구 시작 일시 Example : 2024-10-28T05:52:47 | string (date-time) | |
| restore_state required | 복구 상태 Example : COMPLETED | enum (COMPLETED, FAILED, INPROGRESS) | |
| schedule_name required | 스케줄명 Example : INCREMENTAL_DAILY_15:00:00-chg4By | string |
| Name | Description | Schema | Default |
|---|---|---|---|
| networks optional | 복구용 네트워크 정보 | any of [array[Network], null] | |
| restore_region optional | 서버를 복구할 리전 Example : kr-west1 | any of [string, null] | |
| restore_server_name required | 복구 서버명 Example : restoretest1Pattern : ^[a-zA-Z0-9-_ ]*$Minimum length : 1Maximum length : 63 | string | |
| restore_target_id required | 복구 대상 목록 Example : ca1a8e76-af49-40ea-93f8-a5989ffe138b | string | |
| security_groups optional | Security Group ID 목록 Example : ['023c57b14f11483689338d085e061492'] | any of [array[string], null] | |
| server_type_id required | 서버 유형 ID Example : s1v1m2 | string |
| Name | Description | Schema | Default |
|---|---|---|---|
| result required | 결과 Example : True | boolean |
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | 갯수 Example : 1 | integer | |
| subnets optional | 복구 시 선택 가능한 서브넷 목록 | any of [array[BackupRestoreSubnetResponse], null] |
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : fnsd89fus0f9ds09f90dshf9dshfds09 | string | |
| cidr required | Subnet Cidr Example : 192.167.1.0/24 | string | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| gateway_ip_address required | Gateway IP Example : 192.167.1.1 | any of [string, null] | |
| id required | 서브넷 ID Example : 023c57b14f11483689338d085e061492 | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | Subnet명 Example : subnetName | string | |
| state required | Subnet 상태 Example : ACTIVE | string | |
| type required | Subnet 유형 Example : GENERAL | string | |
| vpc_id required | VPC ID Example : 7df8abb4912e4709b1cb237daccca7a8 | string | |
| vpc_name required | VPC명 Example : vpcName | string |
| Name | Description | Schema | Default |
|---|---|---|---|
| restore_target_ids required | 복구 대상 목록 Example : ['ca1a8e76-af49-40ea-93f8-a5989ffe138b'] | array[string] |
| Name | Description | Schema | Default |
|---|---|---|---|
| contents required | 복구 대상 목록 | any of [array[BackupRestoreTargetResponse], null] | |
| count required | 갯수 Example : 1 | integer |
| Name | Description | Schema | Default |
|---|---|---|---|
| backup_start_time required | 시작 일시 Example : 2024-09-30T15:00:00Z | any of [string (date-time), null] | |
| is_restore_available required | 해당 백업 Image로 복구 가능 여부 Example : true | boolean | |
| restore_target_id required | 복구 대상 목록 Example : ca1a8e76-af49-40ea-93f8-a5989ffe138b | string | |
| retention_period required | Backup 보관 기간 Example : WEEK_2 | string | |
| schedule_id required | 스케줄 ID Example : f5b8e22b-0d88-4698-9996-fb44217c8227 | string | |
| schedule_name required | 스케줄명 Example : INCREMENTAL_DAILY_15:00:00-chg4By | string | |
| usage_gb required | 백업 용량(GB) Example : 123.4 | object |
| Name | Description | Schema | Default |
|---|---|---|---|
| frequency required | 스케줄 주기 유형 Example : DAILY | enum (MONTHLY, WEEKLY, DAILY) | |
| start_day optional | Backup 스케줄 시작 요일 Example : MON | any of [enum (MON, TUE, WED, THU, FRI, SAT, SUN), null] | |
| start_time required | 스케줄 시작 시간 Example : 09:00:00 | string | |
| start_week optional | Backup 스케줄 시작 주 Example : WEEK_2 | any of [enum (WEEK_1, WEEK_2, WEEK_3, WEEK_4, WEEK_LAST), null] | |
| type required | 스케줄 유형 Example : FULL | enum (FULL, INCREMENTAL) |
| Name | Description | Schema | Default |
|---|---|---|---|
| contents required | Backup 스케줄 목록 | any of [array[BackupScheduleResponse], null] | |
| count required | 갯수 Example : 1 | integer |
| Name | Description | Schema | Default |
|---|---|---|---|
| backup_id required | Backup ID Example : 00cd2538fbf94d12b36aabbdd607e974 | string | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| frequency required | 스케줄 주기 유형 Example : DAILY | enum (MONTHLY, WEEKLY, DAILY) | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | 스케줄명 Example : INCREMENTAL_DAILY_15:00:00-chg4By | string | |
| start_day required | 스케줄 시작 요일 Example : MON | any of [string, null] | |
| start_time required | 스케줄 시작 시간 Example : 14:00:00 | any of [string, null] | |
| start_week required | 스케줄 시작 주 Example : WEEK_1 | any of [string, null] | |
| state required | Backup 스케줄 상태 Example : AVAILABLE | string | |
| type required | 스케줄 유형 Example : FULL | string |
| Name | Description | Schema | Default |
|---|---|---|---|
| contents optional | Backup 대상 목록 | any of [array[BackupTargetResponse], null] | |
| count required | 갯수 Example : 1 | integer |
| Name | Description | Schema | Default |
|---|---|---|---|
| server_guid required | Backup 서버 GUID Example : 9ab33c66-3dbd-46cd-b0af-abccd3eb3170 | any of [string, null] | |
| server_name required | Backup 서버명 Example : server-001 | string | |
| server_os_version required | 서버의 OS Type 과 버전 Example : UBUNTU 22.04 | any of [string, null] | |
| server_type required | 백업 서버 타입 Example : s1v1m2 | any of [string, null] | |
| server_uuid required | Backup 서버 UUID Example : 89f5ef44-1021-4a5c-8e06-fbb289eac366 | string |
| Name | Description | Schema | Default |
|---|---|---|---|
| result required | 결과 Example : True | boolean |
| Name | Description | Schema | Default |
|---|---|---|---|
| backup_filesystem_paths required | 백업 대상 파일 시스템 경로 Example : ['/aaa', '/bbb'] | any of [array[string], string] |
| Name | Description | Schema | Default |
|---|---|---|---|
| install_file_path required | 설치 파일 경로 Example : http://linux-agent | string |
| Name | Description | Schema | Default |
|---|---|---|---|
| schedules required | Backup 스케줄 목록 | array[BackupScheduleCreateRequest] |
| Name | Description | Schema | Default |
|---|---|---|---|
| subnet_id required | 서브넷 ID Example : 023c57b14f11483689338d085e061492 | string |
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | ID Example : | string | |
| links optional | Links Example : | any of [array[object], null] |
| Name | Description | Schema | Default |
|---|---|---|---|
| destination required | 복구될 대상 파일 시스템 경로 Example : /data | string | |
| source required | 복구할 원본 파일 시스템 경로 Example : /data | string |
| Name | Description | Schema | Default |
|---|---|---|---|
| retention_period required | Backup 보관 기간 Example : WEEK_2 | enum (WEEK_2, MONTH_1, MONTH_3, MONTH_6, YEAR_1) |
| Name | Description | Schema | Default |
|---|---|---|---|
| request_id required | 요청 ID Example : | string | |
| resource required | 자원 | ResourceInfo |
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | Example : | string | |
| value required | Example : | string |