This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Models

1: AuthKeyRequest
2: AuthKeyResponse
3: CheckListVersionResponse
4: CheckListVersions
5: CheckResponse
6: ConfigInspectionCreateResponse
7: ConfigInspectionListResponse
8: ConfigInspectionListResponseV1Dot3
9: ConfigInspectionLookinError
10: ConfigInspectionLookinResponse
11: ConfigInspectionLookinResult
12: ConfigInspectionLookinTarget
13: DiagnosisObjectDetailResponse
14: DiagnosisObjectDetailResponseV1dot3
15: DiagnosisObjectRequest
16: DiagnosisObjectRequestV1Dot3
17: DiagnosisRequest
18: DiagnosisRequestV1Dot3
19: DiagnosisResultDetail
20: DiagnosisResultDetailResponse
21: DiagnosisResultDetailResponseV1dot3
22: DiagnosisResultListResponse
23: DiagnosisResultListResponseV1dot3
24: DiagnosisResultResponse
25: DiagnosisResultResponseV1dot3
26: DiagnosisScheduleRequest
27: DiagnosisScheduleRequestV1Dot3
28: DiagnosisScheduleResponse
29: DiagnosisScheduleResponseV1Dot3
30: SummaryResponse
31: SummaryResponseV1dot3
32: Tag
33: TerminateResponse

1 - AuthKeyRequest

Name	Description	Schema
auth_key_created_at optional	created date of authkey Example : `2022-01-01 12:00:00`	any of [string, null]
auth_key_expired_at optional	expired date of authkey Example : `2023-01-01 12:00:00`	any of [string, null]
auth_key_id required	Id of auth key Example : `9b72a9856e494e67afc69atd3631fe38`	string
diagnosis_id optional	Id of diagnosis Example : `DIA-943731CB8E3045C289BAECAEC3532097`	any of [string, null]

2 - AuthKeyResponse

Name	Description	Schema
auth_key_created_at optional	created date of authkey Example : `2022-01-01T12:00:00Z`	string
auth_key_expired_at optional	expired date of authkey Example : `2022-01-01T12:00:00Z`	string
auth_key_id optional	Id of auth key Example : `9b72a9856e494e67afc69atd3631fe38`	string
auth_key_state optional	state of auth key Example : `ACTIVATED`	string
user_id optional	user Id Example : `4f5d60e9e08b48d0a0881e21ab14e266`	string

3 - CheckListVersionResponse

Name	Description	Schema
contents required		array[CheckListVersions]
count required	count Example : `20`	integer
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

4 - CheckListVersions

Name	Description	Schema
check_list_name optional	Name of checklist Example : `BP-2024-001`	any of [string, null]
check_list_state optional	Current state of checklist Example : `ACTIVE`	any of [string, null]
check_list_version optional	Checklist version Example : `v1.0`	any of [string, null]
check_list_version_id optional	ID of checklist(use this for check_list_version_id to create config inspection resource.) Example : `d1873841f30c4862897d1f287a973a7f`	any of [string, null]
csp_type optional	Type of cloud service provider Example : `SCP`	any of [string, null]
diagnosis_check_type optional	Check type of diagnosis Example : `BP`	any of [string, null]

5 - CheckResponse

Name	Description	Schema	Default
result required	True, False Check Example : `True`	boolean

6 - ConfigInspectionCreateResponse

Name	Description	Schema	Default
diagnosis_id required	Id of diagnosis Example : `Sample Diagnosis Name`	string
result required	True, False Check Example : `True`	boolean

7 - ConfigInspectionListResponse

Name	Description	Schema
count optional	total count Example : `20`	any of [integer, null]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
summary_responses required		array[SummaryResponse]

8 - ConfigInspectionListResponseV1Dot3

Name	Description	Schema
count optional	total count Example : `20`	any of [integer, null]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
summary_responses required		array[SummaryResponseV1dot3]

9 - ConfigInspectionLookinError

