Usage Reporting API 가이드

1. 문서 개요

1.1. 목적

본 문서는 PaaS-TA Usage Reporting의 API 호출에 대해 기술하였다.

1.2. 범위

본 문서에서는 PaaS-TA Usage Reporting의 API의 인터페이스 정보 및 호출 방법에 대해 작성되었다.

2. GET org_app_usage_summary

해당 조회 월 1일부터 현재 시간까지의 org / space 에서 동작 중인 각 app의 메모리 사용량을 조회한다. space_id parameter 가 ‘all’ 인 경우, org 전체의 값을 리턴한다.

2.1. Request Parameters

이름
설명
기본값
유효값
예시값
org_id
조직 아이디
-
org_guid
‘7726b51e-b7b4-4b9f-a1cf-78eab2710e2d’
space_id
스페이스 아이디
-
space_guid, ‘all’
‘b5e7f478-6f26-457f-97ce-c57a31afe157’

2.2. cURL

1
curl -i -X GET http://paasta-usage-reporting.your-domain.com/v1/org/:org_id/space/:space_id
Copied!

2.3. Response body

프로퍼티 이름
설명
유효값
예시값
org_id
조직 guid
org_guid
‘7726b51e-b7b4-4b9f-a1cf-78eab2710e2d’
from
집계 시작 timestamp
timestamp
1470009600000
end
집계 종료 timestamp
timestamp
1472192759652
sum
합계
number (소수1자리)
6.5
app_usage_array
사용량 배열 객체
array
N/A
space_id
스페이스 guid
space_guid
‘7b85dc3f-85f0-40bc-8532-0dabd0bc7bae’
app_id
app guid (CF이벤트)
app guid
‘4566f4e8-ec03-4aae-a006-3d6b12ce7a9c’
app_name
CF push 시 정의된 앱 명칭
String
‘java_demo’
app_state
앱의 현재 상태
‘STARTED’,’STOPED’,’PENDDING’
‘STARTED’
app_instance
할당된 인스턴스(CF이벤트 기준)
number (정수값)
1
app_memory
할당된 메모리(CF이벤트 기준) 단위 M
512, 1024
512
app_usage
현재까지의 집계 사용량
number (소수1자리)
8.5
1
{
2
"org_id": "e655c52a-6ee5-4cf1-89d4-eac31fb6b36f",
3
"from": 1470009600000,
4
"to": 1472192759652,
5
"sum": 6,
6
"appUsage":[
7
{
8
"space_id": "b5e7f478-6f26-457f-97ce-c57a31afe157",
9
"app_id": "657c7e08-34eb-4d69-88a4-61262ce07685",
10
"app_name": "spring-crt",
11
"app_state": "STARTED",
12
"app_instance": 1,
13
"app_memory": 512,
14
"app_usage": 0.5
15
},
16
{
17
"space_id": "7b85dc3f-85f0-40bc-8532-0dabd0bc7bae",
18
"app_id": "204f83ba-7b3a-4627-9b51-168237fd1695",
19
"app_name": "node_demo",
20
"app_state": "STARTED",
21
"app_instance": 1,
22
"app_memory": 512,
23
"app_usage": 1
24
}
25
]
26
}
Copied!

3. GET monthly_org_usage

org /space 내 동작 중인 각 app의 집계 기간내 월별 메모리 사용량을 조회한다.
space_id parameter 가 ‘all’ 인 경우, org 전체의 값을 리턴한다.

3.1. Request Parameters

이름
설명
기본값
유효값
예시값
org_id
조직 아이디
-
org_guid
‘7726b51e-b7b4-4b9f-a1cf-78eab2710e2d’
space_id
스페이스 아이디
-
space_guid,‘all’
‘b5e7f478-6f26-457f-97ce-c57a31afe157’
from_month
집계 시작 년월 yyyymm
-
yyyymm 형식 String
‘201601’
to_month
집계 종료 년월 yyyymm
-
yyyymm 형식 String
‘201603’

3.2. cURL

