GET
, POST
, PUT
, DELETE
메소드만 사용됩니다./api
로 시작합니다.[자료형]
형태로 작성했습니다.GET
, DELETE
는 기본적으로 query 형식, POST
, PUT
은 기본적으로 body 형식을 따르지만 예외 케이스는 설명란에 표시했습니다.Cloud Resource
/api/cloud/data
/api/cloud/data/:resource
/api/cloud/data/:resource/etc/:func
Key
/api/cloud/key
/api/cloud/key/list
Etc.
/api/scheduler
/api/cloud/history
Cloud key를 관리하는 API입니다.
/api/cloud/key
GET
등록한 클라우드 키에 대한 정보를 가져옵니다
key_id=[string]
Optional:
Success Response:
{
result : true,
data: {
"vendor": "aws" | "azure",
"keys": keyData
}
}
Error Response:
{ result : false, data: undefined }
POST
클라우드키를 등록하고, 스캔을 진행합니다.
vendor는 총 2가지를 지원하며 키에 대한 값이 필수로 들어가야 합니다.
Required:
vendor=[string]
cloud_id=[string]
keys=[key]
=> keys 안에 Optional에 있는 인자들이 들어갑니다.Optional:
accessKeyId=[string]
secretAccessKey=[string]
region=[string]
subscription=[string]
tenant_id=[string]
client_id=[string]
Success Response:
{
result : true,
}
Error Response:
{ result : false, msg: Error }
PUT
등록된 클라우드 키를 수정합니다.
Required:
vendor=[string]
key_id=[string]
keys=[key]
=> keys 안에 Optional에 있는 인자들이 들어갑니다.Optional:
accessKeyId=[string]
secretAccessKey=[string]
region=[string]
subscription=[string]
tenant_id=[string]
client_id=[string]
Success Response:
{
result : true,
}
Error Response:
{ result : false, msg: Error }
DELETE
등록된 클라우드 키를 삭제합니다.
Required:
key_id=[string]
Optional:
none
Success Response:
{
result : true,
}
Error Response:
{ result : false, msg: Error }
/api/cloud/key/list
GET
등록한 클라우드 키에 대한 정보를 가져옵니다.
options
를 줄 경우 해당하는 클라우드 키 정보를 가져오며 아닐 경우 모두 가져옵니다.
Optional:
options=[keyId Array]
Success Response:
{
result : true,
keys: [{
"vendor": "aws" | "azure",
"keys": keyData
}]
}
Error Response:
{ result : false, data: undefined }
기타 다른 API 리스트입니다.
- `/api/scheduler`
- `/api/cloud/history`
/api/scheduler
GET
등록한 scheduler 데이터를 가져옵니다.
Optional:
Success Response:
{
result : true,
schedulerData: [scheduler data]
}
Error Response:
{ result : false }
POST
등록한 scheduler 데이터를 등록합니다.
keyId=[string]
time=[time]
{ hour: number, min: number }
형식의 시간 분 type=[boolean]
true => on, false => offsession='server' | 'database'
args=[args]
=> 필요한 정보들resourceId=[string]
Optional:
Success Response:
{
result : true
}
Error Response:
{ result : false }
DELETE
등록한 scheduler 데이터를 삭제합니다.
schedulerId=[string]
Optional:
Success Response:
{
result : true
}
Error Response:
{ result : false }
/api/cloud/history
GET
해당하는 클라우드 History를 가져옵니다.
Optional:
key_id=[string]
count=[number]
=> 가져올 개수Success Response:
{
result : true,
history: [History data]
}
Error Response:
{ result : false }