6) SKMS 응답 상태 코드 정의
SKMS 응답 상태 코드 정의
설명
- SKMS 응답 상태에 대한 Code 정의
- 참고 : https://wiki.softcamp.co.kr/x/5w2DB
Response Code
Status Code | Status Message | Description |
---|---|---|
200 | OK | 요청 성공 |
400 | Bad Request | 클라이언트 요청이 잘못 됨(e.g. 필수 값 입력 누락) |
401 | Unauthorized | 승인 되지 않음(인증 실패) |
403 | Forbidden | 허가 되지 않음(인증은 되었으나 해당 사용자에게 허가되지 않은 요청 인 경우) |
404 | Not Found | 요청한 리소스가 없음 |
500 | Internal Server Error | 요청을 처리하는 동안 내부 서버 오류 발생 |
Response Error JSON format
Name | Required | Type | Description |
---|---|---|---|
code | required | int | 에러 코드(Error Code 정의 참고) |
message | required | string | 에러 메시지 |
detail | string | 에러 상세 내용(에러에 따라 세부 항목은 달라 질 수 있음) |
Error Code
- 에러 코드 정의
error code | message | Description | Status Code |
---|---|---|---|
40003 | Failed create header | 헤더 생성 실패 | 400 |
40004 | Failed extract header | 헤더 추 실패 | 400 |
40005 | Batch/Scheduler Failed | 배치/스케줄러 실패 | 400 |
40006 | oAuth connection failed | 인증인가 연결 실패 | 400 |
40007 | Integrated Log Service Failed | 통합 로그 서비스 실패 | 400 |
40008 | Key Vault Service Failed | 키볼트 서비스 실패 | 400 |
40009 | Service Linker Key Manager is not used | 키 데이터 연동 실패 | 400 |
40011 | Unable to AzureInfo | azure 정보 조회 실패 | 400 |
40012 | Relay client accessToken Failed | 릴레이 토큰 갱신 실패 | 400 |
40013 | Key not found in the keyVault | 키볼트 키 조회 실패 | 400 |
40101 | Invalid token | 유효하지 않은 토큰 | 401 |
40102 | No matching company ID found | 일치하는 company_id 없음 | 400 |
40103 | Failed Duplicate domain | 중복된 도메인 | 400 |
40104 | No matching domains found | 일치하는 도메인 없음 | 400 |
40105 | Required value is missing | 필수 값 없음 | 400 |
40107 | No matching license found | 일치하는 라이선스 없음 | 400 |
40108 | Unavailable License | 사용 불가능한 라이선스 | 400 |
40110 | HeaderKey is Empty | 일치하는 헤더키 없음 | 400 |
40111 | EncryptionKey is Empty | 일치하는 암호화 키 없음 - DS_KEY_ENCRYPTION_KEY | 400 |
40112 | No matching SCI ServerID found | 일치하는 SCI 서버 ID 없음 | 400 |
40301 | You don't have permission this service | 접근 권한이 없음 | 401 |
50001 | An unexpected error has occurred in the internal system | 접근 권한이 없음 | 400/500 |
50002 | SCI Connection failed | SCI 서버 연결 테스트 실패 | 500 |
50003 | Service Linker Name is Not Exist | SHIELDRM 서비스명 존재하지 않음 | 500 |
50004 | Service Linker is Unused | SHIELDRM 서비스 미사용 | 500 |
50005 | SCI Service Linker registration Failed | SCI 서버 연동 시스템 등록 실패 | 500 |
Examples
Response
Status code : 400 Bad Request
{
"code": 40013,
"message": "Key not found in the keyVault",
"detail": "keyId : 0000009"
}