AWS Mainframe Modernization Service(관리형 런타임 환경 환경 환경)는 더 이상 신규 고객에게 공개되지 않습니다. AWS Mainframe Modernization Service(관리형 런타임 환경 환경)와 유사한 기능은 AWS Mainframe Modernization Service(자체 관리형 환경)를 참조하세요. 기존 고객은 정상적으로 서비스를 계속 이용할 수 있습니다. 자세한 내용은 [AWS Mainframe Modernization 가용성 변경을](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html) 참조하세요.
기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.
# Blusam 애플리케이션 콘솔 REST 엔드포인트
이 섹션에서는 현대화된 VSAM 데이터 세트의 관리를 간소화하도록 설계된 API인 Blusam 애플리케이션 콘솔에 대해 알아볼 수 있습니다. Blusam 웹 애플리케이션의 엔드포인트는 루트 경로를 사용합니다`/bac`.
**Topics**
+ [데이터 세트 관련 엔드포인트](#ba-endpoints-bac-datasets)
+ [대량 데이터 세트 관련 엔드포인트](#ba-endpoints-bac-bulk)
+ [레코드](#ba-endpoints-bac-records)
+ [마스크](#ba-endpoints-bac-masks)
+ [기타](#ba-endpoints-bac-other)
+ [BAC 사용자 관리 엔드포인트](#ba-endpoints-bac-users)
## 데이터 세트 관련 엔드포인트
다음 엔드포인트를 사용하여 특정 데이터 세트를 만들거나 관리합니다.
**Topics**
+ [데이터 세트 생성](#ba-create-data-set)
+ [파일 업로드](#ba-upload-file)
+ [데이터 세트 로드(POST)](#ba-load-data-set-post)
+ [데이터 세트 로드(GET)](#ba-load-data-set-get)
+ [Amazon S3 버킷에서 데이터 세트를 로드할 수 있습니다](#ba-load-data-set-s3)
+ [Amazon S3 버킷으로 데이터 세트를 내보냅니다](#ba-export-data-set-s3)
+ [데이터 세트 생성](#ba-clear-data-set)
+ [데이터 스토어 삭제](#ba-delete-data-set)
+ [데이터 세트 레코드 개수](#ba-count-data-set-records)
### 데이터 세트 생성
이 엔드포인트를 사용하여 데이터 세트 정의를 만들 수 있습니다.
+ 지원되는 방법: POST
+ 인증 및 ROLE\$1ADMIN 역할이 필요합니다.
+ 경로: `/api/services/rest/bluesamservice/createDataSet`
+ 인수:
이름
(필수, 문자열): 데이터 세트의 이름입니다.
type
(필수, 문자열): 데이터 세트 유형. 가능한 값은 `ESDS`, `KSDS`, `RRDS`입니다.
recordSize
(선택 사항, 문자열): 데이터 세트에 있는 각 레코드의 최대 크기입니다.
fixedLength
(선택 사항, 부울): 레코드 길이가 고정되었는지 여부를 나타냅니다.
압축
(선택 사항, 부울): 데이터 세트가 압축되었는지 여부를 나타냅니다.
cacheEnable
(선택 사항, 부울): 데이터 세트에 캐싱이 활성화되었는지 여부를 나타냅니다.
alternativeKeys
(선택 사항, 키 목록):
+ 오프셋(필수, 숫자)
+ 길이(필수, 숫자)
+ 이름(필수, 번호)
+ 새로 만든 데이터 세트를 나타내는 JSON 파일을 반환합니다.
샘플 요청:
```
POST /api/services/rest/bluesamservice/createDataSet
{
"name": "DATASET",
"checked": false,
"records": [],
"primaryKey": {
"name": "PK"
},
"alternativeKeys": [
{
"offset": 10,
"length": 10,
"name": "ALTK_0"
}
],
"type": "ESDS",
"recordSize": 10,
"compression": true,
"cacheEnable": true
}
```
샘플 응답:
```
{
"dataSet": {
"name": "DATASET",
"checked": false,
"nbRecords": 0,
"keyLength": -1,
"recordSize": 10,
"compression": false,
"fixLength": true,
"type": "ESDS",
"cacheEnable": false,
"cacheWarmup": false,
"cacheEviction": "100ms",
"creationDate": 1686744961234,
"modificationDate": 1686744961234,
"records": [],
"primaryKey": {
"name": "PK",
"offset": null,
"length": null,
"columns": null,
"unique": true
},
"alternativeKeys": [
{
"offset": 10,
"length": 10,
"name": "ALTK_0"
}
],
"readLimit": 0,
"readEncoding": null,
"initCharacter": null,
"defaultCharacter": null,
"blankCharacter": null,
"strictZoned": null,
"decimalSeparator": null,
"currencySign": null,
"pictureCurrencySign": null
},
"message": null,
"result": true
}
```
### 파일 업로드
이 엔드포인트는 서버에 파일을 업로드하는 데 사용할 수 있습니다. 파일은 각 특정 사용자에 해당하는 임시 폴더에 저장됩니다. 파일을 업로드해야 할 때마다 이 엔드포인트를 사용합니다.
+ 지원되는 방법: POST
+ 인증 및 ROLE\$1ADMIN 역할이 필요합니다.
+ 경로: `/api/services/rest/bluesamservice/upload`
+ 인수:
파일
(필수, 멀티파트/양식 데이터): 업로드할 파일입니다.
+ 업로드의 상태를 반영하는 부울을 반환합니다
### 데이터 세트 로드(POST)
`createDataSet`를 사용하여 데이터 세트 정의를 생성한 후 업로드된 파일과 연결된 레코드를 특정 데이터 세트에 로드할 수 있습니다.
+ 지원되는 방법: POST
+ 인증 및 ROLE\$1ADMIN 역할이 필요합니다.
+ 경로: `/api/services/rest/bluesamservice/loadDataSet`
+ 인수:
이름
(필수, 문자열): 데이터 세트의 이름입니다.
+ 요청 상태와 로드된 데이터 세트를 반환합니다.
### 데이터 세트 로드(GET)
+ 지원되는 메서드: GET
+ 인증 및 ROLE\$1ADMIN 역할이 필요합니다.
+ 경로: `/api/services/rest/bluesamservice/loadDataSet`
+ 인수:
listcatFileOrDatasetName
(필수, 문자열): 데이터 세트의 이름입니다.
datasetFile
(필수, 문자열): 데이터 세트 파일 이름입니다.
+ 요청 상태와 로드된 데이터 세트를 반환합니다.
### Amazon S3 버킷에서 데이터 세트를 로드할 수 있습니다
Amazon S3 버킷에서 listcat 파일을 사용하여 데이터 세트를 로드합니다.
+ 지원되는 메서드: GET
+ 인증 및 ROLE\$1ADMIN 역할이 필요합니다.
+ 경로: `/api/services/rest/bluesamservice/loadDataSetFromS3`
+ 인수:
listcatFileS3Location
(필수, 문자열): listcat 파일의 Amazon S3 위치입니다.
datasetFileS3Location
(필수, 문자열): 데이터 세트 파일의 Amazon S3 위치입니다.
리전
(필수, 문자열): 파일이 저장되는 Amazon S3 AWS 리전 입니다.
+ 새로 생성된 데이터 세트를 반환합니다
샘플 요청:
```
/BAC/api/services/rest/bluesamservice/loadDataSetFromS3?region=us-east-1&listcatFileS3Location=s3://bucket-name/listcat.json&datasetFileS3Location=s3://bucket-name/dataset.DAT
```
### Amazon S3 버킷으로 데이터 세트를 내보냅니다
지정된 Amazon S3 버킷으로 데이터 세트를 내보냅니다.
+ 지원되는 메서드: GET
+ 인증 및 ROLE\$1ADMIN 역할이 필요합니다.
+ 경로: `/api/services/rest/bluesamservice/exportDataSetToS3`
+ 인수:
s3Location
(필수, 문자열): 데이터 세트를 내보낼 Amazon S3 위치입니다.
datasetName
(필수, 문자열): 내보낼 데이터 세트의 이름.
리전
(필수, 문자열): Amazon S3 버킷 AWS 리전 의 입니다.
kmsKeyId
(선택 사항, 문자열): 내보낸 데이터 세트를 Amazon S3 버킷으로 암호화하는 데 사용할 AWS KMS ID입니다.
+ 내보낸 데이터 세트를 반환합니다
샘플 요청:
```
/BAC/api/services/rest/bluesamservice/exportDataSetToS3?region=eu-west-1&s3Location=s3://bucket-name/dump&datasetName=dataset
```
### 데이터 세트 생성
데이터 세트에서 모든 레코드를 지웁니다.
+ 지원되는 메서드: POST, GET
+ 인증 및 ROLE\$1ADMIN 역할이 필요합니다.
+ 경로: `/api/services/rest/bluesamservice/clearDataSet`
+ 인수:
이름
(필수, 문자열): 지울 데이터 세트의 이름. GET 메서드를 사용할 때 파라미터 이름은 입니다`datasetName`.
+ 반환: 요청 상태를 반환합니다.
### 데이터 스토어 삭제
데이터 세트 정의 및 레코드를 삭제합니다.
+ 지원되는 방법: POST
+ 인증 및 ROLE\$1ADMIN 역할이 필요합니다.
+ 경로: `/api/services/rest/bluesamservice/deleteDataSet`
+ 인수:
이름
(필수, 문자열): 삭제할 데이터 세트의 이름.
+ 요청 상태와 삭제된 데이터 세트를 반환합니다.
### 데이터 세트 레코드 개수
이 엔드포인트는 데이터 세트와 연결된 레코드 수를 반환합니다.
+ 지원되는 방법: POST
+ 인증 및 ROLE\$1USER 역할이 필요합니다.
+ 경로: `/api/services/rest/bluesamservice/countRecords`
+ 인수:
이름
(필수, 문자열): 데이터 세트의 이름입니다.
+ 반환값: 레코드 수
## 대량 데이터 세트 관련 엔드포인트
다음 엔드포인트를 사용하여 여러 데이터 세트를 한 번에 만들거나 관리할 수 있습니다.
**Topics**
+ [데이터 세트 내보내기(GET)](#ba-export-data-sets-get)
+ [데이터 세트 내보내기(POST)](#ba-export-data-sets-post)
+ [여러 데이터 세트 생성](#ba-create-multiple-data-sets)
+ [모든 데이터 세트를 나열합니다](#ba-list-all-data-sets)
+ [모든 데이터 세트 직접 나열](#ba-direct-list-all-data-sets)
+ [모든 데이터 세트 페이지별 직접 나열](#ba-direct-list-all-data-sets-by-page)
+ [데이터 세트 스트리밍](#ba-stream-data-sets)
+ [모든 데이터 세트를 삭제합니다](#ba-delete-all-data-sets)
+ [listcat 파일에서 데이터 세트 정의 가져오기](#ba-get-definitions-listcat)
+ [업로드된 listcat 파일에서 데이터 세트 정의 가져오기](#ba-get-definitions-uploaded-listcat)
+ [데이터 세트 가져오기](#ba-get-data-set)
+ [JSON 파일에서 listcat 로드](#ba-load-listcat)
### 데이터 세트 내보내기(GET)
+ 지원되는 메서드: GET
+ 인증 및 ROLE\$1ADMIN 역할이 필요합니다.
+ 경로: `/api/services/rest/bluesamservice/exportDataSet`
+ 인수:
datasetName
(필수, 문자열): 내보낼 데이터 세트의 이름.
datasetOutputFile
(필수, 문자열): 내보낸 데이터세트를 저장하려는 서버 폴더의 경로입니다.
rdw
(필수, 부울): 레코드 설명자 단어(RDW)를 내보낸 레코드에 포함할지 여부입니다. 데이터 세트에 고정 길이 레코드가 있는 경우 이 파라미터의 값은 무시됩니다.
+ 요청 상태와 내보낸 데이터 세트를 포함하는 파일의 경로를 반환합니다(있는 경우). 응답에서 데이터세트가 Null인 경우, 이는 시스템이 지정된 이름의 데이터세트를 찾을 수 없었음을 의미합니다.
### 데이터 세트 내보내기(POST)
+ 지원되는 방법: POST
+ 인증 및 ROLE\$1USER 역할이 필요합니다.
+ 경로: `/api/services/rest/bluesamservice/exportDataSet`
+ 인수:
dumpParameters
(필수, BACReadParameters): Bluesam 읽기 파라미터입니다.
+ 내보낸 데이터 세트의 상태를 반환합니다.
### 여러 데이터 세트 생성
+ 지원되는 방법: POST
+ 인증 및 ROLE\$1ADMIN 역할이 필요합니다.
+ 경로: `/api/services/rest/bluesamservice/createAllDataSets`
+ 인수:
+ 데이터 세트의 목록
이름
(필수, 문자열): 데이터 세트의 이름입니다.
type
(필수, 문자열): 데이터 세트 유형. 가능한 값은 `ESDS`, `KSDS`, `RRDS`입니다.
recordSize
(선택 사항, 문자열): 데이터 세트에 있는 각 레코드의 최대 크기입니다.
fixedLength
(선택 사항, 부울): 레코드 길이가 고정되었는지 여부를 나타냅니다.
압축
(선택 사항, 부울): 데이터 세트가 압축되었는지 여부를 나타냅니다.
cacheEnable
(선택 사항, 부울): 데이터 세트에 캐싱이 활성화되었는지 여부를 나타냅니다.
+ 반환값: 요청 상태 및 새로 생성된 데이터 세트.
### 모든 데이터 세트를 나열합니다
+ 지원되는 메서드: GET
+ 인증 및 ROLE\$1USER 역할이 필요합니다.
+ 경로: `/api/services/rest/bluesamservice/listDataSet`
+ 인수: 없음
+ 반환값: 요청 상태 및 데이터 세트 목록.
### 모든 데이터 세트 직접 나열
+ 지원되는 메서드: GET
+ 인증 및 ROLE\$1USER 역할이 필요합니다.
+ 경로: `/api/services/rest/bluesamservice/directListDataSet`
+ 인수: 없음
+ 반환값: 요청 상태 및 데이터 세트 목록.
### 모든 데이터 세트 페이지별 직접 나열
+ 지원되는 메서드: GET
+ 인증 및 ROLE\$1USER 역할이 필요합니다.
+ 경로: `/api/services/rest/bluesamservice/directListDataSetByPage`
+ 인수:
이름
(필수, 문자열): 데이터 세트의 이름입니다. 지정하지 않으면 기본값은 `%` (모든 데이터 세트)입니다.
page
(필수, int): 페이지 번호(최소 0).
pageSize
(필수, int): 페이지 크기(최소 1, 최대 500).
+ 반환값: 요청 상태 및 데이터 세트 목록.
### 데이터 세트 스트리밍
+ 지원되는 메서드: GET
+ 인증 및 ROLE\$1ADMIN 역할이 필요합니다.
+ 경로: `/api/services/rest/bluesamservice/streamDataset`
+ 인수:
datasetName
(필수, 문자열): 데이터 세트의 이름입니다.
+ 반환값: 요청된 데이터 세트의 스트림입니다.
### 모든 데이터 세트를 삭제합니다
+ 지원되는 방법: POST
+ 인증 및 ROLE\$1ADMIN 역할이 필요합니다.
+ 경로: `/api/services/rest/bluesamservice/removeAll`
+ 인수: 없음
+ 반환값: 요청 상태를 나타내는 부울입니다.
### listcat 파일에서 데이터 세트 정의 가져오기
+ 지원되는 방법: POST
+ 인증 및 ROLE\$1ADMIN 역할이 필요합니다.
+ 경로: `/api/services/rest/bluesamservice/getDataSetsDefinitionFromListcat`
+ 인수:
paramFilePath
(필수, 문자열): listcat 파일의 경로입니다.
+ 반환값: 데이터 세트 목록
### 업로드된 listcat 파일에서 데이터 세트 정의 가져오기
+ 지원되는 방법: POST
+ 인증 및 ROLE\$1ADMIN 역할이 필요합니다.
+ 경로: `/api/services/rest/bluesamservice/getDataSetsDefinitionFromUploadedListcat`
+ 인수: 없음
+ 반환값: 데이터 세트 목록
### 데이터 세트 가져오기
+ 지원되는 메서드: GET
+ 인증 및 ROLE\$1USER 역할이 필요합니다.
+ 경로: `/api/services/rest/bluesamservice/getDataSet`
+ 인수:
이름
(필수, 문자열): 데이터 세트의 이름입니다.
+ 요청된 데이터 세트를 반환합니다.
### JSON 파일에서 listcat 로드
+ 지원되는 메서드: GET
+ 인증 및 ROLE\$1ADMIN 역할이 필요합니다.
+ 경로: `/api/services/rest/bluesamservice/loadListcatFromJsonFile`
+ 인수:
filePath
(필수, 문자열): listcat 파일의 경로입니다.
+ 반환값: 데이터 세트 목록
## 레코드
다음 엔드포인트를 사용하여 데이터 세트 내에서 레코드를 만들거나 관리합니다.
**Topics**
+ [레코드 생성](#ba-create-record)
+ [데이터 세트 읽기](#ba-read-data-set)
+ [레코드 삭제](#ba-delete-record)
+ [레코드 업데이트](#ba-update-record)
+ [레코드 저장](#ba-save-record)
+ [레코드 검증](#ba-validate-record)
+ [레코드 트리 가져오기](#ba-get-record-tree)
### 레코드 생성
이 엔드포인트를 사용하여 새 레코드를 만들 수 있습니다.
+ 지원되는 방법: POST
+ 인증 및 ROLE\$1USER 역할이 필요합니다.
+ 경로: `/api/services/rest/crud/createRecord`
+ 인수:
데이터세트
(필수, DataSet): 데이터 세트 객체
마스크
(필수, 마스크): 마스크 객체.
+ 요청 상태와 생성된 레코드를 반환합니다.
### 데이터 세트 읽기
이 엔드포인트를 사용하여 데이터 세트를 읽을 수 있습니다.
+ 지원되는 방법: POST
+ 인증 및 ROLE\$1USER 역할이 필요합니다.
+ 경로: `/api/services/rest/crud/readDataSet`
+ 인수:
데이터세트
(필수, DataSet): 데이터 세트 객체.
+ 요청 상태 및 레코드와 함께 데이터 세트를 반환합니다.
### 레코드 삭제
이 엔드포인트를 사용하여 데이터 세트의 레코드를 삭제할 수 있습니다.
+ 지원되는 방법: POST
+ 인증 및 ROLE\$1USER 역할이 필요합니다.
+ 경로: `/api/services/rest/crud/deleteRecord`
+ 인수:
데이터세트
(필수, DataSet): 데이터 세트 객체
record
(필수, 레코드): 삭제할 레코드
+ 삭제 상태를 반환합니다.
### 레코드 업데이트
이 엔드포인트를 사용하여 데이터 세트와 관련된 레코드를 업데이트할 수 있습니다.
+ 지원되는 방법: POST
+ 인증 및 ROLE\$1USER 역할이 필요합니다.
+ 경로: `/api/services/rest/crud/updateRecord`
+ 인수:
데이터세트
(필수, DataSet): 데이터 세트 객체
record
(필수, 레코드): 업데이트할 레코드
마스크
(선택 사항, 마스크): 업데이트 중에 적용할 마스크 객체입니다.
+ 요청 상태 및 레코드와 함께 데이터 세트를 반환합니다.
### 레코드 저장
이 엔드포인트를 사용하여 마스크로 데이터 세트에 레코드를 저장할 수 있습니다.
+ 지원되는 방법: POST
+ 인증 및 ROLE\$1USER 역할이 필요합니다.
+ 경로: `/api/services/rest/crud/saveRecord`
+ 인수:
데이터세트
(필수, DataSet): 데이터 세트 객체
record
(필수, 레코드): 저장할 레코드
마스크
(선택 사항, 마스크): 저장 중에 적용할 마스크 객체입니다.
+ 요청 상태 및 레코드와 함께 데이터 세트를 반환합니다.
### 레코드 검증
이 엔드포인트를 사용하여 레코드를 검증합니다.
+ 지원되는 방법: POST
+ 인증 및 ROLE\$1USER 역할이 필요합니다.
+ 경로: `/api/services/rest/crud/validateRecord`
+ 인수:
데이터세트
(필수, DataSet): 데이터 세트 객체
record
(선택 사항, 레코드): 검증할 레코드입니다.
마스크
(선택 사항, 마스크): 검증 중에 적용할 마스크 객체입니다.
+ 요청 상태 및 레코드와 함께 데이터 세트를 반환합니다.
### 레코드 트리 가져오기
이 엔드포인트를 사용하여 레코드의 계층적 트리를 가져옵니다.
+ 지원되는 방법: POST
+ 인증 및 ROLE\$1USER 역할이 필요합니다.
+ 경로: `/api/services/rest/crud/getRecordTree`
+ 인수:
데이터세트
(필수, DataSet): 데이터 세트 객체
record
(필수, 레코드): 가져올 레코드
마스크
(선택 사항, 마스크): 마스크 객체.
+ 요청의 상태와 요청된 레코드의 계층적 트리를 반환합니다.
## 마스크
다음 엔드포인트를 사용하여 데이터 세트에 마스크를 로드하거나 적용합니다.
**Topics**
+ [마스크 로드](#ba-load-mask)
+ [마스킹 적용](#ba-apply-mask)
+ [마스킹 필터 적용](#ba-apply-mask-filter)
### 마스크 로드
이 엔드포인트를 사용하여 특정 데이터 세트와 연결된 모든 마스크를 검색할 수 있습니다.
+ 지원되는 방법: POST
+ 인증 및 ROLE\$1USER 역할이 필요합니다.
+ 경로: `/api/services/rest/crud/loadMasks`
+ 경로 변수:
recordSize: .../loadMasks/\$1recordSize\$1
(선택 사항, 숫자): 레코드 크기, 이 레코드 크기와 일치하는 필터 로드 마스크
+ 인수:
데이터세트
(필수, DataSet): 데이터 세트 객체
+ 요청 상태와 마스킹 목록을 반환합니다.
### 마스킹 적용
이 엔드포인트를 사용하여 특정 데이터 세트에 마스크를 적용할 수 있습니다.
+ 지원되는 방법: POST
+ 인증 및 ROLE\$1USER 역할이 필요합니다.
+ 경로: `/api/services/rest/crud/applyMask`
+ 인수:
데이터세트
(필수, DataSet): 데이터 세트 객체
마스크
(필수, Mask): 데이터 세트 객체
+ 요청 상태와 마스크가 적용된 데이터 세트를 반환합니다.
### 마스킹 필터 적용
이 엔드포인트를 사용하여 특정 데이터 세트에 마스크를 적용하고 특정 데이터 세트로 필터링할 수 있습니다.
+ 지원되는 방법: POST
+ 인증 및 ROLE\$1USER 역할이 필요합니다.
+ 경로: `/api/services/rest/crud/applyMaskFilter`
+ 인수:
데이터세트
(필수, DataSet): 데이터 세트 객체
마스크
(필수, 마스크): 마스크 객체
필터
(필수, 필터): 적용할 필터 객체입니다.
+ 요청 상태와 마스크 및 필터가 적용된 데이터 세트를 반환합니다.
## 기타
다음 엔드포인트를 사용하여 데이터 세트의 캐시를 관리하거나 데이터 세트 특성을 확인할 수 있습니다
**Topics**
+ [워밍업 캐시 확인](#ba-check-warm-up-cache)
+ [체크 캐시가 활성화됨](#ba-check-cache-enabled)
+ [캐시 활성화](#ba-enable-cache)
+ [할당된 Ram 캐시 확인](#ba-check-allocated-ram-cache)
+ [지속성 확인](#ba-check-persistence)
+ [지원되는 데이터 세트 유형 확인](#ba-check-supported-data-set-types)
+ [상태 확인 서버](#ba-check-server-health)
+ [PostgreSQL 다중 스키마 구성 확인](#ba-check-postgres-multi-schema)
### 워밍업 캐시 확인
특정 데이터 세트에 대해 웜업 캐시가 활성화되어 있는지 확인합니다.
+ 지원되는 방법: POST
+ 인증 및 ROLE\$1ADMIN 역할이 필요합니다.
+ 경로: `/api/services/rest/bluesamservice/warmupCache`
+ 인수:
이름
(필수, 문자열): 데이터 세트의 이름입니다.
+ 반환값: 워밍업 캐시가 활성화되어 있으면 true이고 그렇지 않으면 false입니다.
### 체크 캐시가 활성화됨
특정 데이터 세트에 대해 캐시가 활성화되었는지 확인합니다.
+ 지원되는 메서드: GET
+ 인증 및 ROLE\$1USER 역할이 필요합니다.
+ 경로: `/api/services/rest/bluesamservice/isEnableCache`
+ 인수: 없음
+ 캐싱이 활성화된 경우 true를 반환합니다.
### 캐시 활성화
+ 지원되는 방법: POST
+ 인증과 ROLE\$1ADMIN 및 ROLE\$1SUPER\$1ADMIN 역할이 필요합니다.
+ 경로: `/api/services/rest/bluesamservice/enableDisableCache/{enable}`
+ 인수:
활성화
(필수, 부울): true로 설정하면 캐싱이 활성화됩니다.
데이터세트
(필수, DataSet): 데이터 세트 객체.
+ 반품 없음
### 할당된 Ram 캐시 확인
이 엔드포인트를 사용하여 할당된 RAM 캐시 메모리를 검색할 수 있습니다.
+ 지원되는 메서드: GET
+ 인증 및 ROLE\$1USER 역할이 필요합니다.
+ 경로: `/api/services/rest/bluesamservice/allocatedRamCache`
+ 인수: 없음
+ 반환값: 문자열로 나타낸 메모리의 크기
### 지속성 확인
+ 지원되는 메서드: GET
+ 인증 및 ROLE\$1USER 역할이 필요합니다.
+ 경로: `/api/services/rest/bluesamservice/persistence`
+ 인수: 없음
+ 반환값: 문자열로 사용된 지속성
### 지원되는 데이터 세트 유형 확인
+ 지원되는 메서드: GET
+ 경로: `/api/services/rest/bluesamservice/getDataSetTypes`
+ 인증 및 ROLE\$1USER 역할이 필요합니다.
+ 인수: 없음
+ 반환값: 지원되는 데이터 세트 유형 목록을 문자열 목록으로 표시합니다.
### 상태 확인 서버
+ 지원되는 메서드: GET
+ 경로: `/api/services/rest/bluesamserver/serverIsUp`
+ 인수: 없음
+ 반환값: 없음 HTTP 응답 상태 코드 200은 서버가 작동 중임을 나타냅니다.
### PostgreSQL 다중 스키마 구성 확인
PostgreSQL 다중 스키마 구성이 활성화되어 있는지 확인합니다.
+ 지원되는 메서드: GET
+ 인증 및 ROLE\$1USER 역할이 필요합니다.
+ 경로: `/api/services/rest/bluesamservice/isPostgresMultiSchema`
+ 인수: 없음
+ 반환: PostgreSQL 다중 스키마 구성이 활성화된 경우 true를 반환하고 그렇지 않으면 false를 반환합니다.
## BAC 사용자 관리 엔드포인트
다음 엔드포인트를 사용하여 사용자 상호 작용을 관리하세요.
**Topics**
+ [사용자 로그인](#ba-log-user-in)
+ [시스템에 사용자가 하나 이상 존재하는지 확인](#ba-verify-at-least-one-user-exists)
+ [새 사용자 기록](#ba-record-new-user)
+ [사용자 정보 가져오기](#ba-user-info)
+ [사용자 나열](#ba-list-users)
+ [사용자 삭제](#ba-delete-user)
+ [현재 사용자 로그아웃](#ba-log-user-out)
### 사용자 로그인
+ 지원되는 메서드: POST
+ 경로: `/api/services/security/servicelogin/login`
+ 인수: 없음
+ 현재 요청에 자격 증명이 제공된 사용자를 나타내는 `com.netfective.bluage.bac.entities.SignOn` 객체의 JSON 직렬화를 반환합니다. 비밀번호는 반환된 객체의 뷰에서 숨겨집니다. 사용자에게 부여된 역할이 나열됩니다.
샘플 응답:
```
{
"login": "some-admin",
"password": null,
"roles": [
{
"id": 0,
"roleName": "ROLE_ADMIN"
}
]
}
```
### 시스템에 사용자가 하나 이상 존재하는지 확인
+ 지원되는 메서드: GET
+ 경로: `/api/services/security/servicelogin/hasAccount`
+ 인수: 없음
+ 기본 최고 관리자 사용자 이외의 사용자가 하나 이상 생성된 경우 `true` 부울 값을 반환합니다. 그렇지 않은 경우 `false`를 반환합니다.
### 새 사용자 기록
+ 지원되는 메서드: POST
+ 인증 및 ROLE\$1ADMIN 역할이 필요합니다.
+ 경로: `/api/services/security/servicelogin/recorduser`
+ 인수: 스토리지에 추가할 사용자를 나타내는 `com.netfective.bluage.bac.entities.SignOn` 객체의 JSON 직렬화입니다. 사용자의 역할을 정의해야 합니다. 그러지 않으면 사용자가 BAC 기능 및 엔드포인트를 사용하지 못할 수 있습니다.
+ 사용자가 성공적으로 생성된 경우 `true` 부울 값을 반환합니다. 그렇지 않은 경우 `false`를 반환합니다.
+ 샘플 요청 JSON:
```
{
"login": "simpleuser",
"password": "simplepassword",
"roles": [
{
"id": 2,
"roleName": "ROLE_USER"
}
]
}
```
`roleName`의 유효한 값 2개는 다음과 같습니다.
+ `ROLE_ADMIN`:가 Blusam 리소스와 사용자를 관리할 수 있습니다.
+ `ROLE_USER`:는 Blusam 리소스를 관리할 수 있지만 사용자는 관리할 수 없습니다.
### 사용자 정보 가져오기
+ 지원되는 메서드: GET
+ 경로: `/api/services/security/servicelogin/userInfo`
+ 인수: 없음
+ 현재 연결된 사용자의 사용자 이름과 역할을 반환합니다.
### 사용자 나열
+ 지원되는 메서드: GET
+ 인증 및 ROLE\$1ADMIN 역할이 필요합니다.
+ 경로: `/api/services/security/servicelogin/listusers`
+ 인수: 없음
+ JSON으로 직렬화된 목록을 `com.netfective.bluage.bac.entities.SignOn` 반환합니다.
### 사용자 삭제
**중요**
이 작업은 실행을 취소할 수 없습니다. 삭제된 사용자는 BAC 애플리케이션에 다시 연결할 수 없습니다.
+ 지원되는 메서드: POST
+ 인증 및 ROLE\$1ADMIN 역할이 필요합니다.
+ 경로: `/api/services/security/servicelogin/deleteuser`
+ 인수: 스토리지에서 제거될 사용자를 나타내는 `com.netfective.bluage.bac.entities.SignOn` 객체의 JSON 직렬화입니다.
+ 사용자가 성공적으로 제거된 경우 `true` 부울 값을 반환합니다.
### 현재 사용자 로그아웃
+ 지원되는 메서드: GET
+ 경로: `/api/services/security/servicelogout/logout`
+ 인수: 없음
+ 현재 사용자가 성공적으로 로그아웃된 경우 `{"success":true}` JSON 메시지를 반환합니다. 관련 HTTP 세션이 무효화됩니다.