1
curl -i -X GET http://pasta-usage-reporting.your-domain.com/v1/org/:org_id/space/:space_id/from/:from_month/to/:to_month
Copied!

3.3. Response body

프로퍼티 이름
설명
유효값
예시값
org_id
조직 guid
org_guid
‘7726b51e-b7b4-4b9f-a1cf-78eab2710e2d’
from_month
집계 시작 년월 yyyymm
yyyymm 형식String
‘201601’
to_month
집계 종료 년월yyyymm
yyyymm 형식String
‘201603’
sum
집계 기간 사용량 합계
number
6.5
monthly_usage_arr
월별 사용량 배열 객체
array
N/A
month
집계 월
String
‘201603’
sum
월 사용량 합계
number
6.5
spaces
스페이스 배열 객체
-
N/A
space_id
스페이스 guid
space_guid
‘7b85dc3f-85f0-40bc-8532-0dabd0bc7bae’
sum
스페이스 사용량 합계
-
-
app_usage_arr
앱 사용량 배열 객체
-
-
app_id
앱 guid
app guid
‘4566f4e8-ec03-4aae-a006-3d6b12ce7a9c’
app_name
앱 명칭
string
‘java_demo’
app_instance
인스턴스(CF이벤트 기준)
number
1
app_memory
메모리(CF이벤트 기준)
512,1024
512
app_usage
현재까지의 집계 사용량
number
8.5
total_app_usage_arr
집계 기간내 앱별 총사용량 배열 객체
-
-
app_id
앱 guid
app guid
‘4566f4e8-ec03-4aae-a006-3d6b12ce7a9c’
app_name
앱 명칭
string
‘java_demo’
app_usage
집계 기간내 앱별 총사용량
number
3345
1
{
2
"org_id": "e655c52a-6ee5-4cf1-89d4-eac31fb6b36f",
3
"from_month": "201601",
4
"to_month": "201602",
5
"sum": 8,
6
"monthly_usage_arr": [{
7
"month": "201601",
8
"sum": 5,
9
"spaces": [
10
{
11
"space_id": "7b85dc3f-85f0-40bc-8532-0dabd0bc7bae",
12
"sum": 2,
13
"app_usage": [
14
{
15
"app_id": "204f83ba-7b3a-4627-9b51-168237fd1695",
16
"app_name": "node_demo",
17
"app_instance": 1,
18
"app_memory": 512,
19
"app_usage": 1
20
},
21
{
22
"app_id": "4566f4e8-ec03-4aae-a006-3d6b12ce7a9c",
23
"app_name": "java_demo",
24
"app_instance": 1,
25
"app_memory": 512,
26
"app_usage": 1
27
}
28
]
29
},
30
{
31
"space_id": "7b85dc3f-85f0-40bc-8532-0dabd0bc7bae",
32
"sum": 3,
33
"app_usage": [
34
{
35
"app_id": "204f83ba-7b3a-4627-9b51-168237fd1695",
36
"app_name": "node_demo",
37
"app_instance": 1,
38
"app_memory": 512,
39
"app_usage": 1
40
},
41
{
42
"app_id": "4566f4e8-ec03-4aae-a006-3d6b12ce7a9c",
43
"app_name": "java_demo",
44
"app_instance": 1,
45
"app_memory": 512,
46
"app_usage": 2
47
}
48
]
49
}
50
]
51
},
52
{
53
"month": "201602",
54
"sum": 3,
55
"spaces": [
56
{
57
"space_id": "b5e7f478-6f26-457f-97ce-c57a31afe157",
58
"sum": 0.5,
59
"app_usage": [
60
{
61
"app_id": "657c7e08-34eb-4d69-88a4-61262ce07685",
62
"app_name": "spring-crt",
63
"app_instance": 1,
64
"app_memory": 512,
65
"app_usage": 0.5
66
}
67
]
68
},
69
{
70
"space_id": "7b85dc3f-85f0-40bc-8532-0dabd0bc7bae",
71
"sum": 2.5,
72
"app_usage_arr": [
73
{
74
"app_id": "657c7e08-34eb-4d69-88a4-61262ce07685",
75
"app_name": "spring-crt",
76
"app_instance": 3,
77
"app_memory": 512,
78
"app_usage": 2.5
79
}
80
]
81
}
82
]
83
}
84
] ,
85
"total_app_usage_arr": [
86
{
87
"app_id": "657c7e08-34eb-4d69-88a4-61262ce0768",
88
"app_name": "spring-demo",
89
"app_usage": 223
90
},
91
{
92
"app_id": "7b85dc3f-85f0-40bc-8532-0dabd0bc7bae",
93
"app_name": "spring-crt",
94
"app_usage": 234
95
},
96
{
97
"app_id": "7b85dc3f-85f0-40bc-8532-0dabd0bc7bae",
98
"app_name": "node_demo",
99
"app_usage": 123
100
},
101
{
102
"app_id": "7b85dc3f-85f0-40bc-8532-0dabd0bc7bae",
103
"app_name": "java_demo",
104
"app_usage": 423
105
}
106
]
107
}
Copied!