Name	Description	Schema	Default
message optional	Example :	string
type optional	Example :	string

10 - ConfigInspectionLookinResponse

Name	Description	Schema
requestNumber required	Example :	string
systemId required	Example :	string
targets required		ConfigInspectionLookinTarget

11 - ConfigInspectionLookinResult

Name	Description	Schema
current optional	Example :	string
itemCode required	Example :	string
verify optional	Example :	string

12 - ConfigInspectionLookinTarget

Name	Description	Schema
cloudAccountId required	Example :	string
cspCd required	Example :	string
cspConsoleCd required	Example :	string
error optional		any of [ConfigInspectionLookinError, null]
kind optional	Example :	string
result optional		array[ConfigInspectionLookinResult]
status optional	Example :	string
version optional	Example :	string

13 - DiagnosisObjectDetailResponse

Name	Description	Schema	Default
auth_key_responses required		AuthKeyResponse
schedule_response required		DiagnosisScheduleResponse
summary_responses required		SummaryResponse

14 - DiagnosisObjectDetailResponseV1dot3

Name	Description	Schema	Default
auth_key_responses required		AuthKeyResponse
schedule_response required		DiagnosisScheduleResponseV1Dot3
summary_responses required		SummaryResponseV1dot3

15 - DiagnosisObjectRequest

Name	Description	Schema
account_id required	account Id Example : `0e3dffc50eb247a1adf4f2e5c82c4f99`	string
auth_key_request required		AuthKeyRequest
csp_type required	Type of cloud service provider Example : `SCP`	string
diagnosis_account_id required	Id of diagnosis Example : `0e3dffc50eb247a1adf4f2e5c82c4f99`	string
diagnosis_check_type required	Check type of diagnosis Example : `BP`	string
diagnosis_id required	Id of diagnosis Example : `DIA-943731CB8E3045C289BAECAEC3532097`	string
diagnosis_name required	Name of diagnosis Example : `Sample Diagnosis Name` Pattern : `^[a-zA-Z0-9-_]+$` Maximum length : `25`	string
diagnosis_type required	diagnosis Type Example : `Console`	string
plan_type required	plan Type Example : `STANDARD`	string
schedule_request required		DiagnosisScheduleRequest
tags optional	Tag List	array[Tag]

16 - DiagnosisObjectRequestV1Dot3

Name	Description	Schema
account_id required	account Id Example : `0e3dffc50eb247a1adf4f2e5c82c4f99`	string
auth_key_request required		AuthKeyRequest
check_list_version_id required	ID of checklist(use this for check_list_version_id to create config inspection resource.) Example : `d1873841f30c4862897d1f287a973a7f`	string
csp_type required	Type of cloud service provider Example : `SCP`	string
diagnosis_account_id required	Id of diagnosis Example : `0e3dffc50eb247a1adf4f2e5c82c4f99`	string
diagnosis_check_type required	Check type of diagnosis Example : `BP`	string
diagnosis_id required	Id of diagnosis Example : `DIA-943731CB8E3045C289BAECAEC3532097`	string
diagnosis_name required	Name of diagnosis Example : `Sample Diagnosis Name` Pattern : `^[a-zA-Z0-9-_]+$` Maximum length : `25`	string
diagnosis_type required	diagnosis Type Example : `Console`	string
plan_type required	plan Type Example : `STANDARD`	string
schedule_request required		DiagnosisScheduleRequestV1Dot3
tags optional	Tag List	array[Tag]

17 - DiagnosisRequest

Name	Description	Schema
access_key required	Access Key Example : `SAMPLE KEY`	string
diagnosis_check_type required	Check type of diagnosis Example : `BP`	string
diagnosis_id required	Id of diagnosis Example : `DIA-943731CB8E3045C289BAECAEC3532097`	string
secret_key required	Secret Key Example : `SAMPLE KEY`	string
tenant_id required	Tenant ID Example : `1234567890`	string

