CRMS API Document

• GET, POST, PUT, DELETE 메소드만 사용됩니다.
• 모든 API는 PATH가 /api로 시작합니다.
• 자료형 표시는 [자료형] 형태로 작성했습니다.
• GET, DELETE는 기본적으로 query 형식, POST, PUT은 기본적으로 body 형식을 따르지만 예외 케이스는 설명란에 표시했습니다.

---

API List

• 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

---

Key

Cloud key를 관리하는 API입니다.

/api/cloud/key

• GET

  등록한 클라우드 키에 대한 정보를 가져옵니다

  • Required:
    1. key_id=[string]

  • Optional:

    1. None

  • Success Response:

    • Code: 2xx
    • Content:

        { 
                        result : true, 
                        data: {
                            "vendor": "aws" | "azure",
                            "keys": keyData
                        }
                    }
                  

  • Error Response:

    • Code: 4xx
    • Content: { result : false, data: undefined }
    • 해당하는 키가 없는 경우

• POST

  클라우드키를 등록하고, 스캔을 진행합니다.

  vendor는 총 2가지를 지원하며 키에 대한 값이 필수로 들어가야 합니다.

  1. aws
     • accessKeyId
     • secretAccessKey
     • region
  2. azure
     • subscription
     • tenant_id
     • scret_key
     • client_id

• Required:

  1. vendor=[string]
  2. cloud_id=[string]
  3. keys=[key] => keys 안에 Optional에 있는 인자들이 들어갑니다.

• Optional:

  1. accessKeyId=[string]
  2. secretAccessKey=[string]
  3. region=[string]
  4. subscription=[string]
  5. tenant_id=[string]
  6. client_id=[string]

• Success Response:

  • Code: 2xx
  • Content:

      { 
                      result : true, 
                  }
                

• Error Response:

  • Code: 4xx
  • Content: { result : false, msg: Error }
  • 에러가 발생했거나 파라미터가 잘못된 형식일 경우.

• PUT

  등록된 클라우드 키를 수정합니다.

  • Required:

    1. vendor=[string]
    2. key_id=[string]
    3. keys=[key] => keys 안에 Optional에 있는 인자들이 들어갑니다.

  • Optional:

    1. accessKeyId=[string]
    2. secretAccessKey=[string]
    3. region=[string]
    4. subscription=[string]
    5. tenant_id=[string]
    6. client_id=[string]

• Success Response:

  • Code: 2xx
  • Content:

      { 
                      result : true, 
                  }
                

• Error Response:

  • Code: 4xx
  • Content: { result : false, msg: Error }
  • 에러가 발생했거나 파라미터가 잘못된 형식일 경우.
    • DELETE

  등록된 클라우드 키를 삭제합니다.

• Required:

  1. key_id=[string]

• Optional:

  1. none

• Success Response:

  • Code: 2xx
  • Content:

      { 
                      result : true, 
                  }
                

• Error Response:

  • Code: 4xx
  • Content: { result : false, msg: Error }
  • 에러가 발생했거나 파라미터가 잘못된 형식일 경우.

/api/cloud/key/list

• GET

  등록한 클라우드 키에 대한 정보를 가져옵니다.

  options를 줄 경우 해당하는 클라우드 키 정보를 가져오며 아닐 경우 모두 가져옵니다.

  • Required:
    1. None

  • Optional:

    1. options=[keyId Array]

  • Success Response:

    • Code: 2xx
    • Content:

        { 
                        result : true, 
                        keys: [{
                            "vendor": "aws" | "azure",
                            "keys": keyData
                        }]
                    }
                  

  • Error Response:

    • Code: 4xx
    • Content: { result : false, data: undefined }
    • 해당하는 키가 없는 경우

---

Etc.

기타 다른 API 리스트입니다.

- `/api/scheduler`
            - `/api/cloud/history`
            

/api/scheduler

• GET

  등록한 scheduler 데이터를 가져옵니다.

  • Required:
    1. None

  • Optional:

    1. None

  • Success Response:

    • Code: 2xx
    • Content:

        { 
                        result : true, 
                        schedulerData: [scheduler data]
                    }
                  

  • Error Response:

    • Code: 4xx
    • Content: { result : false }
      • 에러 발생시

• POST

  등록한 scheduler 데이터를 등록합니다.

  • Required:
    1. keyId=[string]
    2. time=[time] { hour: number, min: number } 형식의 시간 분
    3. type=[boolean] true => on, false => off
    4. session='server' | 'database'
    5. args=[args] => 필요한 정보들
    6. resourceId=[string]

  • Optional:

    1. None

  • Success Response:

    • Code: 2xx
    • Content:

        { 
                        result : true
                    }
                  

  • Error Response:

    • Code: 4xx
    • Content: { result : false }
    • 에러 발생시

• DELETE

  등록한 scheduler 데이터를 삭제합니다.

  • Required:
    1. schedulerId=[string]

  • Optional:

    1. None

  • Success Response:

    • Code: 2xx
    • Content:

        { 
                        result : true
                    }
                  

  • Error Response:

    • Code: 4xx
    • Content: { result : false }
    • 에러 발생시

/api/cloud/history

• GET

  해당하는 클라우드 History를 가져옵니다.

  • Required:
    1. None

  • Optional:

    1. key_id=[string]
    2. count=[number] => 가져올 개수

  • Success Response:

    • Code: 2xx
    • Content:

        { 
                        result : true, 
                        history: [History data]
                    }
                  

  • Error Response:

    • Code: 4xx
    • Content: { result : false }
    • 에러 발생시