4. GET app_monthly_usage

해당 app의 집계기간 내의 월별 메모리 사용량을 조회한다.

4.1. Request Parameters

이름
설명
기본값
유효값
예시값
org_id
조직 아이디
-
org_guid
‘7726b51e-b7b4-4b9f-a1cf-78eab2710e2d’
space_id
스페이스 아이디
-
space_guid
‘b5e7f478-6f26-457f-97ce-c57a31afe157’
app_id
앱 아이디
-
app_guid
‘204f83ba-7b3a-4627-9b51-168237fd1695’
from_month
집계 시작 년월 yyyymm
-
yyyymm 형식 String
‘201601’
to_month
집계 종료 년월 yyyymm
-
yyyymm 형식 String
‘201603’

4.2. cURL

1
curl -i -X GET http://pasta-usage-reporting.your-domain.com/v1/ org/:org_id/space/:space_id/app/:app_id/from/:from_month/to/:to_month
Copied!

4.3. Response body

프로퍼티 이름
설명
유효값
예시값
org_id
조직 아이디
org_guid
‘7726b51e-b7b4-4b9f-a1cf-78eab2710e2d'
space_id
스페이스 아이디
space_guid
‘7b85dc3f-85f0-40bc-8532-0dabd0bc7bae’
app_id
앱 guid (CF이벤트)
app_guid
‘4566f4e8-ec03-4aae-a006-3d6b12ce7a9c’
app_name
앱 명칭
string
‘java_demo’
from_month
집계 시작 년월 yyyymm
yyyymm 형식 String
‘201601’
to_month
집계 종료 년월 yyyymm
yyyymm 형식 String
‘201603’
sum
전체 사용량 합계
number
5.5
monthly_usage_arr
월별 사용량 배열 객체
array
N/A
month
집계 월 yyyymm
yyyymm 형식 String
‘201601’
app_instance
할당된 인스턴스(CF이벤트 기준)
number
1
app_memory
할당된 메모리(CF이벤트 기준)
number
512
app_usage
현재까지의 집계 사용량
number
8.5
1
{
2
"org_id": "e655c52a-6ee5-4cf1-89d4-eac31fb6b36f",
3
"space_id": "7b85dc3f-85f0-40bc-8532-0dabd0bc7bae",
4
"app_id": "e655c52a-6ee5-4cf1-89d4-eac31fb6b36f",
5
"app_name": "node_demo",
6
"from_month" : "201601",
7
"to_month" : "201608",
8
"sum": 5,
9
"monthly_usage_arr":[
10
{
11
"month" : "201601",
12
"app_instance": 1,
13
"app_memory": 512,
14
"appUsage": 5
15
},
16
{
17
"month" : "201602",
18
"app_instance": 1,
19
"app_memory": 512,
20
"appUsage": 8.5
21
}
22
]
23
}
Copied!
Last modified 1yr ago