18 - DiagnosisRequestV1Dot3

Name	Description	Schema
access_key required	Access Key Example : `SAMPLE KEY`	string
diagnosis_id required	Id of diagnosis Example : `DIA-943731CB8E3045C289BAECAEC3532097`	string
secret_key required	Secret Key Example : `SAMPLE KEY`	string
tenant_id required	Tenant ID Example : `1234567890`	string

19 - DiagnosisResultDetail

Name	Description	Schema
action_guide required	measure guide description Example : `원격 접속 Port에 Source IP가 ANY(0.0.0.0/0)로 등록되어있거나 과도하게 허용된 Security Group 규칙은 아래와 같이 삭제합니다.`	string
changed required	iS Change result manage Example : `True`	any of [boolean, null]
diagnosis_check_type required	Check type of diagnosis Example : `BP`	string
diagnosis_criteria required	decision standard description Example : `【 Security Group 규칙 】
① 원격접속 Port에 Any IP 접근을 허용하는 규칙이 존재하지 않아야 합니다.`	string
diagnosis_item required	sub category description Example : `2.NW_003. 프로토콜 별 원격접속 Port는 접근이 필요한 IP를 지정하여 접속을 허용해야 합니다.`	string
diagnosis_layer required	inspector item category description Example : `2.NETWORK`	string
diagnosis_method required	inspector method description Example : `Security Group의 Inbound 규칙에 원격 접속이 필요한 사용자나 시스템만 접근을 허용하는 규칙을 등록 하였는지 확인합니다.`	string
diagnosis_result required	verify result state Example : `03`	string
result_contents required	result Contents Example : `상세 내역`	string
sub_category required	Sub Category Example : `NURIBP_SCP_02.NW_004`	any of [string, null]

20 - DiagnosisResultDetailResponse

Name	Description	Schema
checklist_name required	checklist Name Example : `Sample Checklist`	string
count optional	total count Example : `20`	any of [integer, null]
diagnosis_account_id required	Id of diagnosis Example : `0e3dffc50eb247a1adf4f2e5c82c4f99`	string
diagnosis_check_type required	Check type of diagnosis Example : `BP`	string
diagnosis_id required	Id of diagnosis Example : `DIA-943731CB8E3045C289BAECAEC3532097`	string
diagnosis_name required	Name of diagnosis Example : `Sample Diagnosis Name`	string
diagnosis_request_sequence required	Sequence of diagnosis request Example : `SCPCIS-E75FD21CA524441C9C1B1B381D5974F7`	string
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
proceed_date optional	proceed Date Example :	string (date-time)
result_detail_list required		array[DiagnosisResultDetail]
total required	total count Example : `10`	integer

21 - DiagnosisResultDetailResponseV1dot3

Name	Description	Schema
check_list_version optional	Checklist version Example : `v1.0`	any of [string, null]
checklist_name required	checklist Name Example : `Sample Checklist`	string
count optional	total count Example : `20`	any of [integer, null]
diagnosis_account_id required	Id of diagnosis Example : `0e3dffc50eb247a1adf4f2e5c82c4f99`	string
diagnosis_check_type required	Check type of diagnosis Example : `BP`	string
diagnosis_id required	Id of diagnosis Example : `DIA-943731CB8E3045C289BAECAEC3532097`	string
diagnosis_name required	Name of diagnosis Example : `Sample Diagnosis Name`	string
diagnosis_request_sequence required	Sequence of diagnosis request Example : `SCPCIS-E75FD21CA524441C9C1B1B381D5974F7`	string
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
proceed_date optional	proceed Date Example :	string (date-time)
result_detail_list required		array[DiagnosisResultDetail]
total required	total count Example : `10`	integer

22 - DiagnosisResultListResponse

Name	Description	Schema
count optional	total count Example : `20`	any of [integer, null]
diagnosis_result_responses required		array[DiagnosisResultResponse]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]

23 - DiagnosisResultListResponseV1dot3

