This is the multi-page printable view of this section. Click here to print.
Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of Config Inspection and how to call CLI. The output is formatted as a JSON string
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | SUPPORTED | 20260531 |
| 1.1 | CURRENT | - |
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>]
Create Diagnosis Object
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| use_diagnosis_check_type_ssi required | string | Checklist SSI usage | y |
| use_diagnosis_check_type_bp required | string | Checklist Best Practice Use | 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 of auth key | 9b72a9856e494e67afc69atd3631fe38 |
| plan_type required | string | plan Type | STANDARD |
| diagnosis_type required | string | diagnosis Type | Console |
| diagnosis_name required | string | Name of diagnosis | Sample Diagnosis Name |
| diagnosis_id required | string | Id of diagnosis | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_check_type required | string | Check type of diagnosis | BP |
| diagnosis_account_id required | string | Id of diagnosis | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| csp_type required | string | Type of cloud service provider | SCP |
| account_id required | string | account Id | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
| auth_key_created_at optional | string | created date of authkey | 2022-01-01 12:00:00 |
| auth_key_expired_at optional | string | expired date of authkey | 2023-01-01 12:00:00 |
| Name | Description | Example |
|---|---|---|
| diagnosis_id | Id of diagnosis | Sample Diagnosis Name |
| result | True, False Check | True |
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>]
Create Diagnosis Object
State ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|---|
| 1.0 | 20260531 |
| Name | Type | Description | Example |
|---|---|---|---|
| use_diagnosis_check_type_ssi required | string | Checklist SSI usage | y |
| use_diagnosis_check_type_bp required | string | Checklist Best Practice Use | 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 of auth key | 9b72a9856e494e67afc69atd3631fe38 |
| plan_type required | string | plan Type | STANDARD |
| diagnosis_type required | string | diagnosis Type | Console |
| diagnosis_name required | string | Name of diagnosis | Sample Diagnosis Name |
| diagnosis_id required | string | Id of diagnosis | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_check_type required | string | Check type of diagnosis | BP |
| diagnosis_account_id required | string | Id of diagnosis | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| csp_type required | string | Type of cloud service provider | SCP |
| account_id required | string | account Id | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
| auth_key_created_at optional | string | created date of authkey | 2022-01-01 12:00:00 |
| auth_key_expired_at optional | string | expired date of authkey | 2023-01-01 12:00:00 |
| Name | Description | Example |
|---|---|---|
| result | True, False Check | True |
scpcli configinspection ci delete
--diagnosis_id <value>
Delete Config Inspection Product
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| diagnosis_id required | string | Id of diagnosis | Sample Diagnosis Name |
scpcli configinspection ci delete
--diagnosis_id <value>
Delete Config Inspection Product
State ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|---|
| 1.0 | 20260531 |
| Name | Type | Description | Example |
|---|---|---|---|
| diagnosis_id required | string | Id of diagnosis | Sample Diagnosis Name |
scpcli configinspection ci diagnosis request
--tenant_id <value>
--secret_key <value>
--diagnosis_id <value>
--diagnosis_check_type <value>
--access_key <value>
Request diagnosis
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| tenant_id required | string | Tenant ID | 1234567890 |
| secret_key required | string | Secret Key | SAMPLE KEY |
| diagnosis_id required | string | Id of diagnosis | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_check_type required | string | Check type of diagnosis | BP |
| access_key required | string | Access Key | SAMPLE KEY |
| Name | Description | Example |
|---|---|---|
| result | True, False Check | True |
scpcli configinspection ci diagnosis request
--tenant_id <value>
--secret_key <value>
--diagnosis_id <value>
--diagnosis_check_type <value>
--access_key <value>
Request diagnosis
State ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|---|
| 1.0 | 20260531 |
| Name | Type | Description | Example |
|---|---|---|---|
| tenant_id required | string | Tenant ID | 1234567890 |
| secret_key required | string | Secret Key | SAMPLE KEY |
| diagnosis_id required | string | Id of diagnosis | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_check_type required | string | Check type of diagnosis | BP |
| access_key required | string | Access Key | SAMPLE KEY |
| Name | Description | Example |
|---|---|---|
| result | True, False Check | True |
scpcli configinspection ci detail
--diagnosis_id <value>
Get Diagnosis Object Detail
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| diagnosis_id required | string | Id of diagnosis | Sample Diagnosis Name |
| Name | Description | Example |
|---|---|---|
| auth_key_created_at | created date of authkey | 2022-01-01T12:00:00Z |
| auth_key_expired_at | expired date of authkey | 2022-01-01T12:00:00Z |
| auth_key_id | Id of auth key | 9b72a9856e494e67afc69atd3631fe38 |
| auth_key_state | state of auth key | ACTIVATED |
| user_id | user Id | 4f5d60e9e08b48d0a0881e21ab14e266 |
scpcli configinspection ci detail
--diagnosis_id <value>
Get Diagnosis Object Detail
State ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|---|
| 1.0 | 20260531 |
| Name | Type | Description | Example |
|---|---|---|---|
| diagnosis_id required | string | Id of diagnosis | Sample Diagnosis Name |
| Name | Description | Example |
|---|---|---|
| auth_key_created_at | created date of authkey | 2022-01-01T12:00:00Z |
| auth_key_expired_at | expired date of authkey | 2022-01-01T12:00:00Z |
| auth_key_id | Id of auth key | 9b72a9856e494e67afc69atd3631fe38 |
| auth_key_state | state of auth key | ACTIVATED |
| user_id | user Id | 4f5d60e9e08b48d0a0881e21ab14e266 |
scpcli configinspection ci result detail
--diagnosis_request_sequence <value>
--diagnosis_id <value>
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
get Diagnosis Result Detail
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| diagnosis_request_sequence required | string | Sequence of diagnosis request | SCPCIS-E75FD21CA524441C9C1B1B381D5974F7 |
| diagnosis_id required | string | Id of diagnosis | 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 |
| Name | Description | Example |
|---|---|---|
| action_guide | measure guide description | 원격 접속 Port에 Source IP가 ANY(0.0.0.0/0)로 등록되어있거나 과도하게 허용된 Security Group 규칙은 아래와 같이 삭제합니다. |
| changed | iS Change result manage | True |
| diagnosis_check_type | Check type of diagnosis | BP |
| diagnosis_criteria | decision standard description | 【 Security Group 규칙 】 |
| ① 원격접속 Port에 Any IP 접근을 허용하는 규칙이 존재하지 않아야 합니다. | ||
| diagnosis_item | sub category description | 2.NW_003. 프로토콜 별 원격접속 Port는 접근이 필요한 IP를 지정하여 접속을 허용해야 합니다. |
| diagnosis_layer | inspector item category description | 2.NETWORK |
| diagnosis_method | inspector method description | Security Group의 Inbound 규칙에 원격 접속이 필요한 사용자나 시스템만 접근을 허용하는 규칙을 등록 하였는지 확인합니다. |
| diagnosis_result | verify result state | 03 |
| result_contents | result Contents | 상세 내역 |
| sub_category | Sub Category | NURIBP_SCP_02.NW_004 |
scpcli configinspection ci result detail
--diagnosis_request_sequence <value>
--diagnosis_id <value>
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
get Diagnosis Result Detail
State ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|---|
| 1.0 | 20260531 |
| Name | Type | Description | Example |
|---|---|---|---|
| diagnosis_request_sequence required | string | Sequence of diagnosis request | SCPCIS-E75FD21CA524441C9C1B1B381D5974F7 |
| diagnosis_id required | string | Id of diagnosis | 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 |
| Name | Description | Example |
|---|---|---|
| action_guide | measure guide description | 원격 접속 Port에 Source IP가 ANY(0.0.0.0/0)로 등록되어있거나 과도하게 허용된 Security Group 규칙은 아래와 같이 삭제합니다. |
| changed | iS Change result manage | True |
| diagnosis_check_type | Check type of diagnosis | BP |
| diagnosis_criteria | decision standard description | 【 Security Group 규칙 】 |
| ① 원격접속 Port에 Any IP 접근을 허용하는 규칙이 존재하지 않아야 합니다. | ||
| diagnosis_item | sub category description | 2.NW_003. 프로토콜 별 원격접속 Port는 접근이 필요한 IP를 지정하여 접속을 허용해야 합니다. |
| diagnosis_layer | inspector item category description | 2.NETWORK |
| diagnosis_method | inspector method description | Security Group의 Inbound 규칙에 원격 접속이 필요한 사용자나 시스템만 접근을 허용하는 규칙을 등록 하였는지 확인합니다. |
| diagnosis_result | verify result state | 03 |
| result_contents | result Contents | 상세 내역 |
| sub_category | Sub Category | NURIBP_SCP_02.NW_004 |
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>]
get config inspection list
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.1 | - |
| 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 | my Config Inspection | False |
| diagnosis_id optional | string | Id of diagnosis | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_name optional | string | Name of diagnosis | My Diagnosis |
| csp_type optional | string | Type of cloud service provider | SCP |
| diagnosis_account_id optional | string | Id of diagnosis | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| recent_diagnosis_state optional | array | recent Diagnosis State | C |
| start_date optional | string | start Date | 2022-01-01 12:00:00 |
| end_date optional | string | end Date | 2022-01-02 12:00:00 |
| Name | Description | Example |
|---|---|---|
| created_at | Created date | 2022-01-01T12:00:00Z |
| csp_type | Type of cloud service provider | SCP |
| diagnosis_account_id | Id of diagnosis | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| diagnosis_check_type | Check type of diagnosis | BP |
| diagnosis_id | Id of diagnosis | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_name | Name of diagnosis | Sample Diagnosis Name |
| diagnosis_type | diagnosis Type | Console |
| error_state | Error type of recent diagnosis | CONNECTION_FAIL |
| plan_type | plan Type | STANDARD |
| recent_diagnosis_at | recent Diagnosis Date | 2022-01-01T12:00:00Z |
| recent_diagnosis_state | recent Diagnosis State | Completed |
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>]
get config inspection list
State ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|---|
| 1.0 | 20260531 |
| 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 | my Config Inspection | False |
| diagnosis_id optional | string | Id of diagnosis | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_name optional | string | Name of diagnosis | My Diagnosis |
| csp_type optional | string | Type of cloud service provider | SCP |
| diagnosis_account_id optional | string | Id of diagnosis | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| recent_diagnosis_state optional | array | recent Diagnosis State | C |
| start_date optional | string | start Date | 2022-01-01 12:00:00 |
| end_date optional | string | end Date | 2022-01-02 12:00:00 |
| Name | Description | Example |
|---|---|---|
| created_at | Created date | 2022-01-01T12:00:00Z |
| csp_type | Type of cloud service provider | SCP |
| diagnosis_account_id | Id of diagnosis | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| diagnosis_check_type | Check type of diagnosis | BP |
| diagnosis_id | Id of diagnosis | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_name | Name of diagnosis | Sample Diagnosis Name |
| diagnosis_type | diagnosis Type | Console |
| error_state | Error type of recent diagnosis | CONNECTION_FAIL |
| plan_type | plan Type | STANDARD |
| recent_diagnosis_at | recent Diagnosis Date | 2022-01-01T12:00:00Z |
| recent_diagnosis_state | recent Diagnosis State | Completed |
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>]
get Diagnosis Result List
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.1 | - |
| 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 | account Id | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| diagnosis_id optional | string | Id of diagnosis | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_name optional | string | Name of diagnosis | Sample Diagnosis Name |
| start_date optional | string | start Date | 2022-01-01 |
| end_date optional | string | end Date | 2022-12-31 |
| csp_type optional | string | Type of cloud service provider | SCP |
| diagnosis_state optional | string | Status of diagnosis | Completed |
| user_id optional | string | user Id | 76b563a009584b1380715c00703a02ff |
| Name | Description | Example |
|---|---|---|
| count_check | check count | 10 |
| count_error | error count | 0 |
| count_fail | fail count | 3 |
| count_na | na count | 2 |
| count_pass | pass count | 5 |
| csp_type | Type of cloud service provider | SCP |
| diagnosis_account_id | Id of diagnosis | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| diagnosis_check_type | Check type of diagnosis | BP |
| diagnosis_id | Id of diagnosis | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_name | Name of diagnosis | Sample Diagnosis Name |
| diagnosis_request_sequence | Sequence of diagnosis request | 1234567890 |
| diagnosis_result | diagnosis Result | SUCCESS |
| diagnosis_total_count | diagnosis Total Count | 10 |
| proceed_date | proceed Date | 2022-01-01T12:00:00Z |
| total | total count | 10 |
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>]
get Diagnosis Result List
State ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|---|
| 1.0 | 20260531 |
| 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 | account Id | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| diagnosis_id optional | string | Id of diagnosis | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_name optional | string | Name of diagnosis | Sample Diagnosis Name |
| start_date optional | string | start Date | 2022-01-01 |
| end_date optional | string | end Date | 2022-12-31 |
| csp_type optional | string | Type of cloud service provider | SCP |
| diagnosis_state optional | string | Status of diagnosis | Completed |
| user_id optional | string | user Id | 76b563a009584b1380715c00703a02ff |
| Name | Description | Example |
|---|---|---|
| count_check | check count | 10 |
| count_error | error count | 0 |
| count_fail | fail count | 3 |
| count_na | na count | 2 |
| count_pass | pass count | 5 |
| csp_type | Type of cloud service provider | SCP |
| diagnosis_account_id | Id of diagnosis | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| diagnosis_check_type | Check type of diagnosis | BP |
| diagnosis_id | Id of diagnosis | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_name | Name of diagnosis | Sample Diagnosis Name |
| diagnosis_request_sequence | Sequence of diagnosis request | 1234567890 |
| diagnosis_result | diagnosis Result | SUCCESS |
| diagnosis_total_count | diagnosis Total Count | 10 |
| proceed_date | proceed Date | 2022-01-01T12:00:00Z |
| total | total count | 10 |