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

Return to the regular view of this page.

Config Inspection

Overview

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

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionStatusNot Before
1.2CURRENT-
1.1SUPPORTED20260831
1.0DEPRECATED20260531

1 - CLIs

1.1 - Create Config Inspection

1.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)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
schedule_request_diagnosis_id
required
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_id
required
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
use_diagnosis_check_type_ssi
required
stringChecklist SSI usagey
use_diagnosis_check_type_bp
required
stringChecklist Best Practice Usey
frequency_value
required
stringSchedule value (01~31, MONDAY~SUNDAY, everyDay)1
frequency_type
required
stringSchedule type( monthly, weekly, daily)MONTH
diagnosis_start_time_pattern
required
stringStart time( 5-minute increments, 00 to 23 hours, 00 to 55 minutes )08:00
auth_key_id
required
stringId of auth key9b72a9856e494e67afc69atd3631fe38
plan_type
required
stringplan TypeSTANDARD
diagnosis_type
required
stringdiagnosis TypeConsole
diagnosis_name
required
stringName of diagnosisSample Diagnosis Name
diagnosis_check_type
required
stringCheck type of diagnosisBP
diagnosis_account_id
required
stringId of diagnosis0e3dffc50eb247a1adf4f2e5c82c4f99
csp_type
required
stringType of cloud service providerSCP
account_id
required
stringaccount Id0e3dffc50eb247a1adf4f2e5c82c4f99
tags
optional
arrayTag List'{"key": "", "value": ""}'
auth_key_created_at
optional
stringcreated date of authkey2022-01-01 12:00:00
auth_key_expired_at
optional
stringexpired date of authkey2023-01-01 12:00:00
auth_key_request_diagnosis_id
optional
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097

Responses

NameDescriptionExample
diagnosis_idId of diagnosisSample Diagnosis Name
resultTrue, False CheckTrue

1.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)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
schedule_request_diagnosis_id
required
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_id
required
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
use_diagnosis_check_type_ssi
required
stringChecklist SSI usagey
use_diagnosis_check_type_bp
required
stringChecklist Best Practice Usey
frequency_value
required
stringSchedule value (01~31, MONDAY~SUNDAY, everyDay)1
frequency_type
required
stringSchedule type( monthly, weekly, daily)MONTH
diagnosis_start_time_pattern
required
stringStart time( 5-minute increments, 00 to 23 hours, 00 to 55 minutes )08:00
auth_key_id
required
stringId of auth key9b72a9856e494e67afc69atd3631fe38
plan_type
required
stringplan TypeSTANDARD
diagnosis_type
required
stringdiagnosis TypeConsole
diagnosis_name
required
stringName of diagnosisSample Diagnosis Name
diagnosis_check_type
required
stringCheck type of diagnosisBP
diagnosis_account_id
required
stringId of diagnosis0e3dffc50eb247a1adf4f2e5c82c4f99
csp_type
required
stringType of cloud service providerSCP
account_id
required
stringaccount Id0e3dffc50eb247a1adf4f2e5c82c4f99
tags
optional
arrayTag List'{"key": "", "value": ""}'
auth_key_created_at
optional
stringcreated date of authkey2022-01-01 12:00:00
auth_key_expired_at
optional
stringexpired date of authkey2023-01-01 12:00:00
auth_key_request_diagnosis_id
optional
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097

Responses

NameDescriptionExample
diagnosis_idId of diagnosisSample Diagnosis Name
resultTrue, False CheckTrue

