This is the multi-page printable view of this section. Click here to print.
CLIs
1 - Create Config Inspection
1.1 - 1.2
scp-cli configinspection ci create
--schedule_request_diagnosis_id <value>
--diagnosis_id <value>
--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_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>]
[--auth_key_request_diagnosis_id <value>]
Description
Create Diagnosis Object
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| schedule_request_diagnosis_id required | string | Id of diagnosis | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_id required | string | Id of diagnosis | DIA-943731CB8E3045C289BAECAEC3532097 |
| 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_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 |
| auth_key_request_diagnosis_id optional | string | Id of diagnosis | DIA-943731CB8E3045C289BAECAEC3532097 |
Responses
| Name | Description | Example |
|---|---|---|
| diagnosis_id | Id of diagnosis | Sample Diagnosis Name |
| result | True, False Check | True |
1.2 - 1.1
scp-cli configinspection ci create
--schedule_request_diagnosis_id <value>
--diagnosis_id <value>
--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_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>]
[--auth_key_request_diagnosis_id <value>]
Description
Create Diagnosis Object
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| schedule_request_diagnosis_id required | string | Id of diagnosis | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_id required | string | Id of diagnosis | DIA-943731CB8E3045C289BAECAEC3532097 |
| 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_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 |
| auth_key_request_diagnosis_id optional | string | Id of diagnosis | DIA-943731CB8E3045C289BAECAEC3532097 |
Responses
| Name | Description | Example |
|---|---|---|
| diagnosis_id | Id of diagnosis | Sample Diagnosis Name |
| result | True, False Check | True |
1.3 - 1.0
scp-cli configinspection ci create
--schedule_request_diagnosis_id <value>
--diagnosis_id <value>
--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_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>]
[--auth_key_request_diagnosis_id <value>]
Description
Create Diagnosis Object
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| schedule_request_diagnosis_id required | string | Id of diagnosis | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_id required | string | Id of diagnosis | DIA-943731CB8E3045C289BAECAEC3532097 |
| 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_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 |
| auth_key_request_diagnosis_id optional | string | Id of diagnosis | DIA-943731CB8E3045C289BAECAEC3532097 |
Responses
| Name | Description | Example |
|---|---|---|
| result | True, False Check | True |
2 - Delete Config Inspection
2.1 - 1.2
scp-cli configinspection ci delete
--diagnosis_id <value>
Description
Delete Config Inspection Product
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| diagnosis_id required | string | Id of diagnosis | Sample Diagnosis Name |
2.2 - 1.1
scp-cli configinspection ci delete
--diagnosis_id <value>
Description
Delete Config Inspection Product
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| diagnosis_id required | string | Id of diagnosis | Sample Diagnosis Name |
2.3 - 1.0
scp-cli configinspection ci delete
--diagnosis_id <value>
Description
Delete Config Inspection Product
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| diagnosis_id required | string | Id of diagnosis | Sample Diagnosis Name |
3 - Diagnosis Request
3.1 - 1.2
scp-cli configinspection ci diagnosis request
--tenant_id <value>
--secret_key <value>
--diagnosis_id <value>
--diagnosis_check_type <value>
--access_key <value>
Description
Request diagnosis
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
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 of diagnosis | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_check_type required | string | Check type of diagnosis | BP |
| access_key required | string | Access Key | SAMPLE KEY |
Responses
| Name | Description | Example |
|---|---|---|
| result | True, False Check | True |
3.2 - 1.1
scp-cli configinspection ci diagnosis request
--tenant_id <value>
--secret_key <value>
--diagnosis_id <value>
--diagnosis_check_type <value>
--access_key <value>
Description
Request diagnosis
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
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 of diagnosis | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_check_type required | string | Check type of diagnosis | BP |
| access_key required | string | Access Key | SAMPLE KEY |
Responses
| Name | Description | Example |
|---|---|---|
| result | True, False Check | True |
3.3 - 1.0
scp-cli configinspection ci diagnosis request
--tenant_id <value>
--secret_key <value>
--diagnosis_id <value>
--diagnosis_check_type <value>
--access_key <value>
Description
Request diagnosis
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 of diagnosis | DIA-943731CB8E3045C289BAECAEC3532097 |
| diagnosis_check_type required | string | Check type of diagnosis | BP |
| access_key required | string | Access Key | SAMPLE KEY |
Responses
| Name | Description | Example |
|---|---|---|
| result | True, False Check | True |
4 - Get Diagnosis Object Detail
4.1 - 1.2
scp-cli configinspection ci detail
--diagnosis_id <value>
Description
Get Diagnosis Object Detail
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| diagnosis_id required | string | Id of diagnosis | Sample Diagnosis Name |
Responses
| Name | Description | Example |
|---|---|---|
| auth_key_responses | {} | |
| schedule_response | {} | |
| summary_responses | {} |
4.2 - 1.1
scp-cli configinspection ci detail
--diagnosis_id <value>
Description
Get Diagnosis Object Detail
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| diagnosis_id required | string | Id of diagnosis | Sample Diagnosis Name |
Responses
| Name | Description | Example |
|---|---|---|
| auth_key_responses | {} | |
| schedule_response | {} | |
| summary_responses | {} |
4.3 - 1.0
scp-cli configinspection ci detail
--diagnosis_id <value>
Description
Get Diagnosis Object Detail
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| diagnosis_id required | string | Id of diagnosis | Sample Diagnosis Name |
Responses
| Name | Description | Example |
|---|---|---|
| auth_key_responses | {} | |
| schedule_response | {} | |
| summary_responses | {} |
5 - Get Diagnosis Result Detail
5.1 - 1.2
scp-cli configinspection ci result detail
--diagnosis_request_sequence <value>
--diagnosis_id <value>
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
Description
get Diagnosis Result Detail
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| 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 |
Responses
| Name | Description | Example |
|---|---|---|
| checklist_name | checklist Name | Sample Checklist |
| count | total count | 20 |
| 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 | SCPCIS-E75FD21CA524441C9C1B1B381D5974F7 |
| links | links | [{‘href’: ‘http://scp.samsungsdscloud.com/v1/notices’, ‘rel’: ‘self’}] |
| proceed_date | proceed Date | |
| result_detail_list | [] | |
| total | total count | 10 |
5.2 - 1.1
scp-cli configinspection ci result detail
--diagnosis_request_sequence <value>
--diagnosis_id <value>
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
Description
get Diagnosis Result Detail
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Parameters
| 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 |
Responses
| Name | Description | Example |
|---|---|---|
| checklist_name | checklist Name | Sample Checklist |
| count | total count | 20 |
| 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 | SCPCIS-E75FD21CA524441C9C1B1B381D5974F7 |
| links | links | [{‘href’: ‘http://scp.samsungsdscloud.com/v1/notices’, ‘rel’: ‘self’}] |
| proceed_date | proceed Date | |
| result_detail_list | [] | |
| total | total count | 10 |
5.3 - 1.0
scp-cli configinspection ci result detail
--diagnosis_request_sequence <value>
--diagnosis_id <value>
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
Description
get Diagnosis Result Detail
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| 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 |
Responses
| Name | Description | Example |
|---|---|---|
| checklist_name | checklist Name | Sample Checklist |
| count | total count | 20 |
| 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 | SCPCIS-E75FD21CA524441C9C1B1B381D5974F7 |
| links | links | [{‘href’: ‘http://scp.samsungsdscloud.com/v1/notices’, ‘rel’: ‘self’}] |
| proceed_date | proceed Date | |
| result_detail_list | [] | |
| total | total count | 10 |
6 - List Config Inspection
6.1 - 1.2
scp-cli 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
get config inspection list
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
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 | 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 |
Responses
| 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 |
6.2 - 1.1
scp-cli 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
get config inspection list
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
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 | 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 |
Responses
| 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 |
6.3 - 1.0
scp-cli 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
get config inspection list
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 | 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 |
Responses
| 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 |
7 - List Diagnosis Result
7.1 - 1.2
scp-cli 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
get Diagnosis Result List
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
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 | 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 |
Responses
| 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 |
7.2 - 1.1
scp-cli 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
get Diagnosis Result List
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
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 | 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 |
Responses
| 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 |
7.3 - 1.0
scp-cli 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
get Diagnosis Result List
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 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 | 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 |
Responses
| 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 |