Skip to content

Commit 32a8203

Browse files
gunlee01gunlee01
committed
[document] web apis added (user login api)
1 parent be38063 commit 32a8203

File tree

4 files changed

+165
-10
lines changed

4 files changed

+165
-10
lines changed

‎scouter.document/main/Configuration.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -351,6 +351,8 @@ public int sfa_dump_interval_ms = 10000;
351351
//miscellaneous
352352
@ConfigDesc("User ID based(0 : Remote Address, 1 : JSessionID, 2 : Scouter Cookie)")
353353
public int trace_user_mode = 2; // 0:Remote IP, 1:JSessionID, 2:SetCookie
354+
@ConfigDesc("Setting a cookie path for SCOUTER cookie when trace_user_mode is 2")
355+
public String trace_user_cookie_path = "/";
354356

355357
@ConfigDesc("Path to file creation directory of process ID file")
356358
public String counter_object_registry_path = "/tmp/scouter";

‎scouter.document/main/Configuration_kr.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -351,6 +351,8 @@ public int sfa_dump_interval_ms = 10000;
351351
//miscellaneous
352352
@ConfigDesc("User ID based(0 : Remote Address, 1 : JSessionID, 2 : Scouter Cookie)")
353353
public int trace_user_mode = 2; // 0:Remote IP, 1:JSessionID, 2:SetCookie
354+
@ConfigDesc("Setting a cookie path for SCOUTER cookie when trace_user_mode is 2")
355+
public String trace_user_cookie_path = "/";
354356

355357
@ConfigDesc("Path to file creation directory of process ID file")
356358
public String counter_object_registry_path = "/tmp/scouter";

‎scouter.document/tech/Web-API-Guide.md‎

Lines changed: 80 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,10 @@ public String net_http_api_auth_ip_header_key;
8484

8585
@ConfigDesc("Enable api access control by JSESSIONID of Cookie")
8686
public boolean net_http_api_auth_session_enabled = true;
87-
@ConfigDesc("api http session timeout")
87+
@ConfigDesc("api http session timeout(sec)")
8888
public int net_http_api_session_timeout = 3600*24;
89+
@ConfigDesc("Enable api access control by Bearer token(of Authorization http header) - get access token from /user/loginGetToken.")
90+
public boolean net_http_api_auth_bearer_token_enabled = false;
8991

9092
@ConfigDesc("api access allow ip addresses")
9193
@ConfigValueType(ValueType.COMMA_SEPARATED_VALUE)
@@ -399,21 +401,77 @@ public int log_keep_days = 30;
399401
- `serverId` : (optional if single server)
400402

401403
#### - `GET /v1/kv/{key}`
402-
- get value of given key from scouter server's key-value store
404+
- get value of given key from the scouter server's key-value store. (in the global key space)
403405
- **Auth** : required
404406
- **Path params**
405407
- `key` : (required)
406408
- **Query params**
407409
- `serverId` : (optional if single server)
408410

409411
#### - `PUT /v1/kv`
410-
- set key and value and store it to scouter server's key-value store
412+
- store it to the scouter server's key-value store. (in the global key space)
411413
- **Auth** : required
412414
- **Request body (type : application/json)**
413415
- `key` : (required)
414416
- `value` : (required)
415417
- `serverId` : (required)
416418