1.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.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
schedule_request_diagnosis_id
required
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_id
required
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
use_diagnosis_check_type_ssi
required
stringChecklist SSI usagey
use_diagnosis_check_type_bp
required
stringChecklist Best Practice Usey
frequency_value
required
stringSchedule value (01~31, MONDAY~SUNDAY, everyDay)1
frequency_type
required
stringSchedule type( monthly, weekly, daily)MONTH
diagnosis_start_time_pattern
required
stringStart time( 5-minute increments, 00 to 23 hours, 00 to 55 minutes )08:00
auth_key_id
required
stringId of auth key9b72a9856e494e67afc69atd3631fe38
plan_type
required
stringplan TypeSTANDARD
diagnosis_type
required
stringdiagnosis TypeConsole
diagnosis_name
required
stringName of diagnosisSample Diagnosis Name
diagnosis_check_type
required
stringCheck type of diagnosisBP
diagnosis_account_id
required
stringId of diagnosis0e3dffc50eb247a1adf4f2e5c82c4f99
csp_type
required
stringType of cloud service providerSCP
account_id
required
stringaccount Id0e3dffc50eb247a1adf4f2e5c82c4f99
tags
optional
arrayTag List'{"key": "", "value": ""}'
auth_key_created_at
optional
stringcreated date of authkey2022-01-01 12:00:00
auth_key_expired_at
optional
stringexpired date of authkey2023-01-01 12:00:00
auth_key_request_diagnosis_id
optional
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097

Responses

NameDescriptionExample
resultTrue, False CheckTrue

1.2 - Delete Config Inspection

1.2.1 - 1.2

scp-cli configinspection ci delete
--diagnosis_id <value>

Description

Delete Config Inspection Product

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
diagnosis_id
required
stringId of diagnosisSample Diagnosis Name

1.2.2 - 1.1

scp-cli configinspection ci delete
--diagnosis_id <value>

Description

Delete Config Inspection Product

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
diagnosis_id
required
stringId of diagnosisSample Diagnosis Name

1.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.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
diagnosis_id
required
stringId of diagnosisSample Diagnosis Name

1.3 - Diagnosis Request

1.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)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
tenant_id
required
stringTenant ID1234567890
secret_key
required
stringSecret KeySAMPLE KEY
diagnosis_id
required
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_check_type
required
stringCheck type of diagnosisBP
access_key
required
stringAccess KeySAMPLE KEY

Responses

NameDescriptionExample
resultTrue, False CheckTrue

1.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)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
tenant_id
required
stringTenant ID1234567890
secret_key
required
stringSecret KeySAMPLE KEY
diagnosis_id
required
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_check_type
required
stringCheck type of diagnosisBP
access_key
required
stringAccess KeySAMPLE KEY

Responses

NameDescriptionExample
resultTrue, False CheckTrue

1.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.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
tenant_id
required
stringTenant ID1234567890
secret_key
required
stringSecret KeySAMPLE KEY
diagnosis_id
required
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_check_type
required
stringCheck type of diagnosisBP
access_key
required
stringAccess KeySAMPLE KEY

Responses

NameDescriptionExample
resultTrue, False CheckTrue

1.4 - Get Diagnosis Object Detail

1.4.1 - 1.2

scp-cli configinspection ci detail
--diagnosis_id <value>

Description

Get Diagnosis Object Detail

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
diagnosis_id
required
stringId of diagnosisSample Diagnosis Name

Responses

NameDescriptionExample
auth_key_responses{}
schedule_response{}
summary_responses{}

1.4.2 - 1.1

scp-cli configinspection ci detail
--diagnosis_id <value>

Description

Get Diagnosis Object Detail

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
diagnosis_id
required
stringId of diagnosisSample Diagnosis Name

Responses

NameDescriptionExample
auth_key_responses{}
schedule_response{}
summary_responses{}

1.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.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
diagnosis_id
required
stringId of diagnosisSample Diagnosis Name

Responses

NameDescriptionExample
auth_key_responses{}
schedule_response{}
summary_responses{}

1.5 - Get Diagnosis Result Detail

