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

Return to the regular view of this page.

Support

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 Support service and how to call CLI.

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.0CURRENT-

1 - CLIs

1.1 - Get Inquiry List

1.1.1 - 1.0

scpcli support inquiry list
[--size <value>]
[--page <value>]
[--sort <value>]
[--title <value>]
[--state <value>]
[--inquiry_type <value>]
[--region_id <value>]
[--created_at <value>]
[--filter_inquiry_codes <value>]
[--filter_states <value>]

Description

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
title
optional
stringtitleVM usage inquiry
state
optional
stringstateCLOSED
inquiry_type
optional
stringinquiry typeGeneral Inquiry - Account and connection inquiry
region_id
optional
stringregion idkr-west1
created_at
optional
stringcreated at2024-06-01T00:12:57.000000Z
filter_inquiry_codes
optional
stringfilter inquiry codesFL01,FL02
filter_states
optional
stringfilter statesTODO,INPROGRESS

Responses

NameDescriptionExample
ididsr-240530-00028-nuri
account_idaccount id2010571da2f7458e97c3b881b2362b72
closed_atclosed at2024-06-27T08:12:57.000000Z
contentscontentsVM usage inquiry
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
filesfile list
inquiry_codeinquiry codeG01
inquiry_typeinquiry typeGeneral Inquiry - Account and connection inquiry
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
region_idregion idkr-west1
resource_nameresource namelb1
service_categoryservice categoryNetworking
service_itemservice itemLoad Balancer
statestateCLOSED
titletitleVM usage inquiry

1.2 - Get Service Request List

1.2.1 - 1.0

scpcli support service request list
[--size <value>]
[--page <value>]
[--sort <value>]
[--filter_operation_type_ids <value>]
[--filter_service_item_ids <value>]
[--filter_title <value>]
[--filter_states <value>]
[--from_created_at <value>]
[--to_created_at <value>]
[--operation_type <value>]
[--service_item_name <value>]
[--title <value>]
[--state <value>]

Description

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
filter_operation_type_ids
optional
stringoperation type idse8fea87728164808860ad81c6ce779b6
filter_service_item_ids
optional
stringservice item id listVIRTUAL_SERVER,LOAD_BALANCER
filter_title
optional
stringtitleVirtual Server operation related
filter_states
optional
stringfilter statesREQUESTING,CLOSED
from_created_at
optional
stringfrom created at2024-07-01T00:00:00Z
to_created_at
optional
stringto created at2024-07-05T23:59:59Z
operation_type
optional
stringoperation typePlacement Group Set Up Request
service_item_name
optional
stringservice itemLoad Balancer
title
optional
stringtitleVirtual Server operation related
state
optional
stringstateREQUESTING

Responses

NameDescriptionExample
idid007d8cc7d60c4b26bb5a833b06686db3
account_idaccount id2010571da2f7458e97c3b881b2362b72
account_nameaccount namedev_project
closed_atclosed at2024-06-27T08:12:57.000000Z
contentscontentsI need assistance with working with Virtual Server.
created_atcreated at2024-06-01T00:12:57.000000Z
created_bycreated bye3bff0c980dc41b2b6f3ac080b6d3ba0
created_by_namecreated by name and emailKimSamSung(test@samsung.com)
filesfile list
iops_resultiops resultProcessing completed.
iops_sr_idiops sr idSR0002834921
modified_atmodified at2024-06-11T00:12:57.000000Z
modified_bymodified bye3bff0c980dc41b2b6f3ac080b6d3ba0
operation_typeoperation typePlacement Group Set Up Request
regionregionkr-west1
service_category_nameservice categoryNetworking
service_item_nameservice itemLoad Balancer
statestateACTIVE
template_idtemplate ide8fea87728164808860ad81c6ce779b6
titletitleVirtual Server operation related

1.3 - Show Inquiry

1.3.1 - 1.0

scpcli support inquiry show
--inquiry_id <value>

Description

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
inquiry_id
required
stringidsr-240530-00028-nuri

Responses

NameDescriptionExample
ididFile-008ccb7ff65244689dacd605fafec92f
file_namenametest.txt
sizesize298426

1.4 - Show Service Request

1.4.1 - 1.0

scpcli support service request show
--service_request_id <value>

Description

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
service_request_id
required
stringid007d8cc7d60c4b26bb5a833b06686db3

Responses

NameDescriptionExample
ididFile-008ccb7ff65244689dacd605fafec92f
file_namenametest.txt
sizesize298426