Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 Config Inspection에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | SUPPORTED | 20260531 |
| 1.1 | CURRENT | - |
이 섹션의 다중 페이지 출력 화면임. 여기를 클릭하여 프린트.
Config Inspection
1 - CLIs
1.1 - Create Config Inspection
1.1.1 - 1.1
scpcli configinspection ci create
--use_diagnosis_check_type_ssi <value>
--use_diagnosis_check_type_bp <value>
--frequency_value <value>
--frequency_type <value>
--diagnosis_start_time_pattern <value>
--auth_key_id <value>
--plan_type <value>
--diagnosis_type <value>
--diagnosis_name <value>
--diagnosis_id <value>
--diagnosis_check_type <value>
--diagnosis_account_id <value>
--csp_type <value>
--account_id <value>
[--tags <value>]
[--auth_key_created_at <value>]
[--auth_key_expired_at <value>]
Description
진단 상품 생성
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| use_diagnosis_check_type_ssi required | string | 체크리스트 SSI 사용 여부 | y |
| use_diagnosis_check_type_bp required | string | 체크리스트 Best Practice 사용 여부 | y |
| frequency_value required | string | Schedule value (01~31, MONDAY~SUNDAY, everyDay) | 1 |
| frequency_type required | string | Schedule type( monthly, weekly, daily) | MONTH |
| diagnosis_start_time_pattern required | string | Start time( 5-minute increments, 00 to 23 hours, 00 to 55 minutes ) | 08:00 |
| auth_key_id required | string | 인증키 ID | 9b72a9856e494e67afc69atd3631fe38 |
| plan_type required | string | 요금제 | STANDARD |
| diagnosis_type required | string | 진단 유형 | Console |
| diagnosis_name required | string | 진단명 | Sample Diagnosis Name |
| diagnosis_id required | string | 진단 ID | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_check_type required | string | 진단 체크리스트 | BP |
| diagnosis_account_id required | string | 진단 ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| csp_type required | string | 클라우드 서비스 제공자의 유형 | SCP |
| account_id required | string | 진단 계정 | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
| auth_key_created_at optional | string | 인증 키 생성 날짜 | 2022-01-01 12:00:00 |
| auth_key_expired_at optional | string | 인증 키 만료 날짜 | 2023-01-01 12:00:00 |
Responses
| Name | Description | Example |
|---|---|---|
| diagnosis_id | 진단 ID | Sample Diagnosis Name |
| result | True, False 체크 | True |
1.1.2 - 1.0
scpcli configinspection ci create
--use_diagnosis_check_type_ssi <value>
--use_diagnosis_check_type_bp <value>
--frequency_value <value>
--frequency_type <value>
--diagnosis_start_time_pattern <value>
--auth_key_id <value>
--plan_type <value>
--diagnosis_type <value>
--diagnosis_name <value>
--diagnosis_id <value>
--diagnosis_check_type <value>
--diagnosis_account_id <value>
--csp_type <value>
--account_id <value>
[--tags <value>]
[--auth_key_created_at <value>]
[--auth_key_expired_at <value>]
Description
진단 상품 생성
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| use_diagnosis_check_type_ssi required | string | 체크리스트 SSI 사용 여부 | y |
| use_diagnosis_check_type_bp required | string | 체크리스트 Best Practice 사용 여부 | y |
| frequency_value required | string | Schedule value (01~31, MONDAY~SUNDAY, everyDay) | 1 |
| frequency_type required | string | Schedule type( monthly, weekly, daily) | MONTH |
| diagnosis_start_time_pattern required | string | Start time( 5-minute increments, 00 to 23 hours, 00 to 55 minutes ) | 08:00 |
| auth_key_id required | string | 인증키 ID | 9b72a9856e494e67afc69atd3631fe38 |
| plan_type required | string | 요금제 | STANDARD |
| diagnosis_type required | string | 진단 유형 | Console |
| diagnosis_name required | string | 진단명 | Sample Diagnosis Name |
| diagnosis_id required | string | 진단 ID | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_check_type required | string | 진단 체크리스트 | BP |
| diagnosis_account_id required | string | 진단 ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| csp_type required | string | 클라우드 서비스 제공자의 유형 | SCP |
| account_id required | string | 진단 계정 | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
| auth_key_created_at optional | string | 인증 키 생성 날짜 | 2022-01-01 12:00:00 |
| auth_key_expired_at optional | string | 인증 키 만료 날짜 | 2023-01-01 12:00:00 |
Responses
| Name | Description | Example |
|---|---|---|
| result | True, False 체크 | True |
1.2 - Delete Config Inspection
1.2.1 - 1.1
scpcli configinspection ci delete
--diagnosis_id <value>
Description
config inspection 목록 가져오기
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| diagnosis_id required | string | 진단 ID | Sample Diagnosis Name |
1.2.2 - 1.0
scpcli configinspection ci delete
--diagnosis_id <value>
Description
config inspection 목록 가져오기
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| diagnosis_id required | string | 진단 ID | Sample Diagnosis Name |
1.3 - Diagnosis Request
1.3.1 - 1.1
scpcli configinspection ci diagnosis request
--tenant_id <value>
--secret_key <value>
--diagnosis_id <value>
--diagnosis_check_type <value>
--access_key <value>
Description
진단 요청
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| tenant_id required | string | Tenant ID | 1234567890 |
| secret_key required | string | Secret Key | SAMPLE KEY |
| diagnosis_id required | string | 진단 ID | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_check_type required | string | 진단 체크리스트 | BP |
| access_key required | string | Access Key | SAMPLE KEY |
Responses
| Name | Description | Example |
|---|---|---|
| result | True, False 체크 | True |
1.3.2 - 1.0
scpcli configinspection ci diagnosis request
--tenant_id <value>
--secret_key <value>
--diagnosis_id <value>
--diagnosis_check_type <value>
--access_key <value>
Description
진단 요청
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| tenant_id required | string | Tenant ID | 1234567890 |
| secret_key required | string | Secret Key | SAMPLE KEY |
| diagnosis_id required | string | 진단 ID | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_check_type required | string | 진단 체크리스트 | BP |
| access_key required | string | Access Key | SAMPLE KEY |
Responses
| Name | Description | Example |
|---|---|---|
| result | True, False 체크 | True |
1.4 - Get Diagnosis Object Detail
1.4.1 - 1.1
scpcli configinspection ci detail
--diagnosis_id <value>
Description
진단 결과 세부 정보 가져오기
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| diagnosis_id required | string | 진단 ID | Sample Diagnosis Name |
Responses
| Name | Description | Example |
|---|---|---|
| auth_key_created_at | 인증 키 생성 날짜 | 2022-01-01T12:00:00Z |
| auth_key_expired_at | 인증 키 만료 날짜 | 2022-01-01T12:00:00Z |
| auth_key_id | 인증키 ID | 9b72a9856e494e67afc69atd3631fe38 |
| auth_key_state | 인증키 상태 | ACTIVATED |
| user_id | 사용자 ID | 4f5d60e9e08b48d0a0881e21ab14e266 |
1.4.2 - 1.0
scpcli configinspection ci detail
--diagnosis_id <value>
Description
진단 결과 세부 정보 가져오기
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| diagnosis_id required | string | 진단 ID | Sample Diagnosis Name |
Responses
| Name | Description | Example |
|---|---|---|
| auth_key_created_at | 인증 키 생성 날짜 | 2022-01-01T12:00:00Z |
| auth_key_expired_at | 인증 키 만료 날짜 | 2022-01-01T12:00:00Z |
| auth_key_id | 인증키 ID | 9b72a9856e494e67afc69atd3631fe38 |
| auth_key_state | 인증키 상태 | ACTIVATED |
| user_id | 사용자 ID | 4f5d60e9e08b48d0a0881e21ab14e266 |
1.5 - Get Diagnosis Result Detail
1.5.1 - 1.1
scpcli configinspection ci result detail
--diagnosis_request_sequence <value>
--diagnosis_id <value>
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
Description
진단 결과 세부 정보 가져오기
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| diagnosis_request_sequence required | string | 진단 요청 Sequence | SCPCIS-E75FD21CA524441C9C1B1B381D5974F7 |
| diagnosis_id required | string | 진단 ID | DIA-943731CB8E3045C289BAECAEC3532097 |
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| action_guide | 조치 가이드 | 원격 접속 Port에 Source IP가 ANY(0.0.0.0/0)로 등록되어있거나 과도하게 허용된 Security Group 규칙은 아래와 같이 삭제합니다. |
| changed | 관리결과 변경 여부 | True |
| diagnosis_check_type | 진단 체크리스트 | BP |
| diagnosis_criteria | 진단 기준 | 【 Security Group 규칙 】 |
| ① 원격접속 Port에 Any IP 접근을 허용하는 규칙이 존재하지 않아야 합니다. | ||
| diagnosis_item | 진단 항목 | 2.NW_003. 프로토콜 별 원격접속 Port는 접근이 필요한 IP를 지정하여 접속을 허용해야 합니다. |
| diagnosis_layer | 영역 | 2.NETWORK |
| diagnosis_method | 진단 방법 | Security Group의 Inbound 규칙에 원격 접속이 필요한 사용자나 시스템만 접근을 허용하는 규칙을 등록 하였는지 확인합니다. |
| diagnosis_result | 확인결과 상태 | 03 |
| result_contents | 상세 결과 | 상세 내역 |
| sub_category | Sub Category | NURIBP_SCP_02.NW_004 |
1.5.2 - 1.0
scpcli configinspection ci result detail
--diagnosis_request_sequence <value>
--diagnosis_id <value>
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
Description
진단 결과 세부 정보 가져오기
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| diagnosis_request_sequence required | string | 진단 요청 Sequence | SCPCIS-E75FD21CA524441C9C1B1B381D5974F7 |
| diagnosis_id required | string | 진단 ID | DIA-943731CB8E3045C289BAECAEC3532097 |
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| action_guide | 조치 가이드 | 원격 접속 Port에 Source IP가 ANY(0.0.0.0/0)로 등록되어있거나 과도하게 허용된 Security Group 규칙은 아래와 같이 삭제합니다. |
| changed | 관리결과 변경 여부 | True |
| diagnosis_check_type | 진단 체크리스트 | BP |
| diagnosis_criteria | 진단 기준 | 【 Security Group 규칙 】 |
| ① 원격접속 Port에 Any IP 접근을 허용하는 규칙이 존재하지 않아야 합니다. | ||
| diagnosis_item | 진단 항목 | 2.NW_003. 프로토콜 별 원격접속 Port는 접근이 필요한 IP를 지정하여 접속을 허용해야 합니다. |
| diagnosis_layer | 영역 | 2.NETWORK |
| diagnosis_method | 진단 방법 | Security Group의 Inbound 규칙에 원격 접속이 필요한 사용자나 시스템만 접근을 허용하는 규칙을 등록 하였는지 확인합니다. |
| diagnosis_result | 확인결과 상태 | 03 |
| result_contents | 상세 결과 | 상세 내역 |
| sub_category | Sub Category | NURIBP_SCP_02.NW_004 |
1.6 - List Config Inspection
1.6.1 - 1.1
scpcli configinspection ci list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--ismine <value>]
[--diagnosis_id <value>]
[--diagnosis_name <value>]
[--csp_type <value>]
[--diagnosis_account_id <value>]
[--recent_diagnosis_state <value>]
[--start_date <value>]
[--end_date <value>]
Description
config inspection 목록 가져오기
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| ismine optional | boolean | 나의 Config Inspection | False |
| diagnosis_id optional | string | 진단 ID | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_name optional | string | 진단명 | My Diagnosis |
| csp_type optional | string | 클라우드 서비스 제공자의 유형 | SCP |
| diagnosis_account_id optional | string | 진단 ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| recent_diagnosis_state optional | array | 최근 진단 상태 | C |
| start_date optional | string | 시작일 | 2022-01-01 12:00:00 |
| end_date optional | string | 종료일 | 2022-01-02 12:00:00 |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | 생성일시 | 2022-01-01T12:00:00Z |
| csp_type | 클라우드 서비스 제공자의 유형 | SCP |
| diagnosis_account_id | 진단 ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| diagnosis_check_type | 진단 체크리스트 | BP |
| diagnosis_id | 진단 ID | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_name | 진단명 | Sample Diagnosis Name |
| diagnosis_type | 진단 유형 | Console |
| error_state | 최근 진단 오류 타입 | CONNECTION_FAIL |
| plan_type | 요금제 | STANDARD |
| recent_diagnosis_at | 최근 진단 일시 | 2022-01-01T12:00:00Z |
| recent_diagnosis_state | 최근 진단 상태 | Completed |
1.6.2 - 1.0
scpcli configinspection ci list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--ismine <value>]
[--diagnosis_id <value>]
[--diagnosis_name <value>]
[--csp_type <value>]
[--diagnosis_account_id <value>]
[--recent_diagnosis_state <value>]
[--start_date <value>]
[--end_date <value>]
Description
config inspection 목록 가져오기
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| ismine optional | boolean | 나의 Config Inspection | False |
| diagnosis_id optional | string | 진단 ID | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_name optional | string | 진단명 | My Diagnosis |
| csp_type optional | string | 클라우드 서비스 제공자의 유형 | SCP |
| diagnosis_account_id optional | string | 진단 ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| recent_diagnosis_state optional | array | 최근 진단 상태 | C |
| start_date optional | string | 시작일 | 2022-01-01 12:00:00 |
| end_date optional | string | 종료일 | 2022-01-02 12:00:00 |
Responses
| Name | Description | Example |
|---|---|---|
| created_at | 생성일시 | 2022-01-01T12:00:00Z |
| csp_type | 클라우드 서비스 제공자의 유형 | SCP |
| diagnosis_account_id | 진단 ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| diagnosis_check_type | 진단 체크리스트 | BP |
| diagnosis_id | 진단 ID | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_name | 진단명 | Sample Diagnosis Name |
| diagnosis_type | 진단 유형 | Console |
| error_state | 최근 진단 오류 타입 | CONNECTION_FAIL |
| plan_type | 요금제 | STANDARD |
| recent_diagnosis_at | 최근 진단 일시 | 2022-01-01T12:00:00Z |
| recent_diagnosis_state | 최근 진단 상태 | Completed |
1.7 - List Diagnosis Result
1.7.1 - 1.1
scpcli configinspection ci result list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--account_id <value>]
[--diagnosis_id <value>]
[--diagnosis_name <value>]
[--start_date <value>]
[--end_date <value>]
[--csp_type <value>]
[--diagnosis_state <value>]
[--user_id <value>]
Description
진단 결과 목록 가져오기
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| account_id optional | string | 진단 계정 | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| diagnosis_id optional | string | 진단 ID | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_name optional | string | 진단명 | Sample Diagnosis Name |
| start_date optional | string | 시작일 | 2022-01-01 |
| end_date optional | string | 종료일 | 2022-12-31 |
| csp_type optional | string | 클라우드 서비스 제공자의 유형 | SCP |
| diagnosis_state optional | string | 진단 상태 | Completed |
| user_id optional | string | 사용자 ID | 76b563a009584b1380715c00703a02ff |
Responses
| Name | Description | Example |
|---|---|---|
| count_check | check 개수 | 10 |
| count_error | error 개수 | 0 |
| count_fail | fail 개수 | 3 |
| count_na | na 개수 | 2 |
| count_pass | pass 개수 | 5 |
| csp_type | 클라우드 서비스 제공자의 유형 | SCP |
| diagnosis_account_id | 진단 ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| diagnosis_check_type | 진단 체크리스트 | BP |
| diagnosis_id | 진단 ID | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_name | 진단명 | Sample Diagnosis Name |
| diagnosis_request_sequence | 진단 요청 Sequence | 1234567890 |
| diagnosis_result | 진단 결과 | SUCCESS |
| diagnosis_total_count | 총 개수 | 10 |
| proceed_date | 진단 일자 | 2022-01-01T12:00:00Z |
| total | 전체 개수 | 10 |
1.7.2 - 1.0
scpcli configinspection ci result list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--account_id <value>]
[--diagnosis_id <value>]
[--diagnosis_name <value>]
[--start_date <value>]
[--end_date <value>]
[--csp_type <value>]
[--diagnosis_state <value>]
[--user_id <value>]
Description
진단 결과 목록 가져오기
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| account_id optional | string | 진단 계정 | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| diagnosis_id optional | string | 진단 ID | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_name optional | string | 진단명 | Sample Diagnosis Name |
| start_date optional | string | 시작일 | 2022-01-01 |
| end_date optional | string | 종료일 | 2022-12-31 |
| csp_type optional | string | 클라우드 서비스 제공자의 유형 | SCP |
| diagnosis_state optional | string | 진단 상태 | Completed |
| user_id optional | string | 사용자 ID | 76b563a009584b1380715c00703a02ff |
Responses
| Name | Description | Example |
|---|---|---|
| count_check | check 개수 | 10 |
| count_error | error 개수 | 0 |
| count_fail | fail 개수 | 3 |
| count_na | na 개수 | 2 |
| count_pass | pass 개수 | 5 |
| csp_type | 클라우드 서비스 제공자의 유형 | SCP |
| diagnosis_account_id | 진단 ID | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| diagnosis_check_type | 진단 체크리스트 | BP |
| diagnosis_id | 진단 ID | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_name | 진단명 | Sample Diagnosis Name |
| diagnosis_request_sequence | 진단 요청 Sequence | 1234567890 |
| diagnosis_result | 진단 결과 | SUCCESS |
| diagnosis_total_count | 총 개수 | 10 |
| proceed_date | 진단 일자 | 2022-01-01T12:00:00Z |
| total | 전체 개수 | 10 |