419+
#### - `GET /v1/kv/{keys}/:bulk`
420+
- get values of given keys from the scouter server's key-value store. (in the global key space)
421+
- **Auth** : required
422+
- **Path params**
423+
- `keys` : (required) keys by comma separator. also allowed with bracket. eg) mykey-1,mykey2 or [mykey-1,mykey2]
424+
- **Query params**
425+
- `serverId` : (optional if single server)
426+
427+
#### - `PUT /v1/kv/:bulk`
428+
- store key&values to the scouter server's key-value store. (in the global key space)
429+
- **Auth** : required
430+
- **Request body (type : application/json)**
431+
- `kvList` : (required) array of key & value
432+
- `key` : (required)
433+
- `value` : (required)
434+
- `serverId` : (required)
435+
436+
#### - `GET /v1/kv/space/{keySpace}/{key}`
437+
- get value of given key from the key space of scouter server's key-value store.
438+
- **Auth** : required
439+
- **Path params**
440+
- `keySpace` : (required)
441+
- `key` : (required)
442+
- **Query params**
443+
- `serverId` : (optional if single server)
444+
445+
#### - `PUT /v1/kv/space/{keySpace}`
446+
- store it to the key space of scouter server's key-value store
447+
- **Auth** : required
448+
- **Path params**
449+
- `keySpace` : (required)
450+
- **Request body (type : application/json)**
451+
- `key` : (required)
452+
- `value` : (required)
453+
- `serverId` : (required)
454+
455+
#### - `GET /v1/kv/space/{keySpace}/{keys}/:bulk`
456+
- get values of given keys from the key space of scouter server's key-value store
457+
- **Auth** : required
458+
- **Path params**
459+
- `keySpace` : (required)
460+
- `keys` : (required) keys by comma separator. also allowed with bracket. eg) mykey-1,mykey2 or [mykey-1,mykey2]
461+
- **Query params**
462+
- `serverId` : (optional if single server)
463+
464+
#### - `PUT /v1/kv/space/{keySpace}/:bulk`
465+
- store key&values to the key space of scouter server's key-value store
466+
- **Auth** : required
467+
- **Path params**
468+
- `keySpace` : (required)
469+
- **Request body (type : application/json)**
470+
- `kvList` : (required) array of key & value
471+
- `key` : (required)
472+
- `value` : (required)
473+
- `serverId` : (required)
474+
417475
#### - `GET /v1/object/host/realTime/top/ofObject/{objHash}`
418476
- retrieve all OS processes cpu, memory usage of the given object
419477
- **Auth** : required
@@ -422,6 +480,23 @@ public int log_keep_days = 30;
422480
- **Query params**
423481
- `serverId` : (optional if single server)
424482

483+
#### - `PUT /v1/user/loginGetToken`
484+
- login with id & password, and get bearer token.
485+
- this token required on Authorization header for authorized request.
486+
- auth header example : `Authorization: Bearer V1.B3R4FSGEF3POJ.me`
487+
- **Auth** : none
488+
- **Request body (type : application/json)**
489+
- `user` : (required)
490+
- `id` : (required)
491+
- `password` : (required)
492+
- `serverId` : (required)
425493

426-
427-
494+
#### - `PUT /v1/user/login`
495+
- login with id & password for traditional web application.
496+
- this api is answered including with SET-COOKIE response header.
497+
- **Auth** : none
498+
- **Request body (type : application/json)**
499+
- `user` : (required)
500+
- `id` : (required)
501+
- `password` : (required)
502+
- `serverId` : (required)

‎scouter.document/tech/Web-API-Guide_kr.md‎

Lines changed: 81 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ If you include this widget path when setting up a custom alarm, you can use it m
6666

