http API Endpoint
리전 | 엔드포인트 |
---|---|
한국(판교) 리전 | https://kr1-api-sysmon.cloud.toast.com |
한국(평촌) 리전 | https://kr2-api-sysmon.cloud.toast.com |
미국 리전 | https://us1-api-sysmon.cloud.toast.com |
일본 리전 | https://jp1-api-sysmon.cloud.toast.com |
[URL]
[GET,POST] /prometheus/{prometheus-api-endpoint}
Content-Type: application/json
[Request Header]
헤더 이름 | 값 | 필수 | 비고 |
---|---|---|---|
X-TC-APP-KEY | projectAppkey | O | Monitoring > System Monitoring의 우측 상단 URL & Appkey에서 확인 가능합니다. |
curl "https://kr1-api-sysmon.cloud.toast.com/prometheus/api/v1/series?match[]=query&start=1621894796&end=1621905566" -v -H'X-TC-APP-KEY:appkey'
{
"status": "success",
"data": [
{
"__name__": "name",
"domainname": "(none)",
"instance": "instance",
"job": "job",
"machine": "x86_64",
"nodename": "nodename",
"openmetrics_id": "uuid",
"release": "3.10.0-1127.19.1.el7.x86_64",
"sysname": "Linux",
"version": "#1 SMP Tue Aug 25 17:23:54 UTC 2020"
},
{
"__name__": "name",
"domainname": "(none)",
"instance": "instance",
"job": "job",
"machine": "x86_64",
"nodename": "nodename",
"openmetrics_id": "uuid",
"release": "3.10.0-1127.18.2.el7.x86_64",
"sysname": "Linux",
"version": "#1 SMP Sun Jul 26 15:27:06 UTC 2020"
}
]
}
자세한 내용은 Prometheus HTTP API를 참고하시기 바랍니다.
Method | endpoint |
---|---|
GET | /prometheus/api/v1/query |
POST | /prometheus/api/v1/query |
GET | /prometheus/api/v1/query_range |
POST | /prometheus/api/v1/query_range |
GET | /prometheus/api/v1/series |
POST | /prometheus/api/v1/series |
GET | /prometheus/api/v1/labels |
POST | /prometheus/api/v1/labels |
GET | /prometheus/api/v1/label/{label_name}/values |
GET | /prometheus/api/v1/metadata |
response code | 설명 |
---|---|
401 | Appkey가 입력되지 않았거나 입력된 Appkey가 유효하지 않습니다. |
403 | 접근이 불가능한 Project에 접근 시도했습니다. |
[URL]
[GET] /v1.0/projects/{projectId}/jobs
[Request Header]
헤더 이름 | 값 | 필수 | 비고 |
---|---|---|---|
X-TC-APP-KEY | projectAppkey | O | Monitoring > System Monitoring의 우측 상단 URL & Appkey에서 확인 가능합니다. |
X-SYSMON-REGION | regionCode | O | 조회하고자 하는 region의 코드를 입력합니다.(kr, kr2, jp, us) |
curl -i -X GET \
-H "X-TC-APP-KEY:appkey" \
-H "X-SYSMON-REGION:kr" \
'https://kr1-api-sysmon.cloud.toast.com/v1.0/projects/{projectId}/jobs'
키 | 설명 |
---|---|
header.isSuccessful | API 호출 성공 여부 |
header.resultCode | API 호출 결과 코드 |
header.resultMessage | API 호출 결과 메세지 |
body[].jobId | 작업 공간 ID |
body[].projectId | 프로젝트 ID |
body[].jobName | 작업 공간 이름 |
body[].metricsPath | 작업 공간 URL 경로 |
body[].description | 작업 공간 설명 |
body[].lstModifier | 최근 수정자 UUID |
body[].lstModYmdt | 최근 수정 일자 |
body[].reservedJobCd | 작업 공간 생성 유형 (null이면 사용자 직접 생성) |
[예시]
{
"header":{
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body":[
{
"jobId": "jobId",
"projectId": "projectId",
"jobName": "jobName",
"metricsPath": "/metricPath",
"description": "description",
"lstModifier": "lstModifier",
"lstModYmdt": "2021-08-17T10:32:09",
"reservedJobCd": null
}
]
}
[URL]
[POST] /v1.0/projects/{projectId}/jobs
[Request Header]
헤더 이름 | 값 | 필수 | 비고 |
---|---|---|---|
X-TC-APP-KEY | projectAppkey | O | Monitoring > System Monitoring의 우측 상단 URL & Appkey에서 확인 가능합니다. |
X-SYSMON-REGION | regionCode | O | 작업 공간을 생성하고자 하는 region의 코드를 입력합니다.(kr, kr2, jp, us) |
Content-Type | content Type | O | application/json |
[Request Body]
키 | 값 | 필수 | 비고 |
---|---|---|---|
jobName | 작업 공간 이름 | O | |
metricsPath | 작업 공간 URL 경로 | O | |
description | 작업 공간 설명 |
[오류 코드]
response code | resultCode | resultMessage | 설명 |
---|---|---|---|
200 | -40001 | ALREADY_EXIST | 입력한 값이 이미 존재합니다. |
200 | -40002 | BAD_INPUT_VALUE | API 입력값이 잘못되었습니다. |
200 | -50000 | INTERNAL_SERVER_ERROR | 서버 에러가 발생하였습니다. |
curl -i -X POST \
-H "X-TC-APP-KEY:appkey" \
-H "X-SYSMON-REGION:kr" \
-H "Content-Type:application/json" \
-d \
'{"jobName": "jobName",
"metricsPath": "/metricPath",
"description": "description"
} ' \
'https://kr1-api-sysmon.cloud.toast.com/v1.0/projects/{projectId}/jobs'
키 | 설명 |
---|---|
header.isSuccessful | API 호출 성공 여부 |
header.resultCode | API 호출 결과 코드 |
header.resultMessage | API 호출 결과 메세지 |
body.jobId | 생성된 작업 공간 ID |
body.projectId | 프로젝트 ID |
body.jobName | 생성된 작업 공간 이름 |
body.metricsPath | 생성된 작업 공간 URL 경로 |
body.description | 생성된 작업 공간 설명 |
body.lstModifier | 최근 수정자 UUID |
body.lstModYmdt | 최근 수정 일자 |
body.reservedJobCd | 작업 공간 생성 유형 (null이면 사용자 직접 생성) |
[예시]
{
"header":{
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body":{
"jobId": "jobId",
"projectId": "projectId",
"jobName": "jobName",
"metricsPath": "/metricsPath",
"description": "description",
"lstModifier": null,
"lstModYmdt": "2021-08-17T10:30:06",
"reservedJobCd": null
}
}
[URL]
[GET] /v1.0/projects/{projectId}/jobs/{jobId}
[Request Header]
헤더 이름 | 값 | 필수 | 비고 |
---|---|---|---|
X-TC-APP-KEY | projectAppkey | O | Monitoring > System Monitoring의 우측 상단 URL & Appkey에서 확인 가능합니다. |
curl -i -X GET \
-H "X-TC-APP-KEY:appkey" \
'https://kr1-api-sysmon.cloud.toast.com/v1.0/projects/{projectId}/jobs/{jobId}'
키 | 설명 |
---|---|
header.isSuccessful | API 호출 성공 여부 |
header.resultCode | API 호출 결과 코드 |
header.resultMessage | API 호출 결과 메세지 |
body.jobId | 작업 공간 ID |
body.projectId | 프로젝트 ID |
body.jobName | 작업 공간 이름 |
body.metricsPath | 작업 공간 URL 경로 |
body.description | 작업 공간 설명 |
body.lstModifier | 최근 수정자 UUID |
body.lstModYmdt | 최근 수정 일자 |
body.reservedJobCd | 작업 공간 생성 유형 (null이면 사용자 직접 생성) |
[예시]
{
"header":{
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body":{
"jobId": "jobId",
"projectId": "projectId",
"jobName": "jobName",
"metricsPath": "/metricPath",
"description": "description",
"lstModifier": "lstModifier",
"lstModYmdt": "2021-08-17T10:32:09",
"reservedJobCd": null
}
}
[URL]
[PUT] /v1.0/projects/{projectId}/jobs/{jobId}
[Request Header]
헤더 이름 | 값 | 필수 | 비고 |
---|---|---|---|
X-TC-APP-KEY | projectAppkey | O | Monitoring > System Monitoring의 우측 상단 URL & Appkey에서 확인 가능합니다. |
Content-Type | content Type | O | application/json |
[Request Body]
키 | 값 | 필수 | 비고 |
---|---|---|---|
metricsPath | 작업 공간 URL 경로 | O | |
description | 작업 공간 설명 |
[오류 코드]
response code | resultCode | resultMessage | 설명 |
---|---|---|---|
200 | -40002 | BAD_INPUT_VALUE | API 입력값이 잘못되었습니다. |
200 | -40006 | NOT_FOUND_JOB | 입력한 jobId가 없습니다. |
200 | -40012 | SYSTEM_RESERVED_JOB | 기본 작업 공간은 수정할 수 없습니다. |
200 | -50000 | INTERNAL_SERVER_ERROR | 서버 에러가 발생하였습니다. |
curl -i -X PUT \
-H "X-TC-APP-KEY:appkey" \
-H "Content-Type:application/json" \
-d \
'{
"metricsPath": "/updatemetricsPath",
"description": "updatedescription"
} ' \
'https://kr1-api-sysmon.cloud.toast.com/v1.0/projects/aOpreudC/jobs/{jobId}'
키 | 설명 |
---|---|
header.isSuccessful | API 호출 성공 여부 |
header.resultCode | API 호출 결과 코드 |
header.resultMessage | API 호출 결과 메세지 |
body.jobId | 작업 공간 ID |
body.projectId | 프로젝트 ID |
body.jobName | 작업 공간 이름 |
body.metricsPath | 수정된 작업 공간 URL 경로 |
body.description | 수정된 작업 공간 설명 |
body.lstModifier | 최근 수정자 UUID |
body.lstModYmdt | 최근 수정 일자 |
body.reservedJobCd | 작업 공간 생성 유형 (null이면 사용자 직접 생성) |
[예시]
{
"header":{
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body":{
"jobId": "jobId",
"projectId": "projectId",
"jobName": "jobName",
"metricsPath": "/updatemetricsPath",
"description": "updatedescription",
"lstModifier": null,
"lstModYmdt": "2021-08-17T10:35:06",
"reservedJobCd": null
}
}
[URL]
[DELETE] /v1.0/projects/{projectId}/jobs/{jobId}
[Request Header]
헤더 이름 | 값 | 필수 | 비고 |
---|---|---|---|
X-TC-APP-KEY | projectAppkey | O | Monitoring > System Monitoring의 우측 상단 URL & Appkey에서 확인 가능합니다. |
[오류 코드]
response code | resultCode | resultMessage | 설명 |
---|---|---|---|
200 | -40006 | NOT_FOUND_JOB | 입력한 jobId가 없습니다. |
200 | -40012 | SYSTEM_RESERVED_JOB | 기본 작업 공간은 삭제할 수 없습니다. |
200 | -50000 | INTERNAL_SERVER_ERROR | 서버 에러가 발생하였습니다. |
curl -i -X DELETE \
-H "X-TC-APP-KEY:appkey" \
'https://kr1-api-sysmon.cloud.toast.com/v1.0/projects/aOpreudC/jobs/{jobId}'
키 | 설명 |
---|---|
header.isSuccessful | API 호출 성공 여부 |
header.resultCode | API 호출 결과 코드 |
header.resultMessage | API 호출 결과 메세지 |
body | 삭제된 작업 공간 ID |
[예시]
{
"header":{
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": "jobId"
}
response code | message | 설명 |
---|---|---|
401 | Appkey가 입력되지 않았거나 입력된 Appkey가 유효하지 않습니다. | |
403 | 접근이 불가능한 Project에 접근 시도했습니다. |
[URL]
[GET] /v1.0/projects/{projectId}/jobs/{jobId}/targets
[Request Header]
헤더 이름 | 값 | 필수 | 비고 |
---|---|---|---|
X-TC-APP-KEY | projectAppkey | O | Monitoring > System Monitoring의 우측 상단 URL & Appkey에서 확인 가능합니다. |
curl -i -X GET \
-H "X-TC-APP-KEY:appkey" \
'https://kr1-api-sysmon.cloud.toast.com/v1.0/projects/{projectId}/jobs/{jobId}/targets
키 | 설명 |
---|---|
header.isSuccessful | API 호출 성공 여부 |
header.resultCode | API 호출 결과 코드 |
header.resultMessage | API 호출 결과 메세지 |
body[].targetId | 수집 대상 ID |
body[].jobId | 작업 공간 ID |
body[].hostId | 수집 대상 호스트 ID |
body[].port | 수집 대상 포트 번호 |
body[].resultCd | 수집 대상 연결 결과 코드 |
body[].failReason | 수집 대상 연결 실패 이유 |
body[].mntrnStatCd | 수집 대상 모니터링 상태 코드 |
body[].lstModifier | 최근 수정자 UUID |
body[].lstModYmdt | 최근 수정 일자 |
body[].hostNm | 수집 대상 이름 |
body[].svrIp | 수집 대상 IP |
[예시]
{
"header":{
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body":[
{
"targetId": "targetId",
"jobId": "jobId",
"hostId": "hostId",
"port": 9100,
"resultCd": 0,
"failReason": null,
"mntrnStatCd": null,
"lstModifier": "lstModifier",
"lstModYmdt": "2021-08-17T11:06:29",
"hostNm": "hostNm",
"svrIp": "192.168.0.5"
}
]
}
[URL]
[GET] /v1.0/projects/{projectId}/servers
[Request Header]
헤더 이름 | 값 | 필수 | 비고 |
---|---|---|---|
X-TC-APP-KEY | projectAppkey | O | Monitoring > System Monitoring의 우측 상단 URL & Appkey에서 확인 가능합니다. |
X-SYSMON-REGION | regionCode | O | 조회하고자 하는 region의 코드를 입력합니다.(kr, kr2, jp, us) |
curl -i -X GET \
-H "X-TC-APP-KEY:appkey" \
-H "X-SYSMON-REGION:kr" \
'https://kr1-api-sysmon.cloud.toast.com/v1.0/projects/{projectId}/servers'
키 | 설명 |
---|---|
header.isSuccessful | API 호출 성공 여부 |
header.resultCode | API 호출 결과 코드 |
header.resultMessage | API 호출 결과 메세지 |
body[].hostId | 호스트 ID |
body[].hostNm | 호스트 이름 |
body[].projectId | 프로젝트 ID |
body[].svrIp | 서버 IP |
body[].instanceId | 인스턴스 ID |
[예시]
{
"header":{
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body":[
{
"hostId": "hostId",
"hostNm": "hostNm",
"svrIp": "192.168.0.5",
"projectId": "projectId",
"instanceId": "instanceId"
}
]
}
[URL]
[POST] /v1.0/projects/{projectId}/jobs/{jobId}/targets
[Request Header]
헤더 이름 | 값 | 필수 | 비고 |
---|---|---|---|
X-TC-APP-KEY | projectAppkey | O | Monitoring > System Monitoring의 우측 상단 URL & Appkey에서 확인 가능합니다. |
Content-Type | content Type | O | application/json |
[Request Body]
키 | 값 | 필수 | 비고 |
---|---|---|---|
hostId | 수집 대상으로 추가할 호스트 ID | O | /v1.0/projects/{projectId}/servers로 조회한 호스트 ID 입니다. |
port | 수집 대상 PORT | O |
[오류 코드]
response code | resultCode | resultMessage | 설명 |
---|---|---|---|
200 | -40002 | BAD_INPUT_VALUE | API 입력값이 잘못되었습니다. |
200 | -40004 | INVALID_HOST_OR_PROJECT | 입력한 hostId나 projectId가 잘못되었습니다. |
200 | -40006 | NOT_FOUND_JOB | 입력한 jobId가 없습니다. |
200 | -40012 | SYSTEM_RESERVED_JOB | 기본 작업 공간엔 추가할 수 없습니다. |
200 | -50000 | INTERNAL_SERVER_ERROR | 서버 에러가 발생하였습니다. |
curl -i -X POST \
-H "X-TC-APP-KEY:appkey" \
-H "Content-Type:application/json" \
-d \
'{"hostId": "host id",
"port": "post number"
} ' \
'https://kr1-api-sysmon.cloud.toast.com/v1.0/projects/{projectId}/jobs/{jobId}'
키 | 설명 |
---|---|
header.isSuccessful | API 호출 성공 여부 |
header.resultCode | API 호출 결과 코드 |
header.resultMessage | API 호출 결과 메세지 |
body | 생성된 수집 대상 ID |
[예시]
{
"header":{
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": "targetId"
}
[URL]
[GET] /v1.0/projects/{projectId}/jobs/{jobId}/targets/{targetId}
[Request Header]
헤더 이름 | 값 | 필수 | 비고 |
---|---|---|---|
X-TC-APP-KEY | projectAppkey | O | Monitoring > System Monitoring의 우측 상단 URL & Appkey에서 확인 가능합니다. |
curl -i -X GET \
-H "X-TC-APP-KEY:appkey" \
'https://kr1-api-sysmon.cloud.toast.com/v1.0/projects/{projectId}/jobs/{jobId}/targets/{targetId}
키 | 설명 |
---|---|
header.isSuccessful | API 호출 성공 여부 |
header.resultCode | API 호출 결과 코드 |
header.resultMessage | API 호출 결과 메세지 |
body.targetId | 수집 대상 ID |
body.jobId | 작업 공간 ID |
body.hostId | 수집 대상 호스트 ID |
body.port | 수집 대상 포트 번호 |
body.resultCd | 수집 대상 연결 결과 코드 |
body.failReason | 수집 대상 연결 실패 이유 |
body.mntrnStatCd | 모니터링 상태 코드 |
body.lstModifier | 최근 수정자 UUID |
body.lstModYmdt | 최근 수정 일자 |
body.hostNm | 수집 대상 이름 |
body.svrIp | 수집 대상 IP |
[예시]
{
"header":{
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body":{
"targetId": "targetId",
"jobId": "jobId",
"hostId": "hostId",
"port": 9100,
"resultCd": 0,
"failReason": null,
"mntrnStatCd": null,
"lstModifier": "lstModifier",
"lstModYmdt": "2021-08-17T11:06:29",
"hostNm": "hostNm",
"svrIp": "192.168.0.5"
}
}
[URL]
[DELETE] /v1.0/projects/{projectId}/jobs/{jobId}/targets/{targetId}
[Request Header]
헤더 이름 | 값 | 필수 | 비고 |
---|---|---|---|
X-TC-APP-KEY | projectAppkey | O | Monitoring > System Monitoring의 우측 상단 URL & Appkey에서 확인 가능합니다. |
[오류 코드]
response code | resultCode | resultMessage | 설명 |
---|---|---|---|
200 | -40006 | NOT_FOUND_JOB | 입력한 jobId가 없습니다. |
200 | -40007 | NOT_FOUND_TARGET | 입력한 targetId가 없습니다. |
200 | -40012 | SYSTEM_RESERVED_JOB | 기본 작업 공간에서 삭제할 수 없습니다. |
200 | -50000 | INTERNAL_SERVER_ERROR | 서버 에러가 발생하였습니다. |
curl -i -X DELETE \
-H "X-TC-APP-KEY:appkey" \
'https://kr1-api-sysmon.cloud.toast.com/v1.0/projects/{projectId}/jobs/{jobId}/targets/{targetId}'
키 | 설명 |
---|---|
header.isSuccessful | API 호출 성공 여부 |
header.resultCode | API 호출 결과 코드 |
header.resultMessage | API 호출 결과 메세지 |
body | 삭제된 수집 대상 ID |
[예시]
{
"header":{
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": "targetId"
}