/get API alpha

CLI m2 get 와 대응되는 API이다.

명령어 관련 URL 은 아래와 같다.

http://{M2-IP:env.manager.api.port}/get/...

See also

  • env.manager.api.port - api

라이선스 조회

연동 중인 라이선스 정보를 열람한다.

GET /get/license

Response code

설명

200

유효한 인증서

500

인증서 만료됨

응답은 아래와 같다.

{
  "status": "OK",
  "version": "1.1.2",
  "result": {
    "Name": "WineSOFT",
    "Type": "Site",
    "SerialNumber": "KR200039605",
    "Status": "Available",
    "AllowedFeatures": "ALL",
    "Validity": {
      "NotBefore": "20200409150000Z",
      "NotAfter": "20230410145959Z",
      "RemainDays": 123
    }
  }
}

설정 조회

로딩된 setting.json 을 열람한다.

Note

설정은 2가지로 형태로 구분된다.

  • service (기본) 서비스에 반영된 설정

  • artifact 설정 리로드가 요청 되었지만 재시작이 필요한 설정목록 등의 변경등으로 서비스에 반영되지 않은 형상 (재가동시 반영된다.)

# running 조회
GET /get/setting
GET /get/setting/running
GET /get/setting.env
GET /get/setting.functions.network.http
GET /get/setting.hosting[example.com]
GET /get/setting.hosting[name=example.com]
GET /get/setting.hosting[0]

# artifact 조회
GET /get/setting/artifact
GET /get/setting[example.com]/artifact
GET /get/setting[name=example.com]/artifact
GET /get/setting[0]/artifact

Response code

설명

200

성공

400

실패. 잘못된 호출

404

대응되는 설정 없음. 특히 hosting[]

500

내부 설정로딩 오류

응답은 아래와 같이 전체 또는 setting 의 일부가 제공된다.

{
  "meta": {
    ...
  },
  "env": {
    ...
  },
  "functions": {
    ...
  },
  "hosting[]": [
    ...
  ]
}

호스팅 요약

서비스 중인 가상호스트 정보를 간략히 요약한다.

GET /get/hosting
GET /get/hosting[example.com]
GET /get/hosting[name=example.com]
GET /get/hosting[0]

Response code

설명

200

성공

404

호스팅 없음

응답은 아래와 같다.

{
  "status": "OK",
  "version": "1.1.2",
  "result": [
    {
      "name": "example.com",
      "origin": [ "192.168.0.10", "192.168.0.11" ],
      "functions": [ "dims", "pagedesk", "pagemixed" ]
    },
    {
      "name": "bar.com",
      "origin": [ "internal.bar.com" ],
      "functions": [ "dims", "aws_s3" ]
    }
  ]
}

HTTPS 서비스 조회

로딩된 인증서 서비스의 유효성을 테스트한다.

GET /get/https

Response code

설명

200

모든 HTTPS 서비스 정상

204

HTTPS 서비스 없음

501

정상동작하지 않는 HTTPS 서비스 존재

응답은 아래와 같다.

{
  "status": "OK",
  "version": "1.1.2",
  "result": [
    {
      "name": "example.com",
      "enable": true,
      "https": [
        {
          "cert": "/usr/ssl/example.com/cert.pem",
          "key": "/usr/ssl/example.com/certkey.pem",
          "ca": "/usr/ssl/example.com/CA.pem"
        }
      ]
    },
    {
      "name": "sample.com",
      "enable": false,
      "error": "Unable to find valid certification path",
      "https": [
        {
          "cert": "/usr/ssl/example.com/cert.pem",
          "key": "/usr/ssl/example.com/certkey.pem",
          "ca": "/usr/ssl/example.com/CA.pem"
        }
      ]
    }
  ]
}