6767
## Configuration
6868
```java
69+
6970
@ConfigDesc("Collector connection infos - eg) host:6100:id:pw,host2:6100:id2:pw2")
7071
@ConfigValueType(ValueType.COMMA_SEPARATED_VALUE)
7172
public String net_collector_ip_port_id_pws = "127.0.0.1:6100:admin:admin";
@@ -82,8 +83,10 @@ public String net_http_api_auth_ip_header_key;
8283

8384
@ConfigDesc("Enable api access control by JSESSIONID of Cookie")
8485
public boolean net_http_api_auth_session_enabled = true;
85-
@ConfigDesc("api http session timeout")
86+
@ConfigDesc("api http session timeout(sec)")
8687
public int net_http_api_session_timeout = 3600*24;
88+
@ConfigDesc("Enable api access control by Bearer token(of Authorization http header) - get access token from /user/loginGetToken.")
89+
public boolean net_http_api_auth_bearer_token_enabled = false;
8790

8891
@ConfigDesc("api access allow ip addresses")
8992
@ConfigValueType(ValueType.COMMA_SEPARATED_VALUE)
@@ -397,21 +400,77 @@ public int log_keep_days = 30;
397400
- `serverId` : (optional if single server)
398401

399402
#### - `GET /v1/kv/{key}`
400-
- get value of given key from scouter server's key-value store
403+
- get value of given key from the scouter server's key-value store. (in the global key space)
401404
- **Auth** : required
402405
- **Path params**
403406
- `key` : (required)
404407
- **Query params**
405408
- `serverId` : (optional if single server)
406409

407410
#### - `PUT /v1/kv`
408-
- set key and value and store it to scouter server's key-value store
411+
- store it to the scouter server's key-value store. (in the global key space)
409412
- **Auth** : required
410413
- **Request body (type : application/json)**
411414
- `key` : (required)
412415
- `value` : (required)
413416
- `serverId` : (required)
414417

418+
#### - `GET /v1/kv/{keys}/:bulk`
419+
- get values of given keys from the scouter server's key-value store. (in the global key space)
420+
- **Auth** : required
421+
- **Path params**
422+
- `keys` : (required) keys by comma separator. also allowed with bracket. eg) mykey-1,mykey2 or [mykey-1,mykey2]
423+
- **Query params**
424+
- `serverId` : (optional if single server)
425+
426+
#### - `PUT /v1/kv/:bulk`
427+
- store key&values to the scouter server's key-value store. (in the global key space)
428+
- **Auth** : required
429+
- **Request body (type : application/json)**
430+
- `kvList` : (required) array of key & value
431+
- `key` : (required)
432+
- `value` : (required)
433+
- `serverId` : (required)
434+
435+
#### - `GET /v1/kv/space/{keySpace}/{key}`
436+
- get value of given key from the key space of scouter server's key-value store.
437+
- **Auth** : required
438+
- **Path params**
439+
- `keySpace` : (required)
440+
- `key` : (required)
441+
- **Query params**
442+
- `serverId` : (optional if single server)
443+
444+
#### - `PUT /v1/kv/space/{keySpace}`
445+
- store it to the key space of scouter server's key-value store
446+
- **Auth** : required
447+
- **Path params**
448+
- `keySpace` : (required)
449+
- **Request body (type : application/json)**
450+
- `key` : (required)
451+
- `value` : (required)
452+
- `serverId` : (required)
453+
454+
#### - `GET /v1/kv/space/{keySpace}/{keys}/:bulk`
455+
- get values of given keys from the key space of scouter server's key-value store
456+
- **Auth** : required
457+
- **Path params**
458+
- `keySpace` : (required)
459+
- `keys` : (required) keys by comma separator. also allowed with bracket. eg) mykey-1,mykey2 or [mykey-1,mykey2]
460+
- **Query params**
461+
- `serverId` : (optional if single server)
462+
463+
#### - `PUT /v1/kv/space/{keySpace}/:bulk`
464+
- store key&values to the key space of scouter server's key-value store
465+
- **Auth** : required
466+
- **Path params**
467+
- `keySpace` : (required)
468+
- **Request body (type : application/json)**
469+
- `kvList` : (required) array of key & value
470+
- `key` : (required)
471+
- `value` : (required)
472+
- `serverId` : (required)
473+
415474
#### - `GET /v1/object/host/realTime/top/ofObject/{objHash}`
416475
- retrieve all OS processes cpu, memory usage of the given object
417476
- **Auth** : required
@@ -420,6 +479,23 @@ public int log_keep_days = 30;
420479
- **Query params**
421480
- `serverId` : (optional if single server)
422481

482+
#### - `PUT /v1/user/loginGetToken`
483+
- login with id & password, and get bearer token.
484+
- this token required on Authorization header for authorized request.
485+
- auth header example : `Authorization: Bearer V1.B3R4FSGEF3POJ.me`
486+
- **Auth** : none
487+
- **Request body (type : application/json)**
488+
- `user` : (required)
489+
- `id` : (required)
490+
- `password` : (required)
491+
- `serverId` : (required)
423492

424-
425-
493+
#### - `PUT /v1/user/login`
494+
- login with id & password for traditional web application.
495+
- this api is answered including with SET-COOKIE response header.
496+
- **Auth** : none
497+
- **Request body (type : application/json)**
498+
- `user` : (required)
499+
- `id` : (required)
500+
- `password` : (required)
501+
- `serverId` : (required)

0 commit comments

Comments
 (0)