1.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)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
diagnosis_request_sequence
required
stringSequence of diagnosis requestSCPCIS-E75FD21CA524441C9C1B1B381D5974F7
diagnosis_id
required
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
checklist_namechecklist NameSample Checklist
counttotal count20
diagnosis_account_idId of diagnosis0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_check_typeCheck type of diagnosisBP
diagnosis_idId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_nameName of diagnosisSample Diagnosis Name
diagnosis_request_sequenceSequence of diagnosis requestSCPCIS-E75FD21CA524441C9C1B1B381D5974F7
linkslinks[{‘href’: ‘http://scp.samsungsdscloud.com/v1/notices’, ‘rel’: ‘self’}]
proceed_dateproceed Date
result_detail_list[]
totaltotal count10

1.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)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
diagnosis_request_sequence
required
stringSequence of diagnosis requestSCPCIS-E75FD21CA524441C9C1B1B381D5974F7
diagnosis_id
required
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
checklist_namechecklist NameSample Checklist
counttotal count20
diagnosis_account_idId of diagnosis0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_check_typeCheck type of diagnosisBP
diagnosis_idId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_nameName of diagnosisSample Diagnosis Name
diagnosis_request_sequenceSequence of diagnosis requestSCPCIS-E75FD21CA524441C9C1B1B381D5974F7
linkslinks[{‘href’: ‘http://scp.samsungsdscloud.com/v1/notices’, ‘rel’: ‘self’}]
proceed_dateproceed Date
result_detail_list[]
totaltotal count10

1.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.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
diagnosis_request_sequence
required
stringSequence of diagnosis requestSCPCIS-E75FD21CA524441C9C1B1B381D5974F7
diagnosis_id
required
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
checklist_namechecklist NameSample Checklist
counttotal count20
diagnosis_account_idId of diagnosis0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_check_typeCheck type of diagnosisBP
diagnosis_idId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_nameName of diagnosisSample Diagnosis Name
diagnosis_request_sequenceSequence of diagnosis requestSCPCIS-E75FD21CA524441C9C1B1B381D5974F7
linkslinks[{‘href’: ‘http://scp.samsungsdscloud.com/v1/notices’, ‘rel’: ‘self’}]
proceed_dateproceed Date
result_detail_list[]
totaltotal count10

1.6 - List Config Inspection

1.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)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
ismine
optional
booleanmy Config InspectionFalse
diagnosis_id
optional
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_name
optional
stringName of diagnosisMy Diagnosis
csp_type
optional
stringType of cloud service providerSCP
diagnosis_account_id
optional
stringId of diagnosis0e3dffc50eb247a1adf4f2e5c82c4f99
recent_diagnosis_state
optional
arrayrecent Diagnosis StateC
start_date
optional
stringstart Date2022-01-01 12:00:00
end_date
optional
stringend Date2022-01-02 12:00:00

Responses

NameDescriptionExample
created_atCreated date2022-01-01T12:00:00Z
csp_typeType of cloud service providerSCP
diagnosis_account_idId of diagnosis0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_check_typeCheck type of diagnosisBP
diagnosis_idId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_nameName of diagnosisSample Diagnosis Name
diagnosis_typediagnosis TypeConsole
error_stateError type of recent diagnosisCONNECTION_FAIL
plan_typeplan TypeSTANDARD
recent_diagnosis_atrecent Diagnosis Date2022-01-01T12:00:00Z
recent_diagnosis_staterecent Diagnosis StateCompleted

1.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)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
ismine
optional
booleanmy Config InspectionFalse
diagnosis_id
optional
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_name
optional
stringName of diagnosisMy Diagnosis
csp_type
optional
stringType of cloud service providerSCP
diagnosis_account_id
optional
stringId of diagnosis0e3dffc50eb247a1adf4f2e5c82c4f99
recent_diagnosis_state
optional
arrayrecent Diagnosis StateC
start_date
optional
stringstart Date2022-01-01 12:00:00
end_date
optional
stringend Date2022-01-02 12:00:00

Responses

NameDescriptionExample
created_atCreated date2022-01-01T12:00:00Z
csp_typeType of cloud service providerSCP
diagnosis_account_idId of diagnosis0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_check_typeCheck type of diagnosisBP
diagnosis_idId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_nameName of diagnosisSample Diagnosis Name
diagnosis_typediagnosis TypeConsole
error_stateError type of recent diagnosisCONNECTION_FAIL
plan_typeplan TypeSTANDARD
recent_diagnosis_atrecent Diagnosis Date2022-01-01T12:00:00Z
recent_diagnosis_staterecent Diagnosis StateCompleted

1.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.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
ismine
optional
booleanmy Config InspectionFalse
diagnosis_id
optional
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_name
optional
stringName of diagnosisMy Diagnosis
csp_type
optional
stringType of cloud service providerSCP
diagnosis_account_id
optional
stringId of diagnosis0e3dffc50eb247a1adf4f2e5c82c4f99
recent_diagnosis_state
optional
arrayrecent Diagnosis StateC
start_date
optional
stringstart Date2022-01-01 12:00:00
end_date
optional
stringend Date2022-01-02 12:00:00

Responses

NameDescriptionExample
created_atCreated date2022-01-01T12:00:00Z
csp_typeType of cloud service providerSCP
diagnosis_account_idId of diagnosis0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_check_typeCheck type of diagnosisBP
diagnosis_idId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_nameName of diagnosisSample Diagnosis Name
diagnosis_typediagnosis TypeConsole
error_stateError type of recent diagnosisCONNECTION_FAIL
plan_typeplan TypeSTANDARD
recent_diagnosis_atrecent Diagnosis Date2022-01-01T12:00:00Z
recent_diagnosis_staterecent Diagnosis StateCompleted

1.7 - List Diagnosis Result

1.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)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
account_id
optional
stringaccount Id0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_id
optional
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_name
optional
stringName of diagnosisSample Diagnosis Name
start_date
optional
stringstart Date2022-01-01
end_date
optional
stringend Date2022-12-31
csp_type
optional
stringType of cloud service providerSCP
diagnosis_state
optional
stringStatus of diagnosisCompleted
user_id
optional
stringuser Id76b563a009584b1380715c00703a02ff

Responses

NameDescriptionExample
count_checkcheck count10
count_errorerror count0
count_failfail count3
count_nana count2
count_passpass count5
csp_typeType of cloud service providerSCP
diagnosis_account_idId of diagnosis0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_check_typeCheck type of diagnosisBP
diagnosis_idId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_nameName of diagnosisSample Diagnosis Name
diagnosis_request_sequenceSequence of diagnosis request1234567890
diagnosis_resultdiagnosis ResultSUCCESS
diagnosis_total_countdiagnosis Total Count10
proceed_dateproceed Date2022-01-01T12:00:00Z
totaltotal count10

1.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)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
account_id
optional
stringaccount Id0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_id
optional
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_name
optional
stringName of diagnosisSample Diagnosis Name
start_date
optional
stringstart Date2022-01-01
end_date
optional
stringend Date2022-12-31
csp_type
optional
stringType of cloud service providerSCP
diagnosis_state
optional
stringStatus of diagnosisCompleted
user_id
optional
stringuser Id76b563a009584b1380715c00703a02ff

Responses

NameDescriptionExample
count_checkcheck count10
count_errorerror count0
count_failfail count3
count_nana count2
count_passpass count5
csp_typeType of cloud service providerSCP
diagnosis_account_idId of diagnosis0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_check_typeCheck type of diagnosisBP
diagnosis_idId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_nameName of diagnosisSample Diagnosis Name
diagnosis_request_sequenceSequence of diagnosis request1234567890
diagnosis_resultdiagnosis ResultSUCCESS
diagnosis_total_countdiagnosis Total Count10
proceed_dateproceed Date2022-01-01T12:00:00Z
totaltotal count10

1.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.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
account_id
optional
stringaccount Id0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_id
optional
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_name
optional
stringName of diagnosisSample Diagnosis Name
start_date
optional
stringstart Date2022-01-01
end_date
optional
stringend Date2022-12-31
csp_type
optional
stringType of cloud service providerSCP
diagnosis_state
optional
stringStatus of diagnosisCompleted
user_id
optional
stringuser Id76b563a009584b1380715c00703a02ff

Responses

NameDescriptionExample
count_checkcheck count10
count_errorerror count0
count_failfail count3
count_nana count2
count_passpass count5
csp_typeType of cloud service providerSCP
diagnosis_account_idId of diagnosis0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_check_typeCheck type of diagnosisBP
diagnosis_idId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_nameName of diagnosisSample Diagnosis Name
diagnosis_request_sequenceSequence of diagnosis request1234567890
diagnosis_resultdiagnosis ResultSUCCESS
diagnosis_total_countdiagnosis Total Count10
proceed_dateproceed Date2022-01-01T12:00:00Z
totaltotal count10