Name	Description	Schema
count optional	total count Example : `20`	any of [integer, null]
diagnosis_result_responses required		array[DiagnosisResultResponseV1dot3]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]

24 - DiagnosisResultResponse

Name	Description	Schema
count_check optional	check count Example : `10`	integer
count_error optional	error count Example : `0`	integer
count_fail optional	fail count Example : `3`	integer
count_na optional	na count Example : `2`	integer
count_pass optional	pass count Example : `5`	integer
csp_type optional	Type of cloud service provider Example : `SCP`	string
diagnosis_account_id optional	Id of diagnosis Example : `0e3dffc50eb247a1adf4f2e5c82c4f99`	string
diagnosis_check_type optional	Check type of diagnosis Example : `BP`	string
diagnosis_id optional	Id of diagnosis Example : `DIA-943731CB8E3045C289BAECAEC3532097`	string
diagnosis_name optional	Name of diagnosis Example : `Sample Diagnosis Name`	string
diagnosis_request_sequence optional	Sequence of diagnosis request Example : `1234567890`	string
diagnosis_result optional	diagnosis Result Example : `SUCCESS`	string
diagnosis_total_count optional	diagnosis Total Count Example : `10`	integer
proceed_date optional	proceed Date Example : `2022-01-01T12:00:00Z`	string (date-time)
total optional	total count Example : `10`	integer

25 - DiagnosisResultResponseV1dot3

Name	Description	Schema
check_list_state optional	Current state of checklist Example : `ACTIVE`	any of [string, null]
check_list_version optional	Checklist version Example : `v1.0`	any of [string, null]
count_check optional	check count Example : `10`	integer
count_error optional	error count Example : `0`	integer
count_fail optional	fail count Example : `3`	integer
count_na optional	na count Example : `2`	integer
count_pass optional	pass count Example : `5`	integer
csp_type optional	Type of cloud service provider Example : `SCP`	string
diagnosis_account_id optional	Id of diagnosis Example : `0e3dffc50eb247a1adf4f2e5c82c4f99`	string
diagnosis_check_type optional	Check type of diagnosis Example : `BP`	string
diagnosis_id optional	Id of diagnosis Example : `DIA-943731CB8E3045C289BAECAEC3532097`	string
diagnosis_name optional	Name of diagnosis Example : `Sample Diagnosis Name`	string
diagnosis_request_sequence optional	Sequence of diagnosis request Example : `1234567890`	string
diagnosis_result optional	diagnosis Result Example : `SUCCESS`	string
diagnosis_total_count optional	diagnosis Total Count Example : `10`	integer
proceed_date optional	proceed Date Example : `2022-01-01T12:00:00Z`	string (date-time)
total optional	total count Example : `10`	integer

26 - DiagnosisScheduleRequest

Name	Description	Schema
diagnosis_id required	Id of diagnosis Example : `DIA-943731CB8E3045C289BAECAEC3532097`	string
diagnosis_start_time_pattern required	Start time( 5-minute increments, 00 to 23 hours, 00 to 55 minutes ) Example : `08:00`	string
frequency_type required	Schedule type( monthly, weekly, daily) Example : `MONTH`	string
frequency_value required	Schedule value (01~31, MONDAY~SUNDAY, everyDay) Example : `1`	string
use_diagnosis_check_type_bp required	Checklist Best Practice Use Example : `y`	string
use_diagnosis_check_type_ssi required	Checklist SSI usage Example : `y`	string

27 - DiagnosisScheduleRequestV1Dot3

Name	Description	Schema
diagnosis_start_time_pattern required	Start time( 5-minute increments, 00 to 23 hours, 00 to 55 minutes ) Example : `08:00`	string
frequency_type required	Schedule type( monthly, weekly, daily) Example : `MONTH`	string
frequency_value required	Schedule value (01~31, MONDAY~SUNDAY, everyDay) Example : `1`	string

28 - DiagnosisScheduleResponse

Name	Description	Schema
diagnosis_id optional	Id of diagnosis Example : `DIA-943731CB8E3045C289BAECAEC3532097`	string
diagnosis_start_time_pattern optional	Start time( 5-minute increments, 00 to 23 hours, 00 to 55 minutes ) Example : `08:00`	string
frequency_type optional	Schedule type( monthly, weekly, daily) Example : `MONTH`	string
frequency_value optional	Schedule value (01~31, MONDAY~SUNDAY, everyDay) Example : `1`	string
use_diagnosis_check_type_bp optional	Checklist Best Practice Use Example : `y`	string
use_diagnosis_check_type_ssi optional	Checklist SSI usage Example : `y`	string

29 - DiagnosisScheduleResponseV1Dot3

Name	Description	Schema
diagnosis_id optional	Id of diagnosis Example : `DIA-943731CB8E3045C289BAECAEC3532097`	string
diagnosis_start_time_pattern optional	Start time( 5-minute increments, 00 to 23 hours, 00 to 55 minutes ) Example : `08:00`	string
frequency_type optional	Schedule type( monthly, weekly, daily) Example : `MONTH`	string
frequency_value optional	Schedule value (01~31, MONDAY~SUNDAY, everyDay) Example : `1`	string

30 - SummaryResponse

Name	Description	Schema
created_at required	Created date Example : `2022-01-01T12:00:00Z`	string (date-time)
csp_type required	Type of cloud service provider Example : `SCP`	string
diagnosis_account_id required	Id of diagnosis Example : `0e3dffc50eb247a1adf4f2e5c82c4f99`	string
diagnosis_check_type required	Check type of diagnosis Example : `BP`	string
diagnosis_id required	Id of diagnosis Example : `DIA-943731CB8E3045C289BAECAEC3532097`	string
diagnosis_name required	Name of diagnosis Example : `Sample Diagnosis Name`	string
diagnosis_type required	diagnosis Type Example : `Console`	string
error_state optional	Error type of recent diagnosis Example : `CONNECTION_FAIL`	any of [string, null]
plan_type required	plan Type Example : `STANDARD`	string
recent_diagnosis_at optional	recent Diagnosis Date Example : `2022-01-01T12:00:00Z`	any of [string (date-time), null]
recent_diagnosis_state optional	recent Diagnosis State Example : `Completed`	any of [string, null]

31 - SummaryResponseV1dot3

Name	Description	Schema
check_list_state optional	Current state of checklist Example : `ACTIVE`	any of [string, null]
check_list_version optional	Checklist version Example : `v1.0`	any of [string, null]
created_at required	Created date Example : `2022-01-01T12:00:00Z`	string (date-time)
csp_type required	Type of cloud service provider Example : `SCP`	string
diagnosis_account_id required	Id of diagnosis Example : `0e3dffc50eb247a1adf4f2e5c82c4f99`	string
diagnosis_check_type required	Check type of diagnosis Example : `BP`	string
diagnosis_id required	Id of diagnosis Example : `DIA-943731CB8E3045C289BAECAEC3532097`	string
diagnosis_name required	Name of diagnosis Example : `Sample Diagnosis Name`	string
diagnosis_type required	diagnosis Type Example : `Console`	string
error_state optional	Error type of recent diagnosis Example : `CONNECTION_FAIL`	any of [string, null]
plan_type required	plan Type Example : `STANDARD`	string
recent_diagnosis_at optional	recent Diagnosis Date Example : `2022-01-01T12:00:00Z`	any of [string (date-time), null]
recent_diagnosis_state optional	recent Diagnosis State Example : `Completed`	any of [string, null]

32 - Tag

Name	Description	Schema	Default
key required	tag key Example :	string
value required	tag value Example :	string

33 - TerminateResponse

Name	Description	Schema	Default
delete_flag required	True, False Check Example : `True`	boolean
msg required	message of delete Example : `Delete success`	string