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

Return to the regular view of this page.

Networking

1 - Direct Connect

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 Direct Connect 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.2CURRENT-
1.1SUPPORTED20270131
1.0SUPPORTED20261130

CLI Version History

1.2

Multi AZ feature has been added.

Changes

  • [Updated] direct-connect direct-connect create - The following field has been added to the parameters and response.
    • uplink_active_zone
    • uplink_standby_zone
  • [Updated] direct-connect direct-connect show - The following field has been added to the response.
    • uplink_active_zone
    • uplink_standby_zone
  • [Updated] direct-connect direct-connect set - The response is being trimmed for compatibility (changed to include only the requested values).

1.1

The pagination method for the list API has been changed.

Changes

  • [Updated] direct-connect direct-connect list - The following field has been changed to the parameters and response.
    • Deleted : limit, marker
    • Added : size, page
  • [Updated] direct-connect routing-rule list - The following field has been changed to the parameters and response.
    • Deleted : limit, marker
    • Added : size, page

1.0

Direct Connect CLI has been released.

Changes

  • [New] direct-connect direct-connect create - Command has been added.
  • [New] direct-connect direct-connect delete - Command has been added.
  • [New] direct-connect direct-connect list - Command has been added.
  • [New] direct-connect direct-connect set - Command has been added.
  • [New] direct-connect direct-connect show - Command has been added.
  • [New] direct-connect routing-rule create - Command has been added.
  • [New] direct-connect routing-rule delete - Command has been added.
  • [New] direct-connect routing-rule list - Command has been added.

1.1 - CLIs

1.1.1 - Create Direct Connect

1.1.1.1 - 1.2

scp-cli direct-connect direct-connect create
--vpc_id <value>
--name <value>
--bandwidth <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_loggable <value>]
[--tags <value>]
[--uplink_active_zone <value>]
[--uplink_standby_zone <value>]

Description

Create direct connect.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
name
required
stringDirect Connect NameDirectConnectName
bandwidth
required
integerPort Bandwidth1
description
optional
stringDirect Connect DescriptionDirect-connect Description
firewall_enabled
optional
booleanFirewall UseTrue
firewall_loggable
optional
booleanFirewall LoggableTrue
tags
optional
arrayTag List'{"key": "", "value": ""}'
uplink_active_zone
optional
stringUplink Active Zonekr-west1-a
uplink_standby_zone
optional
stringUplink Standby Zonekr-west1-b

Responses

NameDescriptionExample
idDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthPort Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDirect Connect Descriptionfe860e0af0c04dcd8182b84f907f31f4
firewall_idFirewall IDdffc455f1bd14e0594e4faa638aac3a1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameDirect Connect NameDirectConnectName
stateStateACTIVE
uplink_active_zoneUplink Active Zonekr-west1-a
uplink_standby_zoneUplink Standby Zonekr-west1-b
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.1.1.2 - 1.1

scp-cli direct-connect direct-connect create
--vpc_id <value>
--name <value>
--bandwidth <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_loggable <value>]
[--tags <value>]

Description

Create direct connect.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120270131

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
name
required
stringDirect Connect NameDirectConnectName
bandwidth
required
integerPort Bandwidth1
description
optional
stringDirect Connect DescriptionDirect-connect Description
firewall_enabled
optional
booleanFirewall UseTrue
firewall_loggable
optional
booleanFirewall LoggableTrue
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthPort Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDirect Connect Descriptionfe860e0af0c04dcd8182b84f907f31f4
firewall_idFirewall IDdffc455f1bd14e0594e4faa638aac3a1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameDirect Connect NameDirectConnectName
stateStateACTIVE
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.1.1.3 - 1.0

scp-cli direct-connect direct-connect create
--vpc_id <value>
--name <value>
--bandwidth <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_loggable <value>]
[--tags <value>]

Description

Create direct connect.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020261130

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
name
required
stringDirect Connect NameDirectConnectName
bandwidth
required
integerPort Bandwidth1
description
optional
stringDirect Connect DescriptionDirect-connect Description
firewall_enabled
optional
booleanFirewall UseTrue
firewall_loggable
optional
booleanFirewall LoggableTrue
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthPort Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDirect Connect Descriptionfe860e0af0c04dcd8182b84f907f31f4
firewall_idFirewall IDdffc455f1bd14e0594e4faa638aac3a1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameDirect Connect NameDirectConnectName
stateStateACTIVE
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.1.2 - Create Routing Rule

1.1.2.1 - 1.2

scp-cli direct-connect routing-rule create
--direct_connect_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]
[--destination_resource_id <value>]

Description

Create a routing rule.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
direct_connect_id
required
stringDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
destination_type
required
stringDestination TypeON_PREMISE
destination_cidr
required
stringDestination CIDR11.11.11.0/24
description
optional
stringDescriptionTransitGateway Description
destination_resource_id
optional
stringDestination Resource IDbe3c84238562488e81e4e0675f86be62

Responses

NameDescriptionExample
idRouting Rule IDc8980aa2bf1e43c9998682f7baaf1c46
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionTransitGateway Description
destination_cidrDestination CIDR11.11.11.0/24
destination_resource_idDestination Resource IDbe3c84238562488e81e4e0675f86be62
destination_resource_nameDestination Resource NameResourceName
destination_typeDestination TypeON_PREMISE
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
owner_idRouting Rule Owner IDcd1610830b9046418e4bc67831c533e6
owner_typeRouting Rule Owner TypeDIRECT_CONNECT
stateStateACTIVE

1.1.2.2 - 1.1

scp-cli direct-connect routing-rule create
--direct_connect_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]
[--destination_resource_id <value>]

Description

Create a routing rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120270131

Parameters

NameTypeDescriptionExample
direct_connect_id
required
stringDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
destination_type
required
stringDestination TypeON_PREMISE
destination_cidr
required
stringDestination CIDR11.11.11.0/24
description
optional
stringDescriptionTransitGateway Description
destination_resource_id
optional
stringDestination Resource IDbe3c84238562488e81e4e0675f86be62

Responses

NameDescriptionExample
idRouting Rule IDc8980aa2bf1e43c9998682f7baaf1c46
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionTransitGateway Description
destination_cidrDestination CIDR11.11.11.0/24
destination_resource_idDestination Resource IDbe3c84238562488e81e4e0675f86be62
destination_resource_nameDestination Resource NameResourceName
destination_typeDestination TypeON_PREMISE
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
owner_idRouting Rule Owner IDcd1610830b9046418e4bc67831c533e6
owner_typeRouting Rule Owner TypeDIRECT_CONNECT
stateStateACTIVE

1.1.2.3 - 1.0

scp-cli direct-connect routing-rule create
--direct_connect_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]
[--destination_resource_id <value>]

Description

Create a routing rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020261130

Parameters

NameTypeDescriptionExample
direct_connect_id
required
stringDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
destination_type
required
stringDestination TypeON_PREMISE
destination_cidr
required
stringDestination CIDR11.11.11.0/24
description
optional
stringDescriptionTransitGateway Description
destination_resource_id
optional
stringDestination Resource IDbe3c84238562488e81e4e0675f86be62

Responses

NameDescriptionExample
idRouting Rule IDc8980aa2bf1e43c9998682f7baaf1c46
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionTransitGateway Description
destination_cidrDestination CIDR11.11.11.0/24
destination_resource_idDestination Resource IDbe3c84238562488e81e4e0675f86be62
destination_resource_nameDestination Resource NameResourceName
destination_typeDestination TypeON_PREMISE
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
owner_idRouting Rule Owner IDcd1610830b9046418e4bc67831c533e6
owner_typeRouting Rule Owner TypeDIRECT_CONNECT
stateStateACTIVE

1.1.3 - Delete Direct Connect

1.1.3.1 - 1.2

scp-cli direct-connect direct-connect delete
--direct_connect_id <value>

Description

Delete direct connect.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
direct_connect_id
required
stringDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4

1.1.3.2 - 1.1

scp-cli direct-connect direct-connect delete
--direct_connect_id <value>

Description

Delete direct connect.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120270131

Parameters

NameTypeDescriptionExample
direct_connect_id
required
stringDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4

1.1.3.3 - 1.0

scp-cli direct-connect direct-connect delete
--direct_connect_id <value>

Description

Delete direct connect.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020261130

Parameters

NameTypeDescriptionExample
direct_connect_id
required
stringDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4

1.1.4 - Delete Routing Rule

1.1.4.1 - 1.2

scp-cli direct-connect routing-rule delete
--routing_rule_id <value>
--direct_connect_id <value>

Description

Delete a routing rule.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule IDc8980aa2bf1e43c9998682f7baaf1c46
direct_connect_id
required
stringDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4

1.1.4.2 - 1.1

scp-cli direct-connect routing-rule delete
--routing_rule_id <value>
--direct_connect_id <value>

Description

Delete a routing rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120270131

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule IDc8980aa2bf1e43c9998682f7baaf1c46
direct_connect_id
required
stringDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4

1.1.4.3 - 1.0

scp-cli direct-connect routing-rule delete
--routing_rule_id <value>
--direct_connect_id <value>

Description

Delete a routing rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020261130

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule IDc8980aa2bf1e43c9998682f7baaf1c46
direct_connect_id
required
stringDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4

1.1.5 - List Direct Connects

1.1.5.1 - 1.2

scp-cli direct-connect direct-connect list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]

Description

Get direct connect list.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
name
optional
stringDirect Connect NameDirectConnectName
state
optional
****StateACTIVE
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName

Responses

NameDescriptionExample
idDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthPort Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDirect Connect Descriptionfe860e0af0c04dcd8182b84f907f31f4
firewall_idFirewall IDdffc455f1bd14e0594e4faa638aac3a1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameDirect Connect NameDirectConnectName
stateStateACTIVE
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.1.5.2 - 1.1

scp-cli direct-connect direct-connect list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]

Description

Get direct connect list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120270131

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
name
optional
stringDirect Connect NameDirectConnectName
state
optional
****StateACTIVE
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName

Responses

NameDescriptionExample
idDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthPort Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDirect Connect Descriptionfe860e0af0c04dcd8182b84f907f31f4
firewall_idFirewall IDdffc455f1bd14e0594e4faa638aac3a1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameDirect Connect NameDirectConnectName
stateStateACTIVE
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.1.5.3 - 1.0

scp-cli direct-connect direct-connect list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]

Description

Get direct connect list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020261130

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
name
optional
stringDirect Connect NameDirectConnectName
state
optional
****StateACTIVE
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName

Responses

NameDescriptionExample
idDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthPort Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDirect Connect Descriptionfe860e0af0c04dcd8182b84f907f31f4
firewall_idFirewall IDdffc455f1bd14e0594e4faa638aac3a1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameDirect Connect NameDirectConnectName
stateStateACTIVE
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.1.6 - List Routing Rules

1.1.6.1 - 1.2

scp-cli direct-connect routing-rule list
--direct_connect_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--destination_type <value>]
[--destination_cidr <value>]
[--state <value>]

Description

Get routing rule list.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
direct_connect_id
required
stringDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringRouting Rule IDc8980aa2bf1e43c9998682f7baaf1c46
destination_type
optional
****Destination TypeON_PREMISE
destination_cidr
optional
stringDestination CIDR11.11.11.0/24
state
optional
****StateACTIVE

Responses

NameDescriptionExample
idRouting Rule IDc8980aa2bf1e43c9998682f7baaf1c46
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionTransitGateway Description
destination_cidrDestination CIDR11.11.11.0/24
destination_resource_idDestination Resource IDbe3c84238562488e81e4e0675f86be62
destination_resource_nameDestination Resource NameResourceName
destination_typeDestination TypeON_PREMISE
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
owner_idRouting Rule Owner IDcd1610830b9046418e4bc67831c533e6
owner_typeRouting Rule Owner TypeDIRECT_CONNECT
stateStateACTIVE

1.1.6.2 - 1.1

scp-cli direct-connect routing-rule list
--direct_connect_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--destination_type <value>]
[--destination_cidr <value>]
[--state <value>]

Description

Get routing rule list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120270131

Parameters

NameTypeDescriptionExample
direct_connect_id
required
stringDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringRouting Rule IDc8980aa2bf1e43c9998682f7baaf1c46
destination_type
optional
****Destination TypeON_PREMISE
destination_cidr
optional
stringDestination CIDR11.11.11.0/24
state
optional
****StateACTIVE

Responses

NameDescriptionExample
idRouting Rule IDc8980aa2bf1e43c9998682f7baaf1c46
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionTransitGateway Description
destination_cidrDestination CIDR11.11.11.0/24
destination_resource_idDestination Resource IDbe3c84238562488e81e4e0675f86be62
destination_resource_nameDestination Resource NameResourceName
destination_typeDestination TypeON_PREMISE
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
owner_idRouting Rule Owner IDcd1610830b9046418e4bc67831c533e6
owner_typeRouting Rule Owner TypeDIRECT_CONNECT
stateStateACTIVE

1.1.6.3 - 1.0

scp-cli direct-connect routing-rule list
--direct_connect_id <value>
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--destination_type <value>]
[--destination_cidr <value>]
[--state <value>]

Description

Get routing rule list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020261130

Parameters

NameTypeDescriptionExample
direct_connect_id
required
stringDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringRouting Rule IDc8980aa2bf1e43c9998682f7baaf1c46
destination_type
optional
****Destination TypeON_PREMISE
destination_cidr
optional
stringDestination CIDR11.11.11.0/24
state
optional
****StateACTIVE

Responses

NameDescriptionExample
idRouting Rule IDc8980aa2bf1e43c9998682f7baaf1c46
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionTransitGateway Description
destination_cidrDestination CIDR11.11.11.0/24
destination_resource_idDestination Resource IDbe3c84238562488e81e4e0675f86be62
destination_resource_nameDestination Resource NameResourceName
destination_typeDestination TypeON_PREMISE
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
owner_idRouting Rule Owner IDcd1610830b9046418e4bc67831c533e6
owner_typeRouting Rule Owner TypeDIRECT_CONNECT
stateStateACTIVE

1.1.7 - Set Direct Connect

1.1.7.1 - 1.2

scp-cli direct-connect direct-connect set
--direct_connect_id <value>
--description <value>

Description

Set direct connect.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
direct_connect_id
required
stringDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
description
required
stringDirect Connect DescriptionDirect-connect Description

1.1.7.2 - 1.1

scp-cli direct-connect direct-connect set
--direct_connect_id <value>
--description <value>

Description

Set direct connect.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120270131

Parameters

NameTypeDescriptionExample
direct_connect_id
required
stringDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
description
required
stringDirect Connect DescriptionDirect-connect Description

1.1.7.3 - 1.0

scp-cli direct-connect direct-connect set
--direct_connect_id <value>
--description <value>

Description

Set direct connect.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020261130

Parameters

NameTypeDescriptionExample
direct_connect_id
required
stringDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
description
required
stringDirect Connect DescriptionDirect-connect Description

1.1.8 - Show Direct Connect

1.1.8.1 - 1.2

scp-cli direct-connect direct-connect show
--direct_connect_id <value>

Description

Show direct connect.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
direct_connect_id
required
stringDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4

Responses

NameDescriptionExample
idDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthPort Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDirect Connect Descriptionfe860e0af0c04dcd8182b84f907f31f4
firewall_idFirewall IDdffc455f1bd14e0594e4faa638aac3a1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameDirect Connect NameDirectConnectName
stateStateACTIVE
uplink_active_zoneUplink Active Zonekr-west1-a
uplink_standby_zoneUplink Standby Zonekr-west1-b
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.1.8.2 - 1.1

scp-cli direct-connect direct-connect show
--direct_connect_id <value>

Description

Show direct connect.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120270131

Parameters

NameTypeDescriptionExample
direct_connect_id
required
stringDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4

Responses

NameDescriptionExample
idDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthPort Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDirect Connect Descriptionfe860e0af0c04dcd8182b84f907f31f4
firewall_idFirewall IDdffc455f1bd14e0594e4faa638aac3a1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameDirect Connect NameDirectConnectName
stateStateACTIVE
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.1.8.3 - 1.0

scp-cli direct-connect direct-connect show
--direct_connect_id <value>

Description

Show direct connect.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020261130

Parameters

NameTypeDescriptionExample
direct_connect_id
required
stringDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4

Responses

NameDescriptionExample
idDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthPort Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDirect Connect Descriptionfe860e0af0c04dcd8182b84f907f31f4
firewall_idFirewall IDdffc455f1bd14e0594e4faa638aac3a1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameDirect Connect NameDirectConnectName
stateStateACTIVE
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

2 - DNS

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 DNS service 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.3CURRENT-

CLI Version History

1.3

  • DNS CLI has been updated to version 1.3.
  • DNS CLI versions 1.0 to 1.2 have been deprecated.

Changes

  • [Changed] dns hosted-zone create - Command has been changed.
    • The --email option has been removed.
  • [Changed] dns hosted-zone show - Command has been changed.
    • The email field has been removed from the output.
  • [Changed] dns hosted-zone updatedns hosted-zone set - Command has been changed.
    • The --email option has been removed.
  • [Changed] dns hosted-zone-record list - Command has been changed.
    • Zone apex record name is displayed as-is (without @. notation).
  • [Changed] dns record createdns hosted-zone-record create - Command has been changed.
  • [Changed] dns record deletedns hosted-zone-record delete - Command has been changed.
  • [Changed] dns record listdns hosted-zone-record list - Command has been changed.
  • [Changed] dns record showdns hosted-zone-record show - Command has been changed.
  • [Changed] dns record updatedns hosted-zone-record set - Command has been changed.
  • [New] dns public-domain-name-transfer update - Command has been added.

1.2

DNS CLI has been updated to version 1.2.

Changes

  • [Changed] dns hosted-zone list - Command has been changed.
    • The following field has been added to the output:
      • private_dns_name (Private DNS name lookup)
  • [Changed] dns hosted-zone show - Command has been changed.
    • The following field has been added to the output:
      • private_dns_name (Private DNS name lookup)

1.1

DNS CLI has been updated to version 1.1.

Changes

  • [Changed] dns hosted_zone createdns hosted-zone create - Command has been changed.
  • [Changed] dns hosted_zone deletedns hosted-zone delete - Command has been changed.
  • [Changed] dns hosted_zone listdns hosted-zone list - Command has been changed.
  • [Changed] dns hosted_zone showdns hosted-zone show - Command has been changed.
  • [Changed] dns hosted_zone updatedns hosted-zone update - Command has been changed.
  • [Changed] dns private_dns createdns private-dns create - Command has been changed.
    • The following options have been added:
      • --registered-region
      • --private-dns-cr-id
  • [Changed] dns private_dns deletedns private-dns delete - Command has been changed.
  • [Changed] dns private_dns listdns private-dns list - Command has been changed.
  • [Changed] dns private_dns setdns private-dns set - Command has been changed.
  • [Changed] dns private_dns showdns private-dns show - Command has been changed.
  • [Changed] dns recordset createdns record create - Command has been changed.
  • [Changed] dns recordset deletedns record delete - Command has been changed.
  • [Changed] dns recordset listdns record list - Command has been changed.
    • Zone apex record name is displayed using @. notation.
  • [Changed] dns recordset showdns record show - Command has been changed.
  • [Changed] dns recordset updatedns record update - Command has been changed.
  • [New] dns private-dns activate - Command has been added.
  • [New] dns public-domain-name create - Command has been added.
  • [New] dns public-domain-name list - Command has been added.
  • [New] dns public-domain-name show - Command has been added.
  • [New] dns public-domain-name update - Command has been added.
  • [New] dns public-domain-name-info update - Command has been added.

1.0

DNS CLI has been released.

Changes

  • [New] dns hosted_zone create - Command has been added.
  • [New] dns hosted_zone delete - Command has been added.
  • [New] dns hosted_zone list - Command has been added.
  • [New] dns hosted_zone show - Command has been added.
  • [New] dns hosted_zone update - Command has been added.
  • [New] dns private_dns create - Command has been added.
  • [New] dns private_dns delete - Command has been added.
  • [New] dns private_dns list - Command has been added.
  • [New] dns private_dns set - Command has been added.
  • [New] dns private_dns show - Command has been added.
  • [New] dns recordset create - Command has been added.
  • [New] dns recordset delete - Command has been added.
  • [New] dns recordset list - Command has been added.
  • [New] dns recordset show - Command has been added.
  • [New] dns recordset update - Command has been added.

2.1 - CLIs

2.1.1 - Activate Private DNS

2.1.1.1 - 1.3

scp-cli dns private-dns activate
--name <value>

Description

Activate Private DNS

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
name
required
stringThe name of the private DNS.private-dns01

Responses

NameDescriptionExample
idThe unique identifier of the private DNS.fedcba9876543210fedcba9876543210
auth_dns_nameThe authoritative DNS name of the private DNS.authdns-a1b2c3d4e5f6789012345678abcdef90
connected_vpc_idsThe list of VPC identifiers connected to this private DNS.Only VPCs that are connected to the DNS can query the domain information registered in it.[‘1234567890abcdef1234567890abcdef’, ‘fedcba0987654321fedcba0987654321’]
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionThis is description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the private DNS.private-dns01
pool_idThe resource pool identifier associated with the private DNS.12345678-90ab-cdef-1234-567890abcdef
pool_nameThe name of the resource pool.private01-a1b2c3d4e5f6789012345678abcdef90
registered_regionThe region where the private DNS is registered.KR-WEST1
resolver_ipThe IP address of the DNS resolver.198.19.0.101
resolver_nameThe name of the DNS resolver.resolver-a1b2c3d4e5f6789012345678abcdef90
stateStateACTIVE

2.1.2 - Create Hosted Zone

2.1.2.1 - 1.3

scp-cli dns hosted-zone create
--type <value>
--name <value>
[--description <value>]
[--private_dns_id <value>]
[--tags <value>]

Description

Create a hosted zone that contains DNS records for managing domain name resolution.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
type
required
stringThe type of the hosted zone (e.g., public or private).private
name
required
stringThe domain name that a DNS service manages. all DNS records for that domain and its sub‑domains are stored and served within this hosted zone.my-zone.com
description
optional
stringDescriptionThis is description
private_dns_id
optional
stringThe DNS server ID for registering a Hosted Zone.For a Public‑type Hosted Zone, display it as an empty value.fedcba9876543210fedcba9876543210
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idThe unique identifier of the hosted zone.3432012nfdksdf03ktrld9234lgfg
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionThis is description
hosted_zone_typeThe type of the hosted zone (e.g., public or private).
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe domain name that a DNS service manages. all DNS records for that domain and its sub‑domains are stored and served within this hosted zone.my-zone.com
pool_idThe resource pool identifier associated with the hosted zone.12345678-90ab-cdef-1234-567890abcdef
private_dns_idThe DNS server ID for registering a Hosted Zone.For a Public‑type Hosted Zone, display it as an empty value.fedcba9876543210fedcba9876543210
private_dns_nameThe DNS server name for registering a Hosted Zone.For a Public‑type Hosted Zone, display it as an empty value.private-dns01
statusState
ttlThe Time-To-Live (TTL) value in seconds for DNS records in this zone.3600

2.1.3 - Create Hosted Zone Record

2.1.3.1 - 1.3

scp-cli dns hosted-zone-record create
--hosted_zone_id <value>
--type <value>
--records <value>
--name <value>
[--description <value>]
[--ttl <value>]

Description

Create a DNS record resource for managing domain name resolution.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringThe unique identifier of the hosted zone.3432012nfdksdf03ktrld9234lgfg
type
required
stringThe type of the DNS record (e.g., A, AAAA, CNAME, MX, TXT, SPF).-
records
required
arrayA list of data for this record12345.ns.private.kr-west1.dev2.samsungsdscloud.com
name
required
stringThe name of the DNS record.test.app
description
optional
stringDescriptionThis is description
ttl
optional
integerThe Time-To-Live (TTL) value in seconds for the DNS record.3600

Responses

NameDescriptionExample
idThe unique identifier of the DNS record.6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
actionThe action performed on the DNS record.CREATE
created_atThe timestamp when the resource was created, in ISO 8601 format.2025-09-08T03:43:57Z
descriptionDescriptionThis is description
linksThe links related to the DNS record.
nameThe name of the DNS record.test.app
project_idThe project identifier associated with the DNS record.003dffc50eb123a1cbf4f2e5c71d4f15
recordsA list of data for this record[‘12345.ns.private.kr-west1.dev2.samsungsdscloud.com’]
statusThe current status of the DNS record.ACTIVE
ttlThe Time-To-Live (TTL) value in seconds for the DNS record.3600
typeThe type of the DNS record (e.g., A, AAAA, CNAME, MX, TXT, SPF).A
updated_atThe timestamp when the resource was last updated, in ISO 8601 format.2026-02-09T08:00:40Z
versionThe version of the DNS record.1
zone_idID for the zone that contains this record3432012nfdksdf03ktrld9234lgfg
zone_nameThe name of the zone that contains this recordmy-zone.com

2.1.4 - Create Private DNS

2.1.4.1 - 1.3

scp-cli dns private-dns create
--name <value>
[--connected_vpc_ids <value>]
[--description <value>]
[--tags <value>]

Description

Create a private DNS instance for managing internal DNS resolution.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
name
required
stringThe name of the private DNS.private-dns01
connected_vpc_ids
optional
arrayThe list of VPC identifiers connected to this private DNS.Only VPCs that are connected to the DNS can query the domain information registered in it.1234567890abcdef1234567890abcdef
description
optional
stringDescriptionThis is description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idThe unique identifier of the private DNS.fedcba9876543210fedcba9876543210
auth_dns_nameThe authoritative DNS name of the private DNS.authdns-a1b2c3d4e5f6789012345678abcdef90
connected_vpc_idsThe list of VPC identifiers connected to this private DNS.Only VPCs that are connected to the DNS can query the domain information registered in it.[‘1234567890abcdef1234567890abcdef’, ‘fedcba0987654321fedcba0987654321’]
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionThis is description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the private DNS.private-dns01
pool_idThe resource pool identifier associated with the private DNS.12345678-90ab-cdef-1234-567890abcdef
pool_nameThe name of the resource pool.private01-a1b2c3d4e5f6789012345678abcdef90
registered_regionThe region where the private DNS is registered.KR-WEST1
resolver_ipThe IP address of the DNS resolver.198.19.0.101
resolver_nameThe name of the DNS resolver.resolver-a1b2c3d4e5f6789012345678abcdef90
stateStateACTIVE

2.1.5 - Create Public Domain Name

2.1.5.1 - 1.3

scp-cli dns public-domain-name create
--register_telno <value>
--register_name_ko <value>
--register_name_en <value>
--register_email <value>
--postal_code <value>
--overseas_third_address <value>
--overseas_second_address <value>
--overseas_first_address <value>
--name <value>
--domestic_second_address_ko <value>
--domestic_second_address_en <value>
--domestic_first_address_ko <value>
--domestic_first_address_en <value>
--address_type <value>
[--auto_extension <value>]
[--description <value>]
[--tags <value>]

Description

Create a public domain name registration resource.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
register_telno
required
stringThe telephone number of the domain registrant.-
register_name_ko
required
stringThe name of the domain registrant in Korean.홍길동
register_name_en
required
stringThe name of the domain registrant in English.Hong Gildong
register_email
required
stringThe email address of the domain registrant.admin@example.com
postal_code
required
stringThe postal code for the domain registration.12345
overseas_third_address
required
stringThe third line of overseas address.NY 10001
overseas_second_address
required
stringThe second line of overseas address.New York
overseas_first_address
required
stringThe first line of overseas address.123 Main St
name
required
stringThe name of the public domain name.example.com
domestic_second_address_ko
required
stringThe second line of domestic address in Korean.서관 1층
domestic_second_address_en
required
stringThe second line of domestic address in English.West Campus 1F
domestic_first_address_ko
required
stringThe first line of domestic address in Korean.서울특별시 송파구 올림픽로35길 125 (신천동)
domestic_first_address_en
required
stringThe first line of domestic address in English.125 Olympic-ro 35-gil, Songpa-gu, Seoul
address_type
required
stringThe type of address for the domain registration.-
auto_extension
optional
booleanIndicates whether automatic extension is enabled for the domain.True
description
optional
stringDescriptionThis is description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idThe unique identifier of the public domain name.10fjkeweffpublicdomain3193rud543
address_typeThe type of address for the domain registration.DOMESTIC
auto_extensionIndicates whether automatic extension is enabled for the domain.True
created_atThe timestamp when the resource was created, in ISO 8601 format.2025-09-08T03:43:57Z
created_byThe user id that created the resource.504f24f8111e42e0578f367acd2a149f
descriptionDescriptionThis is description
domestic_address_enThe domestic address in English for the domain registration.West Campus 1F, 125 Olympic-ro 35-gil, Songpa-gu, Seoul
domestic_address_koThe domestic address in Korean for the domain registration.서울특별시 송파구 올림픽로35길 125 (신천동), 서관 1층
domestic_first_address_enThe first line of domestic address in English.125 Olympic-ro 35-gil, Songpa-gu, Seoul
domestic_first_address_koThe first line of domestic address in Korean.서울특별시 송파구 올림픽로35길 125 (신천동)
domestic_second_address_enThe second line of domestic address in English.West Campus 1F
domestic_second_address_koThe second line of domestic address in Korean.서관 1층
expired_dateThe expiration date of the domain registration.2026-09-09T00:00:00Z
modified_atThe timestamp when the resource was last modified, in ISO 8601 format.2026-02-09T08:00:40Z
modified_byThe user id that last modified the resource.504f24f8111e42e0578f367acd2a149f
nameThe name of the public domain name.example.com
overseas_addressThe overseas address for the domain registration.123 Main St, New York, NY 10001
overseas_first_addressThe first line of overseas address.123 Main St
overseas_second_addressThe second line of overseas address.New York
overseas_third_addressThe third line of overseas address.NY 10001
postal_codeThe postal code for the domain registration.12345
register_emailThe email address of the domain registrant.admin@example.com
register_name_enThe name of the domain registrant in English.Hong Gildong
register_name_koThe name of the domain registrant in Korean.홍길동
register_telnoThe telephone number of the domain registrant.
start_dateThe start date of the domain registration.2025-09-09T00:00:00Z
statusThe current status of the public domain name.REGISTERED

2.1.6 - Delete Hosted Zone

2.1.6.1 - 1.3

scp-cli dns hosted-zone delete
--hosted_zone_id <value>

Description

Delete the hosted zone.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringThe unique identifier of the hosted zone.3432012nfdksdf03ktrld9234lgfg

2.1.7 - Delete Hosted Zone Record

2.1.7.1 - 1.3

scp-cli dns hosted-zone-record delete
--record_id <value>
--hosted_zone_id <value>

Description

Delete the DNS record resource.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
record_id
required
stringThe unique identifier of the DNS record.6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
hosted_zone_id
required
stringThe identifier of the hosted zone that contains this DNS record.3432012nfdksdf03ktrld9234lgfg

2.1.8 - Delete Private DNS

2.1.8.1 - 1.3

scp-cli dns private-dns delete
--private_dns_id <value>

Description

Delete the private DNS instance.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
private_dns_id
required
stringThe unique identifier of the private DNS.fedcba9876543210fedcba9876543210

2.1.9 - List Hosted Zone Records

2.1.9.1 - 1.3

scp-cli dns hosted-zone-record list
--hosted_zone_id <value>
[--limit <value>]
[--marker <value>]
[--sort_dir <value>]
[--sort_key <value>]
[--name <value>]
[--exact_name <value>]
[--type <value>]
[--data <value>]
[--status <value>]
[--description <value>]
[--ttl <value>]

Description

Provides a list of DNS records.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringThe unique identifier of the hosted zone.3432012nfdksdf03ktrld9234lgfg
limit
optional
integerThe maximum number of items to return.-
marker
optional
stringThe last record ID of the previous page.-
sort_dir
optional
stringThe sort direction for the list (ASC or DESC).-
sort_key
optional
stringThe field to sort by.-
name
optional
stringThe name of the DNS record.test.app
exact_name
optional
stringThe name of the DNS record.test.app
type
optional
stringThe type of the DNS record (e.g., A, AAAA, CNAME, MX, TXT, SPF).A
data
optional
stringThe data to filter DNS records by.12345.ns.private.kr-west1.dev2.samsungsdscloud.com
status
optional
stringThe current status of the DNS record.ACTIVE
description
optional
stringDescriptionThis is description
ttl
optional
integerThe Time-To-Live (TTL) value in seconds for the DNS record.3600

Responses

NameDescriptionExample
idThe unique identifier of the DNS record.6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
actionThe action performed on the DNS record.CREATE
created_atThe timestamp when the resource was created, in ISO 8601 format.2025-09-08T03:43:57Z
descriptionDescriptionThis is description
linksThe links related to the DNS record.
nameThe name of the DNS record.test.app
project_idThe project identifier associated with the DNS record.003dffc50eb123a1cbf4f2e5c71d4f15
recordsA list of data for this record[‘12345.ns.private.kr-west1.dev2.samsungsdscloud.com’]
statusThe current status of the DNS record.ACTIVE
ttlThe Time-To-Live (TTL) value in seconds for the DNS record.3600
typeThe type of the DNS record (e.g., A, AAAA, CNAME, MX, TXT, SPF).A
updated_atThe timestamp when the resource was last updated, in ISO 8601 format.2026-02-09T08:00:40Z
versionThe version of the DNS record.1
zone_idID for the zone that contains this record3432012nfdksdf03ktrld9234lgfg
zone_nameThe name of the zone that contains this recordmy-zone.com

2.1.10 - List Hosted Zones

2.1.10.1 - 1.3

scp-cli dns hosted-zone list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--type <value>]
[--status <value>]

Description

Provides a list of hosted zones.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringThe domain name that a DNS service manages. all DNS records for that domain and its sub‑domains are stored and served within this hosted zone.my-zone.com
type
optional
****The type of the hosted zone (e.g., public or private).-
status
optional
****The current status of the hosted zone (e.g., ACTIVE, CREATING, DELETING).-

Responses

NameDescriptionExample
idThe unique identifier of the hosted zone.3432012nfdksdf03ktrld9234lgfg
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionThis is description
hosted_zone_typeThe type of the hosted zone (e.g., public or private).
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe domain name that a DNS service manages. all DNS records for that domain and its sub‑domains are stored and served within this hosted zone.my-zone.com
pool_idThe resource pool identifier associated with the hosted zone.12345678-90ab-cdef-1234-567890abcdef
private_dns_idThe DNS server ID for registering a Hosted Zone.For a Public‑type Hosted Zone, display it as an empty value.fedcba9876543210fedcba9876543210
private_dns_nameThe DNS server name for registering a Hosted Zone.For a Public‑type Hosted Zone, display it as an empty value.private-dns01
statusState
ttlThe Time-To-Live (TTL) value in seconds for DNS records in this zone.3600

2.1.11 - List Private DNS

2.1.11.1 - 1.3

scp-cli dns private-dns list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--state <value>]

Description

Provides a list of private DNS instances.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringThe unique identifier of the private DNS.fedcba9876543210fedcba9876543210
name
optional
stringThe name of the private DNS.private-dns01
vpc_id
optional
stringThe list of VPC identifiers connected to this private DNS.Only VPCs that are connected to the DNS can query the domain information registered in it.7df8abb4912e4709b1cb237daccca7a8
state
optional
****StateACTIVE

Responses

NameDescriptionExample
idThe unique identifier of the private DNS.fedcba9876543210fedcba9876543210
auth_dns_nameThe authoritative DNS name of the private DNS.authdns-a1b2c3d4e5f6789012345678abcdef90
connected_vpc_idsThe list of VPC identifiers connected to this private DNS.Only VPCs that are connected to the DNS can query the domain information registered in it.[‘1234567890abcdef1234567890abcdef’, ‘fedcba0987654321fedcba0987654321’]
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionThis is description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the private DNS.private-dns01
pool_idThe resource pool identifier associated with the private DNS.12345678-90ab-cdef-1234-567890abcdef
pool_nameThe name of the resource pool.private01-a1b2c3d4e5f6789012345678abcdef90
registered_regionThe region where the private DNS is registered.KR-WEST1
resolver_ipThe IP address of the DNS resolver.198.19.0.101
resolver_nameThe name of the DNS resolver.resolver-a1b2c3d4e5f6789012345678abcdef90
stateStateACTIVE

2.1.12 - List Public Domain Names

2.1.12.1 - 1.3

scp-cli dns public-domain-name list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--created_by <value>]

Description

Provides a list of public domain names.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringThe name of the public domain name.example.com
created_by
optional
stringThe user id that created the resource.504f24f8111e42e0578f367acd2a149f

Responses

NameDescriptionExample
idThe unique identifier of the public domain name.10fjkeweffpublicdomain3193rud543
created_atThe timestamp when the resource was created, in ISO 8601 format.2025-09-08T03:43:57Z
created_byThe user id that created the resource.504f24f8111e42e0578f367acd2a149f
expired_dateThe expiration date of the domain registration.2026-09-09T00:00:00Z
modified_atThe timestamp when the resource was last modified, in ISO 8601 format.2026-02-09T08:00:40Z
modified_byThe user id that last modified the resource.504f24f8111e42e0578f367acd2a149f
nameThe name of the public domain name.example.com
register_emailThe email address of the domain registrant.admin@example.com
start_dateThe start date of the domain registration.2025-09-09T00:00:00Z
statusThe current status of the public domain name.REGISTERED

2.1.13 - Set Hosted Zone

2.1.13.1 - 1.3

scp-cli dns hosted-zone set
--hosted_zone_id <value>
[--description <value>]

Description

Update the hosted zone.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringThe unique identifier of the hosted zone.3432012nfdksdf03ktrld9234lgfg
description
optional
stringDescriptionThis is description

2.1.14 - Set Hosted Zone Record

2.1.14.1 - 1.3

scp-cli dns hosted-zone-record set
--record_id <value>
--hosted_zone_id <value>
[--records <value>]
[--ttl <value>]

Description

Update the DNS record values.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
record_id
required
stringThe unique identifier of the DNS record.6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
hosted_zone_id
required
stringThe identifier of the hosted zone that contains this DNS record.3432012nfdksdf03ktrld9234lgfg
records
optional
arrayA list of data for this record12345.ns.private.kr-west1.dev2.samsungsdscloud.com
ttl
optional
integerThe Time-To-Live (TTL) value in seconds for the DNS record.3600

2.1.15 - Set Private DNS

2.1.15.1 - 1.3

scp-cli dns private-dns set
--private_dns_id <value>
[--connected_vpc_ids <value>]
[--description <value>]

Description

Update the private DNS connected VPC List.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
private_dns_id
required
stringThe unique identifier of the private DNS.fedcba9876543210fedcba9876543210
connected_vpc_ids
optional
arrayThe list of VPC identifiers connected to this private DNS.Only VPCs that are connected to the DNS can query the domain information registered in it.1234567890abcdef1234567890abcdef
description
optional
stringDescriptionThis is description

2.1.16 - Set Public Domain Name

2.1.16.1 - 1.3

scp-cli dns public-domain-name update
--public_domain_id <value>
[--auto_extension <value>]
[--description <value>]

Description

Update the public domain name.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
public_domain_id
required
stringThe unique identifier of the public domain name.10fjkeweffpublicdomain3193rud543
auto_extension
optional
booleanIndicates whether automatic extension is enabled for the domain.True
description
optional
stringDescriptionThis is description

2.1.17 - Set Public Domain Name Whois Info

2.1.17.1 - 1.3

scp-cli dns public-domain-name-info update
--public_domain_id <value>
--register_telno <value>
--register_email <value>
--postal_code <value>
--overseas_third_address <value>
--overseas_second_address <value>
--overseas_first_address <value>
--domestic_second_address_ko <value>
--domestic_second_address_en <value>
--domestic_first_address_ko <value>
--domestic_first_address_en <value>
--address_type <value>

Description

Update Public Domain Name Whois Info

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
public_domain_id
required
stringThe unique identifier of the public domain name.10fjkeweffpublicdomain3193rud543
register_telno
required
stringThe telephone number of the domain registrant.-
register_email
required
stringThe email address of the domain registrant.admin@example.com
postal_code
required
stringThe postal code for the domain registration.12345
overseas_third_address
required
stringThe third line of overseas address.NY 10001
overseas_second_address
required
stringThe second line of overseas address.New York
overseas_first_address
required
stringThe first line of overseas address.123 Main St
domestic_second_address_ko
required
stringThe second line of domestic address in Korean.서관 1층
domestic_second_address_en
required
stringThe second line of domestic address in English.West Campus 1F
domestic_first_address_ko
required
stringThe first line of domestic address in Korean.서울특별시 송파구 올림픽로35길 125 (신천동)
domestic_first_address_en
required
stringThe first line of domestic address in English.125 Olympic-ro 35-gil, Songpa-gu, Seoul
address_type
required
stringThe type of address for the domain registration.-

2.1.18 - Show Hosted Zone

2.1.18.1 - 1.3

scp-cli dns hosted-zone show
--hosted_zone_id <value>

Description

Provides details about a specific hosted zone.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringThe unique identifier of the hosted zone.3432012nfdksdf03ktrld9234lgfg

Responses

NameDescriptionExample
idThe unique identifier of the hosted zone.3432012nfdksdf03ktrld9234lgfg
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionThis is description
hosted_zone_typeThe type of the hosted zone (e.g., public or private).
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe domain name that a DNS service manages. all DNS records for that domain and its sub‑domains are stored and served within this hosted zone.my-zone.com
pool_idThe resource pool identifier associated with the hosted zone.12345678-90ab-cdef-1234-567890abcdef
private_dns_idThe DNS server ID for registering a Hosted Zone.For a Public‑type Hosted Zone, display it as an empty value.fedcba9876543210fedcba9876543210
private_dns_nameThe DNS server name for registering a Hosted Zone.For a Public‑type Hosted Zone, display it as an empty value.private-dns01
statusState
ttlThe Time-To-Live (TTL) value in seconds for DNS records in this zone.3600

2.1.19 - Show Hosted Zone Record

2.1.19.1 - 1.3

scp-cli dns hosted-zone-record show
--record_id <value>
--hosted_zone_id <value>

Description

Provides details about a specific DNS record.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
record_id
required
stringThe unique identifier of the DNS record.6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
hosted_zone_id
required
stringThe identifier of the hosted zone that contains this DNS record.3432012nfdksdf03ktrld9234lgfg

Responses

NameDescriptionExample
idThe unique identifier of the DNS record.6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
actionThe action performed on the DNS record.CREATE
created_atThe timestamp when the resource was created, in ISO 8601 format.2025-09-08T03:43:57Z
descriptionDescriptionThis is description
linksThe links related to the DNS record.
nameThe name of the DNS record.test.app
project_idThe project identifier associated with the DNS record.003dffc50eb123a1cbf4f2e5c71d4f15
recordsA list of data for this record[‘12345.ns.private.kr-west1.dev2.samsungsdscloud.com’]
statusThe current status of the DNS record.ACTIVE
ttlThe Time-To-Live (TTL) value in seconds for the DNS record.3600
typeThe type of the DNS record (e.g., A, AAAA, CNAME, MX, TXT, SPF).A
updated_atThe timestamp when the resource was last updated, in ISO 8601 format.2026-02-09T08:00:40Z
versionThe version of the DNS record.1
zone_idID for the zone that contains this record3432012nfdksdf03ktrld9234lgfg
zone_nameThe name of the zone that contains this recordmy-zone.com

2.1.20 - Show Private DNS

2.1.20.1 - 1.3

scp-cli dns private-dns show
--private_dns_id <value>

Description

Provides details about a specific private DNS.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
private_dns_id
required
stringThe unique identifier of the private DNS.fedcba9876543210fedcba9876543210

Responses

NameDescriptionExample
idThe unique identifier of the private DNS.fedcba9876543210fedcba9876543210
auth_dns_nameThe authoritative DNS name of the private DNS.authdns-a1b2c3d4e5f6789012345678abcdef90
connected_vpc_idsThe list of VPC identifiers connected to this private DNS.Only VPCs that are connected to the DNS can query the domain information registered in it.[‘1234567890abcdef1234567890abcdef’, ‘fedcba0987654321fedcba0987654321’]
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionThis is description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the private DNS.private-dns01
pool_idThe resource pool identifier associated with the private DNS.12345678-90ab-cdef-1234-567890abcdef
pool_nameThe name of the resource pool.private01-a1b2c3d4e5f6789012345678abcdef90
registered_regionThe region where the private DNS is registered.KR-WEST1
resolver_ipThe IP address of the DNS resolver.198.19.0.101
resolver_nameThe name of the DNS resolver.resolver-a1b2c3d4e5f6789012345678abcdef90
stateStateACTIVE

2.1.21 - Show Public Domain Name

2.1.21.1 - 1.3

scp-cli dns public-domain-name show
--public_domain_id <value>

Description

Provides details about a specific public domain name.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
public_domain_id
required
stringThe unique identifier of the public domain name.10fjkeweffpublicdomain3193rud543

Responses

NameDescriptionExample
idThe unique identifier of the public domain name.10fjkeweffpublicdomain3193rud543
address_typeThe type of address for the domain registration.DOMESTIC
auto_extensionIndicates whether automatic extension is enabled for the domain.True
created_atThe timestamp when the resource was created, in ISO 8601 format.2025-09-08T03:43:57Z
created_byThe user id that created the resource.504f24f8111e42e0578f367acd2a149f
descriptionDescriptionThis is description
domestic_address_enThe domestic address in English for the domain registration.West Campus 1F, 125 Olympic-ro 35-gil, Songpa-gu, Seoul
domestic_address_koThe domestic address in Korean for the domain registration.서울특별시 송파구 올림픽로35길 125 (신천동), 서관 1층
domestic_first_address_enThe first line of domestic address in English.125 Olympic-ro 35-gil, Songpa-gu, Seoul
domestic_first_address_koThe first line of domestic address in Korean.서울특별시 송파구 올림픽로35길 125 (신천동)
domestic_second_address_enThe second line of domestic address in English.West Campus 1F
domestic_second_address_koThe second line of domestic address in Korean.서관 1층
expired_dateThe expiration date of the domain registration.2026-09-09T00:00:00Z
modified_atThe timestamp when the resource was last modified, in ISO 8601 format.2026-02-09T08:00:40Z
modified_byThe user id that last modified the resource.504f24f8111e42e0578f367acd2a149f
nameThe name of the public domain name.example.com
overseas_addressThe overseas address for the domain registration.123 Main St, New York, NY 10001
overseas_first_addressThe first line of overseas address.123 Main St
overseas_second_addressThe second line of overseas address.New York
overseas_third_addressThe third line of overseas address.NY 10001
postal_codeThe postal code for the domain registration.12345
register_emailThe email address of the domain registrant.admin@example.com
register_name_enThe name of the domain registrant in English.Hong Gildong
register_name_koThe name of the domain registrant in Korean.홍길동
register_telnoThe telephone number of the domain registrant.
start_dateThe start date of the domain registration.2025-09-09T00:00:00Z
statusThe current status of the public domain name.REGISTERED

2.1.22 - Transfer Public Domain Name

2.1.22.1 - 1.3

scp-cli dns public-domain-name-transfer update
--public_domain_id <value>
--type <value>
[--target_account_id <value>]

Description

Transfer The Public Domain Name to other Account

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
public_domain_id
required
stringThe unique identifier of the public domain name.10fjkeweffpublicdomain3193rud543
type
required
stringTransfer operation typeREQUEST
target_account_id
optional
stringTarget account id (required when type=REQUEST)003dffc50eb123a1cbf4f2e5c71d4f15

Responses

NameDescriptionExample
idThe unique identifier of the public domain name.10fjkeweffpublicdomain3193rud543
auto_extensionIndicates whether automatic extension is enabled for the domain.True
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionThis is description
expired_dateThe expiration date of the domain registration.2026-09-09T00:00:00Z
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the public domain name.example.com
start_dateThe start date of the domain registration.2025-09-09T00:00:00Z
stateStateTRANSFER_REQUESTED

3 - Firewall

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 Firewall service 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.1CURRENT-
1.0SUPPORTED20270131

CLI Version History

1.1

Firewall CLI version 1.1 has been released.

Changes

  • [Changed] firewall firewall list - List Firewalls command has been changed.
    • The following fields have been added to the response.
      • zone_resources
    • The following fields have been removed from the response.
      • fw_resource_id
  • [Changed] firewall firewall show - Show Firewall command has been changed.
    • The following fields have been added to the response.
      • zone_resources
    • The following fields have been removed from the response.
      • fw_resource_id
  • [Changed] firewall firewall set - Set Firewall command has been changed.
    • The following fields have been added to the response.
      • zone_resources
    • The following fields have been removed from the response.
      • fw_resource_id
  • [Changed] firewall firewall-rule list - List Firewall Rules command has been changed.
    • The following fields have been removed from the request.
      • fetch_all
    • The following fields have been removed from the response.
      • destination_interface, name, source_interface, vendor_rule_id
  • [Changed] firewall firewall-rule show - Show Firewall Rule command has been changed.
    • The following fields have been removed from the response.
      • destination_interface, name, source_interface, vendor_rule_id
  • [Changed] firewall firewall-rule create - Create Firewall Rule command has been changed.
    • Changed to asynchronous processing.
    • Command execution result is no longer returned.
    • The following fields have been removed from the request.
      • destination_interface, name, source_interface
  • [Changed] firewall firewall-rule set - Set Firewall Rule command has been changed.
    • Changed to asynchronous processing.
    • Command execution result is no longer returned.
    • The following fields have been added to the request.
      • order_direction, order_rule_id, status
  • [Changed] firewall firewall-rule delete - Delete Firewall Rule command has been changed.
    • Changed to asynchronous processing.

1.0

Firewall CLI has been released.

Changes

  • [New] firewall firewall list - Command has been added.
  • [New] firewall firewall show - Command has been added.
  • [New] firewall firewall set - Command has been added.
  • [New] firewall firewall-rule list - Command has been added.
  • [New] firewall firewall-rule create - Command has been added.
  • [New] firewall firewall-rule show - Command has been added.
  • [New] firewall firewall-rule set - Command has been added.
  • [New] firewall firewall-rule delete - Command has been added.

3.1 - CLIs

3.1.1 - Create Firewall Rule

3.1.1.1 - 1.1

scp-cli firewall firewall-rule create
--status <value>
--source_address <value>
--service <value>
--direction <value>
--destination_address <value>
--action <value>
--firewall_id <value>
[--description <value>]
[--order_direction <value>]
[--order_rule_id <value>]

Description

Create firewall rule.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
status
required
stringFirewall Rule Status-
source_address
required
arraySource Address192.168.1.1
service
required
arrayService Port'{"service_type": "TCP", "service_value": "443"}'
direction
required
stringFirewall Rule Direction-
destination_address
required
arrayDestination Address10.0.0.1
action
required
stringFirewall Rule Action-
firewall_id
required
stringFirewall IDb156740b6335468d8354eb9ef8eddf5a
description
optional
stringFirewall Rule DescriptionFirewall rule description example
order_direction
optional
stringOrder Direction-
order_rule_id
optional
stringOrder Rule ID043aa63459da466faad71fe4fe587031

Responses

NameDescriptionExample

3.1.1.2 - 1.0

scp-cli firewall firewall-rule create
--status <value>
--source_address <value>
--service <value>
--direction <value>
--destination_address <value>
--action <value>
--firewall_id <value>
[--description <value>]
[--order_direction <value>]
[--order_rule_id <value>]

Description

Create firewall rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020270131

Parameters

NameTypeDescriptionExample
status
required
stringFirewall Rule Status-
source_address
required
arraySource Address192.168.1.1
service
required
arrayService Port'{"service_type": "TCP", "service_value": "443"}'
direction
required
stringFirewall Rule Direction-
destination_address
required
arrayDestination Address10.0.0.1
action
required
stringFirewall Rule Action-
firewall_id
required
stringFirewall IDb156740b6335468d8354eb9ef8eddf5a
description
optional
stringFirewall Rule DescriptionFirewall rule description example
order_direction
optional
stringOrder Direction-
order_rule_id
optional
stringOrder Rule ID043aa63459da466faad71fe4fe587031

Responses

NameDescriptionExample
idFirewall Rule IDb156740b6335468d8354eb9ef8eddf5a
actionFirewall Rule Action
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionFirewall Rule DescriptionFirewall rule description example
destination_addressDestination Address[‘10.0.0.1’, ‘10.0.0.2’]
destination_interfaceDestination Interface NameIFW1-v1001dn
directionFirewall Rule Direction
firewall_idFirewall IDb156740b6335468d8354eb9ef8eddf5a
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameFirewall Rule Nameb156740b6335468d8354eb9ef8eddf5a
sequenceFirewall Rule Sequence100
serviceService Port
source_addressSource Address[‘192.168.1.1’, ‘192.168.1.2’]
source_interfaceSource Interface NameIFW1-v2501up
stateFirewall Rule State
statusFirewall Rule Status
vendor_rule_idVendor Rule ID72

3.1.2 - Delete Firewall Rule

3.1.2.1 - 1.1

scp-cli firewall firewall-rule delete
--firewall_rule_id <value>

Description

Delete firewall rule.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
firewall_rule_id
required
stringFirewall Rule IDb156740b6335468d8354eb9ef8eddf5a

3.1.2.2 - 1.0

scp-cli firewall firewall-rule delete
--firewall_rule_id <value>

Description

Delete firewall rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020270131

Parameters

NameTypeDescriptionExample
firewall_rule_id
required
stringFirewall Rule IDb156740b6335468d8354eb9ef8eddf5a

3.1.3 - List Firewall Rules

3.1.3.1 - 1.1

scp-cli firewall firewall-rule list
--firewall_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--src_ip <value>]
[--dst_ip <value>]
[--description <value>]
[--state <value>]
[--status <value>]

Description

Get firewall rule list.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
firewall_id
required
stringFirewall IDb156740b6335468d8354eb9ef8eddf5a
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
src_ip
optional
stringSource IP192.168.1.1
dst_ip
optional
stringDestination IP192.168.1.1
description
optional
stringFirewall Rule DescriptionFirewall rule description example
state
optional
arrayFirewall Rule State-
status
optional
****Firewall Rule Status-

Responses

NameDescriptionExample
idFirewall Rule IDb156740b6335468d8354eb9ef8eddf5a
actionFirewall Rule Action
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionFirewall Rule DescriptionFirewall rule description example
destination_addressDestination Address[‘10.0.0.1’, ‘10.0.0.2’]
directionFirewall Rule Direction
firewall_idFirewall IDb156740b6335468d8354eb9ef8eddf5a
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
sequenceFirewall Rule Sequence100
serviceService Port
source_addressSource Address[‘192.168.1.1’, ‘192.168.1.2’]
stateFirewall Rule State
statusFirewall Rule Status

3.1.3.2 - 1.0

scp-cli firewall firewall-rule list
--firewall_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--src_ip <value>]
[--dst_ip <value>]
[--description <value>]
[--state <value>]
[--status <value>]
[--fetch_all <value>]

Description

Get firewall rule list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020270131

Parameters

NameTypeDescriptionExample
firewall_id
required
stringFirewall IDb156740b6335468d8354eb9ef8eddf5a
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
src_ip
optional
stringSource IP192.168.1.1
dst_ip
optional
stringDestination IP192.168.1.1
description
optional
stringFirewall Rule DescriptionFirewall rule description example
state
optional
arrayFirewall Rule State-
status
optional
****Firewall Rule Status-
fetch_all
optional
booleanFirewall Rule Fetch ALL-

Responses

NameDescriptionExample
idFirewall Rule IDb156740b6335468d8354eb9ef8eddf5a
actionFirewall Rule Action
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionFirewall Rule DescriptionFirewall rule description example
destination_addressDestination Address[‘10.0.0.1’, ‘10.0.0.2’]
destination_interfaceDestination Interface NameIFW1-v1001dn
directionFirewall Rule Direction
firewall_idFirewall IDb156740b6335468d8354eb9ef8eddf5a
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameFirewall Rule Nameb156740b6335468d8354eb9ef8eddf5a
sequenceFirewall Rule Sequence100
serviceService Port
source_addressSource Address[‘192.168.1.1’, ‘192.168.1.2’]
source_interfaceSource Interface NameIFW1-v2501up
stateFirewall Rule State
statusFirewall Rule Status
vendor_rule_idVendor Rule ID72

3.1.4 - List Firewalls

3.1.4.1 - 1.1

scp-cli firewall firewall list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--vpc_name <value>]
[--product_type <value>]
[--state <value>]

Description

Get firewall list.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringFirewall NameFW_IGW_secuVPC
vpc_name
optional
stringVPC NamesecuVPC
product_type
optional
arrayFirewall Product Type-
state
optional
arrayFirewall State-

Responses

NameDescriptionExample
idFirewall IDb156740b6335468d8354eb9ef8eddf5a
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
flavor_nameFirewall Size NameSMALL
flavor_rule_quotaFirewall Rule Quota100
loggableLogging UseFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameFirewall NameFW_IGW_secuVPC
pre_product_idPre Product ID76479b7ffee1431198d9beb4502cda08
product_typeFirewall Product Type
stateFirewall State
statusFirewall Status
total_rule_countTotal Rule Count8
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NamesecuVPC
zone_resourcesFirewall Zone Resources

3.1.4.2 - 1.0

scp-cli firewall firewall list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--vpc_name <value>]
[--product_type <value>]
[--state <value>]

Description

Get firewall list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020270131

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringFirewall NameFW_IGW_secuVPC
vpc_name
optional
stringVPC NamesecuVPC
product_type
optional
arrayFirewall Product Type-
state
optional
arrayFirewall State-

Responses

NameDescriptionExample
idFirewall IDb156740b6335468d8354eb9ef8eddf5a
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
flavor_nameFirewall Size NameSMALL
flavor_rule_quotaFirewall Rule Quota100
fw_resource_idFw Resource ID005fd1d30dea11f08a2c56773bef875b
loggableLogging UseFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameFirewall NameFW_IGW_secuVPC
pre_product_idPre Product ID76479b7ffee1431198d9beb4502cda08
product_typeFirewall Product Type
stateFirewall State
statusFirewall Status
total_rule_countTotal Rule Count8
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NamesecuVPC

3.1.5 - Set Firewall

3.1.5.1 - 1.1

scp-cli firewall firewall set
--firewall_id <value>
[--flavor_name <value>]
[--loggable <value>]

Description

Set firewall.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
firewall_id
required
stringFirewall IDb156740b6335468d8354eb9ef8eddf5a
flavor_name
optional
stringFirewall Size Name-
loggable
optional
booleanLogging UseFalse

3.1.5.2 - 1.0

scp-cli firewall firewall set
--firewall_id <value>
[--flavor_name <value>]
[--loggable <value>]

Description

Set firewall.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020270131

Parameters

NameTypeDescriptionExample
firewall_id
required
stringFirewall IDb156740b6335468d8354eb9ef8eddf5a
flavor_name
optional
stringFirewall Size Name-
loggable
optional
booleanLogging UseFalse

3.1.6 - Set Firewall Rule

3.1.6.1 - 1.1

scp-cli firewall firewall-rule set
--firewall_rule_id <value>
--status <value>
--source_address <value>
--service <value>
--direction <value>
--destination_address <value>
--action <value>
[--description <value>]
[--order_direction <value>]
[--order_rule_id <value>]

Description

Set firewall rule.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
firewall_rule_id
required
stringFirewall Rule IDb156740b6335468d8354eb9ef8eddf5a
status
required
stringFirewall Rule Status-
source_address
required
arraySource Address192.168.1.1
service
required
arrayService Port'{"service_type": "TCP", "service_value": "443"}'
direction
required
stringFirewall Rule Direction-
destination_address
required
arrayDestination Address10.0.0.1
action
required
stringFirewall Rule Action-
description
optional
stringFirewall Rule DescriptionFirewall rule description example
order_direction
optional
stringOrder Direction-
order_rule_id
optional
stringOrder Rule ID043aa63459da466faad71fe4fe587031

3.1.6.2 - 1.0

scp-cli firewall firewall-rule set
--firewall_rule_id <value>
--source_address <value>
--service <value>
--direction <value>
--destination_address <value>
--action <value>
[--description <value>]

Description

Set firewall rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020270131

Parameters

NameTypeDescriptionExample
firewall_rule_id
required
stringFirewall Rule IDb156740b6335468d8354eb9ef8eddf5a
source_address
required
arraySource Address192.168.1.1
service
required
arrayService Port'{"service_type": "TCP", "service_value": "443"}'
direction
required
stringFirewall Rule Direction-
destination_address
required
arrayDestination Address10.0.0.1
action
required
stringFirewall Rule Action-
description
optional
stringFirewall Rule DescriptionFirewall rule description example

3.1.7 - Show Firewall

3.1.7.1 - 1.1

scp-cli firewall firewall show
--firewall_id <value>

Description

Show firewall.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
firewall_id
required
stringFirewall IDb156740b6335468d8354eb9ef8eddf5a

Responses

NameDescriptionExample
idFirewall IDb156740b6335468d8354eb9ef8eddf5a
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
flavor_nameFirewall Size NameSMALL
flavor_rule_quotaFirewall Rule Quota100
loggableLogging UseFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameFirewall NameFW_IGW_secuVPC
pre_product_idPre Product ID76479b7ffee1431198d9beb4502cda08
product_typeFirewall Product Type
stateFirewall State
statusFirewall Status
total_rule_countTotal Rule Count8
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NamesecuVPC
zone_resourcesFirewall Zone Resources

3.1.7.2 - 1.0

scp-cli firewall firewall show
--firewall_id <value>

Description

Show firewall.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020270131

Parameters

NameTypeDescriptionExample
firewall_id
required
stringFirewall IDb156740b6335468d8354eb9ef8eddf5a

Responses

NameDescriptionExample
idFirewall IDb156740b6335468d8354eb9ef8eddf5a
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
flavor_nameFirewall Size NameSMALL
flavor_rule_quotaFirewall Rule Quota100
fw_resource_idFw Resource ID005fd1d30dea11f08a2c56773bef875b
loggableLogging UseFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameFirewall NameFW_IGW_secuVPC
pre_product_idPre Product ID76479b7ffee1431198d9beb4502cda08
product_typeFirewall Product Type
stateFirewall State
statusFirewall Status
total_rule_countTotal Rule Count8
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NamesecuVPC

3.1.8 - Show Firewall Rule

3.1.8.1 - 1.1

scp-cli firewall firewall-rule show
--firewall_rule_id <value>

Description

Show firewall rule.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
firewall_rule_id
required
stringFirewall Rule IDb156740b6335468d8354eb9ef8eddf5a

Responses

NameDescriptionExample
idFirewall Rule IDb156740b6335468d8354eb9ef8eddf5a
actionFirewall Rule Action
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionFirewall Rule DescriptionFirewall rule description example
destination_addressDestination Address[‘10.0.0.1’, ‘10.0.0.2’]
directionFirewall Rule Direction
firewall_idFirewall IDb156740b6335468d8354eb9ef8eddf5a
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
sequenceFirewall Rule Sequence100
serviceService Port
source_addressSource Address[‘192.168.1.1’, ‘192.168.1.2’]
stateFirewall Rule State
statusFirewall Rule Status

3.1.8.2 - 1.0

scp-cli firewall firewall-rule show
--firewall_rule_id <value>

Description

Show firewall rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020270131

Parameters

NameTypeDescriptionExample
firewall_rule_id
required
stringFirewall Rule IDb156740b6335468d8354eb9ef8eddf5a

Responses

NameDescriptionExample
idFirewall Rule IDb156740b6335468d8354eb9ef8eddf5a
actionFirewall Rule Action
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionFirewall Rule DescriptionFirewall rule description example
destination_addressDestination Address[‘10.0.0.1’, ‘10.0.0.2’]
destination_interfaceDestination Interface NameIFW1-v1001dn
directionFirewall Rule Direction
firewall_idFirewall IDb156740b6335468d8354eb9ef8eddf5a
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameFirewall Rule Nameb156740b6335468d8354eb9ef8eddf5a
sequenceFirewall Rule Sequence100
serviceService Port
source_addressSource Address[‘192.168.1.1’, ‘192.168.1.2’]
source_interfaceSource Interface NameIFW1-v2501up
stateFirewall Rule State
statusFirewall Rule Status
vendor_rule_idVendor Rule ID72

4 - Global CDN

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 Global CDN service 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.0CURRENT-

CLI Version History

1.0

CDN CLI has been released.

Changes

  • [New] cdn cdn service list - Command has been added.
  • [New] cdn cdn service create - Command has been added.
  • [New] cdn cdn service detail - Command has been added.
  • [New] cdn cdn service update - Command has been added.
  • [New] cdn cdn service delete - Command has been added.
  • [New] cdn cdn service start - Command has been added.
  • [New] cdn cdn service stop - Command has been added.
  • [New] cdn cdn service purge - Command has been added.
  • [New] cdn description update - Command has been added.

4.1 - CLIs

4.1.1 - Create Cdn Service

4.1.1.1 - 1.0

scp-cli cdn cdn service create
--range_request_allowed <value>
--query_string_ignored <value>
--origin_hostname_type <value>
--name <value>
--forward_host_header <value>
--content_policy <value>
--cdn_service_domain_prefix <value>
--cdn_origin_protocol <value>
--cdn_origin_port <value>
--cdn_origin_hostname <value>
--caching_option <value>
--cache_key_hostname <value>
--cache_expiry_time <value>
[--cdn_service_origin_path <value>]
[--custom_forward_host_header <value>]
[--description <value>]
[--request_custom_headers <value>]
[--response_custom_headers <value>]
[--tags <value>]

Description

Create CDN service resource for caching and delivering content from an origin server through edge locations.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
range_request_allowed
required
booleanIndicates whether range requests are allowed for content delivery.True
query_string_ignored
required
booleanIndicates whether the query string is ignored when caching content.True
origin_hostname_type
required
stringThe type of the origin hostname (e.g., DOMAIN, IP).-
name
required
stringThe name of the CDN service.test1
forward_host_header
required
stringThe host header forwarded to the origin server (e.g., ORIGIN_HOSTNAME, INCOMING_HOST_HEADER, CUSTOM).-
content_policy
required
stringThe content delivery policy for the CDN service (e.g., ONLY_VALIDATED_CONTENTS, ALL_CONTENTS).ONLY_VALIDATED_CONTENTS
cdn_service_domain_prefix
required
stringThe prefix of the CDN service domain.global1
cdn_origin_protocol
required
stringThe protocol used to connect to the origin server (e.g., HTTP, HTTPS).HTTPS
cdn_origin_port
required
integerThe port used to connect to the origin server.443
cdn_origin_hostname
required
stringThe hostname of the origin server from which the CDN retrieves content.test.example.com
caching_option
required
stringThe caching option for the CDN content (e.g., CACHE, NO_CACHE, BYPASS_CACHE).CACHE
cache_key_hostname
required
stringThe hostname used as part of the cache key (e.g., ORIGIN_HOSTNAME, INCOMING_HOST_HEADER).-
cache_expiry_time
required
integerThe cache expiry time in seconds for content stored at edge locations.86400
cdn_service_origin_path
optional
stringThe path on the origin server from which the CDN retrieves content./test/global/
custom_forward_host_header
optional
stringThe custom host header forwarded to the origin when forward host header is set to CUSTOM.-
description
optional
stringDescription추가 정보 입력 - 설명
request_custom_headers
optional
objectThe custom headers added to requests forwarded to the origin server.-
response_custom_headers
optional
objectThe custom headers added to responses returned to the client.-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
account_idAccount ID
resource_idThe identifier of the resource.
workflow_idThe identifier of the workflow processing the request.

4.1.2 - Delete Cdn Service

4.1.2.1 - 1.0

scp-cli cdn cdn service delete
--id <value>

Description

Delete CDN service resource

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
id
required
stringThe unique identifier of the CDN service.-

4.1.3 - Detail Cdn Service

4.1.3.1 - 1.0

scp-cli cdn cdn service detail
--id <value>

Description

Provides details about a specific CDN service.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
id
required
stringThe unique identifier of the CDN service.-

Responses

NameDescriptionExample
idThe unique identifier of the CDN service.
account_idAccount ID
cache_expiry_timeThe cache expiry time in seconds for content stored at edge locations.
cache_key_hostnameThe hostname used as part of the cache key (e.g., ORIGIN_HOSTNAME, INCOMING_HOST_HEADER).
caching_optionThe caching option for the CDN content (e.g., CACHE, NO_CACHE, BYPASS_CACHE).
cdn_origin_hostnameThe hostname of the origin server from which the CDN retrieves content.
cdn_origin_portThe port used to connect to the origin server.
cdn_origin_protocolThe protocol used to connect to the origin server (e.g., HTTP, HTTPS).
cdn_service_activation_stateThe activation state of the CDN service.
cdn_service_config_versionThe configuration version of the CDN service.
cdn_service_domainThe domain name through which the CDN service delivers content.
cdn_service_origin_pathThe path on the origin server from which the CDN retrieves content.
cdn_service_stateThe current state of the CDN service (e.g., RUNNING, STOPPED, CREATING, DELETING).
content_policyThe content delivery policy for the CDN service (e.g., ONLY_VALIDATED_CONTENTS, ALL_CONTENTS).
created_atThe timestamp when the resource was created, in ISO 8601 format.
created_byThe user id that created the resource.
custom_forward_host_headerThe custom host header forwarded to the origin when forward host header is set to CUSTOM.
descriptionDescription
forward_host_headerThe host header forwarded to the origin server (e.g., ORIGIN_HOSTNAME, INCOMING_HOST_HEADER, CUSTOM).
modified_atThe timestamp when the resource was last modified, in ISO 8601 format.
modified_byThe user id that last modified the resource.
nameThe name of the CDN service.
origin_hostname_typeThe type of the origin hostname (e.g., DOMAIN, IP).
query_string_ignoredIndicates whether the query string is ignored when caching content.
range_request_allowedIndicates whether range requests are allowed for content delivery.
regionThe region where the CDN service is provided.
request_custom_headersThe custom headers added to requests forwarded to the origin server.
response_custom_headersThe custom headers added to responses returned to the client.

4.1.4 - List Cdn Service

4.1.4.1 - 1.0

scp-cli cdn cdn service list
[--size <value>]
[--page <value>]
[--sort <value>]
[--created_by <value>]
[--name <value>]
[--cdn_service_domain <value>]
[--cdn_origin_hostname <value>]

Description

Provides a list of CDN services.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
created_by
optional
stringThe user id that created the resource.-
name
optional
stringThe name of the CDN service.-
cdn_service_domain
optional
stringThe domain name through which the CDN service delivers content.-
cdn_origin_hostname
optional
stringThe hostname of the origin server from which the CDN retrieves content.-

Responses

NameDescriptionExample
idThe unique identifier of the CDN service.
account_idAccount ID
cdn_origin_hostnameThe hostname of the origin server from which the CDN retrieves content.
cdn_service_domainThe domain name through which the CDN service delivers content.
cdn_service_stateThe current state of the CDN service (e.g., RUNNING, STOPPED, CREATING, DELETING).
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the CDN service.
regionThe region where the CDN service is provided.

4.1.5 - Purge Cdn Service

4.1.5.1 - 1.0

scp-cli cdn cdn service purge
--id <value>
--target_url <value>
--target_content <value>
[--custom_url <value>]

Description

Purges cached content from the CDN service.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
id
required
stringThe unique identifier of the CDN service.-
target_url
required
stringThe target URL scope for the purge operation (e.g., ALL, CUSTOM).CUSTOM
target_content
required
stringThe target content type to purge (e.g., ALL_CONTENT, INVALIDATED_CONTENT).INVALIDATED_CONTENT
custom_url
optional
stringThe custom URL to purge when the target URL is set to CUSTOM./test/

Responses

NameDescriptionExample
account_idAccount ID
resource_idThe identifier of the resource.
workflow_idThe identifier of the workflow processing the request.

4.1.6 - Start Cdn Service

4.1.6.1 - 1.0

scp-cli cdn cdn service start
--id <value>

Description

Starts the CDN service.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
id
required
stringThe unique identifier of the CDN service.-

Responses

NameDescriptionExample
account_idAccount ID
resource_idThe identifier of the resource.
workflow_idThe identifier of the workflow processing the request.

4.1.7 - Stop Cdn Service

4.1.7.1 - 1.0

scp-cli cdn cdn service stop
--id <value>

Description

Stops the CDN service.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
id
required
stringThe unique identifier of the CDN service.-

Responses

NameDescriptionExample
account_idAccount ID
resource_idThe identifier of the resource.
workflow_idThe identifier of the workflow processing the request.

4.1.8 - Update Cdn Service

4.1.8.1 - 1.0

scp-cli cdn cdn service update
--id <value>
--range_request_allowed <value>
--query_string_ignored <value>
--origin_hostname_type <value>
--forward_host_header <value>
--content_policy <value>
--cdn_origin_protocol <value>
--cdn_origin_port <value>
--cdn_origin_hostname <value>
--caching_option <value>
--cache_key_hostname <value>
--cache_expiry_time <value>
[--cdn_service_origin_path <value>]
[--custom_forward_host_header <value>]
[--request_custom_headers <value>]
[--response_custom_headers <value>]

Description

Update a CDN service resource

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
id
required
stringThe unique identifier of the CDN service.-
range_request_allowed
required
booleanIndicates whether range requests are allowed for content delivery.True
query_string_ignored
required
booleanIndicates whether the query string is ignored when caching content.True
origin_hostname_type
required
stringThe type of the origin hostname (e.g., DOMAIN, IP).-
forward_host_header
required
stringThe host header forwarded to the origin server (e.g., ORIGIN_HOSTNAME, INCOMING_HOST_HEADER, CUSTOM).-
content_policy
required
stringThe content delivery policy for the CDN service (e.g., ONLY_VALIDATED_CONTENTS, ALL_CONTENTS).ONLY_VALIDATED_CONTENTS
cdn_origin_protocol
required
stringThe protocol used to connect to the origin server (e.g., HTTP, HTTPS).HTTPS
cdn_origin_port
required
integerThe port used to connect to the origin server.443
cdn_origin_hostname
required
stringThe hostname of the origin server from which the CDN retrieves content.test.example.com
caching_option
required
stringThe caching option for the CDN content (e.g., CACHE, NO_CACHE, BYPASS_CACHE).CACHE
cache_key_hostname
required
stringThe hostname used as part of the cache key (e.g., ORIGIN_HOSTNAME, INCOMING_HOST_HEADER).-
cache_expiry_time
required
integerThe cache expiry time in seconds for content stored at edge locations.86400
cdn_service_origin_path
optional
stringThe path on the origin server from which the CDN retrieves content./test/global/
custom_forward_host_header
optional
stringThe custom host header forwarded to the origin when forward host header is set to CUSTOM.-
request_custom_headers
optional
objectThe custom headers added to requests forwarded to the origin server.-
response_custom_headers
optional
objectThe custom headers added to responses returned to the client.-

4.1.9 - Update Description of Cdn Service

4.1.9.1 - 1.0

scp-cli cdn description update
--id <value>
--description <value>

Description

Updates the description of the CDN service.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
id
required
stringThe unique identifier of the CDN service.-
description
required
stringDescription추가 정보 입력 - 설명

5 - GSLB

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 GSLB service 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.1CURRENT-
1.0DEPRECATED20260531

CLI Version History

1.1

GSLB CLI has been updated to version 1.1.

Changes

  • [Changed] gslb gslb create - Command has been changed.
    • The following option has been added:
      • --routing-control-enabled
  • [New] gslb gslb regional routing list - Command has been added.
  • [New] gslb gslb-regional-routing-set - Command has been added.

1.0

GSLB CLI has been released.

Changes

  • [New] gslb gslb list - Command has been added.
  • [New] gslb gslb create - Command has been added.
  • [New] gslb gslb show - Command has been added.
  • [New] gslb gslb update - Command has been added.
  • [New] gslb gslb delete - Command has been added.
  • [New] gslb gslb-health-check update - Command has been added.
  • [New] gslb gslb-resource list - Command has been added.
  • [New] gslb gslb-resource update - Command has been added.

5.1 - CLIs

5.1.1 - CreateGslb

5.1.1.1 - 1.1

scp-cli gslb gslb create
--protocol <value>
--resources <value>
--name <value>
--env_usage <value>
--algorithm <value>
[--description <value>]
[--tags <value>]
[--health_check_interval <value>]
[--health_check_probe_timeout <value>]
[--health_check_user_id <value>]
[--health_check_user_password <value>]
[--receive_string <value>]
[--send_string <value>]
[--service_port <value>]
[--timeout <value>]

Description

Create a global Server Load Balancer resource for distributing traffic across multiple regions.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
protocol
required
stringThe protocol used for health checks (e.g., ICMP, TCP, HTTP, HTTPS).https
resources
required
arrayThe list of resources for the GSLB.'{"description": "", "destination": "192.168.1.100", "region": "KR-WEST-1", "weight": 10}'
name
required
stringThe name of the GSLB.example.gslb.e.samsungsdscloud.com
env_usage
required
stringThe environment usage type for the GSLB (e.g., PUBLIC).PUBLIC
algorithm
required
stringThe load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO).ROUND_ROBIN
description
optional
stringDescriptionExample Description for GSLB
tags
optional
arrayTag List'{"key": "", "value": ""}'
health_check_interval
optional
integerThe GSLB Health Check Interval.5
health_check_probe_timeout
optional
integerThe GSLB Health Check Probe Timeout.5
health_check_user_id
optional
stringThe GSLB Health Check User Name.user
health_check_user_password
optional
stringThe GSLB Health Check Password.Passw0rd!
receive_string
optional
stringThe GSLB Health Check Receive String.OK
send_string
optional
stringThe GSLB Health Check Send String. If no input is provided, it operates as a “GET /” request.GET /
service_port
optional
integerThe GSLB Health Check Service Port.1
timeout
optional
integerThe GSLB Health Check Timeout. It must be greater than the Interval.6

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO).ROUND_ROBIN
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for GSLB
env_usageThe environment usage type for the GSLB (e.g., PUBLIC).PUBLIC
health_checkHealth check configuration for monitoring GSLB endpoint availability.
linked_resource_countThe number of resources linked to this GSLB.2
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the GSLB.example.gslb.e.samsungsdscloud.com
stateThe current state of the GSLB (e.g., ACTIVE, CREATING, EDITING, ERROR, DELETING).ACTIVE

5.1.1.2 - 1.0

scp-cli gslb gslb create
--protocol <value>
--resources <value>
--name <value>
--env_usage <value>
--algorithm <value>
[--description <value>]
[--tags <value>]
[--health_check_interval <value>]
[--health_check_probe_timeout <value>]
[--health_check_user_id <value>]
[--health_check_user_password <value>]
[--receive_string <value>]
[--send_string <value>]
[--service_port <value>]
[--timeout <value>]

Description

Create a global Server Load Balancer resource for distributing traffic across multiple regions.

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
protocol
required
stringThe protocol used for health checks (e.g., ICMP, TCP, HTTP, HTTPS).https
resources
required
array'{"description": "", "destination": "192.168.1.100", "disabled": false, "region": "KR-WEST-1", "weight": 10}'
name
required
stringThe name of the GSLB.-
env_usage
required
stringThe environment usage type for the GSLB (e.g., PUBLIC).-
algorithm
required
stringThe load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO).-
description
optional
stringDescription-
tags
optional
arrayTag List'{"key": "", "value": ""}'
health_check_interval
optional
integerThe GSLB Health Check Interval.5
health_check_probe_timeout
optional
integerThe GSLB Health Check Probe Timeout.5
health_check_user_id
optional
stringThe GSLB Health Check User Name.user
health_check_user_password
optional
stringThe GSLB Health Check Password.Passw0rd!
receive_string
optional
stringThe GSLB Health Check Receive String.OK
send_string
optional
stringThe GSLB Health Check Send String. If no input is provided, it operates as a “GET /” request.GET /
service_port
optional
integerThe GSLB Health Check Service Port.1
timeout
optional
integerThe GSLB Health Check Timeout. It must be greater than the Interval.6

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO).
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
env_usageThe environment usage type for the GSLB (e.g., PUBLIC).
health_check
linked_resource_countThe number of resources linked to this GSLB.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the GSLB.
stateThe current state of the GSLB (e.g., ACTIVE, CREATING, EDITING, ERROR, DELETING).

5.1.2 - DeleteGslb

5.1.2.1 - 1.1

scp-cli gslb gslb delete
--gslb_id <value>

Description

Delete the Global Server Load Balancer resource.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
gslb_id
required
stringThe unique identifier of the GSLB.-

5.1.2.2 - 1.0

scp-cli gslb gslb delete
--gslb_id <value>

Description

Delete the Global Server Load Balancer resource.

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
gslb_id
required
stringThe unique identifier of the GSLB.-

5.1.3 - ListGslbResources

5.1.3.1 - 1.1

scp-cli gslb gslb-resource list
--gslb_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

The list of resources for the GSLB.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
gslb_id
required
stringThe unique identifier of the GSLB.-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
destinationThe destination endpoint for the GSLB resource.192.168.1.100
health_check_statusThe health check status of the GSLB resource (e.g., CONNECTED, DISCONNECTED).
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
regionThe region where the GSLB resource is located.KR-WEST-1
statusWhether to use the GSLB resource. (e.g., ENABLE, DISABLE)
weightThe weight for load balancing distribution (0-100).10

5.1.3.2 - 1.0

scp-cli gslb gslb-resource list
--gslb_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

The list of resources for the GSLB.

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
gslb_id
required
stringThe unique identifier of the GSLB.-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
destinationThe destination endpoint for the GSLB resource.192.168.1.100
disabledThe GSLB Resource disabled.False
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
regionThe region where the GSLB resource is located.KR-WEST-1
weightThe weight for load balancing distribution (0-100).10

5.1.4 - ListGslbs

5.1.4.1 - 1.1

scp-cli gslb gslb list
[--size <value>]
[--page <value>]
[--sort <value>]
[--state <value>]
[--name <value>]

Description

Gets a list of Global Server Load Balancers.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
state
optional
stringThe current state of the GSLB (e.g., ACTIVE, CREATING, EDITING, ERROR, DELETING).-
name
optional
stringThe name of the GSLB.-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO).
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
env_usageThe environment usage type for the GSLB (e.g., PUBLIC).
linked_resource_countThe number of resources linked to this GSLB.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the GSLB.
stateThe current state of the GSLB (e.g., ACTIVE, CREATING, EDITING, ERROR, DELETING).

5.1.4.2 - 1.0

scp-cli gslb gslb list
[--size <value>]
[--page <value>]
[--sort <value>]
[--state <value>]
[--name <value>]

Description

Gets a list of Global Server Load Balancers.

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
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
state
optional
stringThe current state of the GSLB (e.g., ACTIVE, CREATING, EDITING, ERROR, DELETING).-
name
optional
stringThe name of the GSLB.-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO).
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
env_usageThe environment usage type for the GSLB (e.g., PUBLIC).
linked_resource_countThe number of resources linked to this GSLB.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the GSLB.
stateThe current state of the GSLB (e.g., ACTIVE, CREATING, EDITING, ERROR, DELETING).

5.1.5 - ListGslbsRegionalRoutingControl

5.1.5.1 - 1.1

scp-cli gslb gslb regional routing list
[--size <value>]
[--page <value>]
[--sort <value>]
[--region <value>]
[--status <value>]
[--name <value>]

Description

Gets a list of GSLB regional routing controls.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
region
optional
stringThe region where the GSLB resource is located.-
status
optional
****Whether to use the GSLB resource. (e.g., ENABLE, DISABLE)-
name
optional
stringThe name of the GSLB.-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO).
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
env_usageThe environment usage type for the GSLB (e.g., PUBLIC).
linked_regional_resource_countThe number of resources linked to this GSLB in the region.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the GSLB.
regionThe region where the GSLB resource is located.
statusWhether to use the GSLB resource. (e.g., ENABLE, DISABLE)

5.1.6 - SetGslb

5.1.6.1 - 1.1

scp-cli gslb gslb update
--gslb_id <value>
[--algorithm <value>]
[--description <value>]

Description

Update the Global Server Load Balancer resource.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
gslb_id
required
stringThe unique identifier of the GSLB.-
algorithm
optional
stringThe load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO).ROUND_ROBIN
description
optional
stringDescription-

5.1.6.2 - 1.0

scp-cli gslb gslb update
--gslb_id <value>
[--algorithm <value>]
[--description <value>]

Description

Update the Global Server Load Balancer resource.

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
gslb_id
required
stringThe unique identifier of the GSLB.-
algorithm
optional
stringThe load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO).ROUND_ROBIN
description
optional
stringDescription-

5.1.7 - SetGslbHealthCheck

5.1.7.1 - 1.1

scp-cli gslb gslb-health-check update
--gslb_id <value>
--protocol <value>
[--health_check_interval <value>]
[--health_check_probe_timeout <value>]
[--health_check_user_id <value>]
[--health_check_user_password <value>]
[--receive_string <value>]
[--send_string <value>]
[--service_port <value>]
[--timeout <value>]

Description

Set GSLB Health Checks.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
gslb_id
required
stringThe unique identifier of the GSLB.-
protocol
required
stringThe protocol used for health checks (e.g., ICMP, TCP, HTTP, HTTPS).https
health_check_interval
optional
integerThe GSLB Health Check Interval.5
health_check_probe_timeout
optional
integerThe GSLB Health Check Probe Timeout.5
health_check_user_id
optional
stringThe GSLB Health Check User Name.user
health_check_user_password
optional
stringThe GSLB Health Check Password.Passw0rd!
receive_string
optional
stringThe GSLB Health Check Receive String.OK
send_string
optional
stringThe GSLB Health Check Send String. If no input is provided, it operates as a “GET /” request.GET /
service_port
optional
integerThe GSLB Health Check Service Port.1
timeout
optional
integerThe GSLB Health Check Timeout. It must be greater than the Interval.6

5.1.7.2 - 1.0

scp-cli gslb gslb-health-check update
--gslb_id <value>
--protocol <value>
[--health_check_interval <value>]
[--health_check_probe_timeout <value>]
[--health_check_user_id <value>]
[--health_check_user_password <value>]
[--receive_string <value>]
[--send_string <value>]
[--service_port <value>]
[--timeout <value>]

Description

Set GSLB Health Checks.

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
gslb_id
required
stringThe unique identifier of the GSLB.-
protocol
required
stringThe protocol used for health checks (e.g., ICMP, TCP, HTTP, HTTPS).https
health_check_interval
optional
integerThe GSLB Health Check Interval.5
health_check_probe_timeout
optional
integerThe GSLB Health Check Probe Timeout.5
health_check_user_id
optional
stringThe GSLB Health Check User Name.user
health_check_user_password
optional
stringThe GSLB Health Check Password.Passw0rd!
receive_string
optional
stringThe GSLB Health Check Receive String.OK
send_string
optional
stringThe GSLB Health Check Send String. If no input is provided, it operates as a “GET /” request.GET /
service_port
optional
integerThe GSLB Health Check Service Port.1
timeout
optional
integerThe GSLB Health Check Timeout. It must be greater than the Interval.6

5.1.8 - SetGslbRegionalRoutingControl

5.1.8.1 - 1.1

scp-cli gslb gslb-regional-routing-set
--gslb_id <value>
--status <value>
--region <value>

Description

Updates GSLB regional routing control settings.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
gslb_id
required
stringThe unique identifier of the GSLB.-
status
required
stringWhether to use the GSLB resource. (e.g., ENABLE, DISABLE)ENABLE
region
required
stringThe region where the GSLB resource is located.KR-WEST-1

5.1.9 - SetGslbResources

5.1.9.1 - 1.1

scp-cli gslb gslb-resource update
--gslb_id <value>
--resources <value>

Description

Set GSLB Resources.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
gslb_id
required
stringThe unique identifier of the GSLB.-
resources
required
arrayThe list of resources for the GSLB.'{"description": "", "destination": "192.168.1.100", "region": "KR-WEST-1", "weight": 10}'

5.1.9.2 - 1.0

scp-cli gslb gslb-resource update
--gslb_id <value>
--resources <value>

Description

Set GSLB Resources.

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
gslb_id
required
stringThe unique identifier of the GSLB.-
resources
required
array'{"description": "", "destination": "192.168.1.100", "disabled": false, "region": "KR-WEST-1", "weight": 10}'

5.1.10 - ShowGslb

5.1.10.1 - 1.1

scp-cli gslb gslb show
--gslb_id <value>

Description

Shows details of a specific Global Server Load Balancer.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
gslb_id
required
stringThe unique identifier of the GSLB.-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO).
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
env_usageThe environment usage type for the GSLB (e.g., PUBLIC).
health_check
linked_resource_countThe number of resources linked to this GSLB.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the GSLB.
stateThe current state of the GSLB (e.g., ACTIVE, CREATING, EDITING, ERROR, DELETING).

5.1.10.2 - 1.0

scp-cli gslb gslb show
--gslb_id <value>

Description

Shows details of a specific Global Server Load Balancer.

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
gslb_id
required
stringThe unique identifier of the GSLB.-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO).
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
env_usageThe environment usage type for the GSLB (e.g., PUBLIC).
health_check
linked_resource_countThe number of resources linked to this GSLB.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the GSLB.
stateThe current state of the GSLB (e.g., ACTIVE, CREATING, EDITING, ERROR, DELETING).

6 - Load Balancer

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 LOADBALANCER service 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.4CURRENT-
1.3SUPPORTED20261031

6.1 - CLIs

6.1.1 - AddLbServerGroupMembers

6.1.1.1 - 1.4

scp-cli loadbalancer lb-server-group-members add
--lb_server_group_id <value>
--members <value>

Description

Add Lb Server Group Member bulk

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringID of Lb Server Group-
members
required
array'{"member_ip": "192.168.0.1", "member_port": 80, "member_state": "ENABLE", "member_weight": 100, "name": "virtualserver-1", "object_id": "1", "object_type": "VM"}'

Responses

NameDescriptionExample
counttotal count20
linkslinks[{‘href’: ‘http://scp.samsungsdscloud.com/v1/notices’, ‘rel’: ‘self’}]
members[]

6.1.1.2 - 1.3

scp-cli loadbalancer lb-server-group-members add
--lb_server_group_id <value>
--members <value>

Description

Add Lb Server Group Member bulk

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringID of Lb Server Group-
members
required
array'{"member_ip": "192.168.0.1", "member_port": 80, "member_state": "ENABLE", "member_weight": 100, "name": "virtualserver-1", "object_id": "1", "object_type": "VM"}'

Responses

NameDescriptionExample
counttotal count20
linkslinks[{‘href’: ‘http://scp.samsungsdscloud.com/v1/notices’, ‘rel’: ‘self’}]
members[]

6.1.2 - CreateLBHealthCheck

6.1.2.1 - 1.4

scp-cli loadbalancer lb-health-check create
--vpc_id <value>
--subnet_id <value>
--protocol <value>
--name <value>
[--description <value>]
[--health_check_count <value>]
[--health_check_interval <value>]
[--health_check_port <value>]
[--health_check_timeout <value>]
[--health_check_url <value>]
[--http_method <value>]
[--request_data <value>]
[--response_code <value>]
[--tags <value>]

Description

Create LB Health Check

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID8acceeb6920c4fc494490d864f67f0b5
subnet_id
required
stringService Subnet ID60fba45cb6c811efba41ba92e4fe7200
protocol
required
stringLB Health Check ProtocolTCP
name
required
stringLB Health Check nameServerGroup01
description
optional
stringDescriptionthis is an lb server group
health_check_count
optional
integerLB Health Check count3
health_check_interval
optional
integerLB Health Check interval5
health_check_port
optional
integerLB Health Check port80
health_check_timeout
optional
integerLB Health Check timeout5
health_check_url
optional
stringLB Health Check URL/test
http_method
optional
****LB Health Check HTTP MethodGET
request_data
optional
stringLB Health Check Request datausername=admin&password=1234
response_code
optional
stringLB Health Check Response code200
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idLB Health Check ID46c681018e33453085ca7c8db54e0076
account_idAccount IDe3cd678b11784734bc366148aa37580e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionthis is an lb server group
health_check_countLB Health Check count3
health_check_intervalLB Health Check interval5
health_check_portLB Health Check port80
health_check_timeoutLB Health Check timeout5
health_check_typeLB Health Check typeDEFAULT
health_check_urlLB Health Check URL/test
http_methodLB Health Check HTTP MethodGET
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLB Health Check nameTest-LbMonitor-01
protocolLB Health Check ProtocolTCP
request_dataLB Health Check Request datausername=admin&password=1234
response_codeLB Health Check Response code200
stateLB Health Check stateACTIVE
subnet_idService Subnet ID60fba45cb6c811efba41ba92e4fe7200
vpc_idVPC ID8acceeb6920c4fc494490d864f67f0b5

6.1.2.2 - 1.3

scp-cli loadbalancer lb-health-check create
--vpc_id <value>
--subnet_id <value>
--protocol <value>
--name <value>
[--description <value>]
[--health_check_count <value>]
[--health_check_interval <value>]
[--health_check_port <value>]
[--health_check_timeout <value>]
[--health_check_url <value>]
[--http_method <value>]
[--request_data <value>]
[--response_code <value>]
[--tags <value>]

Description

Create LB Health Check

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID8acceeb6920c4fc494490d864f67f0b5
subnet_id
required
stringService Subnet ID60fba45cb6c811efba41ba92e4fe7200
protocol
required
stringLB Health Check ProtocolTCP
name
required
stringLB Health Check nameServerGroup01
description
optional
stringDescriptionthis is an lb server group
health_check_count
optional
integerLB Health Check count3
health_check_interval
optional
integerLB Health Check interval5
health_check_port
optional
integerLB Health Check port80
health_check_timeout
optional
integerLB Health Check timeout5
health_check_url
optional
stringLB Health Check URL/test
http_method
optional
****LB Health Check HTTP MethodGET
request_data
optional
stringLB Health Check Request datausername=admin&password=1234
response_code
optional
stringLB Health Check Response code200
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idLB Health Check ID46c681018e33453085ca7c8db54e0076
account_idAccount IDe3cd678b11784734bc366148aa37580e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionthis is an lb server group
health_check_countLB Health Check count3
health_check_intervalLB Health Check interval5
health_check_portLB Health Check port80
health_check_timeoutLB Health Check timeout5
health_check_typeLB Health Check typeDEFAULT
health_check_urlLB Health Check URL/test
http_methodLB Health Check HTTP MethodGET
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLB Health Check nameTest-LbMonitor-01
protocolLB Health Check ProtocolTCP
request_dataLB Health Check Request datausername=admin&password=1234
response_codeLB Health Check Response code200
stateLB Health Check stateACTIVE
subnet_idService Subnet ID60fba45cb6c811efba41ba92e4fe7200
vpc_idVPC ID8acceeb6920c4fc494490d864f67f0b5

6.1.3 - CreateLbListener

6.1.3.1 - 1.4

scp-cli loadbalancer lb-listener create
--listener_protocol <value>
--service_port <value>
--routing_action <value>
--name <value>
--loadbalancer_id <value>
[--condition_type <value>]
[--description <value>]
[--idle_timeout <value>]
[--insert_client_ip <value>]
[--persistence <value>]
[--response_timeout <value>]
[--server_group_id <value>]
[--session_duration_time <value>]
[--support_http2 <value>]
[--tags <value>]
[--url_handler <value>]
[--url_redirection <value>]
[--x_forwarded_for <value>]
[--x_forwarded_port <value>]
[--x_forwarded_proto <value>]
[--port <value>]
[--response_code <value>]
[--client_cert_id <value>]
[--client_cert_level <value>]
[--server_cert_level <value>]
[--listener_https_redirection_protocol <value>]

Description

create LB listener

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
listener_protocol
required
stringprotocol-
service_port
required
integerThe port of the listener.-
routing_action
required
stringThe routing action of the listener.-
name
required
stringThe name of the listener.-
loadbalancer_id
required
stringThe ID of the load balancer.-
condition_type
optional
****The condition type of the listener.-
description
optional
stringdescription-
idle_timeout
optional
integerThe idle timeout(L7) of the listener.-
insert_client_ip
optional
booleanWhether the client IP should be inserted.-
persistence
optional
stringThe persistence of the listener.-
response_timeout
optional
integerThe response timeout of the listener.-
server_group_id
optional
stringThe ID of the server group.-
session_duration_time
optional
integerThe session duration time.-
support_http2
optional
booleanWhether the HTTP 2.0 is supported-
tags
optional
arrayTag List'{"key": "", "value": ""}'
url_handler
optional
arrayThe URL handler of the listener.'{"seq": "", "server_group_id": "", "url_pattern": ""}'
url_redirection
optional
stringThe URL redirect of the listener.-
x_forwarded_for
optional
booleanWhether the X-Forwarded-For should be inserted.-
x_forwarded_port
optional
booleanWhether the X-Forwarded-Port should be inserted.-
x_forwarded_proto
optional
booleanWhether the X-Forwarded-Protocol should be inserted.-
port
optional
stringport-
response_code
optional
stringresponse_code-
client_cert_id
optional
stringCertificate id for client ssl-
client_cert_level
optional
stringCertificate level for client ssl-
server_cert_level
optional
stringCertificate level for server ssl-
listener_https_redirection_protocol
optional
stringprotocol-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
condition_typeThe condition type of the listener.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescription
hsts_configThe hsts response header of the listener.
https_redirectionThe https redirection of the listener.
idle_timeoutThe idle timeout(L7) of the listener.
insert_client_ipWhether the client IP should be inserted.
loadbalancer_idThe ID of the load balancer.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the listener.
persistenceThe persistence of the listener.
protocolThe protocol of the listener.
response_timeoutThe response timeout of the listener.
routing_actionThe routing action of the listener.
server_group_idThe ID of the server group.
server_group_nameThe Name of the server group.
service_portThe port of the listener.
session_duration_timeThe session duration time.
sni_certificateThe sni certificate of the listener.
ssl_certificateThe ssl certificate of the listener.
stateThe State of the listener.
support_http2Whether the HTTP 2.0 is supported
tagsTag List
url_handlerURL handler list
url_redirectionThe URL redirect of the listener.
x_forwarded_forWhether the X-Forwarded-For should be inserted.
x_forwarded_portWhether the X-Forwarded-Port should be inserted.
x_forwarded_protoWhether the X-Forwarded-Protocol should be inserted.

6.1.3.2 - 1.3

scp-cli loadbalancer lb-listener create
--listener_protocol <value>
--service_port <value>
--routing_action <value>
--name <value>
--loadbalancer_id <value>
[--condition_type <value>]
[--description <value>]
[--hsts_max_age <value>]
[--idle_timeout <value>]
[--insert_client_ip <value>]
[--persistence <value>]
[--response_timeout <value>]
[--server_group_id <value>]
[--session_duration_time <value>]
[--sni_certificate <value>]
[--support_http2 <value>]
[--tags <value>]
[--url_handler <value>]
[--url_redirection <value>]
[--x_forwarded_for <value>]
[--x_forwarded_port <value>]
[--x_forwarded_proto <value>]
[--port <value>]
[--response_code <value>]
[--client_cert_id <value>]
[--client_cert_level <value>]
[--server_cert_level <value>]
[--listener_https_redirection_protocol <value>]

Description

create LB listener

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
listener_protocol
required
stringprotocol-
service_port
required
integerThe port of the listener.-
routing_action
required
stringThe routing action of the listener.-
name
required
stringThe name of the listener.-
loadbalancer_id
required
stringThe ID of the load balancer.-
condition_type
optional
****The condition type of the listener.-
description
optional
stringdescription-
hsts_max_age
optional
integerThe hsts max_age of the listener.-
idle_timeout
optional
integerThe idle timeout(L7) of the listener.-
insert_client_ip
optional
booleanWhether the client IP should be inserted.-
persistence
optional
stringThe persistence of the listener.-
response_timeout
optional
integerThe response timeout of the listener.-
server_group_id
optional
stringThe ID of the server group.-
session_duration_time
optional
integerThe session duration time.-
sni_certificate
optional
arrayThe sni certificate of the listener.'{"domain_name": "", "sni_cert_id": ""}'
support_http2
optional
booleanWhether the HTTP 2.0 is supported-
tags
optional
arrayTag List'{"key": "", "value": ""}'
url_handler
optional
arrayThe URL handler of the listener.-
url_redirection
optional
stringThe URL redirect of the listener.-
x_forwarded_for
optional
booleanWhether the X-Forwarded-For should be inserted.-
x_forwarded_port
optional
booleanWhether the X-Forwarded-Port should be inserted.-
x_forwarded_proto
optional
booleanWhether the X-Forwarded-Protocol should be inserted.-
port
optional
stringport-
response_code
optional
stringresponse_code-
client_cert_id
optional
stringCertificate id for client ssl-
client_cert_level
optional
stringCertificate level for client ssl-
server_cert_level
optional
stringCertificate level for server ssl-
listener_https_redirection_protocol
optional
stringprotocol-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
condition_typeThe condition type of the listener.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescription
hsts_max_ageThe hsts max_age of the listener.
https_redirectionThe https redirection of the listener.
idle_timeoutThe idle timeout(L7) of the listener.
insert_client_ipWhether the client IP should be inserted.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the listener.
persistenceThe persistence of the listener.
protocolThe protocol of the listener.
response_timeoutThe response timeout of the listener.
routing_actionThe routing action of the listener.
server_group_idThe ID of the server group.
server_group_nameThe Name of the server group.
service_portThe port of the listener.
session_duration_timeThe session duration time.
sni_certificateThe sni certificate of the listener.
ssl_certificateThe ssl certificate of the listener.
stateThe State of the listener.
support_http2Whether the HTTP 2.0 is supported
url_handlerThe URL handler of the listener.
url_redirectionThe URL redirect of the listener.
x_forwarded_forWhether the X-Forwarded-For should be inserted.
x_forwarded_portWhether the X-Forwarded-Port should be inserted.
x_forwarded_protoWhether the X-Forwarded-Protocol should be inserted.

6.1.4 - CreateLBServerGroup

6.1.4.1 - 1.4

scp-cli loadbalancer lb-server-group create
--vpc_id <value>
--subnet_id <value>
--protocol <value>
--name <value>
--lb_method <value>
[--description <value>]
[--lb_health_check_id <value>]
[--tags <value>]

Description

Create LB Server Group

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID8acceeb6920c4fc494490d864f67f0b5
subnet_id
required
stringService Subnet ID60fba45cb6c811efba41ba92e4fe7200
protocol
required
stringProtocolTCP
name
required
stringLB Health Check nameServerGroup01
lb_method
required
stringLB MethodROUND_ROBIN
description
optional
stringDescriptionthis is an lb server group
lb_health_check_id
optional
stringLB Health Check ID46c681018e33453085ca7c8db54e0076
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idLB Server Group ID3d8d8754d0d54683a29f3dcc3dd95d5b
account_idAccount IDe3cd678b11784734bc366148aa37580e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionthis is an lb server group
lb_health_check_idLB Health Check ID46c681018e33453085ca7c8db54e0076
lb_methodLB MethodROUND_ROBIN
lb_nameLoad Balancer nameTest-LB-01
loadbalancer_idLoad Balancer ID82efa35c88834bc083020443e57faa10
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLB Server Group nameServerGroup01
protocolProtocolTCP
stateLB Server Group stateACTIVE
subnet_idService Subnet ID60fba45cb6c811efba41ba92e4fe7200
vpc_idVPC ID8acceeb6920c4fc494490d864f67f0b5

6.1.4.2 - 1.3

scp-cli loadbalancer lb-server-group create
--vpc_id <value>
--subnet_id <value>
--protocol <value>
--name <value>
--lb_method <value>
[--description <value>]
[--lb_health_check_id <value>]
[--tags <value>]

Description

Create LB Server Group

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID8acceeb6920c4fc494490d864f67f0b5
subnet_id
required
stringService Subnet ID60fba45cb6c811efba41ba92e4fe7200
protocol
required
stringProtocolTCP
name
required
stringLB Health Check nameServerGroup01
lb_method
required
stringLB MethodROUND_ROBIN
description
optional
stringDescriptionthis is an lb server group
lb_health_check_id
optional
stringLB Health Check ID46c681018e33453085ca7c8db54e0076
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idLB Server Group ID3d8d8754d0d54683a29f3dcc3dd95d5b
account_idAccount IDe3cd678b11784734bc366148aa37580e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionthis is an lb server group
lb_health_check_idLB Health Check ID46c681018e33453085ca7c8db54e0076
lb_methodLB MethodROUND_ROBIN
lb_nameLoad Balancer nameTest-LB-01
loadbalancer_idLoad Balancer ID82efa35c88834bc083020443e57faa10
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLB Server Group nameServerGroup01
protocolProtocolTCP
stateLB Server Group stateACTIVE
subnet_idService Subnet ID60fba45cb6c811efba41ba92e4fe7200
vpc_idVPC ID8acceeb6920c4fc494490d864f67f0b5

6.1.5 - CreateLoadbalancer

6.1.5.1 - 1.4

scp-cli loadbalancer loadbalancer create
--vpc_id <value>
--subnet_id <value>
--name <value>
--layer_type <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_logging_enabled <value>]
[--health_check_ips <value>]
[--publicip_id <value>]
[--service_ip <value>]
[--source_nat_ip <value>]
[--tags <value>]
[--zones <value>]

Description

create Load Balancer

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID-
subnet_id
required
stringSubnet ID-
name
required
stringname-
layer_type
required
stringLayer type-
description
optional
stringdescription-
firewall_enabled
optional
booleanFirewall enabled-
firewall_logging_enabled
optional
booleanFirewall logging enabled-
health_check_ips
optional
arrayThe list of Health check IPs-
publicip_id
optional
stringPublic IP ID-
service_ip
optional
stringThe service IP of the load balancer.-
source_nat_ip
optional
stringSource NAT IP-
tags
optional
arrayTag List'{"key": "", "value": ""}'
zones
optional
arrayAvailability Zones-

Responses

NameDescriptionExample
idID
account_idThe account ID of the load balancer.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescription
layer_typeLayer type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namename
stateThe state of the load balancer.
subnet_idSubnet ID
vpc_idVPC ID

6.1.5.2 - 1.3

scp-cli loadbalancer loadbalancer create
--vpc_id <value>
--subnet_id <value>
--name <value>
--layer_type <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_logging_enabled <value>]
[--health_check_ip_1 <value>]
[--health_check_ip_2 <value>]
[--publicip_id <value>]
[--service_ip <value>]
[--source_nat_ip <value>]
[--tags <value>]

Description

create Load Balancer

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC ID-
subnet_id
required
stringSubnet ID-
name
required
stringname-
layer_type
required
stringLayer type-
description
optional
stringdescription-
firewall_enabled
optional
booleanFirewall enabled-
firewall_logging_enabled
optional
booleanFirewall logging enabled-
health_check_ip_1
optional
stringHealth check IP-
health_check_ip_2
optional
stringHealth check IP-
publicip_id
optional
stringPublic IP ID-
service_ip
optional
stringThe service IP of the load balancer.-
source_nat_ip
optional
stringSource NAT IP-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID
account_idThe account ID of the load balancer.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescription
layer_typeLayer type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namename
stateThe state of the load balancer.
subnet_idSubnet ID
vpc_idVPC ID

6.1.6 - CreateLoadbalancerPrivateNatIp

6.1.6.1 - 1.4

scp-cli loadbalancer loadbalancer-private-nat-ip create
--loadbalancer_id <value>
--private_nat_ip_id <value>
--private_nat_id <value>

Description

create Load Balancer Private NAT IP

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-
private_nat_ip_id
required
stringprivate_nat_ip_id-
private_nat_id
required
stringprivate_nat_id-

Responses

NameDescriptionExample
idID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
external_ip_addressexternal_ip_address
internal_ip_addressinternal_ip_address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
private_nat_ip_idprivate_nat_ip_id
statestate
subnet_idsubnet_id

6.1.6.2 - 1.3

scp-cli loadbalancer loadbalancer-private-nat-ip create
--loadbalancer_id <value>
--private_nat_ip_id <value>
--private_nat_id <value>

Description

create Load Balancer Private NAT IP

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-
private_nat_ip_id
required
stringprivate_nat_ip_id-
private_nat_id
required
stringprivate_nat_id-

Responses

NameDescriptionExample
idID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
external_ip_addressexternal_ip_address
internal_ip_addressinternal_ip_address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
private_nat_ip_idprivate_nat_ip_id
statestate
subnet_idsubnet_id

6.1.7 - CreateLoadbalancerPublicNatIp

6.1.7.1 - 1.4

scp-cli loadbalancer loadbalancer-public-nat-ip create
--loadbalancer_id <value>
--publicip_id <value>

Description

create Load Balancer Public NAT IP

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-
publicip_id
required
stringpublicip_id-

Responses

NameDescriptionExample
idID
account_idaccount_id
action_typeaction_type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescription
external_ip_addressexternal_ip_address
internal_ip_addressinternal_ip_address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namename
owner_idowner_id
owner_nameowner_name
owner_typeowner_type
publicip_idpublicip_id
service_ip_port_idservice_ip_port_id
statestate
subnet_idsubnet_id
typetype
vpc_idvpc_id

6.1.7.2 - 1.3

scp-cli loadbalancer loadbalancer-public-nat-ip create
--loadbalancer_id <value>
--publicip_id <value>

Description

create Load Balancer Public NAT IP

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-
publicip_id
required
stringpublicip_id-

Responses

NameDescriptionExample
idID
account_idaccount_id
action_typeaction_type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescription
external_ip_addressexternal_ip_address
internal_ip_addressinternal_ip_address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namename
owner_idowner_id
owner_nameowner_name
owner_typeowner_type
publicip_idpublicip_id
service_ip_port_idservice_ip_port_id
statestate
subnet_idsubnet_id
typetype
vpc_idvpc_id

6.1.8 - DeleteLBHealthCheck

6.1.8.1 - 1.4

scp-cli loadbalancer lb-health-check delete
--lb_health_check_id <value>

Description

Delete LB Health Check

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
lb_health_check_id
required
stringLB Health Check IDe3cd678b11784734bc366148aa37580e

6.1.8.2 - 1.3

scp-cli loadbalancer lb-health-check delete
--lb_health_check_id <value>

Description

Delete LB Health Check

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
lb_health_check_id
required
stringLB Health Check IDe3cd678b11784734bc366148aa37580e

6.1.9 - DeleteLbListener

6.1.9.1 - 1.4

scp-cli loadbalancer lb-listener delete
--listener_id <value>

Description

delete LB listener

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
listener_id
required
stringThe ID of the listener.-

6.1.9.2 - 1.3

scp-cli loadbalancer lb-listener delete
--listener_id <value>

Description

delete LB listener

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
listener_id
required
stringThe ID of the listener.-

6.1.10 - DeleteLBServerGroup

6.1.10.1 - 1.4

scp-cli loadbalancer lb-server-group delete
--lb_server_group_id <value>

Description

Delete LB Server Group

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringLB Server Group ID3d8d8754d0d54683a29f3dcc3dd95d5b

6.1.10.2 - 1.3

scp-cli loadbalancer lb-server-group delete
--lb_server_group_id <value>

Description

Delete LB Server Group

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringLB Server Group ID3d8d8754d0d54683a29f3dcc3dd95d5b

6.1.11 - DeleteLoadbalancer

6.1.11.1 - 1.4

scp-cli loadbalancer loadbalancer delete
--loadbalancer_id <value>

Description

delete Load Balancer

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-

6.1.11.2 - 1.3

scp-cli loadbalancer loadbalancer delete
--loadbalancer_id <value>

Description

delete Load Balancer

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-

6.1.12 - DeleteLoadbalancerPrivateNatIp

6.1.12.1 - 1.4

scp-cli loadbalancer loadbalancer-private-nat-ip delete
--loadbalancer_id <value>

Description

delete Load Balancer Private NAT IP

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-

6.1.12.2 - 1.3

scp-cli loadbalancer loadbalancer-private-nat-ip delete
--loadbalancer_id <value>

Description

delete Load Balancer Private NAT IP

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-

6.1.13 - DeleteLoadbalancerPublicNatIp

6.1.13.1 - 1.4

scp-cli loadbalancer loadbalancer-public-nat-ip delete
--loadbalancer_id <value>

Description

delete Load Balancer Public NAT IP

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-

6.1.13.2 - 1.3

scp-cli loadbalancer loadbalancer-public-nat-ip delete
--loadbalancer_id <value>

Description

delete Load Balancer Public NAT IP

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-

6.1.14 - ListLBHealthChecks

6.1.14.1 - 1.4

scp-cli loadbalancer lb-health-check list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--protocol <value>]
[--subnet_id <value>]

Description

List LB Health Checks

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringLB Health Check nameTest-LbMonitor-01
protocol
optional
arrayLB Health Check Protocol'TCP'
subnet_id
optional
stringService Subnet ID60fba45cb6c811efba41ba92e4fe7200

Responses

NameDescriptionExample
idLB Health Check ID46c681018e33453085ca7c8db54e0076
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
health_check_typeLB Health Check typeDEFAULT
lb_server_group_countLB Server Group count2
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLB Health Check nameTest-LbMonitor-01
protocolLB Health Check ProtocolTCP
stateLB Health Check stateACTIVE
subnet_idService Subnet ID60fba45cb6c811efba41ba92e4fe7200

6.1.14.2 - 1.3

scp-cli loadbalancer lb-health-check list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--protocol <value>]
[--subnet_id <value>]

Description

List LB Health Checks

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringLB Health Check nameTest-LbMonitor-01
protocol
optional
arrayLB Health Check Protocol'TCP'
subnet_id
optional
stringService Subnet ID60fba45cb6c811efba41ba92e4fe7200

Responses

NameDescriptionExample
idLB Health Check ID46c681018e33453085ca7c8db54e0076
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
health_check_typeLB Health Check typeDEFAULT
lb_server_group_countLB Server Group count2
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLB Health Check nameTest-LbMonitor-01
protocolLB Health Check ProtocolTCP
stateLB Health Check stateACTIVE
subnet_idService Subnet ID60fba45cb6c811efba41ba92e4fe7200

6.1.15 - ListLbListeners

6.1.15.1 - 1.4

scp-cli loadbalancer lb-listener list
[--size <value>]
[--page <value>]
[--sort <value>]
[--loadbalancer_id <value>]
[--state <value>]
[--name <value>]
[--service_port <value>]
[--protocol <value>]
[--not_protocol <value>]

Description

get LB listener list

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
loadbalancer_id
optional
stringThe ID of the load balancer.-
state
optional
stringThe State of the listener.-
name
optional
stringThe name of the listener.-
service_port
optional
integerThe port of the listener.-
protocol
optional
arrayProtocol'TCP'
not_protocol
optional
****The protocol of the listener to exclude.TCP

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the listener.
protocolThe protocol of the listener.
service_portThe port of the listener.
stateThe State of the listener.

6.1.15.2 - 1.3

scp-cli loadbalancer lb-listener list
[--size <value>]
[--page <value>]
[--sort <value>]
[--loadbalancer_id <value>]
[--state <value>]
[--name <value>]
[--service_port <value>]
[--protocol <value>]
[--not_protocol <value>]

Description

get LB listener list

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
loadbalancer_id
optional
stringThe ID of the load balancer.-
state
optional
stringThe State of the listener.-
name
optional
stringThe name of the listener.-
service_port
optional
integerThe port of the listener.-
protocol
optional
arrayProtocol'TCP'
not_protocol
optional
****The protocol of the listener to exclude.TCP

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the listener.
protocolThe protocol of the listener.
service_portThe port of the listener.
stateThe State of the listener.

6.1.16 - ListLbServerGroupMembers

6.1.16.1 - 1.4

scp-cli loadbalancer lb-server-group-member list
--lb_server_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--member_ip <value>]
[--member_port <value>]

Description

Get Lb Server Group Member List

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringID of Lb Server Group-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringName of Member-
member_ip
optional
stringIP of Member-
member_port
optional
integerProtocol port of Member-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
health_stateHealth State of Member
lb_server_group_idID of Lb Server Group
member_ipIP of Member
member_portProtocol port of Member
member_stateMember State of Member
member_weightWeight of Member
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of Member
object_azObject AZ of Member
object_idObject ID of Member
object_typeObject Type of Member
stateState of Member

6.1.16.2 - 1.3

scp-cli loadbalancer lb-server-group-member list
--lb_server_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--member_ip <value>]
[--member_port <value>]

Description

Get Lb Server Group Member List

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringID of Lb Server Group-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringName of Member-
member_ip
optional
stringIP of Member-
member_port
optional
integerProtocol port of Member-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
health_stateHealth State of Member
lb_server_group_idID of Lb Server Group
member_ipIP of Member
member_portProtocol port of Member
member_stateMember State of Member
member_weightWeight of Member
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of Member
object_idObject ID of Member
object_typeObject Type of Member
stateState of Member

6.1.17 - ListLBServerGroups

6.1.17.1 - 1.4

scp-cli loadbalancer lb-server-group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--state <value>]
[--protocol <value>]
[--subnet_id <value>]
[--vpc_id <value>]
[--lb_health_check_id <value>]
[--lb_method <value>]

Description

Get LB Server Group list

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringLB Server Group nameServerGroup01
state
optional
stringLB Server Group stateACTIVE
protocol
optional
arrayProtocol'TCP'
subnet_id
optional
stringService Subnet ID60fba45cb6c811efba41ba92e4fe7200
vpc_id
optional
stringVPC ID8acceeb6920c4fc494490d864f67f0b5
lb_health_check_id
optional
stringLB Health Check ID46c681018e33453085ca7c8db54e0076
lb_method
optional
arrayLB Method'R'

Responses

NameDescriptionExample
idLB Server Group ID3d8d8754d0d54683a29f3dcc3dd95d5b
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
lb_health_check_idLB Health Check ID46c681018e33453085ca7c8db54e0076
lb_nameLoad Balancer nameTest-LB-01
lb_server_group_member_countLB Server Group Member count2
loadbalancer_idLoad Balancer ID82efa35c88834bc083020443e57faa10
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLB Server Group nameServerGroup01
protocolProtocolTCP
stateLB Server Group stateACTIVE
vpc_idVPC ID8acceeb6920c4fc494490d864f67f0b5

6.1.17.2 - 1.3

scp-cli loadbalancer lb-server-group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--state <value>]
[--protocol <value>]
[--subnet_id <value>]
[--vpc_id <value>]
[--lb_health_check_id <value>]
[--lb_method <value>]

Description

Get LB Server Group list

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringLB Server Group nameServerGroup01
state
optional
stringLB Server Group stateACTIVE
protocol
optional
arrayProtocol'TCP'
subnet_id
optional
stringService Subnet ID60fba45cb6c811efba41ba92e4fe7200
vpc_id
optional
stringVPC ID8acceeb6920c4fc494490d864f67f0b5
lb_health_check_id
optional
stringLB Health Check ID46c681018e33453085ca7c8db54e0076
lb_method
optional
arrayLB Method'R'

Responses

NameDescriptionExample
idLB Server Group ID3d8d8754d0d54683a29f3dcc3dd95d5b
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
lb_health_check_idLB Health Check ID46c681018e33453085ca7c8db54e0076
lb_nameLoad Balancer nameTest-LB-01
lb_server_group_member_countLB Server Group Member count2
loadbalancer_idLoad Balancer ID82efa35c88834bc083020443e57faa10
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLB Server Group nameServerGroup01
protocolProtocolTCP
stateLB Server Group stateACTIVE
vpc_idVPC ID8acceeb6920c4fc494490d864f67f0b5

6.1.18 - ListLoadbalancerCertificates

6.1.18.1 - 1.4

scp-cli loadbalancer loadbalancer-certificate list

Description

get Load Balancer certificate list

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Responses

NameDescriptionExample
idID of the certificate
cert_kindKind of certificate
cnCommon Name of certificate
created_atCreated At
created_byCreated By
modified_atModified At
modified_byModified By
nameName of the certificate
not_after_dtExpiration date and time of the certificate
not_before_dtStart date and time when the certificate becomes valid
stateState of the certificate

6.1.18.2 - 1.3

scp-cli loadbalancer loadbalancer-certificate list

Description

get Load Balancer certificate list

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Responses

NameDescriptionExample
idID of the certificate
cert_kindKind of certificate
cnCommon Name of certificate
created_atCreated At
created_byCreated By
modified_atModified At
modified_byModified By
nameName of the certificate
not_after_dtExpiration date and time of the certificate
not_before_dtStart date and time when the certificate becomes valid
stateState of the certificate

6.1.19 - ListLoadbalancers

6.1.19.1 - 1.4

scp-cli loadbalancer loadbalancer list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--state <value>]
[--service_ip <value>]
[--subnet_id <value>]
[--layer_type <value>]
[--vpc_id <value>]

Description

get Load Balancer list

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringThe name of the load balancer.-
state
optional
****The state of the load balancer.-
service_ip
optional
stringThe service IP of the load balancer.-
subnet_id
optional
stringSubnet ID-
layer_type
optional
****Layer type-
vpc_id
optional
stringVPC ID-

Responses

NameDescriptionExample
idID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
firewall_idFirewall ID
layer_typeLayer type
listener_countThe number of listeners.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the load balancer.
public_nat_enabledPublic NAT Enabled Status
service_ipThe service IP of the load balancer.
source_nat_ipSource NAT IP
stateThe state of the load balancer.
subnet_idSubnet ID
vpc_idVPC ID
zonesAvailability Zones

6.1.19.2 - 1.3

scp-cli loadbalancer loadbalancer list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--state <value>]
[--service_ip <value>]
[--subnet_id <value>]
[--layer_type <value>]
[--vpc_id <value>]

Description

get Load Balancer list

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringThe name of the load balancer.-
state
optional
****The state of the load balancer.-
service_ip
optional
stringThe service IP of the load balancer.-
subnet_id
optional
stringSubnet ID-
layer_type
optional
****Layer type-
vpc_id
optional
stringVPC ID-

Responses

NameDescriptionExample
idID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
firewall_idFirewall ID
layer_typeLayer type
listener_countThe number of listeners.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the load balancer.
public_nat_enabledPublic NAT Enabled Status
service_ipThe service IP of the load balancer.
source_nat_ipSource NAT IP
stateThe state of the load balancer.
subnet_idSubnet ID
vpc_idVPC ID

6.1.20 - RemoveLbServerGroupMember

6.1.20.1 - 1.4

scp-cli loadbalancer lb-server-group-member remove
--member_id <value>
--lb_server_group_id <value>

Description

Remove Lb Server Group Member

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
member_id
required
stringID of Member-
lb_server_group_id
required
stringID of Lb Server Group-

6.1.20.2 - 1.3

scp-cli loadbalancer lb-server-group-member remove
--member_id <value>
--lb_server_group_id <value>

Description

Remove Lb Server Group Member

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
member_id
required
stringID of Member-
lb_server_group_id
required
stringID of Lb Server Group-

6.1.21 - RemoveLbServerGroupMembers

6.1.21.1 - 1.4

scp-cli loadbalancer lb-server-group-members remove
--lb_server_group_id <value>
--member_id_list <value>

Description

Remove Lb Server Group Members

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringID of Lb Server Group-
member_id_list
required
arrayID list of Member-

6.1.21.2 - 1.3

scp-cli loadbalancer lb-server-group-members remove
--lb_server_group_id <value>
--member_id_list <value>

Description

Remove Lb Server Group Members

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringID of Lb Server Group-
member_id_list
required
arrayID list of Member-

6.1.22 - SetLBHealthCheck

6.1.22.1 - 1.4

scp-cli loadbalancer lb-health-check update
--lb_health_check_id <value>
[--description <value>]
[--health_check_count <value>]
[--health_check_interval <value>]
[--health_check_port <value>]
[--health_check_timeout <value>]
[--health_check_url <value>]
[--http_method <value>]
[--protocol <value>]
[--request_data <value>]
[--response_code <value>]

Description

Set LB Health Check

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
lb_health_check_id
required
stringLB Health Check IDe3cd678b11784734bc366148aa37580e
description
optional
stringDescriptionthis is an lb server group
health_check_count
optional
integerLB Health Check count3
health_check_interval
optional
integerLB Health Check interval5
health_check_port
optional
integerLB Health Check port80
health_check_timeout
optional
integerLB Health Check timeout5
health_check_url
optional
stringLB Health Check URL/test
http_method
optional
****LB Health Check HTTP MethodGET
protocol
optional
****LB Health Check ProtocolTCP
request_data
optional
stringLB Health Check Request datausername=admin&password=1234
response_code
optional
stringLB Health Check Response code200

6.1.22.2 - 1.3

scp-cli loadbalancer lb-health-check update
--lb_health_check_id <value>
[--description <value>]
[--health_check_count <value>]
[--health_check_interval <value>]
[--health_check_port <value>]
[--health_check_timeout <value>]
[--health_check_url <value>]
[--http_method <value>]
[--protocol <value>]
[--request_data <value>]
[--response_code <value>]

Description

Set LB Health Check

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
lb_health_check_id
required
stringLB Health Check IDe3cd678b11784734bc366148aa37580e
description
optional
stringDescriptionthis is an lb server group
health_check_count
optional
integerLB Health Check count3
health_check_interval
optional
integerLB Health Check interval5
health_check_port
optional
integerLB Health Check port80
health_check_timeout
optional
integerLB Health Check timeout5
health_check_url
optional
stringLB Health Check URL/test
http_method
optional
****LB Health Check HTTP MethodGET
protocol
optional
****LB Health Check ProtocolTCP
request_data
optional
stringLB Health Check Request datausername=admin&password=1234
response_code
optional
stringLB Health Check Response code200

6.1.23 - SetLbListener

6.1.23.1 - 1.3

scp-cli loadbalancer lb-listener update
--listener_id <value>
[--condition_type <value>]
[--description <value>]
[--hsts_max_age <value>]
[--idle_timeout <value>]
[--insert_client_ip <value>]
[--persistence <value>]
[--response_timeout <value>]
[--server_group_id <value>]
[--session_duration_time <value>]
[--sni_certificate <value>]
[--support_http2 <value>]
[--url_handler <value>]
[--url_redirection <value>]
[--x_forwarded_for <value>]
[--x_forwarded_port <value>]
[--x_forwarded_proto <value>]
[--port <value>]
[--protocol <value>]
[--response_code <value>]
[--client_cert_id <value>]
[--client_cert_level <value>]
[--server_cert_level <value>]

Description

set loadbalancer listener

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
listener_id
required
stringThe ID of the listener.-
condition_type
optional
****The condition type of the listener.-
description
optional
stringdescription-
hsts_max_age
optional
integerThe hsts max_age of the listener.-
idle_timeout
optional
integerThe idle timeout(L7) of the listener.-
insert_client_ip
optional
booleanWhether the client IP should be inserted.-
persistence
optional
stringThe persistence of the listener.-
response_timeout
optional
integerThe response timeout of the listener.-
server_group_id
optional
stringThe ID of the server group.-
session_duration_time
optional
integerThe session duration time.-
sni_certificate
optional
arrayThe sni certificate of the listener.'{"domain_name": "", "sni_cert_id": ""}'
support_http2
optional
booleanWhether the HTTP 2.0 is supported-
url_handler
optional
arrayThe URL handler of the listener.-
url_redirection
optional
stringThe URL redirect of the listener.-
x_forwarded_for
optional
booleanWhether the X-Forwarded-For should be inserted.-
x_forwarded_port
optional
booleanWhether the X-Forwarded-Port should be inserted.-
x_forwarded_proto
optional
booleanWhether the X-Forwarded-Protocol should be inserted.-
port
optional
stringport-
protocol
optional
stringprotocol-
response_code
optional
stringresponse_code-
client_cert_id
optional
stringCertificate id for client ssl-
client_cert_level
optional
stringCertificate level for client ssl-
server_cert_level
optional
stringCertificate level for server ssl-

6.1.24 - SetLbListenerCertificate

6.1.24.1 - 1.4

scp-cli loadbalancer lb-listener-certificate update
--listener_id <value>
[--sni_certificate <value>]
[--client_cert_id <value>]
[--client_cert_level <value>]
[--server_cert_level <value>]

Description

set loadbalancer listener certificate

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
listener_id
required
stringThe ID of the listener.-
sni_certificate
optional
arrayThe sni certificate of the listener.'{"domain_name": "", "sni_cert_id": ""}'
client_cert_id
optional
stringCertificate id for client ssl-
client_cert_level
optional
stringCertificate level for client ssl-
server_cert_level
optional
stringCertificate level for server ssl-

6.1.25 - SetLbListenerResource

6.1.25.1 - 1.4

scp-cli loadbalancer lb-listener-resource update
--listener_id <value>
[--description <value>]
[--idle_timeout <value>]
[--insert_client_ip <value>]
[--persistence <value>]
[--response_timeout <value>]
[--session_duration_time <value>]
[--support_http2 <value>]
[--x_forwarded_for <value>]
[--x_forwarded_port <value>]
[--x_forwarded_proto <value>]
[--include_sub_domains <value>]
[--max_age <value>]

Description

set loadbalancer listener resource

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
listener_id
required
stringThe ID of the listener.-
description
optional
stringdescription-
idle_timeout
optional
integerThe idle timeout(L7) of the listener.-
insert_client_ip
optional
booleanWhether the client IP should be inserted.-
persistence
optional
stringThe persistence of the listener.-
response_timeout
optional
integerThe response timeout of the listener.-
session_duration_time
optional
integerThe session duration time.-
support_http2
optional
booleanWhether the HTTP 2.0 is supported-
x_forwarded_for
optional
booleanWhether the X-Forwarded-For should be inserted.-
x_forwarded_port
optional
booleanWhether the X-Forwarded-Port should be inserted.-
x_forwarded_proto
optional
booleanWhether the X-Forwarded-Protocol should be inserted.-
include_sub_domains
optional
booleanThe hsts include_sub_domains of the listener.-
max_age
optional
integerThe hsts max_age of the listener.-

6.1.26 - SetLbListenerRule

6.1.26.1 - 1.4

scp-cli loadbalancer lb-listener-rule update
--listener_id <value>
[--condition_type <value>]
[--server_group_id <value>]
[--url_handler <value>]
[--url_redirection <value>]
[--port <value>]
[--protocol <value>]
[--response_code <value>]

Description

set loadbalancer listener rule

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
listener_id
required
stringThe ID of the listener.-
condition_type
optional
****The condition type of the listener.-
server_group_id
optional
stringThe ID of the server group.-
url_handler
optional
arrayThe URL handler of the listener.'{"seq": "", "server_group_id": "", "url_pattern": ""}'
url_redirection
optional
stringThe URL redirect of the listener.-
port
optional
stringport-
protocol
optional
stringprotocol-
response_code
optional
stringresponse_code-

6.1.27 - SetLBServerGroup

6.1.27.1 - 1.4

scp-cli loadbalancer lb-server-group update
--lb_server_group_id <value>
[--description <value>]
[--lb_health_check_id <value>]
[--lb_method <value>]

Description

Set LB Server Group

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringLB Server Group ID3d8d8754d0d54683a29f3dcc3dd95d5b
description
optional
stringDescriptionthis is an lb server group
lb_health_check_id
optional
stringLB Health Check ID46c681018e33453085ca7c8db54e0076
lb_method
optional
****LB MethodROUND_ROBIN

6.1.27.2 - 1.3

scp-cli loadbalancer lb-server-group update
--lb_server_group_id <value>
[--description <value>]
[--lb_health_check_id <value>]
[--lb_method <value>]

Description

Set LB Server Group

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringLB Server Group ID3d8d8754d0d54683a29f3dcc3dd95d5b
description
optional
stringDescriptionthis is an lb server group
lb_health_check_id
optional
stringLB Health Check ID46c681018e33453085ca7c8db54e0076
lb_method
optional
****LB MethodROUND_ROBIN

6.1.28 - SetLbServerGroupMember

6.1.28.1 - 1.4

scp-cli loadbalancer lb-server-group-member set
--member_id <value>
--lb_server_group_id <value>
[--member_port <value>]
[--member_state <value>]
[--member_weight <value>]

Description

Set Lb Server Group Member

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
member_id
required
stringID of Member-
lb_server_group_id
required
stringID of Lb Server Group-
member_port
optional
integerProtocol port of Member80
member_state
optional
****Member State of Member-
member_weight
optional
integerWeight of Member100

6.1.28.2 - 1.3

scp-cli loadbalancer lb-server-group-member set
--member_id <value>
--lb_server_group_id <value>
[--member_port <value>]
[--member_state <value>]
[--member_weight <value>]

Description

Set Lb Server Group Member

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
member_id
required
stringID of Member-
lb_server_group_id
required
stringID of Lb Server Group-
member_port
optional
integerProtocol port of Member80
member_state
optional
****Member State of Member-
member_weight
optional
integerWeight of Member100

6.1.29 - SetLoadbalancer

6.1.29.1 - 1.4

scp-cli loadbalancer loadbalancer update
--loadbalancer_id <value>
--description <value>

Description

Set Load Balancer

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-
description
required
stringdescription-

6.1.29.2 - 1.3

scp-cli loadbalancer loadbalancer update
--loadbalancer_id <value>
--description <value>

Description

Set Load Balancer

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-
description
required
stringdescription-

6.1.30 - ShowLBHealthCheck

6.1.30.1 - 1.4

scp-cli loadbalancer lb-health-check read
--lb_health_check_id <value>

Description

Get LB Health Check

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
lb_health_check_id
required
stringLB Health Check IDe3cd678b11784734bc366148aa37580e

Responses

NameDescriptionExample
idLB Health Check ID46c681018e33453085ca7c8db54e0076
account_idAccount IDe3cd678b11784734bc366148aa37580e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionthis is an lb server group
health_check_countLB Health Check count3
health_check_intervalLB Health Check interval5
health_check_portLB Health Check port80
health_check_timeoutLB Health Check timeout5
health_check_typeLB Health Check typeDEFAULT
health_check_urlLB Health Check URL/test
http_methodLB Health Check HTTP MethodGET
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLB Health Check nameTest-LbMonitor-01
protocolLB Health Check ProtocolTCP
request_dataLB Health Check Request datausername=admin&password=1234
response_codeLB Health Check Response code200
stateLB Health Check stateACTIVE
subnet_idService Subnet ID60fba45cb6c811efba41ba92e4fe7200
vpc_idVPC ID8acceeb6920c4fc494490d864f67f0b5

6.1.30.2 - 1.3

scp-cli loadbalancer lb-health-check read
--lb_health_check_id <value>

Description

Get LB Health Check

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
lb_health_check_id
required
stringLB Health Check IDe3cd678b11784734bc366148aa37580e

Responses

NameDescriptionExample
idLB Health Check ID46c681018e33453085ca7c8db54e0076
account_idAccount IDe3cd678b11784734bc366148aa37580e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionthis is an lb server group
health_check_countLB Health Check count3
health_check_intervalLB Health Check interval5
health_check_portLB Health Check port80
health_check_timeoutLB Health Check timeout5
health_check_typeLB Health Check typeDEFAULT
health_check_urlLB Health Check URL/test
http_methodLB Health Check HTTP MethodGET
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLB Health Check nameTest-LbMonitor-01
protocolLB Health Check ProtocolTCP
request_dataLB Health Check Request datausername=admin&password=1234
response_codeLB Health Check Response code200
stateLB Health Check stateACTIVE
subnet_idService Subnet ID60fba45cb6c811efba41ba92e4fe7200
vpc_idVPC ID8acceeb6920c4fc494490d864f67f0b5

6.1.31 - ShowLbListener

6.1.31.1 - 1.4

scp-cli loadbalancer lb-listener show
--listener_id <value>

Description

show LB listener

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
listener_id
required
stringThe ID of the listener.-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
condition_typeThe condition type of the listener.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescription
hsts_configThe hsts response header of the listener.
https_redirectionThe https redirection of the listener.
idle_timeoutThe idle timeout(L7) of the listener.
insert_client_ipWhether the client IP should be inserted.
loadbalancer_idThe ID of the load balancer.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the listener.
persistenceThe persistence of the listener.
protocolThe protocol of the listener.
response_timeoutThe response timeout of the listener.
routing_actionThe routing action of the listener.
server_group_idThe ID of the server group.
server_group_nameThe Name of the server group.
service_portThe port of the listener.
session_duration_timeThe session duration time.
sni_certificateThe sni certificate of the listener.
ssl_certificateThe ssl certificate of the listener.
stateThe State of the listener.
support_http2Whether the HTTP 2.0 is supported
tagsTag List
url_handlerURL handler list
url_redirectionThe URL redirect of the listener.
x_forwarded_forWhether the X-Forwarded-For should be inserted.
x_forwarded_portWhether the X-Forwarded-Port should be inserted.
x_forwarded_protoWhether the X-Forwarded-Protocol should be inserted.

6.1.31.2 - 1.3

scp-cli loadbalancer lb-listener show
--listener_id <value>

Description

show LB listener

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
listener_id
required
stringThe ID of the listener.-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
condition_typeThe condition type of the listener.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescription
hsts_max_ageThe hsts max_age of the listener.
https_redirectionThe https redirection of the listener.
idle_timeoutThe idle timeout(L7) of the listener.
insert_client_ipWhether the client IP should be inserted.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the listener.
persistenceThe persistence of the listener.
protocolThe protocol of the listener.
response_timeoutThe response timeout of the listener.
routing_actionThe routing action of the listener.
server_group_idThe ID of the server group.
server_group_nameThe Name of the server group.
service_portThe port of the listener.
session_duration_timeThe session duration time.
sni_certificateThe sni certificate of the listener.
ssl_certificateThe ssl certificate of the listener.
stateThe State of the listener.
support_http2Whether the HTTP 2.0 is supported
url_handlerThe URL handler of the listener.
url_redirectionThe URL redirect of the listener.
x_forwarded_forWhether the X-Forwarded-For should be inserted.
x_forwarded_portWhether the X-Forwarded-Port should be inserted.
x_forwarded_protoWhether the X-Forwarded-Protocol should be inserted.

6.1.32 - ShowLBServerGroup

6.1.32.1 - 1.4

scp-cli loadbalancer lb-server-group read
--lb_server_group_id <value>

Description

Show LB Server Group

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringLB Server Group ID3d8d8754d0d54683a29f3dcc3dd95d5b

Responses

NameDescriptionExample
idLB Server Group ID3d8d8754d0d54683a29f3dcc3dd95d5b
account_idAccount IDe3cd678b11784734bc366148aa37580e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionthis is an lb server group
lb_health_check_idLB Health Check ID46c681018e33453085ca7c8db54e0076
lb_methodLB MethodROUND_ROBIN
lb_nameLoad Balancer nameTest-LB-01
loadbalancer_idLoad Balancer ID82efa35c88834bc083020443e57faa10
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLB Server Group nameServerGroup01
protocolProtocolTCP
stateLB Server Group stateACTIVE
subnet_idService Subnet ID60fba45cb6c811efba41ba92e4fe7200
vpc_idVPC ID8acceeb6920c4fc494490d864f67f0b5

6.1.32.2 - 1.3

scp-cli loadbalancer lb-server-group read
--lb_server_group_id <value>

Description

Show LB Server Group

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringLB Server Group ID3d8d8754d0d54683a29f3dcc3dd95d5b

Responses

NameDescriptionExample
idLB Server Group ID3d8d8754d0d54683a29f3dcc3dd95d5b
account_idAccount IDe3cd678b11784734bc366148aa37580e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionthis is an lb server group
lb_health_check_idLB Health Check ID46c681018e33453085ca7c8db54e0076
lb_methodLB MethodROUND_ROBIN
lb_nameLoad Balancer nameTest-LB-01
loadbalancer_idLoad Balancer ID82efa35c88834bc083020443e57faa10
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameLB Server Group nameServerGroup01
protocolProtocolTCP
stateLB Server Group stateACTIVE
subnet_idService Subnet ID60fba45cb6c811efba41ba92e4fe7200
vpc_idVPC ID8acceeb6920c4fc494490d864f67f0b5

6.1.33 - ShowLbServerGroupMember

6.1.33.1 - 1.4

scp-cli loadbalancer lb-server-group-member show
--member_id <value>
--lb_server_group_id <value>

Description

Show Lb Server Group Member

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
member_id
required
stringID of Member-
lb_server_group_id
required
stringID of Lb Server Group-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
lb_server_group_idID of Lb Server Group
member_ipIP of Member
member_portProtocol port of Member
member_stateMember State of Member
member_weightWeight of Member
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of Member
object_idObject ID of Member
object_typeObject Type of Member
stateState of Member
subnet_idID of Subnet
uuidUUID of Member

6.1.33.2 - 1.3

scp-cli loadbalancer lb-server-group-member show
--member_id <value>
--lb_server_group_id <value>

Description

Show Lb Server Group Member

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
member_id
required
stringID of Member-
lb_server_group_id
required
stringID of Lb Server Group-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
lb_server_group_idID of Lb Server Group
member_ipIP of Member
member_portProtocol port of Member
member_stateMember State of Member
member_weightWeight of Member
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of Member
object_idObject ID of Member
object_typeObject Type of Member
stateState of Member
subnet_idID of Subnet
uuidUUID of Member

6.1.34 - ShowLoadbalancer

6.1.34.1 - 1.4

scp-cli loadbalancer loadbalancer show
--loadbalancer_id <value>

Description

show Load Balancer

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-

Responses

NameDescriptionExample
idID
account_idThe account ID of the load balancer.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescription
firewall_idFirewall ID
health_check_ipsHealth check IP
layer_typeLayer type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namename
public_nat_enabledPublic NAT Enabled Status
service_ipThe service IP of the load balancer.
source_nat_ipSource NAT IP
stateThe state of the load balancer.
subnet_idSubnet ID
vpc_idVPC ID
zonesAvailability Zones

6.1.34.2 - 1.3

scp-cli loadbalancer loadbalancer show
--loadbalancer_id <value>

Description

show Load Balancer

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-

Responses

NameDescriptionExample
idID
account_idThe account ID of the load balancer.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescription
firewall_idFirewall ID
health_check_ipHealth check IP
layer_typeLayer type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namename
public_nat_enabledPublic NAT Enabled Status
service_ipThe service IP of the load balancer.
source_nat_ipSource NAT IP
stateThe state of the load balancer.
subnet_idSubnet ID
vpc_idVPC ID

6.1.35 - ShowLoadbalancerCertificate

6.1.35.1 - 1.4

scp-cli loadbalancer loadbalancer-certificate show
--lb_certificate_id <value>

Description

show Load Balancer certificate

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
lb_certificate_id
required
stringThe ID of the certificate-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idThe project ID of the certificate
cert_bodyThe body of the certificate
cert_chainThe chain of the certificate
cert_kind
cn
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
name
not_after_dt
not_before_dt
organizationThe organization of the certificate
private_keyThe private key of the certificate
state

6.1.35.2 - 1.3

scp-cli loadbalancer loadbalancer-certificate show
--lb_certificate_id <value>

Description

show Load Balancer certificate

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
lb_certificate_id
required
stringThe ID of the certificate-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idThe project ID of the certificate
cert_bodyThe body of the certificate
cert_chainThe chain of the certificate
cert_kind
cn
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
name
not_after_dt
not_before_dt
organizationThe organization of the certificate
private_keyThe private key of the certificate
state

6.1.36 - ShowLoadbalancerPrivateNatIp

6.1.36.1 - 1.4

scp-cli loadbalancer loadbalancer-private-nat-ip show
--loadbalancer_id <value>

Description

Show Load Balancer Private NAT IP

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-

Responses

NameDescriptionExample
idID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
external_ip_addressexternal_ip_address
internal_ip_addressinternal_ip_address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
private_nat_ip_idprivate_nat_ip_id
statestate

6.1.36.2 - 1.3

scp-cli loadbalancer loadbalancer-private-nat-ip show
--loadbalancer_id <value>

Description

Show Load Balancer Private NAT IP

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-

Responses

NameDescriptionExample
idID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
external_ip_addressexternal_ip_address
internal_ip_addressinternal_ip_address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
private_nat_ip_idprivate_nat_ip_id
statestate

6.1.37 - ShowLoadbalancerPublicNatIp

6.1.37.1 - 1.4

scp-cli loadbalancer loadbalancer-public-nat-ip show
--loadbalancer_id <value>

Description

Show Load Balancer Public NAT IP

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-

Responses

NameDescriptionExample
external_ip_addressStatic Nat External Ip Address
publicip_idPublicip ID
stateStatic Nat State

6.1.37.2 - 1.3

scp-cli loadbalancer loadbalancer-public-nat-ip show
--loadbalancer_id <value>

Description

Show Load Balancer Public NAT IP

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261031

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-

Responses

NameDescriptionExample
external_ip_addressStatic Nat External Ip Address
publicip_idPublicip ID
stateStatic Nat State

7 - Security Group

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 Security Group service 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.1CURRENT-
1.0SUPPORTED20270131

CLI Version History

1.1

CLI version 1.1 release for Security Group

Changes

  • [Changed] security-group list security group rules - Command has been changed.
    • The following fields are added to the response.
      • remote_address_group_id, remote_address_group_name
  • [Changed] security-group create security group rule - Command has been changed.
    • The following field is added to the request.
      • remote_address_group_id
    • The following fields are added to the response.
      • remote_address_group_id, remote_address_group_name
  • [Changed] security-group show security group rule - Command has been changed.
    • The following fields are added to the response.
      • remote_address_group_id, remote_address_group_name
  • [New] security-group list address groups - Command has been added.
  • [New] security-group create address group - Command has been added.
  • [New] security-group show address group - Command has been added.
  • [New] security-group set address group - Command has been added.
  • [New] security-group delete address group - Command has been added.
  • [New] security-group list address group ips - Command has been added.
  • [New] security-group add address group ips - Command has been added.
  • [New] security-group remove address group ips - Command has been added.

1.0

Initial CLI release for Security Group

Changes

  • [New] security-group list security groups - Command has been added.
  • [New] security-group create security group - Command has been added.
  • [New] security-group show security group - Command has been added.
  • [New] security-group set security group - Command has been added.
  • [New] security-group delete security group - Command has been added.
  • [New] security-group list security group rules - Command has been added.
  • [New] security-group create security group rule - Command has been added.
  • [New] security-group show security group rule - Command has been added.
  • [New] security-group delete security group rule - Command has been added.

7.1 - CLIs

7.1.1 - Add Address Group IPs

7.1.1.1 - 1.1

scp-cli security-group address-group-cidr add
--address_group_id <value>
--addresses <value>

Description

Add IP addresses to address group.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
address_group_id
required
stringAddress Group ID4b18494930bf4c5dbb97a9eb2ef68fe1
addresses
required
arrayAddress Group IP Address List10.1.1.1/32

7.1.2 - Create Address Group

7.1.2.1 - 1.1

scp-cli security-group address-group create
--name <value>
[--addresses <value>]
[--description <value>]
[--tags <value>]

Description

Create Address Group.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
name
required
stringAddress Group NameExampleAG1
addresses
optional
arrayAddress Group IP Address10.1.1.1/32
description
optional
stringAddress Group DescriptionExample Description for Address Group
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idAddress Group ID4b18494930bf4c5dbb97a9eb2ef68fe1
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
address_countAddress Group Address Count10
address_limitAddress Group Address Limit1000
addressesAddress Group IP Address[‘10.1.1.1/32’, ‘10.1.2.0/24’, ‘10.1.3.0/24’]
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for Address Group
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameAddress Group NameExampleAG1
stateAddress Group StateACTIVE

7.1.3 - Create Security Group

7.1.3.1 - 1.1

scp-cli security-group security-group create
--name <value>
[--description <value>]
[--loggable <value>]
[--tags <value>]

Description

Create Security Group.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
name
required
stringSecurity Group NameExampleSG1
description
optional
stringSecurity Group DescriptionExample Description for Security Group
loggable
optional
booleanSecurity Group LoggableFalse
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idSecurity Group ID06e5d676-f330-485a-94e9-47ac91cce09a
account_idSecurity Group Account ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionSecurity Group DescriptionExample Description for Security Group
loggableSecurity Group LoggableFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSecurity Group NameExampleSG1
rule_countSecurity Group Rule Count200
stateSecurity Group StateACTIVE

7.1.3.2 - 1.0

scp-cli security-group security-group create
--name <value>
[--description <value>]
[--loggable <value>]
[--tags <value>]

Description

Create Security Group.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020270131

Parameters

NameTypeDescriptionExample
name
required
stringSecurity Group NameExampleSG1
description
optional
stringSecurity Group DescriptionExample Description for Security Group
loggable
optional
booleanSecurity Group LoggableFalse
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idSecurity Group ID06e5d676-f330-485a-94e9-47ac91cce09a
account_idSecurity Group Account ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionSecurity Group DescriptionExample Description for Security Group
loggableSecurity Group LoggableFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSecurity Group NameExampleSG1
rule_countSecurity Group Rule Count200
stateSecurity Group StateACTIVE

7.1.4 - Create Security Group Rule

7.1.4.1 - 1.1

scp-cli security-group security-group-rule create
--security_group_id <value>
--direction <value>
[--description <value>]
[--ethertype <value>]
[--port_range_max <value>]
[--port_range_min <value>]
[--protocol <value>]
[--remote_address_group_id <value>]
[--remote_group_id <value>]
[--remote_ip_prefix <value>]

Description

Create Security Group rule.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
security_group_id
required
stringSecurity Group ID06e5d676-f330-485a-94e9-47ac91cce09a
direction
required
stringSecurity Group Rule Direction (Ingress, Egress)Ingress
description
optional
stringSecurity Group Rule DescriptionExample Description for Security Group Rule
ethertype
optional
stringSecurity Group Rule Ethertype (IPV4)IPv4
port_range_max
optional
integerSecurity Group Rule Maximum Port Number(None/1-65535). For ICMP and IP Protocol, None22
port_range_min
optional
integerSecurity Group Rule Minimum Port Number(None, 1-65535). For ICMP, 0-255. For IP Protocol, None22
protocol
optional
stringSecurity Group Rule Protocol (None, TCP, UDP, ICMP, IP Protocol Number 1-254)TCP
remote_address_group_id
optional
stringSecurity Group Rule Address Group ID4b18494930bf4c5dbb97a9eb2ef68fe1
remote_group_id
optional
stringSecurity Group Rule Remote Group ID06e5d676-f330-485a-94e9-47ac91cce09a
remote_ip_prefix
optional
stringSecurity Group Rule Remote IP Address1.1.1.1/32

Responses

NameDescriptionExample
idSecurity Group Rule ID10d8250e-f4eb-453a-96af-b50b5b514a1a
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionSecurity Group Rule DescriptionExample Description for Security Group Rule
directionSecurity Group Rule Direction (Ingress, Egress)Ingress
ethertypeSecurity Group Rule Ethertype (IPV4)IPv4
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
port_range_maxSecurity Group Rule Maximum Port Number(None/1-65535). For ICMP and IP Protocol, None22
port_range_minSecurity Group Rule Minimum Port Number(None, 1-65535). For ICMP, 0-255. For IP Protocol, None22
protocolSecurity Group Rule Protocol (None, TCP, UDP, ICMP, IP Protocol Number 1-254)TCP
remote_address_group_idAddress Group ID4b18494930bf4c5dbb97a9eb2ef68fe1
remote_address_group_nameAddress Group NameExampleAG1
remote_group_idSecurity Group Rule Remote Group ID06e5d676-f330-485a-94e9-47ac91cce09a
remote_group_nameSecurity Group Rule Remote Group NameExampleSG2
remote_ip_prefixSecurity Group Rule Remote IP Address1.1.1.1/32
security_group_idSecurity Group ID06e5d676-f330-485a-94e9-47ac91cce09a

7.1.4.2 - 1.0

scp-cli security-group security-group-rule create
--security_group_id <value>
--direction <value>
[--description <value>]
[--ethertype <value>]
[--port_range_max <value>]
[--port_range_min <value>]
[--protocol <value>]
[--remote_group_id <value>]
[--remote_ip_prefix <value>]

Description

Create Security Group rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020270131

Parameters

NameTypeDescriptionExample
security_group_id
required
stringSecurity Group ID06e5d676-f330-485a-94e9-47ac91cce09a
direction
required
stringSecurity Group Rule Direction (Ingress, Egress)Ingress
description
optional
stringSecurity Group Rule DescriptionExample Description for Security Group Rule
ethertype
optional
stringSecurity Group Rule Ethertype (IPV4)IPv4
port_range_max
optional
integerSecurity Group Rule Maximum Port Number(None/1-65535). For ICMP and IP Protocol, None22
port_range_min
optional
integerSecurity Group Rule Minimum Port Number(None, 1-65535). For ICMP, 0-255. For IP Protocol, None22
protocol
optional
stringSecurity Group Rule Protocol (None, TCP, UDP, ICMP, IP Protocol Number 1-254)TCP
remote_group_id
optional
stringSecurity Group Rule Remote Group ID06e5d676-f330-485a-94e9-47ac91cce09a
remote_ip_prefix
optional
stringSecurity Group Rule Remote IP Address1.1.1.1/32

Responses

NameDescriptionExample
idSecurity Group Rule ID10d8250e-f4eb-453a-96af-b50b5b514a1a
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionSecurity Group Rule DescriptionExample Description for Security Group Rule
directionSecurity Group Rule Direction (Ingress, Egress)Ingress
ethertypeSecurity Group Rule Ethertype (IPV4)IPv4
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
port_range_maxSecurity Group Rule Maximum Port Number(None/1-65535). For ICMP and IP Protocol, None22
port_range_minSecurity Group Rule Minimum Port Number(None, 1-65535). For ICMP, 0-255. For IP Protocol, None22
protocolSecurity Group Rule Protocol (None, TCP, UDP, ICMP, IP Protocol Number 1-254)TCP
remote_group_idSecurity Group Rule Remote Group ID06e5d676-f330-485a-94e9-47ac91cce09a
remote_group_nameSecurity Group Rule Remote Group NameExampleSG2
remote_ip_prefixSecurity Group Rule Remote IP Address1.1.1.1/32
security_group_idSecurity Group ID06e5d676-f330-485a-94e9-47ac91cce09a

7.1.5 - Delete Address Group

7.1.5.1 - 1.1

scp-cli security-group address-group delete
--address_group_id <value>

Description

Delete Address Group.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
address_group_id
required
stringAddress Group ID4b18494930bf4c5dbb97a9eb2ef68fe1

7.1.6 - Delete Security Group

7.1.6.1 - 1.1

scp-cli security-group security-group delete
--security_group_id <value>

Description

Delete Security Group.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
security_group_id
required
stringSecurity Group ID-

7.1.6.2 - 1.0

scp-cli security-group security-group delete
--security_group_id <value>

Description

Delete Security Group.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020270131

Parameters

NameTypeDescriptionExample
security_group_id
required
stringSecurity Group ID-

7.1.7 - Delete Security Group Rule

7.1.7.1 - 1.1

scp-cli security-group security-group-rule delete
--security_group_rule_id <value>

Description

Delete Security Group rule.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
security_group_rule_id
required
stringSecurity Group Rule ID10d8250e-f4eb-453a-96af-b50b5b514a1a

7.1.7.2 - 1.0

scp-cli security-group security-group-rule delete
--security_group_rule_id <value>

Description

Delete Security Group rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020270131

Parameters

NameTypeDescriptionExample
security_group_rule_id
required
stringSecurity Group Rule ID10d8250e-f4eb-453a-96af-b50b5b514a1a

7.1.8 - List Address Group IPs

7.1.8.1 - 1.1

scp-cli security-group address-group-cidr list
--address_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--address <value>]

Description

Get Address Group IP list.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
address_group_id
required
stringAddress Group ID4b18494930bf4c5dbb97a9eb2ef68fe1
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
address
optional
stringAddress Group IP Address10.1.1.1/32

Responses

NameDescriptionExample
addressesAddress Group IP Address List[‘10.1.1.1/32’, ‘10.1.2.0/24’, ‘10.1.3.0/24’]
counttotal count20
linkslinks[{‘href’: ‘http://scp.samsungsdscloud.com/v1/notices’, ‘rel’: ‘self’}]

7.1.9 - List Address Groups

7.1.9.1 - 1.1

scp-cli security-group address-group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]

Description

Get Address Group list.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringAddress Group ID4b18494930bf4c5dbb97a9eb2ef68fe1
name
optional
stringAddress Group NameExampleAG1

Responses

NameDescriptionExample
idAddress Group ID4b18494930bf4c5dbb97a9eb2ef68fe1
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
address_countAddress Group Address Count10
address_limitAddress Group Address Limit1000
addressesAddress Group IP Address[‘10.1.1.1/32’, ‘10.1.2.0/24’, ‘10.1.3.0/24’]
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for Address Group
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameAddress Group NameExampleAG1
stateAddress Group StateACTIVE

7.1.10 - List Security Group Rules

7.1.10.1 - 1.1

scp-cli security-group security-group-rule list
--security_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--remote_ip_prefix <value>]
[--remote_group_id <value>]
[--description <value>]
[--direction <value>]
[--service <value>]

Description

Get Security Group rule list.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
security_group_id
required
stringSecurity Group ID06e5d676-f330-485a-94e9-47ac91cce09a
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringSecurity Group Rule ID10d8250e-f4eb-453a-96af-b50b5b514a1a
remote_ip_prefix
optional
stringSecurity Group Rule Remote IP Address1.1.1.1/32
remote_group_id
optional
stringSecurity Group Rule Remote Group ID06e5d676-f330-485a-94e9-47ac91cce09a
description
optional
stringSecurity Group Rule DescriptionExample Description for Security Group Rule
direction
optional
stringSecurity Group Rule Direction (Ingress, Egress)Ingress
service
optional
stringSecurity Group Rule ServiceTCP 22

Responses

NameDescriptionExample
idSecurity Group Rule ID10d8250e-f4eb-453a-96af-b50b5b514a1a
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionSecurity Group Rule DescriptionExample Description for Security Group Rule
directionSecurity Group Rule Direction (Ingress, Egress)Ingress
ethertypeSecurity Group Rule Ethertype (IPV4)IPv4
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
port_range_maxSecurity Group Rule Maximum Port Number(None/1-65535). For ICMP and IP Protocol, None22
port_range_minSecurity Group Rule Minimum Port Number(None, 1-65535). For ICMP, 0-255. For IP Protocol, None22
protocolSecurity Group Rule Protocol (None, TCP, UDP, ICMP, IP Protocol Number 1-254)TCP
remote_address_group_idAddress Group ID4b18494930bf4c5dbb97a9eb2ef68fe1
remote_address_group_nameAddress Group NameExampleAG1
remote_group_idSecurity Group Rule Remote Group ID06e5d676-f330-485a-94e9-47ac91cce09a
remote_group_nameSecurity Group Rule Remote Group NameExampleSG2
remote_ip_prefixSecurity Group Rule Remote IP Address1.1.1.1/32
security_group_idSecurity Group ID06e5d676-f330-485a-94e9-47ac91cce09a

7.1.10.2 - 1.0

scp-cli security-group security-group-rule list
--security_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--remote_ip_prefix <value>]
[--remote_group_id <value>]
[--description <value>]
[--direction <value>]
[--service <value>]

Description

Get Security Group rule list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020270131

Parameters

NameTypeDescriptionExample
security_group_id
required
stringSecurity Group ID06e5d676-f330-485a-94e9-47ac91cce09a
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringSecurity Group Rule ID10d8250e-f4eb-453a-96af-b50b5b514a1a
remote_ip_prefix
optional
stringSecurity Group Rule Remote IP Address1.1.1.1/32
remote_group_id
optional
stringSecurity Group Rule Remote Group ID06e5d676-f330-485a-94e9-47ac91cce09a
description
optional
stringSecurity Group Rule DescriptionExample Description for Security Group Rule
direction
optional
stringSecurity Group Rule Direction (Ingress, Egress)Ingress
service
optional
stringSecurity Group Rule ServiceTCP 22

Responses

NameDescriptionExample
idSecurity Group Rule ID10d8250e-f4eb-453a-96af-b50b5b514a1a
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionSecurity Group Rule DescriptionExample Description for Security Group Rule
directionSecurity Group Rule Direction (Ingress, Egress)Ingress
ethertypeSecurity Group Rule Ethertype (IPV4)IPv4
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
port_range_maxSecurity Group Rule Maximum Port Number(None/1-65535). For ICMP and IP Protocol, None22
port_range_minSecurity Group Rule Minimum Port Number(None, 1-65535). For ICMP, 0-255. For IP Protocol, None22
protocolSecurity Group Rule Protocol (None, TCP, UDP, ICMP, IP Protocol Number 1-254)TCP
remote_group_idSecurity Group Rule Remote Group ID06e5d676-f330-485a-94e9-47ac91cce09a
remote_group_nameSecurity Group Rule Remote Group NameExampleSG2
remote_ip_prefixSecurity Group Rule Remote IP Address1.1.1.1/32
security_group_idSecurity Group ID06e5d676-f330-485a-94e9-47ac91cce09a

7.1.11 - List Security Groups

7.1.11.1 - 1.1

scp-cli security-group security-group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]

Description

Get Security Group list.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringSecurity Group ID-
name
optional
stringSecurity Group Name-

Responses

NameDescriptionExample
idSecurity Group ID06e5d676-f330-485a-94e9-47ac91cce09a
account_idSecurity Group Account ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionSecurity Group DescriptionExample Description for Security Group
loggableSecurity Group LoggableFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSecurity Group NameExampleSG1
rule_countSecurity Group Rule Count200
stateSecurity Group StateACTIVE

7.1.11.2 - 1.0

scp-cli security-group security-group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]

Description

Get Security Group list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020270131

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringSecurity Group ID-
name
optional
stringSecurity Group Name-

Responses

NameDescriptionExample
idSecurity Group ID06e5d676-f330-485a-94e9-47ac91cce09a
account_idSecurity Group Account ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionSecurity Group DescriptionExample Description for Security Group
loggableSecurity Group LoggableFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSecurity Group NameExampleSG1
rule_countSecurity Group Rule Count200
stateSecurity Group StateACTIVE

7.1.12 - Remove Address Group IPs

7.1.12.1 - 1.1

scp-cli security-group address-group-cidr remove
--address_group_id <value>
--addresses <value>

Description

Remove IP addresses to address group.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
address_group_id
required
stringAddress Group ID4b18494930bf4c5dbb97a9eb2ef68fe1
addresses
required
arrayAddress Group IP Address List10.1.1.1/32

7.1.13 - Set Address Group

7.1.13.1 - 1.1

scp-cli security-group address-group set
--address_group_id <value>
[--description <value>]

Description

Set Address Group.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
address_group_id
required
stringAddress Group ID4b18494930bf4c5dbb97a9eb2ef68fe1
description
optional
stringAddress Group DescriptionExample Description for Address Group

7.1.14 - Set Security Group

7.1.14.1 - 1.1

scp-cli security-group security-group set
--security_group_id <value>
[--description <value>]
[--loggable <value>]

Description

Set Security Group.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
security_group_id
required
stringSecurity Group ID-
description
optional
stringSecurity Group DescriptionExample Description for Security Group
loggable
optional
booleanSecurity Group LoggableFalse

7.1.14.2 - 1.0

scp-cli security-group security-group set
--security_group_id <value>
[--description <value>]
[--loggable <value>]

Description

Set Security Group.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020270131

Parameters

NameTypeDescriptionExample
security_group_id
required
stringSecurity Group ID-
description
optional
stringSecurity Group DescriptionExample Description for Security Group
loggable
optional
booleanSecurity Group LoggableFalse

7.1.15 - Show Address Group

7.1.15.1 - 1.1

scp-cli security-group address-group show
--address_group_id <value>

Description

Show Address Group.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
address_group_id
required
stringAddress Group ID4b18494930bf4c5dbb97a9eb2ef68fe1

Responses

NameDescriptionExample
idAddress Group ID4b18494930bf4c5dbb97a9eb2ef68fe1
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
address_countAddress Group Address Count10
address_limitAddress Group Address Limit1000
addressesAddress Group IP Address[‘10.1.1.1/32’, ‘10.1.2.0/24’, ‘10.1.3.0/24’]
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for Address Group
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameAddress Group NameExampleAG1
stateAddress Group StateACTIVE

7.1.16 - Show Security Group

7.1.16.1 - 1.1

scp-cli security-group security-group show
--security_group_id <value>

Description

Show Security Group.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
security_group_id
required
stringSecurity Group ID-

Responses

NameDescriptionExample
idSecurity Group ID06e5d676-f330-485a-94e9-47ac91cce09a
account_idSecurity Group Account ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionSecurity Group DescriptionExample Description for Security Group
loggableSecurity Group LoggableFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSecurity Group NameExampleSG1
rule_countSecurity Group Rule Count200
stateSecurity Group StateACTIVE

7.1.16.2 - 1.0

scp-cli security-group security-group show
--security_group_id <value>

Description

Show Security Group.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020270131

Parameters

NameTypeDescriptionExample
security_group_id
required
stringSecurity Group ID-

Responses

NameDescriptionExample
idSecurity Group ID06e5d676-f330-485a-94e9-47ac91cce09a
account_idSecurity Group Account ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionSecurity Group DescriptionExample Description for Security Group
loggableSecurity Group LoggableFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSecurity Group NameExampleSG1
rule_countSecurity Group Rule Count200
stateSecurity Group StateACTIVE

7.1.17 - Show Security Group Rule

7.1.17.1 - 1.1

scp-cli security-group security-group-rule show
--security_group_rule_id <value>
[--fields <value>]

Description

Show Security Group rule.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
security_group_rule_id
required
stringSecurity Group Rule ID10d8250e-f4eb-453a-96af-b50b5b514a1a
fields
optional
arrayField Name-

Responses

NameDescriptionExample
idSecurity Group Rule ID10d8250e-f4eb-453a-96af-b50b5b514a1a
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionSecurity Group Rule DescriptionExample Description for Security Group Rule
directionSecurity Group Rule Direction (Ingress, Egress)Ingress
ethertypeSecurity Group Rule Ethertype (IPV4)IPv4
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
port_range_maxSecurity Group Rule Maximum Port Number(None/1-65535). For ICMP and IP Protocol, None22
port_range_minSecurity Group Rule Minimum Port Number(None, 1-65535). For ICMP, 0-255. For IP Protocol, None22
protocolSecurity Group Rule Protocol (None, TCP, UDP, ICMP, IP Protocol Number 1-254)TCP
remote_address_group_idAddress Group ID4b18494930bf4c5dbb97a9eb2ef68fe1
remote_address_group_nameAddress Group NameExampleAG1
remote_group_idSecurity Group Rule Remote Group ID06e5d676-f330-485a-94e9-47ac91cce09a
remote_group_nameSecurity Group Rule Remote Group NameExampleSG2
remote_ip_prefixSecurity Group Rule Remote IP Address1.1.1.1/32
security_group_idSecurity Group ID06e5d676-f330-485a-94e9-47ac91cce09a

7.1.17.2 - 1.0

scp-cli security-group security-group-rule show
--security_group_rule_id <value>
[--fields <value>]

Description

Show Security Group rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020270131

Parameters

NameTypeDescriptionExample
security_group_rule_id
required
stringSecurity Group Rule ID10d8250e-f4eb-453a-96af-b50b5b514a1a
fields
optional
arrayField Name-

Responses

NameDescriptionExample
idSecurity Group Rule ID10d8250e-f4eb-453a-96af-b50b5b514a1a
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionSecurity Group Rule DescriptionExample Description for Security Group Rule
directionSecurity Group Rule Direction (Ingress, Egress)Ingress
ethertypeSecurity Group Rule Ethertype (IPV4)IPv4
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
port_range_maxSecurity Group Rule Maximum Port Number(None/1-65535). For ICMP and IP Protocol, None22
port_range_minSecurity Group Rule Minimum Port Number(None, 1-65535). For ICMP, 0-255. For IP Protocol, None22
protocolSecurity Group Rule Protocol (None, TCP, UDP, ICMP, IP Protocol Number 1-254)TCP
remote_group_idSecurity Group Rule Remote Group ID06e5d676-f330-485a-94e9-47ac91cce09a
remote_group_nameSecurity Group Rule Remote Group NameExampleSG2
remote_ip_prefixSecurity Group Rule Remote IP Address1.1.1.1/32
security_group_idSecurity Group ID06e5d676-f330-485a-94e9-47ac91cce09a

8 - VPC

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 VPC service 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.3CURRENT-
1.2SUPPORTED20270131
1.1SUPPORTED20261130
1.0DEPRECATED20251231

CLI Version History

1.3

Multi AZ feature has been added.

Changes

  • [Updated] vpc vpc create - The following field has been added to the response.
    • Added : zones, zone_type
  • [Updated] vpc vpc list - The following field has been added to the parameters and response.
    • Added : zone, zones, zone_type
  • [Updated] vpc vpc show - The following field has been added to the response.
    • Added : zones, zone_type
  • [Updated] vpc vpc set - When responding, everything except the description field will be removed.
  • [Updated] vpc vpc cidr create - When responding, everything except the cidr field will be removed.
  • [Updated] vpc subnet create - The following field has been changed to the parameters and response.
    • Added : zones, role, primary_subnet_id, secondary_subnet_ids
    • Changed : The boundary value of type has been changed and added (General → Public changed, Private newly added).
  • [Updated] vpc subnet list - The following field has been changed to the parameters and response.
    • Added : zones, role, primary_subnet_id
    • Changed : The boundary value of type has been changed and added (General → Public changed, Private newly added).
  • [Updated] vpc subnet show - The following field has been changed to the response.
    • Added : zones, role, primary_subnet_id, secondary_subnet_ids
    • Changed : The boundary value of type has been changed and added (General → Public changed, Private newly added).
  • [Updated] vpc subnet set - When responding, everything except the description and dhcp_ip_address fields will be removed.
  • [Updated] vpc internet-gateway create - The following field has been added to the response.
    • Added : multi_zone_enabled
  • [Updated] vpc internet-gateway list - The following field has been added to the response.
    • Added : multi_zone_enabled
  • [Updated] vpc internet-gateway show - The following field has been added to the response.
    • Added : multi_zone_enabled
  • [Updated] vpc internet-gateway set - When responding, everything except the description and loggable fields will be removed.
  • [Updated] vpc nat-gateway create - The following field has been changed to the parameters and response.
    • Added : publicip_ids, multi_zone_enabled, nat_gateway_ip_addresses
    • Removed : publicip_id, nat_gateway_ip_address
  • [Updated] vpc nat-gateway list - The following field has been changed to the response.
    • Added : multi_zone_enabled, nat_gateway_ip_addresses
    • Removed : nat_gateway_ip_address
  • [Updated] vpc nat-gateway show - The following field has been changed to the response.
    • Added : multi_zone_enabled, nat_gateway_ip_addresses
    • Removed : nat_gateway_ip_address
  • [Updated] vpc nat-gateway set - When responding, everything except the description field will be removed.
  • [Updated] vpc public-ip create - The following field has been added to the parameters and response.
    • Added : zone
  • [Updated] vpc public-ip list - The following field has been added to the parameters and response.
    • Added : zone
  • [Updated] vpc public-ip show - The following field has been added to the response.
    • Added : zone
  • [Updated] vpc public-ip set - When responding, everything except the description field will be removed.
  • [Updated] vpc transit-gateway list - The following field has been added to the parameters.
    • Added : uplink_zone_state
  • [Updated] vpc transit-gateway create - The following field has been added to the response.
    • Added : uplink_active_zone, uplink_standby_zone, uplink_zone_state
  • [Updated] vpc transit-gateway show - The following field has been added to the response.
    • Added : uplink_active_zone, uplink_standby_zone, uplink_zone_state
  • [Updated] vpc transit-gateway set - When responding, everything except the description field will be removed.
  • [Updated] vpc transit-gateway-firewall-connection create - When responding, everything except the firewall_connection_state field will be removed.
  • [Updated] vpc transit-gateway-firewall-connection delete - When responding, everything except the firewall_connection_state field will be removed.
  • [Updated] vpc transit-gateway-firewall create - The following field has been added to the parameters and response.
    • Added : uplink_active_zone, uplink_standby_zone, uplink_zone_state
  • [Updated] vpc transit-gateway-firewall delete - The following field has been added to the response.
    • Added : uplink_active_zone, uplink_standby_zone, uplink_zone_state

1.2

Virtual IP functionality and Transit Gateway Firewall connection capability have been added.

Changes

  • [New] vpc subnet_vip list - Command has been added.
  • [New] vpc subnet_vip create - Command has been added.
  • [New] vpc subnet_vip delete - Command has been added.
  • [New] vpc subnet_vip show - Command has been added.
  • [New] vpc subnet_vip set - Command has been added.
  • [New] vpc subnet_vip_port create - Command has been added.
  • [New] vpc subnet_vip_port delete - Command has been added.
  • [New] vpc subnet_vip_nat create - Command has been added.
  • [New] vpc subnet_vip_nat delete - Command has been added.
  • [New] vpc transit-gateway-firewall-connection delete - Command has been added.
  • [New] vpc transit-gateway-firewall-connection create - Command has been added.
  • [New] vpc transit-gateway-firewall create - Command has been added.
  • [New] vpc transit-gateway-firewall delete - Command has been added.
  • [New] vpc vpc cidr create - Command has been added.
  • [Updated] vpc vpc list - The following field has been changed to the parameters and response.
    • Added : size, page, cidr_count, cidrs
    • Removed : limit, marker, cidr
  • [Updated] vpc vpc show - The following field has been changed to the response.
    • Added : cidr_count, cidrs
    • Removed : cidr
  • [Updated] vpc vpc create - The following field has been changed to the response.
    • Added : cidr_count, cidrs
    • Removed : cidr
  • [Updated] vpc vpc set - The following field has been changed to the response.
    • Added : cidr_count, cidrs
    • Removed : cidr
  • [Updated] vpc subnet list - The following field has been changed to the parameters and response.
    • Added : size, page
    • Removed : limit, marker
  • [Updated] vpc subnet show - The following field has been added to the response.
    • Added : dhcp_ip_addres
  • [Updated] vpc subnet create - The following field has been added to the parameters.
    • Added : gateway_ip_address
  • [Updated] vpc subnet set - The following field has been added to the parameters.
    • Added : dhcp_ip_address
  • [Updated] vpc port list - The following field has been added to the parameters.
    • Added : attached_resource_types
  • [Updated] vpc port show - The following field has been added to the response.
    • Added : virtual_ip_addresses
  • [Updated] vpc port create - The following field has been added to the response.
    • Added : virtual_ip_addresses
  • [Updated] vpc port set - The following field has been added to the response.
    • Added : virtual_ip_addresses
  • [Updated] vpc internet-gateway list - The following field has been changed to the parameters and response.
    • Added : size, page
    • Removed : limit, marker
  • [Updated] vpc nat-gateway list - The following field has been changed to the parameters and response.
    • Added : size, page
    • Removed : limit, marker
  • [Updated] vpc public-ip list - The following field has been changed to the parameters and response.
    • Added : size, page
    • Removed : limit, marker
  • [Updated] vpc public-ip show - The boundary values for the attached_resource_type field have been expanded.
  • [Updated] vpc vpc-endpoint list - The following field has been changed to the parameters and response.
    • Added : size, page
    • Removed : limit, marker
  • [Updated] vpc private-nat list - The following field has been added to the parameters and response. And the fields related to VPC and DCON have been removed.
    • Added : service_type, service_resource_id, service_resource_name
  • [Updated] vpc private-nat show - The following field has been added to the parameters and response. And the fields related to VPC and DCON have been removed.
    • Added : service_type, service_resource_id, service_resource_name
  • [Updated] vpc private-nat create - The following field has been added to the parameters and response. And the fields related to VPC and DCON have been removed.
    • Added : service_type, service_resource_id, service_resource_name
  • [Updated] vpc private-nat set - The following field has been added to the parameters and response. And the fields related to VPC and DCON have been removed.
    • Added : service_type, service_resource_id, service_resource_name
  • [Updated] vpc vpc-peering-routing-rule list - The following field has been changed to the parameters.
    • Removed : name
  • [Updated] vpc transit-gateway list - The following field has been added to the parameters and response.
    • Added : firewall_connection_state
  • [Updated] vpc transit-gateway show - The following field has been added to the response.
    • Added : firewall_connection_state
  • [Updated] vpc transit-gateway create - The following field has been added to the response.
    • Added : firewall_connection_state
  • [Updated] vpc transit-gateway set - The following field has been added to the response.
    • Added : firewall_connection_state
  • [Updated] vpc transit-gateway-rule list - The following field has been added to the parameters and response.
    • Added : rule_type

1.1

VPC CLI has been released.

Changes

  • [New] vpc privatelink-endpoint list - Command has been added.
  • [New] vpc privatelink-endpoint create - Command has been added.
  • [New] vpc privatelink-endpoint show - Command has been added.
  • [New] vpc privatelink-endpoint set - Command has been added.
  • [New] vpc privatelink-endpoint delete - Command has been added.
  • [New] vpc privatelink-endpoint approve - Command has been added.
  • [New] vpc privatelink-endpoint connect - Command has been added.
  • [New] vpc privatelink-endpoint request - Command has been added.
  • [New] vpc privatelink-service list - Command has been added.
  • [New] vpc privatelink-service create - Command has been added.
  • [New] vpc privatelink-service show - Command has been added.
  • [New] vpc privatelink-service set - Command has been added.
  • [New] vpc privatelink-service delete - Command has been added.
  • [New] vpc privatelink-service-connected-endpoint list - Command has been added.
  • [New] vpc vpc-peering approval - Command has been added.

1.0

VPC CLI has been released.

Changes

  • [New] vpc internet-gateway create - Command has been added.
  • [New] vpc internet-gateway delete - Command has been added.
  • [New] vpc internet-gateway list - Command has been added.
  • [New] vpc internet-gateway set - Command has been added.
  • [New] vpc internet-gateway show - Command has been added.
  • [New] vpc nat-gateway create - Command has been added.
  • [New] vpc nat-gateway delete - Command has been added.
  • [New] vpc nat-gateway list - Command has been added.
  • [New] vpc nat-gateway set - Command has been added.
  • [New] vpc nat-gateway show - Command has been added.
  • [New] vpc port create - Command has been added.
  • [New] vpc port delete - Command has been added.
  • [New] vpc port list - Command has been added.
  • [New] vpc port set - Command has been added.
  • [New] vpc port show - Command has been added.
  • [New] vpc private-nat create - Command has been added.
  • [New] vpc private-nat delete - Command has been added.
  • [New] vpc private-nat-ip create - Command has been added.
  • [New] vpc private-nat-ip delete - Command has been added.
  • [New] vpc private-nat-ip list - Command has been added.
  • [New] vpc private-nat-ip show - Command has been added.
  • [New] vpc private-nat list - Command has been added.
  • [New] vpc private-nat set - Command has been added.
  • [New] vpc private-nat show - Command has been added.
  • [New] vpc public-ip create - Command has been added.
  • [New] vpc public-ip delete - Command has been added.
  • [New] vpc public-ip list - Command has been added.
  • [New] vpc public-ip set - Command has been added.
  • [New] vpc public-ip show - Command has been added.
  • [New] vpc subnet create - Command has been added.
  • [New] vpc subnet delete - Command has been added.
  • [New] vpc subnet list - Command has been added.
  • [New] vpc subnet set - Command has been added.
  • [New] vpc subnet show - Command has been added.
  • [New] vpc transit-gateway create - Command has been added.
  • [New] vpc transit-gateway delete - Command has been added.
  • [New] vpc transit-gateway list - Command has been added.
  • [New] vpc transit-gateway-rule create - Command has been added.
  • [New] vpc transit-gateway-rule delete - Command has been added.
  • [New] vpc transit-gateway-rule list - Command has been added.
  • [New] vpc transit-gateway set - Command has been added.
  • [New] vpc transit-gateway show - Command has been added.
  • [New] vpc transit-gateway-uplink-rule create - Command has been added.
  • [New] vpc transit-gateway-uplink-rule delete - Command has been added.
  • [New] vpc transit-gateway-vpc-connection create - Command has been added.
  • [New] vpc transit-gateway-vpc-connection delete - Command has been added.
  • [New] vpc transit-gateway-vpc-connection list - Command has been added.
  • [New] vpc vpc create - Command has been added.
  • [New] vpc vpc delete - Command has been added.
  • [New] vpc vpc-endpoint-connectable-resource list - Command has been added.
  • [New] vpc vpc-endpoint create - Command has been added.
  • [New] vpc vpc-endpoint delete - Command has been added.
  • [New] vpc vpc-endpoint list - Command has been added.
  • [New] vpc vpc-endpoint set - Command has been added.
  • [New] vpc vpc-endpoint show - Command has been added.
  • [New] vpc vpc list - Command has been added.
  • [New] vpc vpc-peering create - Command has been added.
  • [New] vpc vpc-peering delete - Command has been added.
  • [New] vpc vpc-peering list - Command has been added.
  • [New] vpc vpc-peering-routing-rule create - Command has been added.
  • [New] vpc vpc-peering-routing-rule list - Command has been added.
  • [New] vpc vpc-peering-rule delete - Command has been added.
  • [New] vpc vpc-peering set - Command has been added.
  • [New] vpc vpc-peering show - Command has been added.
  • [New] vpc vpc set - Command has been added.
  • [New] vpc vpc show - Command has been added.

8.1 - CLIs

8.1.1 - Add VPC CIDR

8.1.1.1 - 1.3

scp-cli vpc vpc cidr create
--vpc_id <value>
--cidr <value>

Description

Add VPC CIDR.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-
cidr
required
stringVPC Cidr192.167.0.0/18

Responses

NameDescriptionExample
cidrVPC Cidr192.167.0.0/18

8.1.1.2 - 1.2

scp-cli vpc vpc cidr create
--vpc_id <value>
--cidr <value>

Description

Add VPC CIDR.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-
cidr
required
stringVPC Cidr192.167.0.0/18

Responses

NameDescriptionExample
idVPC Id7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidr_countCidr Count20
cidrs
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionvpcDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC NamevpcName
stateState

8.1.2 - Approval VPC Peering

8.1.2.1 - 1.3

scp-cli vpc vpc-peering approval
--vpc_peering_id <value>
--type <value>

Description

Approval VPC Peering.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492
type
required
stringApproval Type-

8.1.2.2 - 1.2

scp-cli vpc vpc-peering approval
--vpc_peering_id <value>
--type <value>

Description

Approval VPC Peering.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492
type
required
stringApproval Type-

8.1.2.3 - 1.1

scp-cli vpc vpc-peering approval
--vpc_peering_id <value>
--type <value>

Description

Approval VPC Peering.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492
type
required
stringApproval Type-

8.1.3 - Approve PrivateLink Endpoint

8.1.3.1 - 1.3

scp-cli vpc privatelink-endpoint approve
--privatelink_endpoint_id <value>
--type <value>

Description

Approve PrivateLink Endpoint

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
type
required
stringPrivateLink Endpoint Action TypeAPPROVE

8.1.3.2 - 1.2

scp-cli vpc privatelink-endpoint approve
--privatelink_endpoint_id <value>
--type <value>

Description

Approve PrivateLink Endpoint

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
type
required
stringPrivateLink Endpoint Action TypeAPPROVE

8.1.3.3 - 1.1

scp-cli vpc privatelink-endpoint approve
--privatelink_endpoint_id <value>
--type <value>

Description

Approve PrivateLink Endpoint

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
type
required
stringPrivateLink Endpoint Action TypeAPPROVE

8.1.4 - Connect PrivateLink Endpoint

8.1.4.1 - 1.3

scp-cli vpc privatelink-endpoint connect
--privatelink_endpoint_id <value>
--type <value>

Description

Connect PrivateLink Endpoint

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
type
required
stringPrivateLink Endpoint Action TypeDISCONNECT

8.1.4.2 - 1.2

scp-cli vpc privatelink-endpoint connect
--privatelink_endpoint_id <value>
--type <value>

Description

Connect PrivateLink Endpoint

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
type
required
stringPrivateLink Endpoint Action TypeDISCONNECT

8.1.4.3 - 1.1

scp-cli vpc privatelink-endpoint connect
--privatelink_endpoint_id <value>
--type <value>

Description

Connect PrivateLink Endpoint

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
type
required
stringPrivateLink Endpoint Action TypeDISCONNECT

8.1.5 - Connect Subnet VIP Port

8.1.5.1 - 1.3

scp-cli vpc subnet vip port create
--vip_id <value>
--subnet_id <value>
--port_id <value>

Description

Connect Subnet Vip Port

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
vip_id
required
stringSubnet Vip Id0466a9448d9a4411a86055939e451c8f
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492
port_id
required
stringPort ID35268a9f2eda4cde83b1d85c1f61f67d

Responses

NameDescriptionExample
idConnected Port Id35268a9f2eda4cde83b1d85c1f61f67d
subnet_vip_idSubnet Vip Id0466a9448d9a4411a86055939e451c8f

8.1.5.2 - 1.2

scp-cli vpc subnet vip port create
--vip_id <value>
--subnet_id <value>
--port_id <value>

Description

Connect Subnet Vip Port

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
vip_id
required
stringSubnet Vip Id0466a9448d9a4411a86055939e451c8f
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492
port_id
required
stringPort ID35268a9f2eda4cde83b1d85c1f61f67d

Responses

NameDescriptionExample
idConnected Port Id35268a9f2eda4cde83b1d85c1f61f67d
subnet_vip_idSubnet Vip Id0466a9448d9a4411a86055939e451c8f

8.1.6 - Create Internet Gateway

8.1.6.1 - 1.3

scp-cli vpc internet-gateway create
--vpc_id <value>
--type <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_loggable <value>]
[--tags <value>]

Description

Create Internet Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
type
required
stringInternet Gateway Type-
description
optional
stringDescriptionInternet Gateway Description
firewall_enabled
optional
booleanFirewall Enable-
firewall_loggable
optional
booleanFirewall Loggable-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idInternet Gateway ID023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionInternet Gateway Description
firewall_idFirewall IDb156740b6335468d8354eb9ef8eddf5a
loggableNAT LoggableFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
multi_zone_enabledMulti Zone EnabledTrue
nameInternet Gateway NameIGW_VPCname
stateState
typeInternet Gateway Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.6.2 - 1.2

scp-cli vpc internet-gateway create
--vpc_id <value>
--type <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_loggable <value>]
[--tags <value>]

Description

Create Internet Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
type
required
stringInternet Gateway Type-
description
optional
stringDescriptionInternet Gateway Description
firewall_enabled
optional
booleanFirewall Enable-
firewall_loggable
optional
booleanFirewall Loggable-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idInternet Gateway ID023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionInternet Gateway Description
firewall_idFirewall IDb156740b6335468d8354eb9ef8eddf5a
loggableNAT LoggableFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway NameIGW_VPCname
stateState
typeInternet Gateway Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.6.3 - 1.1

scp-cli vpc internet-gateway create
--vpc_id <value>
--type <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_loggable <value>]
[--tags <value>]

Description

Create Internet Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
type
required
stringInternet Gateway Type-
description
optional
stringDescriptionInternet Gateway Description
firewall_enabled
optional
booleanFirewall Enable-
firewall_loggable
optional
booleanFirewall Loggable-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idInternet Gateway ID023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionInternet Gateway Description
firewall_idFirewall IDb156740b6335468d8354eb9ef8eddf5a
loggableNAT LoggableFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway NameIGW_VPCname
stateState
typeInternet Gateway Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.6.4 - 1.0

scp-cli vpc internet-gateway create
--vpc_id <value>
--type <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_loggable <value>]
[--tags <value>]

Description

Create Internet Gateway.

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

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
type
required
stringInternet Gateway Type-
description
optional
stringDescriptionInternet Gateway Description
firewall_enabled
optional
booleanFirewall Enable-
firewall_loggable
optional
booleanFirewall Loggable-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idInternet Gateway ID023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionInternet Gateway Description
firewall_idFirewall IDb156740b6335468d8354eb9ef8eddf5a
loggableNAT LoggableFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway NameIGW_VPCname
stateState
typeInternet Gateway Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.7 - Create NAT Gateway

8.1.7.1 - 1.3

scp-cli vpc nat-gateway create
--subnet_id <value>
--publicip_ids <value>
[--description <value>]
[--multi_zone_enabled <value>]
[--tags <value>]

Description

Create NAT Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet CIDR023c57b14f11483689338d085e061492
publicip_ids
required
arrayPublicIP IDs12f56e27070248a6a240a497e43fbe18
description
optional
stringNAT Gateway DescriptionVpcEndpoint Description
multi_zone_enabled
optional
booleanMulti Zone Usetrue
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idNAT Gateway ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway DescriptionVpcEndpoint Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
multi_zone_enabledMulti Zone Usetrue
nameNAT Gateway NameNatGatewayName
nat_gateway_ipsNAT Gateway IPs
stateNAT Gateway StateACTIVE
subnet_cidrSubnet Cidr192.167.1.0/24
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.7.2 - 1.2

scp-cli vpc nat-gateway create
--subnet_id <value>
--publicip_id <value>
[--description <value>]
[--tags <value>]

Description

Create NAT Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet CIDR023c57b14f11483689338d085e061492
publicip_id
required
stringPublicIP ID12f56e27070248a6a240a497e43fbe18
description
optional
stringNAT Gateway DescriptionVpcEndpoint Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idNAT Gateway ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway DescriptionVpcEndpoint Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway NameNatGatewayName
nat_gateway_ip_addressNAT Gateway IP Address192.167.0.5
publicip_idPublicIP ID12f56e27070248a6a240a497e43fbe18
stateNAT Gateway StateACTIVE
subnet_cidrSubnet Cidr192.167.1.0/24
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.7.3 - 1.1

scp-cli vpc nat-gateway create
--subnet_id <value>
--publicip_id <value>
[--description <value>]
[--tags <value>]

Description

Create NAT Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet CIDR023c57b14f11483689338d085e061492
publicip_id
required
stringPublicIP ID12f56e27070248a6a240a497e43fbe18
description
optional
stringNAT Gateway DescriptionVpcEndpoint Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idNAT Gateway ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway DescriptionVpcEndpoint Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway NameNatGatewayName
nat_gateway_ip_addressNAT Gateway IP Address192.167.0.5
publicip_idPublicIP ID12f56e27070248a6a240a497e43fbe18
stateNAT Gateway StateACTIVE
subnet_cidrSubnet Cidr192.167.1.0/24
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.7.4 - 1.0

scp-cli vpc nat-gateway create
--subnet_id <value>
--publicip_id <value>
[--description <value>]
[--tags <value>]

Description

Create NAT Gateway.

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

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet CIDR023c57b14f11483689338d085e061492
publicip_id
required
stringPublicIP ID12f56e27070248a6a240a497e43fbe18
description
optional
stringNAT Gateway DescriptionVpcEndpoint Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idNAT Gateway ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway DescriptionVpcEndpoint Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway NameNatGatewayName
nat_gateway_ip_addressNAT Gateway IP Address192.167.0.5
publicip_idPublicIP ID12f56e27070248a6a240a497e43fbe18
stateNAT Gateway StateACTIVE
subnet_cidrSubnet Cidr192.167.1.0/24
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.8 - Create Port

8.1.8.1 - 1.3

scp-cli vpc port create
--subnet_id <value>
--name <value>
[--description <value>]
[--fixed_ip_address <value>]
[--security_groups <value>]
[--tags <value>]

Description

Create port.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id-
name
required
stringPort NameportName
description
optional
stringDescriptionPort Description
fixed_ip_address
optional
stringFixed IP-
security_groups
optional
arraySecurity Group List-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPort ID023c57b1-4f11-4836-8933-8d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idConnected resource ID9387e8f51de04a03994de8a9c3524935
attached_resource_typeConnected resource Type
created_atCreated date
descriptionDescriptionPort Description
fixed_ip_addressFixed IP192.168.1.100
mac_addressMAC Addressfa:16:3e:00:00:01
modified_atModified date
namePort NameportName
security_groupsSecurity Group List
stateState
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
virtual_ip_addressesVirtual IP Address
vpc_idVPC Id071bc63b767444c9afaab1c972d302d5
vpc_nameVPC NamevpcName

8.1.8.2 - 1.2

scp-cli vpc port create
--subnet_id <value>
--name <value>
[--description <value>]
[--fixed_ip_address <value>]
[--security_groups <value>]
[--tags <value>]

Description

Create port.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id-
name
required
stringPort NameportName
description
optional
stringDescriptionPort Description
fixed_ip_address
optional
stringFixed IP-
security_groups
optional
arraySecurity Group List-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPort ID023c57b1-4f11-4836-8933-8d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idConnected resource ID9387e8f51de04a03994de8a9c3524935
attached_resource_typeConnected resource Type
created_atCreated date
descriptionDescriptionPort Description
fixed_ip_addressFixed IP192.168.1.100
mac_addressMAC Addressfa:16:3e:00:00:01
modified_atModified date
namePort NameportName
security_groupsSecurity Group List
stateState
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
virtual_ip_addressesVirtual IP Address
vpc_idVPC Id071bc63b767444c9afaab1c972d302d5
vpc_nameVPC NamevpcName

8.1.8.3 - 1.1

scp-cli vpc port create
--subnet_id <value>
--name <value>
[--description <value>]
[--fixed_ip_address <value>]
[--security_groups <value>]
[--tags <value>]

Description

Create port.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id-
name
required
stringPort NameportName
description
optional
stringDescriptionPort Description
fixed_ip_address
optional
stringFixed IP-
security_groups
optional
arraySecurity Group List-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPort ID023c57b1-4f11-4836-8933-8d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idConnected resource ID9387e8f51de04a03994de8a9c3524935
attached_resource_typeConnected resource Type
created_atCreated date
descriptionDescriptionPort Description
fixed_ip_addressFixed IP192.168.1.100
mac_addressMAC Addressfa:16:3e:00:00:01
modified_atModified date
namePort NameportName
security_groupsSecurity Group List
stateState
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id071bc63b767444c9afaab1c972d302d5
vpc_nameVPC NamevpcName

8.1.8.4 - 1.0

scp-cli vpc port create
--subnet_id <value>
--name <value>
[--description <value>]
[--fixed_ip_address <value>]
[--security_groups <value>]
[--tags <value>]

Description

Create port.

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

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id-
name
required
stringPort NameportName
description
optional
stringDescriptionPort Description
fixed_ip_address
optional
stringFixed IP-
security_groups
optional
arraySecurity Group List-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPort ID023c57b1-4f11-4836-8933-8d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idConnected resource ID9387e8f51de04a03994de8a9c3524935
attached_resource_typeConnected resource Type
created_atCreated date
descriptionDescriptionPort Description
fixed_ip_addressFixed IP192.168.1.100
mac_addressMAC Addressfa:16:3e:00:00:01
modified_atModified date
namePort NameportName
security_groupsSecurity Group List
stateState
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id071bc63b767444c9afaab1c972d302d5
vpc_nameVPC NamevpcName

8.1.9 - Create Private NAT

8.1.9.1 - 1.3

scp-cli vpc private-nat create
--service_type <value>
--service_resource_id <value>
--name <value>
--cidr <value>
[--description <value>]
[--tags <value>]

Description

Create Private NAT.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
service_type
required
stringPrivate NAT connected Service TypeDIRECT_CONNECT
service_resource_id
required
stringPrivate NAT connected Service Resource ID3f342bf9a557405b997c2cf48c89cbc2
name
required
stringPrivate NAT NamePrivateNatName
cidr
required
stringPrivate NAT IP range192.167.0.0/24
description
optional
stringDescriptionPrivateNat Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivate NAT ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrPrivate NAT IP range192.167.0.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateNat Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT NamePrivateNatName
service_resource_idPrivate NAT connected Service Resource ID3f342bf9a557405b997c2cf48c89cbc2
service_resource_namePrivate NAT connected Service Resource NamePrivateNatName
service_typePrivate NAT connected Service TypeDIRECT_CONNECT
statePrivate NAT StateACTIVE

8.1.9.2 - 1.2

scp-cli vpc private-nat create
--service_type <value>
--service_resource_id <value>
--name <value>
--cidr <value>
[--description <value>]
[--tags <value>]

Description

Create Private NAT.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
service_type
required
stringPrivate NAT connected Service TypeDIRECT_CONNECT
service_resource_id
required
stringPrivate NAT connected Service Resource ID3f342bf9a557405b997c2cf48c89cbc2
name
required
stringPrivate NAT NamePrivateNatName
cidr
required
stringPrivate NAT IP range192.167.0.0/24
description
optional
stringDescriptionPrivateNat Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivate NAT ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrPrivate NAT IP range192.167.0.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateNat Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT NamePrivateNatName
service_resource_idPrivate NAT connected Service Resource ID3f342bf9a557405b997c2cf48c89cbc2
service_resource_namePrivate NAT connected Service Resource NamePrivateNatName
service_typePrivate NAT connected Service TypeDIRECT_CONNECT
statePrivate NAT StateACTIVE

8.1.9.3 - 1.1

scp-cli vpc private-nat create
--name <value>
--direct_connect_id <value>
--cidr <value>
[--description <value>]
[--tags <value>]

Description

Create Private NAT.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
name
required
stringPrivate NAT NamePrivateNatName
direct_connect_id
required
stringDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
cidr
required
stringPrivate NAT IP range192.167.0.0/24
description
optional
stringDescriptionPrivateNat Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivate NAT ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrPrivate NAT IP range192.167.0.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateNat Description
direct_connect_idDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
direct_connect_nameDirect Connect NameDirectConnectName
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT NamePrivateNatName
statePrivate NAT StateACTIVE
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.9.4 - 1.0

scp-cli vpc private-nat create
--name <value>
--direct_connect_id <value>
--cidr <value>
[--description <value>]
[--tags <value>]

Description

Create Private NAT.

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

Parameters

NameTypeDescriptionExample
name
required
stringPrivate NAT NamePrivateNatName
direct_connect_id
required
stringDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
cidr
required
stringPrivate NAT IP range192.167.0.0/24
description
optional
stringDescriptionPrivateNat Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivate NAT ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrPrivate NAT IP range192.167.0.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateNat Description
direct_connect_idDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
direct_connect_nameDirect Connect NameDirectConnectName
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT NamePrivateNatName
statePrivate NAT StateACTIVE
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.10 - Create Private NAT IP

8.1.10.1 - 1.3

scp-cli vpc private-nat-ip create
--private_nat_id <value>
--ip_address <value>

Description

Create Private NAT IP.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18
ip_address
required
stringPrivate NAT IP Address-

Responses

NameDescriptionExample
idPrivate NAT IP ID
attached_resource_idPrivate NAT IP Attached Resource ID
attached_resource_namePrivate NAT IP Attached Resource Name
attached_resource_typePrivate NAT IP Attached Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
ip_addressPrivate NAT IP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
private_nat_idPrivate NAT ID
statePrivate NAT IP State

8.1.10.2 - 1.2

scp-cli vpc private-nat-ip create
--private_nat_id <value>
--ip_address <value>

Description

Create Private NAT IP.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18
ip_address
required
stringPrivate NAT IP Address-

Responses

NameDescriptionExample
idPrivate NAT IP ID
attached_resource_idPrivate NAT IP Attached Resource ID
attached_resource_namePrivate NAT IP Attached Resource Name
attached_resource_typePrivate NAT IP Attached Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
ip_addressPrivate NAT IP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
private_nat_idPrivate NAT ID
statePrivate NAT IP State

8.1.10.3 - 1.1

scp-cli vpc private-nat-ip create
--private_nat_id <value>
--ip_address <value>

Description

Create Private NAT IP.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18
ip_address
required
stringPrivate NAT IP Address-

Responses

NameDescriptionExample
idPrivate NAT IP ID
attached_resource_idPrivate NAT IP Attached Resource ID
attached_resource_namePrivate NAT IP Attached Resource Name
attached_resource_typePrivate NAT IP Attached Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
ip_addressPrivate NAT IP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
private_nat_idPrivate NAT ID
statePrivate NAT IP State

8.1.10.4 - 1.0

scp-cli vpc private-nat-ip create
--private_nat_id <value>
--ip_address <value>

Description

Create Private NAT IP.

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

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18
ip_address
required
stringPrivate NAT IP Address-

Responses

NameDescriptionExample
idPrivate NAT IP ID
attached_resource_idPrivate NAT IP Attached Resource ID
attached_resource_namePrivate NAT IP Attached Resource Name
attached_resource_typePrivate NAT IP Attached Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
ip_addressPrivate NAT IP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
private_nat_idPrivate NAT ID
statePrivate NAT IP State

8.1.11 - Create PrivateLink Endpoint

8.1.11.1 - 1.3

scp-cli vpc privatelink-endpoint create
--subnet_id <value>
--name <value>
--endpoint_ip_address <value>
[--description <value>]
[--privatelink_service_id <value>]
[--security_group_ids <value>]
[--tags <value>]

Description

Create PrivateLink Endpoint.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
name
required
stringPrivateLink Endpoint NameEndpointName
endpoint_ip_address
required
stringEndpoint IP Address192.167.1.5
description
optional
stringDescriptionPrivateLink Endpoint Description
privatelink_service_id
optional
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
security_group_ids
optional
arraySecurity Group List[
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
approval_typePrivateLink Service Approval TypeAUTO
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateLink Endpoint Description
endpoint_ip_addressEndpoint IP Address192.167.1.5
endpoint_ip_port_idEndpoint IP Port IDb44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Endpoint NameEndpointName
privatelink_service_idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
security_group_idsSecurity Group List[‘17776b52-0a64-440d-9e93-b4fc37be935b’]
statePrivateLink Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8

8.1.11.2 - 1.2

scp-cli vpc privatelink-endpoint create
--subnet_id <value>
--name <value>
--endpoint_ip_address <value>
[--description <value>]
[--privatelink_service_id <value>]
[--security_group_ids <value>]
[--tags <value>]

Description

Create PrivateLink Endpoint.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
name
required
stringPrivateLink Endpoint NameEndpointName
endpoint_ip_address
required
stringEndpoint IP Address192.167.1.5
description
optional
stringDescriptionPrivateLink Endpoint Description
privatelink_service_id
optional
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
security_group_ids
optional
arraySecurity Group List[
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
approval_typePrivateLink Service Approval TypeAUTO
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateLink Endpoint Description
endpoint_ip_addressEndpoint IP Address192.167.1.5
endpoint_ip_port_idEndpoint IP Port IDb44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Endpoint NameEndpointName
privatelink_service_idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
security_group_idsSecurity Group List[‘17776b52-0a64-440d-9e93-b4fc37be935b’]
statePrivateLink Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8

8.1.11.3 - 1.1

scp-cli vpc privatelink-endpoint create
--subnet_id <value>
--name <value>
--endpoint_ip_address <value>
[--description <value>]
[--privatelink_service_id <value>]
[--security_group_ids <value>]
[--tags <value>]

Description

Create PrivateLink Endpoint.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
name
required
stringPrivateLink Endpoint NameEndpointName
endpoint_ip_address
required
stringEndpoint IP Address192.167.1.5
description
optional
stringDescriptionPrivateLink Endpoint Description
privatelink_service_id
optional
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
security_group_ids
optional
arraySecurity Group List[
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
approval_typePrivateLink Service Approval TypeAUTO
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateLink Endpoint Description
endpoint_ip_addressEndpoint IP Address192.167.1.5
endpoint_ip_port_idEndpoint IP Port IDb44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Endpoint NameEndpointName
privatelink_service_idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
security_group_idsSecurity Group List[‘17776b52-0a64-440d-9e93-b4fc37be935b’]
statePrivateLink Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8

8.1.12 - Create PrivateLink Service

8.1.12.1 - 1.3

scp-cli vpc privatelink-service create
--subnet_id <value>
--service_ip_address <value>
--name <value>
--connected_resource_type <value>
--approval_type <value>
[--connected_resource_id <value>]
[--connected_resource_ip_address <value>]
[--description <value>]
[--high_speed_transfer <value>]
[--security_group_ids <value>]
[--tags <value>]

Description

Create PrivateLink Service.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
service_ip_address
required
stringService IP Address192.167.0.5
name
required
stringPrivateLink Service NameServiceName
connected_resource_type
required
stringConnected Resource TypeLB
approval_type
required
stringPrivateLink Service Approval TypeAUTO
connected_resource_id
optional
stringConnected Resource IDa3e3a662a4f34442a94166df5ff9f577
connected_resource_ip_address
optional
stringConnected Resource IP Address192.167.0.10
description
optional
stringDescriptionPrivateLink Service Description
high_speed_transfer
optional
booleanHigh Speed Data Transfer UseFalse
security_group_ids
optional
arraySecurity Group List[
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
approval_typePrivateLink Service Approval TypeAUTO
connected_resource_idConnected Resource IDa3e3a662a4f34442a94166df5ff9f577
connected_resource_ip_addressConnected Resource IP Address192.167.0.10
connected_resource_nameConnected Resource NamelbResourceName
connected_resource_typeConnected Resource TypeLB
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateLink Service Description
high_speed_transferHigh Speed Data Transfer UseFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Service NameServiceName
security_group_idsSecurity Group List[‘00b6af37-73b5-4de2-b080-c295a1a0382e’]
service_ip_addressService IP Address192.167.0.5
service_ip_port_idService IP Port IDd21a4b81-f52a-43a8-b985-341e763458bb
statePrivateLink Service State
subnet_idSubnet Id023c57b14f11483689338d085e061492
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8

8.1.12.2 - 1.2

scp-cli vpc privatelink-service create
--subnet_id <value>
--service_ip_address <value>
--name <value>
--connected_resource_type <value>
--approval_type <value>
[--connected_resource_id <value>]
[--connected_resource_ip_address <value>]
[--description <value>]
[--high_speed_transfer <value>]
[--security_group_ids <value>]
[--tags <value>]

Description

Create PrivateLink Service.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
service_ip_address
required
stringService IP Address192.167.0.5
name
required
stringPrivateLink Service NameServiceName
connected_resource_type
required
stringConnected Resource TypeLB
approval_type
required
stringPrivateLink Service Approval TypeAUTO
connected_resource_id
optional
stringConnected Resource IDa3e3a662a4f34442a94166df5ff9f577
connected_resource_ip_address
optional
stringConnected Resource IP Address192.167.0.10
description
optional
stringDescriptionPrivateLink Service Description
high_speed_transfer
optional
booleanHigh Speed Data Transfer UseFalse
security_group_ids
optional
arraySecurity Group List[
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
approval_typePrivateLink Service Approval TypeAUTO
connected_resource_idConnected Resource IDa3e3a662a4f34442a94166df5ff9f577
connected_resource_ip_addressConnected Resource IP Address192.167.0.10
connected_resource_nameConnected Resource NamelbResourceName
connected_resource_typeConnected Resource TypeLB
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateLink Service Description
high_speed_transferHigh Speed Data Transfer UseFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Service NameServiceName
security_group_idsSecurity Group List[‘00b6af37-73b5-4de2-b080-c295a1a0382e’]
service_ip_addressService IP Address192.167.0.5
service_ip_port_idService IP Port IDd21a4b81-f52a-43a8-b985-341e763458bb
statePrivateLink Service State
subnet_idSubnet Id023c57b14f11483689338d085e061492
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8

8.1.12.3 - 1.1

scp-cli vpc privatelink-service create
--subnet_id <value>
--service_ip_address <value>
--name <value>
--connected_resource_type <value>
--approval_type <value>
[--connected_resource_id <value>]
[--connected_resource_ip_address <value>]
[--description <value>]
[--high_speed_transfer <value>]
[--security_group_ids <value>]
[--tags <value>]

Description

Create PrivateLink Service.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
service_ip_address
required
stringService IP Address192.167.0.5
name
required
stringPrivateLink Service NameServiceName
connected_resource_type
required
stringConnected Resource TypeLB
approval_type
required
stringPrivateLink Service Approval TypeAUTO
connected_resource_id
optional
stringConnected Resource IDa3e3a662a4f34442a94166df5ff9f577
connected_resource_ip_address
optional
stringConnected Resource IP Address192.167.0.10
description
optional
stringDescriptionPrivateLink Service Description
high_speed_transfer
optional
booleanHigh Speed Data Transfer UseFalse
security_group_ids
optional
arraySecurity Group List[
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
approval_typePrivateLink Service Approval TypeAUTO
connected_resource_idConnected Resource IDa3e3a662a4f34442a94166df5ff9f577
connected_resource_ip_addressConnected Resource IP Address192.167.0.10
connected_resource_nameConnected Resource NamelbResourceName
connected_resource_typeConnected Resource TypeLB
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateLink Service Description
high_speed_transferHigh Speed Data Transfer UseFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Service NameServiceName
security_group_idsSecurity Group List[‘00b6af37-73b5-4de2-b080-c295a1a0382e’]
service_ip_addressService IP Address192.167.0.5
service_ip_port_idService IP Port IDd21a4b81-f52a-43a8-b985-341e763458bb
statePrivateLink Service State
subnet_idSubnet Id023c57b14f11483689338d085e061492
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8

8.1.13 - Create PublicIP

8.1.13.1 - 1.3

scp-cli vpc public-ip create
--zone <value>
--type <value>
[--description <value>]
[--tags <value>]

Description

Create PublicIP.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
zone
required
stringZonekr-west1-a
type
required
stringPublicIP TypeIGW
description
optional
stringPublicIP DescriptionPublic IP Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPublicIP ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idPublicIP Attached Resource ID37e6db41f5124184a43251a63124cdc9
attached_resource_namePublicIP Attached Resource NameAttached NAT Gateway Name
attached_resource_typePublicIP Attached Resource TypeNAT_GW
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP DescriptionPublic IP Description
ip_addressIP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP StateATTACHED
typePublicIP TypeIGW
zoneZonekr-west1-a

8.1.13.2 - 1.2

scp-cli vpc public-ip create
--type <value>
[--description <value>]
[--tags <value>]

Description

Create PublicIP.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
type
required
stringPublicIP TypeIGW
description
optional
stringPublicIP DescriptionPublic IP Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPublicIP ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idPublicIP Attached Resource ID37e6db41f5124184a43251a63124cdc9
attached_resource_namePublicIP Attached Resource NameAttached NAT Gateway Name
attached_resource_typePublicIP Attached Resource TypeNAT_GW
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP DescriptionPublic IP Description
ip_addressIP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP StateATTACHED
typePublicIP TypeIGW

8.1.13.3 - 1.1

scp-cli vpc public-ip create
--type <value>
[--description <value>]
[--tags <value>]

Description

Create PublicIP.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
type
required
stringPublicIP TypeIGW
description
optional
stringPublicIP DescriptionPublic IP Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPublicIP ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idPublicIP Attached Resource ID37e6db41f5124184a43251a63124cdc9
attached_resource_namePublicIP Attached Resource NameAttached NAT Gateway Name
attached_resource_typePublicIP Attached Resource TypeNAT_GW
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP DescriptionPublic IP Description
ip_addressIP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP StateATTACHED
typePublicIP TypeIGW

8.1.13.4 - 1.0

scp-cli vpc public-ip create
--type <value>
[--description <value>]
[--tags <value>]

Description

Create PublicIP.

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

Parameters

NameTypeDescriptionExample
type
required
stringPublicIP TypeIGW
description
optional
stringPublicIP DescriptionPublic IP Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPublicIP ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idPublicIP Attached Resource ID37e6db41f5124184a43251a63124cdc9
attached_resource_namePublicIP Attached Resource NameAttached NAT Gateway Name
attached_resource_typePublicIP Attached Resource TypeNAT_GW
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP DescriptionPublic IP Description
ip_addressIP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP StateATTACHED
typePublicIP TypeIGW

8.1.14 - Create Subnet

8.1.14.1 - 1.3

scp-cli vpc subnet create
--vpc_id <value>
--type <value>
--name <value>
--cidr <value>
--category <value>
[--allocation_pools <value>]
[--description <value>]
[--dns_nameservers <value>]
[--gateway_ip_address <value>]
[--host_routes <value>]
[--primary_subnet_id <value>]
[--tags <value>]

Description

Create subnet.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
type
required
stringSubnet Type-
name
required
stringSubnet NamesubnetName
cidr
required
stringSubnet Cidr192.167.1.0/24
category
required
stringSubnet CategoryPRIMARY
allocation_pools
optional
arrayAllocation Pools[
description
optional
stringDescriptionSubnet Description
dns_nameservers
optional
arrayDNS Name Servers[
gateway_ip_address
optional
stringGateway IP Address192.167.1.1
host_routes
optional
arrayHost Routes[
primary_subnet_id
optional
stringPrimary Subnet ID023c57b14f11483689338d085e061492
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idSubnet Id023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
allocation_poolsAllocation Pools
categorySubnet CategoryPRIMARY
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionSubnet Description
dhcp_ip_addressDHCP IP Address
dns_nameserversDNS Name Servers
gateway_ip_addressGateway IP Address192.167.1.1
host_routesHost Routes
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
primary_subnet_idPrimary Subnet ID023c57b14f11483689338d085e061492
secondary_subnet_idsSecondary Subnet ID List[“522e102f680448a8804d18d4838baa78”, “aec40baf53c243c1bb8401a703a2c888”]
stateState
typeSubnet TypePUBLIC
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName
zonesSubnet Zone List[“kr-west1-a”, “kr-west1-b”, “kr-west1-c”]

8.1.14.2 - 1.2

scp-cli vpc subnet create
--vpc_id <value>
--type <value>
--name <value>
--cidr <value>
[--allocation_pools <value>]
[--description <value>]
[--dns_nameservers <value>]
[--gateway_ip_address <value>]
[--host_routes <value>]
[--tags <value>]

Description

Create subnet.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
type
required
stringSubnet TypeGENERAL
name
required
stringSubnet NamesubnetName
cidr
required
stringSubnet Cidr192.167.1.0/24
allocation_pools
optional
arrayAllocation Pools[
description
optional
stringDescriptionSubnet Description
dns_nameservers
optional
arrayDNS Name Servers[
gateway_ip_address
optional
stringGateway IP Address192.167.1.1
host_routes
optional
arrayHost Routes[
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idSubnet Id023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
allocation_poolsAllocation Pools
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionSubnet Description
dhcp_ip_addressDHCP IP Address
dns_nameserversDNS Name Servers
gateway_ip_addressGateway IP Address192.167.1.1
host_routesHost Routes
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
stateState
typeSubnet TypeGENERAL
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.14.3 - 1.1

scp-cli vpc subnet create
--vpc_id <value>
--type <value>
--name <value>
--cidr <value>
[--allocation_pools <value>]
[--description <value>]
[--dns_nameservers <value>]
[--host_routes <value>]
[--tags <value>]

Description

Create subnet.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
type
required
stringSubnet TypeGENERAL
name
required
stringSubnet NamesubnetName
cidr
required
stringSubnet Cidr192.167.1.0/24
allocation_pools
optional
arrayAllocation Pools[
description
optional
stringDescriptionSubnet Description
dns_nameservers
optional
arrayDNS Name Servers[
host_routes
optional
arrayHost Routes[
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idSubnet Id023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
allocation_poolsAllocation Pools
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionSubnet Description
dns_nameserversDNS Name Servers
gateway_ip_addressGateway IP Address192.167.1.1
host_routesHost Routes
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
stateState
typeSubnet TypeGENERAL
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.14.4 - 1.0

scp-cli vpc subnet create
--vpc_id <value>
--type <value>
--name <value>
--cidr <value>
[--allocation_pools <value>]
[--description <value>]
[--dns_nameservers <value>]
[--host_routes <value>]
[--tags <value>]

Description

Create subnet.

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

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
type
required
stringSubnet TypeGENERAL
name
required
stringSubnet NamesubnetName
cidr
required
stringSubnet Cidr192.167.1.0/24
allocation_pools
optional
arrayAllocation Pools[
description
optional
stringDescriptionSubnet Description
dns_nameservers
optional
arrayDNS Name Servers[
host_routes
optional
arrayHost Routes[
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idSubnet Id023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
allocation_poolsAllocation Pools
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionSubnet Description
dns_nameserversDNS Name Servers
gateway_ip_addressGateway IP Address192.167.1.1
host_routesHost Routes
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
stateState
typeSubnet TypeGENERAL
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.15 - Create Subnet VIP

8.1.15.1 - 1.3

scp-cli vpc subnet vip create
--subnet_id <value>
[--description <value>]
[--virtual_ip_address <value>]

Description

Create Subnet Vip

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
description
optional
stringDescriptionSubnet VIP Description
virtual_ip_address
optional
stringVirtual IP Address192.168.20.6

Responses

NameDescriptionExample
idSubnet Vip Id0466a9448d9a4411a86055939e451c8f
connected_ports
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionSubnet VIP Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
stateStateACTIVE
static_natStatic NAT Info
subnet_idSubnet ID023c57b14f11483689338d085e061492
vip_port_idVip Port Id35268a9f2eda4cde83b1d85c1f61f67d
virtual_ip_addressVirtual IP Address192.168.20.6

8.1.15.2 - 1.2

scp-cli vpc subnet vip create
--subnet_id <value>
[--description <value>]
[--virtual_ip_address <value>]

Description

Create Subnet Vip

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
description
optional
stringDescriptionSubnet VIP Description
virtual_ip_address
optional
stringVirtual IP Address192.168.20.6

Responses

NameDescriptionExample
idSubnet Vip Id0466a9448d9a4411a86055939e451c8f
connected_ports
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionSubnet VIP Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
stateStateACTIVE
static_natStatic NAT Info
subnet_idSubnet ID023c57b14f11483689338d085e061492
vip_port_idVip Port Id35268a9f2eda4cde83b1d85c1f61f67d
virtual_ip_addressVirtual IP Address192.168.20.6

8.1.16 - Create Subnet VIP NAT IP

8.1.16.1 - 1.3

scp-cli vpc subnet vip nat create
--vip_id <value>
--subnet_id <value>
--publicip_id <value>
--nat_type <value>

Description

Create Subnet Vip Nat Ip

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
vip_id
required
stringSubnet Vip Id0466a9448d9a4411a86055939e451c8f
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492
publicip_id
required
stringPublicip ID12f56e27070248a6a240a497e43fbe18
nat_type
required
stringNAT TypePUBLIC

Responses

NameDescriptionExample
idStatic Nat Id0009e49548154745948e9722adefbf40
publicip_idPublicip ID12f56e27070248a6a240a497e43fbe18
stateStatic Nat StateACTIVE

8.1.16.2 - 1.2

scp-cli vpc subnet vip nat create
--vip_id <value>
--subnet_id <value>
--publicip_id <value>
--nat_type <value>

Description

Create Subnet Vip Nat Ip

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
vip_id
required
stringSubnet Vip Id0466a9448d9a4411a86055939e451c8f
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492
publicip_id
required
stringPublicip ID12f56e27070248a6a240a497e43fbe18
nat_type
required
stringNAT TypePUBLIC

Responses

NameDescriptionExample
idStatic Nat Id0009e49548154745948e9722adefbf40
publicip_idPublicip ID12f56e27070248a6a240a497e43fbe18
stateStatic Nat StateACTIVE

8.1.17 - Create Transit Gateway

8.1.17.1 - 1.3

scp-cli vpc transit-gateway create
--name <value>
[--description <value>]
[--tags <value>]

Description

Create Transit Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
name
required
stringTransit Gateway NameTransitGatewayName
description
optional
stringDescriptionTransitGateway Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthTransit Gateway Port Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway DescriptionTransitGateway Description
firewall_connection_stateFirewall Connection StateINACTIVE
firewall_idsFirewall IDsbbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_active_zoneUplink Active Zonekr-west1-a
uplink_enabledUplink EnabledFalse
uplink_standby_zoneUplink Standby Zonekr-west1-b
uplink_zone_stateUplink Zone Connect stateACTIVE

8.1.17.2 - 1.2

scp-cli vpc transit-gateway create
--name <value>
[--description <value>]
[--tags <value>]

Description

Create Transit Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
name
required
stringTransit Gateway NameTransitGatewayName
description
optional
stringDescriptionTransitGateway Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthTransit Gateway Port Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway DescriptionTransitGateway Description
firewall_connection_stateFirewall Connection StateINACTIVE
firewall_idsFirewall IDsbbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse

8.1.17.3 - 1.1

scp-cli vpc transit-gateway create
--name <value>
[--description <value>]
[--tags <value>]

Description

Create Transit Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
name
required
stringTransit Gateway NameTransitGatewayName
description
optional
stringDescriptionTransitGateway Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthTransit Gateway Port Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway DescriptionTransitGateway Description
firewall_idsFirewall IDsbbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse

8.1.17.4 - 1.0

scp-cli vpc transit-gateway create
--name <value>
[--description <value>]
[--tags <value>]

Description

Create Transit Gateway.

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

Parameters

NameTypeDescriptionExample
name
required
stringTransit Gateway NameTransitGatewayName
description
optional
stringDescriptionTransitGateway Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthTransit Gateway Port Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway DescriptionTransitGateway Description
firewall_idsFirewall IDsbbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse

8.1.18 - Create Transit Gateway Firewall

8.1.18.1 - 1.3

scp-cli vpc transit-gateway-firewall create
--transit_gateway_id <value>
--product_type <value>
[--uplink_active_zone <value>]
[--uplink_standby_zone <value>]

Description

Create Transit Gateway Firewall.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
product_type
required
stringFw Product TypeTGW_DGW
uplink_active_zone
optional
stringUplink Active Zonekr-west1-a
uplink_standby_zone
optional
stringUplink Standby Zonekr-west1-b

Responses

NameDescriptionExample
stateStateACTIVE
uplink_active_zoneUplink Active Zonekr-west1-a
uplink_standby_zoneUplink Standby Zonekr-west1-b
uplink_zone_stateUplink Zone Connect stateACTIVE

8.1.18.2 - 1.2

scp-cli vpc transit-gateway-firewall create
--transit_gateway_id <value>
--product_type <value>

Description

Create Transit Gateway Firewall.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
product_type
required
stringFw Product TypeTGW_DGW

Responses

NameDescriptionExample
idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthTransit Gateway Port Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway DescriptionTransitGateway Description
firewall_connection_stateFirewall Connection StateINACTIVE
firewall_idsFirewall IDsbbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse

8.1.19 - Create Transit Gateway Firewall Connection

8.1.19.1 - 1.3

scp-cli vpc transit-gateway-firewall-connection create
--transit_gateway_id <value>

Description

Create Transit Gateway Firewall Connection.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

Responses

NameDescriptionExample

8.1.19.2 - 1.2

scp-cli vpc transit-gateway-firewall-connection create
--transit_gateway_id <value>

Description

Create Transit Gateway Firewall Connection.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

Responses

NameDescriptionExample
idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthTransit Gateway Port Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway DescriptionTransitGateway Description
firewall_connection_stateFirewall Connection StateINACTIVE
firewall_idsFirewall IDsbbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse

8.1.20 - Create Transit Gateway Rule

8.1.20.1 - 1.3

scp-cli vpc transit-gateway-rule create
--transit_gateway_id <value>
--tgw_connection_vpc_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]

Description

Create Transit Gateway Rule.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
tgw_connection_vpc_id
required
stringVPC ID Connected to Transit Gateway.ffeced8e191c478eabd66b6e2cab8e34
destination_type
required
stringDestination TypeVPC
destination_cidr
required
stringDestination CIDR192.167.5.0/24
description
optional
stringDescriptionRouting Rule Description

Responses

NameDescriptionExample
idRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
descriptionDescriptionRouting Rule Description
destination_cidrDestination CIDR192.167.5.0/24
destination_resource_idDestination Resource IDceb44ea5ecb34a49b16495f9a63b0718
destination_resource_nameDestination Resource NameVpcName
destination_typeDestination TypeVPC
source_resource_idSource Resource ID8582cc5d89994a42ad53282fd4a8d8be
source_resource_nameSource Resource NameTgwName
source_typeSource TypeTGW
stateStateACTIVE
tgw_connection_vpc_idVPC ID Connected to Transit Gateway.ffeced8e191c478eabd66b6e2cab8e34
tgw_connection_vpc_nameVPC Name Connected to Transit Gateway.ConnectedVpcName

8.1.20.2 - 1.2

scp-cli vpc transit-gateway-rule create
--transit_gateway_id <value>
--tgw_connection_vpc_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]

Description

Create Transit Gateway Rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
tgw_connection_vpc_id
required
stringVPC ID Connected to Transit Gateway.ffeced8e191c478eabd66b6e2cab8e34
destination_type
required
stringDestination TypeVPC
destination_cidr
required
stringDestination CIDR192.167.5.0/24
description
optional
stringDescriptionRouting Rule Description

Responses

NameDescriptionExample
idRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
descriptionDescriptionRouting Rule Description
destination_cidrDestination CIDR192.167.5.0/24
destination_resource_idDestination Resource IDceb44ea5ecb34a49b16495f9a63b0718
destination_resource_nameDestination Resource NameVpcName
destination_typeDestination TypeVPC
source_resource_idSource Resource ID8582cc5d89994a42ad53282fd4a8d8be
source_resource_nameSource Resource NameTgwName
source_typeSource TypeTGW
stateStateACTIVE
tgw_connection_vpc_idVPC ID Connected to Transit Gateway.ffeced8e191c478eabd66b6e2cab8e34
tgw_connection_vpc_nameVPC Name Connected to Transit Gateway.ConnectedVpcName

8.1.20.3 - 1.1

scp-cli vpc transit-gateway-rule create
--transit_gateway_id <value>
--tgw_connection_vpc_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]

Description

Create Transit Gateway Rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
tgw_connection_vpc_id
required
stringVPC ID Connected to Transit Gateway.ffeced8e191c478eabd66b6e2cab8e34
destination_type
required
stringDestination TypeVPC
destination_cidr
required
stringDestination CIDR192.167.5.0/24
description
optional
stringDescriptionRouting Rule Description

Responses

NameDescriptionExample
idRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
descriptionDescriptionRouting Rule Description
destination_cidrDestination CIDR192.167.5.0/24
destination_resource_idDestination Resource IDceb44ea5ecb34a49b16495f9a63b0718
destination_resource_nameDestination Resource NameVpcName
destination_typeDestination TypeVPC
source_resource_idSource Resource ID8582cc5d89994a42ad53282fd4a8d8be
source_resource_nameSource Resource NameTgwName
source_typeSource TypeTGW
stateStateACTIVE
tgw_connection_vpc_idVPC ID Connected to Transit Gateway.ffeced8e191c478eabd66b6e2cab8e34
tgw_connection_vpc_nameVPC Name Connected to Transit Gateway.ConnectedVpcName

8.1.20.4 - 1.0

scp-cli vpc transit-gateway-rule create
--transit_gateway_id <value>
--tgw_connection_vpc_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]

Description

Create Transit Gateway Rule.

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

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
tgw_connection_vpc_id
required
stringVPC ID Connected to Transit Gateway.ffeced8e191c478eabd66b6e2cab8e34
destination_type
required
stringDestination TypeVPC
destination_cidr
required
stringDestination CIDR192.167.5.0/24
description
optional
stringDescriptionRouting Rule Description

Responses

NameDescriptionExample
idRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
descriptionDescriptionRouting Rule Description
destination_cidrDestination CIDR192.167.5.0/24
destination_resource_idDestination Resource IDceb44ea5ecb34a49b16495f9a63b0718
destination_resource_nameDestination Resource NameVpcName
destination_typeDestination TypeVPC
source_resource_idSource Resource ID8582cc5d89994a42ad53282fd4a8d8be
source_resource_nameSource Resource NameTgwName
source_typeSource TypeTGW
stateStateACTIVE
tgw_connection_vpc_idVPC ID Connected to Transit Gateway.ffeced8e191c478eabd66b6e2cab8e34
tgw_connection_vpc_nameVPC Name Connected to Transit Gateway.ConnectedVpcName

8.1.21 - Create Transit Gateway Uplink Rule

8.1.21.1 - 1.3

scp-cli vpc transit-gateway-uplink-rule create
--transit_gateway_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]

Description

Create Transit Gateway Uplink Rule.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
destination_type
required
stringDestination TypeON_PREMISE
destination_cidr
required
stringDestination CIDR192.167.5.0/24
description
optional
stringDescriptionRouting Rule Description

Responses

NameDescriptionExample
idRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
descriptionDescriptionRouting Rule Description
destination_cidrDestination CIDR192.167.5.0/24
destination_typeDestination TypeON_PREMISE
stateStateACTIVE

8.1.21.2 - 1.2

scp-cli vpc transit-gateway-uplink-rule create
--transit_gateway_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]

Description

Create Transit Gateway Uplink Rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
destination_type
required
stringDestination TypeON_PREMISE
destination_cidr
required
stringDestination CIDR192.167.5.0/24
description
optional
stringDescriptionRouting Rule Description

Responses

NameDescriptionExample
idRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
descriptionDescriptionRouting Rule Description
destination_cidrDestination CIDR192.167.5.0/24
destination_typeDestination TypeON_PREMISE
stateStateACTIVE

8.1.21.3 - 1.1

scp-cli vpc transit-gateway-uplink-rule create
--transit_gateway_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]

Description

Create Transit Gateway Uplink Rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
destination_type
required
stringDestination TypeON_PREMISE
destination_cidr
required
stringDestination CIDR192.167.5.0/24
description
optional
stringDescriptionRouting Rule Description

Responses

NameDescriptionExample
idRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
descriptionDescriptionRouting Rule Description
destination_cidrDestination CIDR192.167.5.0/24
destination_typeDestination TypeON_PREMISE
stateStateACTIVE

8.1.21.4 - 1.0

scp-cli vpc transit-gateway-uplink-rule create
--transit_gateway_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]

Description

Create Transit Gateway Uplink Rule.

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

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
destination_type
required
stringDestination TypeON_PREMISE
destination_cidr
required
stringDestination CIDR192.167.5.0/24
description
optional
stringDescriptionRouting Rule Description

Responses

NameDescriptionExample
idRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
descriptionDescriptionRouting Rule Description
destination_cidrDestination CIDR192.167.5.0/24
destination_typeDestination TypeON_PREMISE
stateStateACTIVE

8.1.22 - Create Transit Gateway VPC Connection

8.1.22.1 - 1.3

scp-cli vpc transit-gateway-vpc-connection create
--transit_gateway_id <value>
--vpc_id <value>

Description

Create Transit Gateway VPC Connection.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8

Responses

NameDescriptionExample
idTransit Gateway VPC Connection IDffeced8e191c478eabd66b6e2cab8e34
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
stateStateACTIVE
transit_gateway_idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.22.2 - 1.2

scp-cli vpc transit-gateway-vpc-connection create
--transit_gateway_id <value>
--vpc_id <value>

Description

Create Transit Gateway VPC Connection.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8

Responses

NameDescriptionExample
idTransit Gateway VPC Connection IDffeced8e191c478eabd66b6e2cab8e34
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
stateStateACTIVE
transit_gateway_idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.22.3 - 1.1

scp-cli vpc transit-gateway-vpc-connection create
--transit_gateway_id <value>
--vpc_id <value>

Description

Create Transit Gateway VPC Connection.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8

Responses

NameDescriptionExample
idTransit Gateway VPC Connection IDffeced8e191c478eabd66b6e2cab8e34
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
stateStateACTIVE
transit_gateway_idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.22.4 - 1.0

scp-cli vpc transit-gateway-vpc-connection create
--transit_gateway_id <value>
--vpc_id <value>

Description

Create Transit Gateway VPC Connection.

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

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8

Responses

NameDescriptionExample
idTransit Gateway VPC Connection IDffeced8e191c478eabd66b6e2cab8e34
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
stateStateACTIVE
transit_gateway_idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.23 - Create VPC

8.1.23.1 - 1.3

scp-cli vpc vpc create
--name <value>
--cidr <value>
[--description <value>]
[--tags <value>]

Description

Create VPC.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
name
required
stringVPC NamevpcName
cidr
required
stringVPC Cidr192.167.0.0/18
description
optional
stringDescriptionVPC Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Id7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidr_countCidr Count20
cidrs
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionvpcDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC NamevpcName
stateState
zone_typeVpc Zone Type InformationPUBLIC
zonesVpc Zones Information[‘zone-a’, ‘zone-b’, ‘zone-c’]

8.1.23.2 - 1.2

scp-cli vpc vpc create
--name <value>
--cidr <value>
[--description <value>]
[--tags <value>]

Description

Create VPC.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
name
required
stringVPC NamevpcName
cidr
required
stringVPC Cidr192.167.0.0/18
description
optional
stringDescriptionVPC Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Id7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidr_countCidr Count20
cidrs
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionvpcDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC NamevpcName
stateState

8.1.23.3 - 1.1

scp-cli vpc vpc create
--name <value>
--cidr <value>
[--description <value>]
[--tags <value>]

Description

Create VPC.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
name
required
stringVPC NamevpcName
cidr
required
stringVPC Cidr192.167.0.0/18
description
optional
stringDescriptionVPC Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Id7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrVPC Cidr192.167.0.0/18
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionvpcDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC NamevpcName
stateState

8.1.23.4 - 1.0

scp-cli vpc vpc create
--name <value>
--cidr <value>
[--description <value>]
[--tags <value>]

Description

Create VPC.

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

Parameters

NameTypeDescriptionExample
name
required
stringVPC NamevpcName
cidr
required
stringVPC Cidr192.167.0.0/18
description
optional
stringDescriptionVPC Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Id7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrVPC Cidr192.167.0.0/18
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionvpcDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC NamevpcName
stateState

8.1.24 - Create VPC Endpoint

8.1.24.1 - 1.3

scp-cli vpc vpc-endpoint create
--vpc_id <value>
--subnet_id <value>
--resource_type <value>
--resource_key <value>
--resource_info <value>
--name <value>
--endpoint_ip_address <value>
[--description <value>]
[--tags <value>]

Description

Create VPC Endpoint.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
resource_type
required
stringVPC Endpoint Resource TypeFS
resource_key
required
stringVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_info
required
stringVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
name
required
stringVPC Endpoint NameVpcEndpointName
endpoint_ip_address
required
stringVPC Endpoint IP Address192.167.0.5
description
optional
stringDescriptionVpcEndpoint Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionVpcEndpoint Description
endpoint_ip_addressVPC Endpoint IP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint NameVpcEndpointName
resource_infoVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
resource_keyVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_typeVPC Endpoint Resource TypeFS
stateVPC Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.24.2 - 1.2

scp-cli vpc vpc-endpoint create
--vpc_id <value>
--subnet_id <value>
--resource_type <value>
--resource_key <value>
--resource_info <value>
--name <value>
--endpoint_ip_address <value>
[--description <value>]
[--tags <value>]

Description

Create VPC Endpoint.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
resource_type
required
stringVPC Endpoint Resource TypeFS
resource_key
required
stringVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_info
required
stringVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
name
required
stringVPC Endpoint NameVpcEndpointName
endpoint_ip_address
required
stringVPC Endpoint IP Address192.167.0.5
description
optional
stringDescriptionVpcEndpoint Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionVpcEndpoint Description
endpoint_ip_addressVPC Endpoint IP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint NameVpcEndpointName
resource_infoVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
resource_keyVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_typeVPC Endpoint Resource TypeFS
stateVPC Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.24.3 - 1.1

scp-cli vpc vpc-endpoint create
--vpc_id <value>
--subnet_id <value>
--resource_type <value>
--resource_key <value>
--resource_info <value>
--name <value>
--endpoint_ip_address <value>
[--description <value>]
[--tags <value>]

Description

Create VPC Endpoint.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
resource_type
required
stringVPC Endpoint Resource TypeFS
resource_key
required
stringVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_info
required
stringVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
name
required
stringVPC Endpoint NameVpcEndpointName
endpoint_ip_address
required
stringVPC Endpoint IP Address192.167.0.5
description
optional
stringDescriptionVpcEndpoint Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionVpcEndpoint Description
endpoint_ip_addressVPC Endpoint IP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint NameVpcEndpointName
resource_infoVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
resource_keyVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_typeVPC Endpoint Resource TypeFS
stateVPC Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.24.4 - 1.0

scp-cli vpc vpc-endpoint create
--vpc_id <value>
--subnet_id <value>
--resource_type <value>
--resource_key <value>
--resource_info <value>
--name <value>
--endpoint_ip_address <value>
[--description <value>]
[--tags <value>]

Description

Create VPC Endpoint.

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

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
resource_type
required
stringVPC Endpoint Resource TypeFS
resource_key
required
stringVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_info
required
stringVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
name
required
stringVPC Endpoint NameVpcEndpointName
endpoint_ip_address
required
stringVPC Endpoint IP Address192.167.0.5
description
optional
stringDescriptionVpcEndpoint Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionVpcEndpoint Description
endpoint_ip_addressVPC Endpoint IP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint NameVpcEndpointName
resource_infoVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
resource_keyVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_typeVPC Endpoint Resource TypeFS
stateVPC Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.25 - Create VPC Peering

8.1.25.1 - 1.3

scp-cli vpc vpc-peering create
--requester_vpc_id <value>
--name <value>
--approver_vpc_id <value>
--approver_vpc_account_id <value>
[--description <value>]
[--tags <value>]

Description

Create VPC Peering.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
requester_vpc_id
required
stringRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
name
required
stringVPC Peering NamevpcPeeringName
approver_vpc_id
required
stringApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_account_id
required
stringApprover VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
description
optional
stringDescriptionvpcPeering Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Peering ID023c57b14f11483689338d085e061492
account_typeAccount Type
approver_vpc_account_idApprover VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
approver_vpc_idApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_nameApprover VPC NamevpcName
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
descriptionVPC Peering DescriptionvpcPeering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering NamevpcPeeringName
requester_vpc_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
requester_vpc_idRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
requester_vpc_nameRequester VPC NamevpcName
stateState

8.1.25.2 - 1.2

scp-cli vpc vpc-peering create
--requester_vpc_id <value>
--name <value>
--approver_vpc_id <value>
--approver_vpc_account_id <value>
[--description <value>]
[--tags <value>]

Description

Create VPC Peering.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
requester_vpc_id
required
stringRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
name
required
stringVPC Peering NamevpcPeeringName
approver_vpc_id
required
stringApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_account_id
required
stringApprover VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
description
optional
stringDescriptionvpcPeering Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Peering ID023c57b14f11483689338d085e061492
account_typeAccount Type
approver_vpc_account_idApprover VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
approver_vpc_idApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_nameApprover VPC NamevpcName
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
descriptionVPC Peering DescriptionvpcPeering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering NamevpcPeeringName
requester_vpc_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
requester_vpc_idRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
requester_vpc_nameRequester VPC NamevpcName
stateState

8.1.25.3 - 1.1

scp-cli vpc vpc-peering create
--requester_vpc_id <value>
--name <value>
--approver_vpc_id <value>
--approver_vpc_account_id <value>
[--description <value>]
[--tags <value>]

Description

Create VPC Peering.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
requester_vpc_id
required
stringRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
name
required
stringVPC Peering NamevpcPeeringName
approver_vpc_id
required
stringApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_account_id
required
stringApprover VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
description
optional
stringDescriptionvpcPeering Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Peering ID023c57b14f11483689338d085e061492
account_typeAccount Type
approver_vpc_account_idApprover VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
approver_vpc_idApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_nameApprover VPC NamevpcName
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
descriptionVPC Peering DescriptionvpcPeering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering NamevpcPeeringName
requester_vpc_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
requester_vpc_idRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
requester_vpc_nameRequester VPC NamevpcName
stateState

8.1.25.4 - 1.0

scp-cli vpc vpc-peering create
--requester_vpc_id <value>
--name <value>
--approver_vpc_id <value>
--approver_vpc_account_id <value>
[--description <value>]
[--tags <value>]

Description

Create VPC Peering.

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

Parameters

NameTypeDescriptionExample
requester_vpc_id
required
stringRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
name
required
stringVPC Peering NamevpcPeeringName
approver_vpc_id
required
stringApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_account_id
required
stringApprover VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
description
optional
stringDescriptionvpcPeering Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Peering ID023c57b14f11483689338d085e061492
account_typeAccount Type
approver_vpc_account_idApprover VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
approver_vpc_idApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_nameApprover VPC NamevpcName
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
descriptionVPC Peering DescriptionvpcPeering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering NamevpcPeeringName
requester_vpc_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
requester_vpc_idRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
requester_vpc_nameRequester VPC NamevpcName
stateState

8.1.26 - Create Vpc Peering Rule

8.1.26.1 - 1.3

scp-cli vpc vpc-peering-routing-rule create
--vpc_peering_id <value>
--destination_vpc_type <value>
--destination_cidr <value>
[--tags <value>]

Description

Create a VPC Peering Rule.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492
destination_vpc_type
required
stringDestination VPC Type-
destination_cidr
required
stringDestination CIDR-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Peering Rule ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
destination_cidrDestination CIDR
destination_vpc_idDestination VPC ID
destination_vpc_nameDestination VPC Name
destination_vpc_typeDestination VPC Type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
source_vpc_idSource VPC ID
source_vpc_nameSource VPC Name
source_vpc_typeSource VPC Type
stateState
vpc_peering_idVPC Peering ID

8.1.26.2 - 1.2

scp-cli vpc vpc-peering-routing-rule create
--vpc_peering_id <value>
--destination_vpc_type <value>
--destination_cidr <value>
[--tags <value>]

Description

Create a VPC Peering Rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492
destination_vpc_type
required
stringDestination VPC Type-
destination_cidr
required
stringDestination CIDR-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Peering Rule ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
destination_cidrDestination CIDR
destination_vpc_idDestination VPC ID
destination_vpc_nameDestination VPC Name
destination_vpc_typeDestination VPC Type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
source_vpc_idSource VPC ID
source_vpc_nameSource VPC Name
source_vpc_typeSource VPC Type
stateState
vpc_peering_idVPC Peering ID

8.1.26.3 - 1.1

scp-cli vpc vpc-peering-routing-rule create
--vpc_peering_id <value>
--destination_vpc_type <value>
--destination_cidr <value>
[--tags <value>]

Description

Create a VPC Peering Rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492
destination_vpc_type
required
stringDestination VPC Type-
destination_cidr
required
stringDestination CIDR-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Peering Rule ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
destination_cidrDestination CIDR
destination_vpc_idDestination VPC ID
destination_vpc_nameDestination VPC Name
destination_vpc_typeDestination VPC Type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
source_vpc_idSource VPC ID
source_vpc_nameSource VPC Name
source_vpc_typeSource VPC Type
stateState
vpc_peering_idVPC Peering ID

8.1.26.4 - 1.0

scp-cli vpc vpc-peering-routing-rule create
--vpc_peering_id <value>
--destination_vpc_type <value>
--destination_cidr <value>
[--tags <value>]

Description

Create a VPC Peering Rule.

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

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492
destination_vpc_type
required
stringDestination VPC Type-
destination_cidr
required
stringDestination CIDR-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Peering Rule ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
destination_cidrDestination CIDR
destination_vpc_idDestination VPC ID
destination_vpc_nameDestination VPC Name
destination_vpc_typeDestination VPC Type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
source_vpc_idSource VPC ID
source_vpc_nameSource VPC Name
source_vpc_typeSource VPC Type
stateState
vpc_peering_idVPC Peering ID

8.1.27 - Delete Internet Gateway

8.1.27.1 - 1.3

scp-cli vpc internet-gateway delete
--internet_gateway_id <value>

Description

Delete Internet Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID023c57b14f11483689338d085e061492

8.1.27.2 - 1.2

scp-cli vpc internet-gateway delete
--internet_gateway_id <value>

Description

Delete Internet Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID023c57b14f11483689338d085e061492

8.1.27.3 - 1.1

scp-cli vpc internet-gateway delete
--internet_gateway_id <value>

Description

Delete Internet Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID023c57b14f11483689338d085e061492

8.1.27.4 - 1.0

scp-cli vpc internet-gateway delete
--internet_gateway_id <value>

Description

Delete Internet Gateway.

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

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID023c57b14f11483689338d085e061492

8.1.28 - Delete NAT Gateway

8.1.28.1 - 1.3

scp-cli vpc nat-gateway delete
--nat_gateway_id <value>

Description

Delete NAT Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID12f56e27070248a6a240a497e43fbe18

8.1.28.2 - 1.2

scp-cli vpc nat-gateway delete
--nat_gateway_id <value>

Description

Delete NAT Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID12f56e27070248a6a240a497e43fbe18

8.1.28.3 - 1.1

scp-cli vpc nat-gateway delete
--nat_gateway_id <value>

Description

Delete NAT Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID12f56e27070248a6a240a497e43fbe18

8.1.28.4 - 1.0

scp-cli vpc nat-gateway delete
--nat_gateway_id <value>

Description

Delete NAT Gateway.

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

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID12f56e27070248a6a240a497e43fbe18

8.1.29 - Delete Port

8.1.29.1 - 1.3

scp-cli vpc port delete
--port_id <value>

Description

Delete port.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID023c57b1-4f11-4836-8933-8d085e061492

8.1.29.2 - 1.2

scp-cli vpc port delete
--port_id <value>

Description

Delete port.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID023c57b1-4f11-4836-8933-8d085e061492

8.1.29.3 - 1.1

scp-cli vpc port delete
--port_id <value>

Description

Delete port.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID023c57b1-4f11-4836-8933-8d085e061492

8.1.29.4 - 1.0

scp-cli vpc port delete
--port_id <value>

Description

Delete port.

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

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID023c57b1-4f11-4836-8933-8d085e061492

8.1.30 - Delete Private NAT

8.1.30.1 - 1.3

scp-cli vpc private-nat delete
--private_nat_id <value>

Description

Delete Private NAT.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18

8.1.30.2 - 1.2

scp-cli vpc private-nat delete
--private_nat_id <value>

Description

Delete Private NAT.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18

8.1.30.3 - 1.1

scp-cli vpc private-nat delete
--private_nat_id <value>

Description

Delete Private NAT.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18

8.1.30.4 - 1.0

scp-cli vpc private-nat delete
--private_nat_id <value>

Description

Delete Private NAT.

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

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18

8.1.31 - Delete Private NAT IP

8.1.31.1 - 1.3

scp-cli vpc private-nat-ip delete
--private_nat_ip_id <value>
--private_nat_id <value>

Description

Delete Private NAT IP.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
private_nat_ip_id
required
stringPrivate NAT IP ID-
private_nat_id
required
stringPrivate NAT ID-

8.1.31.2 - 1.2

scp-cli vpc private-nat-ip delete
--private_nat_ip_id <value>
--private_nat_id <value>

Description

Delete Private NAT IP.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
private_nat_ip_id
required
stringPrivate NAT IP ID-
private_nat_id
required
stringPrivate NAT ID-

8.1.31.3 - 1.1

scp-cli vpc private-nat-ip delete
--private_nat_ip_id <value>
--private_nat_id <value>

Description

Delete Private NAT IP.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
private_nat_ip_id
required
stringPrivate NAT IP ID-
private_nat_id
required
stringPrivate NAT ID-

8.1.31.4 - 1.0

scp-cli vpc private-nat-ip delete
--private_nat_ip_id <value>
--private_nat_id <value>

Description

Delete Private NAT IP.

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

Parameters

NameTypeDescriptionExample
private_nat_ip_id
required
stringPrivate NAT IP ID-
private_nat_id
required
stringPrivate NAT ID-

8.1.32 - Delete PrivateLink Endpoint

8.1.32.1 - 1.3

scp-cli vpc privatelink-endpoint delete
--privatelink_endpoint_id <value>

Description

Delete PrivateLink Endpoint.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02

8.1.32.2 - 1.2

scp-cli vpc privatelink-endpoint delete
--privatelink_endpoint_id <value>

Description

Delete PrivateLink Endpoint.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02

8.1.32.3 - 1.1

scp-cli vpc privatelink-endpoint delete
--privatelink_endpoint_id <value>

Description

Delete PrivateLink Endpoint.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02

8.1.33 - Delete PrivateLink Service

8.1.33.1 - 1.3

scp-cli vpc privatelink-service delete
--privatelink_service_id <value>

Description

Delete PrivateLink Service.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d

8.1.33.2 - 1.2

scp-cli vpc privatelink-service delete
--privatelink_service_id <value>

Description

Delete PrivateLink Service.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d

8.1.33.3 - 1.1

scp-cli vpc privatelink-service delete
--privatelink_service_id <value>

Description

Delete PrivateLink Service.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d

8.1.34 - Delete PublicIP

8.1.34.1 - 1.3

scp-cli vpc public-ip delete
--publicip_id <value>

Description

Delete PublicIP.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID12f56e27070248a6a240a497e43fbe18

8.1.34.2 - 1.2

scp-cli vpc public-ip delete
--publicip_id <value>

Description

Delete PublicIP.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID12f56e27070248a6a240a497e43fbe18

8.1.34.3 - 1.1

scp-cli vpc public-ip delete
--publicip_id <value>

Description

Delete PublicIP.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID12f56e27070248a6a240a497e43fbe18

8.1.34.4 - 1.0

scp-cli vpc public-ip delete
--publicip_id <value>

Description

Delete PublicIP.

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

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID12f56e27070248a6a240a497e43fbe18

8.1.35 - Delete Subnet

8.1.35.1 - 1.3

scp-cli vpc subnet delete
--subnet_id <value>

Description

Delete subnet.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492

8.1.35.2 - 1.2

scp-cli vpc subnet delete
--subnet_id <value>

Description

Delete subnet.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492

8.1.35.3 - 1.1

scp-cli vpc subnet delete
--subnet_id <value>

Description

Delete subnet.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492

8.1.35.4 - 1.0

scp-cli vpc subnet delete
--subnet_id <value>

Description

Delete subnet.

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

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492

8.1.36 - Delete Subnet Vip

8.1.36.1 - 1.3

scp-cli vpc subnet vip delete
--vip_id <value>
--subnet_id <value>

Description

Delete Subnet Vip

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
vip_id
required
stringSubnet Vip Id0466a9448d9a4411a86055939e451c8f
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492

8.1.36.2 - 1.2

scp-cli vpc subnet vip delete
--vip_id <value>
--subnet_id <value>

Description

Delete Subnet Vip

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
vip_id
required
stringSubnet Vip Id0466a9448d9a4411a86055939e451c8f
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492

8.1.37 - Delete Subnet Vip Connected Port

8.1.37.1 - 1.3

scp-cli vpc subnet vip port delete 
--connected_port_id <value>
--vip_id <value>
--subnet_id <value>

Description

Delete Subnet Vip Connected Port

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
connected_port_id
required
stringSubnet Vip Connected Port Id13e2a5a1acbe4713a9a2c70ce226e822
vip_id
required
stringSubnet Vip Id0466a9448d9a4411a86055939e451c8f
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492

8.1.37.2 - 1.2

scp-cli vpc subnet vip port delete 
--connected_port_id <value>
--vip_id <value>
--subnet_id <value>

Description

Delete Subnet Vip Connected Port

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
connected_port_id
required
stringSubnet Vip Connected Port Id13e2a5a1acbe4713a9a2c70ce226e822
vip_id
required
stringSubnet Vip Id0466a9448d9a4411a86055939e451c8f
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492

8.1.38 - Delete Subnet VIP NAT IP

8.1.38.1 - 1.3

scp-cli vpc subnet vip nat delete
--static_nat_id <value>
--vip_id <value>
--subnet_id <value>

Description

Delete Subnet Vip Nat Ip

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
static_nat_id
required
stringStatic NAT ID0009e49548154745948e9722adefbf40
vip_id
required
stringSubnet Vip Id0466a9448d9a4411a86055939e451c8f
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492

8.1.38.2 - 1.2

scp-cli vpc subnet vip nat delete
--static_nat_id <value>
--vip_id <value>
--subnet_id <value>

Description

Delete Subnet Vip Nat Ip

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
static_nat_id
required
stringStatic NAT ID0009e49548154745948e9722adefbf40
vip_id
required
stringSubnet Vip Id0466a9448d9a4411a86055939e451c8f
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492

8.1.39 - Delete Transit Gateway

8.1.39.1 - 1.3

scp-cli vpc transit-gateway delete
--transit_gateway_id <value>

Description

Delete Transit Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

8.1.39.2 - 1.2

scp-cli vpc transit-gateway delete
--transit_gateway_id <value>

Description

Delete Transit Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

8.1.39.3 - 1.1

scp-cli vpc transit-gateway delete
--transit_gateway_id <value>

Description

Delete Transit Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

8.1.39.4 - 1.0

scp-cli vpc transit-gateway delete
--transit_gateway_id <value>

Description

Delete Transit Gateway.

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

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

8.1.40 - Delete Transit Gateway Firewall

8.1.40.1 - 1.3

scp-cli vpc transit-gateway-firewall-delete
--firewall_id <value>
--transit_gateway_id <value>

Description

Delete Transit Gateway Firewall.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
firewall_id
required
stringFirewall IDbbb93aca123f4bb2b2c0f206f4a86b2b
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

8.1.40.2 - 1.2

scp-cli vpc transit-gateway-firewall-delete
--firewall_id <value>
--transit_gateway_id <value>

Description

Delete Transit Gateway Firewall.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
firewall_id
required
stringFirewall IDbbb93aca123f4bb2b2c0f206f4a86b2b
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

8.1.41 - Delete Transit Gateway Firewall Connection

8.1.41.1 - 1.3

scp-cli vpc transit-gateway-firewall-connection delete
--transit_gateway_id <value>

Description

Delete Transit Gateway Firewall Connection.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

8.1.41.2 - 1.2

scp-cli vpc transit-gateway-firewall-connection delete
--transit_gateway_id <value>

Description

Delete Transit Gateway Firewall Connection.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

8.1.42 - Delete Transit Gateway Rule

8.1.42.1 - 1.3

scp-cli vpc transit-gateway-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>

Description

Delete Transit Gateway Rule.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

8.1.42.2 - 1.2

scp-cli vpc transit-gateway-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>

Description

Delete Transit Gateway Rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

8.1.42.3 - 1.1

scp-cli vpc transit-gateway-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>

Description

Delete Transit Gateway Rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

8.1.42.4 - 1.0

scp-cli vpc transit-gateway-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>

Description

Delete Transit Gateway Rule.

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

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

8.1.43 - Delete Transit Gateway Uplink Rule

8.1.43.1 - 1.3

scp-cli vpc transit-gateway-uplink-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>

Description

Delete Transit Gateway Uplink Rule.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

8.1.43.2 - 1.2

scp-cli vpc transit-gateway-uplink-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>

Description

Delete Transit Gateway Uplink Rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

8.1.43.3 - 1.1

scp-cli vpc transit-gateway-uplink-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>

Description

Delete Transit Gateway Uplink Rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

8.1.43.4 - 1.0

scp-cli vpc transit-gateway-uplink-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>

Description

Delete Transit Gateway Uplink Rule.

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

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

8.1.44 - Delete Transit Gateway VPC Connection

8.1.44.1 - 1.3

scp-cli vpc transit-gateway-vpc-connection delete
--vpc_connection_id <value>
--transit_gateway_id <value>

Description

Delete Transit Gateway VPC Connection.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
vpc_connection_id
required
stringTransit Gateway VPC Connection IDffeced8e191c478eabd66b6e2cab8e34
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

8.1.44.2 - 1.2

scp-cli vpc transit-gateway-vpc-connection delete
--vpc_connection_id <value>
--transit_gateway_id <value>

Description

Delete Transit Gateway VPC Connection.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
vpc_connection_id
required
stringTransit Gateway VPC Connection IDffeced8e191c478eabd66b6e2cab8e34
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

8.1.44.3 - 1.1

scp-cli vpc transit-gateway-vpc-connection delete
--vpc_connection_id <value>
--transit_gateway_id <value>

Description

Delete Transit Gateway VPC Connection.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
vpc_connection_id
required
stringTransit Gateway VPC Connection IDffeced8e191c478eabd66b6e2cab8e34
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

8.1.44.4 - 1.0

scp-cli vpc transit-gateway-vpc-connection delete
--vpc_connection_id <value>
--transit_gateway_id <value>

Description

Delete Transit Gateway VPC Connection.

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

Parameters

NameTypeDescriptionExample
vpc_connection_id
required
stringTransit Gateway VPC Connection IDffeced8e191c478eabd66b6e2cab8e34
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

8.1.45 - Delete VPC

8.1.45.1 - 1.3

scp-cli vpc vpc delete
--vpc_id <value>

Description

Delete VPC.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-

8.1.45.2 - 1.2

scp-cli vpc vpc delete
--vpc_id <value>

Description

Delete VPC.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-

8.1.45.3 - 1.1

scp-cli vpc vpc delete
--vpc_id <value>

Description

Delete VPC.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-

8.1.45.4 - 1.0

scp-cli vpc vpc delete
--vpc_id <value>

Description

Delete VPC.

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

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-

8.1.46 - Delete VPC Endpoint

8.1.46.1 - 1.3

scp-cli vpc vpc-endpoint delete
--vpc_endpoint_id <value>

Description

Delete VPC Endpoint.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID12f56e27070248a6a240a497e43fbe18

8.1.46.2 - 1.2

scp-cli vpc vpc-endpoint delete
--vpc_endpoint_id <value>

Description

Delete VPC Endpoint.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID12f56e27070248a6a240a497e43fbe18

8.1.46.3 - 1.1

scp-cli vpc vpc-endpoint delete
--vpc_endpoint_id <value>

Description

Delete VPC Endpoint.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID12f56e27070248a6a240a497e43fbe18

8.1.46.4 - 1.0

scp-cli vpc vpc-endpoint delete
--vpc_endpoint_id <value>

Description

Delete VPC Endpoint.

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

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID12f56e27070248a6a240a497e43fbe18

8.1.47 - Delete VPC Peering

8.1.47.1 - 1.3

scp-cli vpc vpc-peering delete
--vpc_peering_id <value>

Description

Delete VPC Peering.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492

8.1.47.2 - 1.2

scp-cli vpc vpc-peering delete
--vpc_peering_id <value>

Description

Delete VPC Peering.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492

8.1.47.3 - 1.1

scp-cli vpc vpc-peering delete
--vpc_peering_id <value>

Description

Delete VPC Peering.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492

8.1.47.4 - 1.0

scp-cli vpc vpc-peering delete
--vpc_peering_id <value>

Description

Delete VPC Peering.

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

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492

8.1.48 - Delete VPC Peering Rule

8.1.48.1 - 1.3

scp-cli vpc vpc-peering-rule delete
--routing_rule_id <value>
--vpc_peering_id <value>

Description

Delete a VPC Peering Rule.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule ID-
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492

8.1.48.2 - 1.2

scp-cli vpc vpc-peering-rule delete
--routing_rule_id <value>
--vpc_peering_id <value>

Description

Delete a VPC Peering Rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule ID-
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492

8.1.48.3 - 1.1

scp-cli vpc vpc-peering-rule delete
--routing_rule_id <value>
--vpc_peering_id <value>

Description

Delete a VPC Peering Rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule ID-
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492

8.1.48.4 - 1.0

scp-cli vpc vpc-peering-rule delete
--routing_rule_id <value>
--vpc_peering_id <value>

Description

Delete a VPC Peering Rule.

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

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule ID-
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492

8.1.49 - List Connected PrivateLink Endpoints

8.1.49.1 - 1.3

scp-cli vpc privatelink-service-connected-endpoint list
--privatelink_service_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

Get Connected PrivateLink Endpoint List.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
privatelink_service_idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
statePrivateLink Endpoint StateACTIVE

8.1.49.2 - 1.2

scp-cli vpc privatelink-service-connected-endpoint list
--privatelink_service_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

Get Connected PrivateLink Endpoint List.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
privatelink_service_idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
statePrivateLink Endpoint StateACTIVE

8.1.49.3 - 1.1

scp-cli vpc privatelink-service-connected-endpoint list
--privatelink_service_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

Get Connected PrivateLink Endpoint List.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
privatelink_service_idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
statePrivateLink Endpoint StateACTIVE

8.1.50 - List Internet Gateways

8.1.50.1 - 1.3

scp-cli vpc internet-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]

Description

Get Internet Gateway list.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringInternet Gateway ID023c57b14f11483689338d085e061492
name
optional
stringInternet Gateway NameIGW_VPCname
type
optional
****Internet Gateway Type-
state
optional
stringState-
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName

Responses

NameDescriptionExample
idInternet Gateway ID023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionInternet Gateway Description
firewall_idFirewall IDb156740b6335468d8354eb9ef8eddf5a
loggableNAT LoggableFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
multi_zone_enabledMulti Zone EnabledTrue
nameInternet Gateway NameIGW_VPCname
stateState
typeInternet Gateway Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.50.2 - 1.2

scp-cli vpc internet-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]

Description

Get Internet Gateway list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringInternet Gateway ID023c57b14f11483689338d085e061492
name
optional
stringInternet Gateway NameIGW_VPCname
type
optional
****Internet Gateway Type-
state
optional
stringState-
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName

Responses

NameDescriptionExample
idInternet Gateway ID023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionInternet Gateway Description
firewall_idFirewall IDb156740b6335468d8354eb9ef8eddf5a
loggableNAT LoggableFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway NameIGW_VPCname
stateState
typeInternet Gateway Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.50.3 - 1.1

scp-cli vpc internet-gateway list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]

Description

Get Internet Gateway list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringInternet Gateway ID023c57b14f11483689338d085e061492
name
optional
stringInternet Gateway NameIGW_VPCname
type
optional
****Internet Gateway Type-
state
optional
stringState-
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName

Responses

NameDescriptionExample
idInternet Gateway ID023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionInternet Gateway Description
firewall_idFirewall IDb156740b6335468d8354eb9ef8eddf5a
loggableNAT LoggableFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway NameIGW_VPCname
stateState
typeInternet Gateway Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.50.4 - 1.0

scp-cli vpc internet-gateway list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]

Description

Get Internet Gateway 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.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringInternet Gateway ID023c57b14f11483689338d085e061492
name
optional
stringInternet Gateway NameIGW_VPCname
type
optional
****Internet Gateway Type-
state
optional
stringState-
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName

Responses

NameDescriptionExample
idInternet Gateway ID023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionInternet Gateway Description
firewall_idFirewall IDb156740b6335468d8354eb9ef8eddf5a
loggableNAT LoggableFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway NameIGW_VPCname
stateState
typeInternet Gateway Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.51 - List NAT Gateways

8.1.51.1 - 1.3

scp-cli vpc nat-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--subnet_id <value>]
[--subnet_name <value>]
[--nat_gateway_ip_address <value>]
[--state <value>]
[--multi_zone_enabled <value>]

Description

Get NAT Gateway list.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringNAT Gateway NameNatGatewayName
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName
subnet_id
optional
stringSubnet Id023c57b14f11483689338d085e061492
subnet_name
optional
stringSubnet NamesubnetName
nat_gateway_ip_address
optional
stringNAT Gateway IP Address192.167.0.5
state
optional
****NAT Gateway StateACTIVE
multi_zone_enabled
optional
booleanMulti Zone Usetrue

Responses

NameDescriptionExample
idNAT Gateway ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway DescriptionVpcEndpoint Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
multi_zone_enabledMulti Zone Usetrue
nameNAT Gateway NameNatGatewayName
nat_gateway_ipsNAT Gateway IPs
stateNAT Gateway StateACTIVE
subnet_cidrSubnet Cidr192.167.1.0/24
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.51.2 - 1.2

scp-cli vpc nat-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--subnet_id <value>]
[--subnet_name <value>]
[--nat_gateway_ip_address <value>]
[--state <value>]

Description

Get NAT Gateway list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringNAT Gateway NameNatGatewayName
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName
subnet_id
optional
stringSubnet Id023c57b14f11483689338d085e061492
subnet_name
optional
stringSubnet NamesubnetName
nat_gateway_ip_address
optional
stringNAT Gateway IP Address192.167.0.5
state
optional
****NAT Gateway StateACTIVE

Responses

NameDescriptionExample
idNAT Gateway ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway DescriptionVpcEndpoint Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway NameNatGatewayName
nat_gateway_ip_addressNAT Gateway IP Address192.167.0.5
publicip_idPublicIP ID12f56e27070248a6a240a497e43fbe18
stateNAT Gateway StateACTIVE
subnet_cidrSubnet Cidr192.167.1.0/24
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.51.3 - 1.1

scp-cli vpc nat-gateway list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--name <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--subnet_id <value>]
[--subnet_name <value>]
[--nat_gateway_ip_address <value>]
[--state <value>]

Description

Get NAT Gateway list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
name
optional
stringNAT Gateway NameNatGatewayName
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName
subnet_id
optional
stringSubnet Id023c57b14f11483689338d085e061492
subnet_name
optional
stringSubnet NamesubnetName
nat_gateway_ip_address
optional
stringNAT Gateway IP Address192.167.0.5
state
optional
****NAT Gateway StateACTIVE

Responses

NameDescriptionExample
idNAT Gateway ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway DescriptionVpcEndpoint Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway NameNatGatewayName
nat_gateway_ip_addressNAT Gateway IP Address192.167.0.5
publicip_idPublicIP ID12f56e27070248a6a240a497e43fbe18
stateNAT Gateway StateACTIVE
subnet_cidrSubnet Cidr192.167.1.0/24
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.51.4 - 1.0

scp-cli vpc nat-gateway list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--name <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--subnet_id <value>]
[--subnet_name <value>]
[--nat_gateway_ip_address <value>]
[--state <value>]

Description

Get NAT Gateway 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.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
name
optional
stringNAT Gateway NameNatGatewayName
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName
subnet_id
optional
stringSubnet Id023c57b14f11483689338d085e061492
subnet_name
optional
stringSubnet NamesubnetName
nat_gateway_ip_address
optional
stringNAT Gateway IP Address192.167.0.5
state
optional
****NAT Gateway StateACTIVE

Responses

NameDescriptionExample
idNAT Gateway ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway DescriptionVpcEndpoint Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway NameNatGatewayName
nat_gateway_ip_addressNAT Gateway IP Address192.167.0.5
publicip_idPublicIP ID12f56e27070248a6a240a497e43fbe18
stateNAT Gateway StateACTIVE
subnet_cidrSubnet Cidr192.167.1.0/24
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.52 - List Ports

8.1.52.1 - 1.3

scp-cli vpc port list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--name <value>]
[--subnet_id <value>]
[--subnet_name <value>]
[--id <value>]
[--attached_resource_id <value>]
[--fixed_ip_address <value>]
[--mac_address <value>]
[--state <value>]
[--security_groups <value>]
[--attached_resource_types <value>]

Description

Get port list.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerPort Limit-
marker
optional
stringPort Marker-
sort
optional
stringPort Sort-
name
optional
stringPort NameportName
subnet_id
optional
stringSubnet Id023c57b14f11483689338d085e061492
subnet_name
optional
stringSubnet NamesubnetName
id
optional
stringPort ID023c57b1-4f11-4836-8933-8d085e061492
attached_resource_id
optional
stringConnected resource ID9387e8f51de04a03994de8a9c3524935
fixed_ip_address
optional
stringFixed IP192.168.1.100
mac_address
optional
stringMAC Addressfa:16:3e:00:00:01
state
optional
stringState-
security_groups
optional
stringSecurity Group List-
attached_resource_types
optional
****Attached Resource Type-

Responses

NameDescriptionExample
idPort ID023c57b1-4f11-4836-8933-8d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idConnected resource ID9387e8f51de04a03994de8a9c3524935
attached_resource_typeConnected resource Type
created_atCreated date
descriptionDescriptionPort Description
fixed_ip_addressFixed IP192.168.1.100
mac_addressMAC Addressfa:16:3e:00:00:01
modified_atModified date
namePort NameportName
stateState
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id071bc63b767444c9afaab1c972d302d5
vpc_nameVPC NamevpcName

8.1.52.2 - 1.2

scp-cli vpc port list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--name <value>]
[--subnet_id <value>]
[--subnet_name <value>]
[--id <value>]
[--attached_resource_id <value>]
[--fixed_ip_address <value>]
[--mac_address <value>]
[--state <value>]
[--security_groups <value>]
[--attached_resource_types <value>]

Description

Get port list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerPort Limit-
marker
optional
stringPort Marker-
sort
optional
stringPort Sort-
name
optional
stringPort NameportName
subnet_id
optional
stringSubnet Id023c57b14f11483689338d085e061492
subnet_name
optional
stringSubnet NamesubnetName
id
optional
stringPort ID023c57b1-4f11-4836-8933-8d085e061492
attached_resource_id
optional
stringConnected resource ID9387e8f51de04a03994de8a9c3524935
fixed_ip_address
optional
stringFixed IP192.168.1.100
mac_address
optional
stringMAC Addressfa:16:3e:00:00:01
state
optional
stringState-
security_groups
optional
stringSecurity Group List-
attached_resource_types
optional
****Attached Resource Type-

Responses

NameDescriptionExample
idPort ID023c57b1-4f11-4836-8933-8d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idConnected resource ID9387e8f51de04a03994de8a9c3524935
attached_resource_typeConnected resource Type
created_atCreated date
descriptionDescriptionPort Description
fixed_ip_addressFixed IP192.168.1.100
mac_addressMAC Addressfa:16:3e:00:00:01
modified_atModified date
namePort NameportName
stateState
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id071bc63b767444c9afaab1c972d302d5
vpc_nameVPC NamevpcName

8.1.52.3 - 1.1

scp-cli vpc port list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--name <value>]
[--subnet_id <value>]
[--subnet_name <value>]
[--id <value>]
[--attached_resource_id <value>]
[--fixed_ip_address <value>]
[--mac_address <value>]
[--state <value>]
[--security_groups <value>]
[--attached_resource_types <value>]

Description

Get port list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerPort Limit-
marker
optional
stringPort Marker-
sort
optional
stringPort Sort-
name
optional
stringPort NameportName
subnet_id
optional
stringSubnet Id023c57b14f11483689338d085e061492
subnet_name
optional
stringSubnet NamesubnetName
id
optional
stringPort ID023c57b1-4f11-4836-8933-8d085e061492
attached_resource_id
optional
stringConnected resource ID9387e8f51de04a03994de8a9c3524935
fixed_ip_address
optional
stringFixed IP192.168.1.100
mac_address
optional
stringMAC Addressfa:16:3e:00:00:01
state
optional
stringState-
security_groups
optional
stringSecurity Group List-
attached_resource_types
optional
****Attached Resource Type-

Responses

NameDescriptionExample
idPort ID023c57b1-4f11-4836-8933-8d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idConnected resource ID9387e8f51de04a03994de8a9c3524935
attached_resource_typeConnected resource Type
created_atCreated date
descriptionDescriptionPort Description
fixed_ip_addressFixed IP192.168.1.100
mac_addressMAC Addressfa:16:3e:00:00:01
modified_atModified date
namePort NameportName
stateState
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id071bc63b767444c9afaab1c972d302d5
vpc_nameVPC NamevpcName

8.1.52.4 - 1.0

scp-cli vpc port list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--name <value>]
[--subnet_id <value>]
[--subnet_name <value>]
[--id <value>]
[--attached_resource_id <value>]
[--fixed_ip_address <value>]
[--mac_address <value>]
[--state <value>]
[--security_groups <value>]
[--attached_resource_types <value>]

Description

Get port 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.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerPort Limit-
marker
optional
stringPort Marker-
sort
optional
stringPort Sort-
name
optional
stringPort NameportName
subnet_id
optional
stringSubnet Id023c57b14f11483689338d085e061492
subnet_name
optional
stringSubnet NamesubnetName
id
optional
stringPort ID023c57b1-4f11-4836-8933-8d085e061492
attached_resource_id
optional
stringConnected resource ID9387e8f51de04a03994de8a9c3524935
fixed_ip_address
optional
stringFixed IP192.168.1.100
mac_address
optional
stringMAC Addressfa:16:3e:00:00:01
state
optional
stringState-
security_groups
optional
stringSecurity Group List-
attached_resource_types
optional
****Attached Resource Type-

Responses

NameDescriptionExample
idPort ID023c57b1-4f11-4836-8933-8d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idConnected resource ID9387e8f51de04a03994de8a9c3524935
attached_resource_typeConnected resource Type
created_atCreated date
descriptionDescriptionPort Description
fixed_ip_addressFixed IP192.168.1.100
mac_addressMAC Addressfa:16:3e:00:00:01
modified_atModified date
namePort NameportName
stateState
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id071bc63b767444c9afaab1c972d302d5
vpc_nameVPC NamevpcName

8.1.53 - List Private NAT

8.1.53.1 - 1.3

scp-cli vpc private-nat list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--cidr <value>]
[--vpc_id <value>]
[--service_resource_id <value>]
[--service_type <value>]
[--service_resource_name <value>]
[--state <value>]

Description

Get Private NAT list.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringPrivate NAT NamePrivateNatName
cidr
optional
stringPrivate NAT IP range192.167.0.0/24
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
service_resource_id
optional
stringPrivate NAT connected Service Resource ID3f342bf9a557405b997c2cf48c89cbc2
service_type
optional
****Private NAT connected Service TypeDIRECT_CONNECT
service_resource_name
optional
stringPrivate NAT connected Service Resource NameService Resource Name
state
optional
****Private NAT StateACTIVE

Responses

NameDescriptionExample
idPrivate NAT ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrPrivate NAT IP range192.167.0.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateNat Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT NamePrivateNatName
service_resource_idPrivate NAT connected Service Resource ID3f342bf9a557405b997c2cf48c89cbc2
service_resource_namePrivate NAT connected Service Resource NamePrivateNatName
service_typePrivate NAT connected Service TypeDIRECT_CONNECT
statePrivate NAT StateACTIVE

8.1.53.2 - 1.2

scp-cli vpc private-nat list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--cidr <value>]
[--vpc_id <value>]
[--service_resource_id <value>]
[--service_type <value>]
[--service_resource_name <value>]
[--state <value>]

Description

Get Private NAT list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringPrivate NAT NamePrivateNatName
cidr
optional
stringPrivate NAT IP range192.167.0.0/24
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
service_resource_id
optional
stringPrivate NAT connected Service Resource ID3f342bf9a557405b997c2cf48c89cbc2
service_type
optional
****Private NAT connected Service TypeDIRECT_CONNECT
service_resource_name
optional
stringPrivate NAT connected Service Resource NameService Resource Name
state
optional
****Private NAT StateACTIVE

Responses

NameDescriptionExample
idPrivate NAT ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrPrivate NAT IP range192.167.0.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateNat Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT NamePrivateNatName
service_resource_idPrivate NAT connected Service Resource ID3f342bf9a557405b997c2cf48c89cbc2
service_resource_namePrivate NAT connected Service Resource NamePrivateNatName
service_typePrivate NAT connected Service TypeDIRECT_CONNECT
statePrivate NAT StateACTIVE

8.1.53.3 - 1.1

scp-cli vpc private-nat list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--cidr <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--direct_connect_id <value>]
[--direct_connect_name <value>]
[--state <value>]

Description

Get Private NAT list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringPrivate NAT NamePrivateNatName
cidr
optional
stringPrivate NAT IP range192.167.0.0/24
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName
direct_connect_id
optional
stringDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
direct_connect_name
optional
stringDirect Connect NameDirectConnectName
state
optional
****Private NAT StateACTIVE

Responses

NameDescriptionExample
idPrivate NAT ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrPrivate NAT IP range192.167.0.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateNat Description
direct_connect_idDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
direct_connect_nameDirect Connect NameDirectConnectName
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT NamePrivateNatName
statePrivate NAT StateACTIVE
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.53.4 - 1.0

scp-cli vpc private-nat list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--cidr <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--direct_connect_id <value>]
[--direct_connect_name <value>]
[--state <value>]

Description

Get Private NAT 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.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringPrivate NAT NamePrivateNatName
cidr
optional
stringPrivate NAT IP range192.167.0.0/24
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName
direct_connect_id
optional
stringDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
direct_connect_name
optional
stringDirect Connect NameDirectConnectName
state
optional
****Private NAT StateACTIVE

Responses

NameDescriptionExample
idPrivate NAT ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrPrivate NAT IP range192.167.0.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateNat Description
direct_connect_idDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
direct_connect_nameDirect Connect NameDirectConnectName
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT NamePrivateNatName
statePrivate NAT StateACTIVE
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.54 - List Private NAT IP

8.1.54.1 - 1.3

scp-cli vpc private-nat-ip list
--private_nat_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--ip_address <value>]
[--state <value>]
[--attached_resource_type <value>]
[--attached_resource_id <value>]
[--attached_resource_name <value>]

Description

Get Private NAT IP list.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
ip_address
optional
stringPrivate NAT IP Address-
state
optional
****Private NAT IP State-
attached_resource_type
optional
****Private NAT IP Attached Resource Type-
attached_resource_id
optional
stringPrivate NAT IP Attached Resource ID-
attached_resource_name
optional
stringPrivate NAT IP Attached Resource Name-

Responses

NameDescriptionExample
idPrivate NAT IP ID
attached_resource_idPrivate NAT IP Attached Resource ID
attached_resource_namePrivate NAT IP Attached Resource Name
attached_resource_typePrivate NAT IP Attached Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
ip_addressPrivate NAT IP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
private_nat_idPrivate NAT ID
statePrivate NAT IP State

8.1.54.2 - 1.2

scp-cli vpc private-nat-ip list
--private_nat_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--ip_address <value>]
[--state <value>]
[--attached_resource_type <value>]
[--attached_resource_id <value>]
[--attached_resource_name <value>]

Description

Get Private NAT IP list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
ip_address
optional
stringPrivate NAT IP Address-
state
optional
****Private NAT IP State-
attached_resource_type
optional
****Private NAT IP Attached Resource Type-
attached_resource_id
optional
stringPrivate NAT IP Attached Resource ID-
attached_resource_name
optional
stringPrivate NAT IP Attached Resource Name-

Responses

NameDescriptionExample
idPrivate NAT IP ID
attached_resource_idPrivate NAT IP Attached Resource ID
attached_resource_namePrivate NAT IP Attached Resource Name
attached_resource_typePrivate NAT IP Attached Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
ip_addressPrivate NAT IP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
private_nat_idPrivate NAT ID
statePrivate NAT IP State

8.1.54.3 - 1.1

scp-cli vpc private-nat-ip list
--private_nat_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--ip_address <value>]
[--state <value>]
[--attached_resource_type <value>]
[--attached_resource_id <value>]
[--attached_resource_name <value>]

Description

Get Private NAT IP list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
ip_address
optional
stringPrivate NAT IP Address-
state
optional
****Private NAT IP State-
attached_resource_type
optional
****Private NAT IP Attached Resource Type-
attached_resource_id
optional
stringPrivate NAT IP Attached Resource ID-
attached_resource_name
optional
stringPrivate NAT IP Attached Resource Name-

Responses

NameDescriptionExample
idPrivate NAT IP ID
attached_resource_idPrivate NAT IP Attached Resource ID
attached_resource_namePrivate NAT IP Attached Resource Name
attached_resource_typePrivate NAT IP Attached Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
ip_addressPrivate NAT IP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
private_nat_idPrivate NAT ID
statePrivate NAT IP State

8.1.54.4 - 1.0

scp-cli vpc private-nat-ip list
--private_nat_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--ip_address <value>]
[--state <value>]
[--attached_resource_type <value>]
[--attached_resource_id <value>]
[--attached_resource_name <value>]

Description

Get Private NAT IP 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.020251231

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
ip_address
optional
stringPrivate NAT IP Address-
state
optional
****Private NAT IP State-
attached_resource_type
optional
****Private NAT IP Attached Resource Type-
attached_resource_id
optional
stringPrivate NAT IP Attached Resource ID-
attached_resource_name
optional
stringPrivate NAT IP Attached Resource Name-

Responses

NameDescriptionExample
idPrivate NAT IP ID
attached_resource_idPrivate NAT IP Attached Resource ID
attached_resource_namePrivate NAT IP Attached Resource Name
attached_resource_typePrivate NAT IP Attached Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
ip_addressPrivate NAT IP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
private_nat_idPrivate NAT ID
statePrivate NAT IP State

8.1.55 - List PrivateLink Endpoint

8.1.55.1 - 1.3

scp-cli vpc privatelink-endpoint list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--subnet_id <value>]
[--privatelink_service_id <value>]
[--endpoint_ip_address <value>]
[--state <value>]

Description

Get PrivateLink Endpoint List.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
name
optional
stringPrivateLink Endpoint NameEndpointName
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
subnet_id
optional
stringSubnet Id023c57b14f11483689338d085e061492
privatelink_service_id
optional
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
endpoint_ip_address
optional
stringEndpoint IP Address192.167.1.5
state
optional
****PrivateLink Endpoint StateACTIVE

Responses

NameDescriptionExample
idPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
approval_typePrivateLink Service Approval TypeAUTO
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
endpoint_ip_addressEndpoint IP Address192.167.1.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Endpoint NameEndpointName
privatelink_service_idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
statePrivateLink Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8

8.1.55.2 - 1.2

scp-cli vpc privatelink-endpoint list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--subnet_id <value>]
[--privatelink_service_id <value>]
[--endpoint_ip_address <value>]
[--state <value>]

Description

Get PrivateLink Endpoint List.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
name
optional
stringPrivateLink Endpoint NameEndpointName
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
subnet_id
optional
stringSubnet Id023c57b14f11483689338d085e061492
privatelink_service_id
optional
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
endpoint_ip_address
optional
stringEndpoint IP Address192.167.1.5
state
optional
****PrivateLink Endpoint StateACTIVE

Responses

NameDescriptionExample
idPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
approval_typePrivateLink Service Approval TypeAUTO
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
endpoint_ip_addressEndpoint IP Address192.167.1.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Endpoint NameEndpointName
privatelink_service_idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
statePrivateLink Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8

8.1.55.3 - 1.1

scp-cli vpc privatelink-endpoint list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--subnet_id <value>]
[--privatelink_service_id <value>]
[--endpoint_ip_address <value>]
[--state <value>]

Description

Get PrivateLink Endpoint List.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
name
optional
stringPrivateLink Endpoint NameEndpointName
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
subnet_id
optional
stringSubnet Id023c57b14f11483689338d085e061492
privatelink_service_id
optional
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
endpoint_ip_address
optional
stringEndpoint IP Address192.167.1.5
state
optional
****PrivateLink Endpoint StateACTIVE

Responses

NameDescriptionExample
idPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
approval_typePrivateLink Service Approval TypeAUTO
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
endpoint_ip_addressEndpoint IP Address192.167.1.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Endpoint NameEndpointName
privatelink_service_idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
statePrivateLink Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8

8.1.56 - List PrivateLink Service

8.1.56.1 - 1.3

scp-cli vpc privatelink-service list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--subnet_id <value>]
[--service_ip_address <value>]
[--connected_resource_id <value>]
[--connected_resource_type <value>]
[--connected_resource_name <value>]
[--connected_resource_ip_address <value>]
[--state <value>]

Description

Get PrivateLink Service List.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
name
optional
stringPrivateLink Service NameServiceName
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
subnet_id
optional
stringSubnet Id023c57b14f11483689338d085e061492
service_ip_address
optional
stringService IP Address192.167.0.5
connected_resource_id
optional
stringConnected Resource IDa3e3a662a4f34442a94166df5ff9f577
connected_resource_type
optional
****Connected Resource TypeLB
connected_resource_name
optional
stringConnected Resource NamelbResourceName
connected_resource_ip_address
optional
stringConnected Resource IP Address192.167.0.10
state
optional
****PrivateLink Service StateACTIVE

Responses

NameDescriptionExample
idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
approval_typePrivateLink Service Approval TypeAUTO
connected_resource_idConnected Resource IDa3e3a662a4f34442a94166df5ff9f577
connected_resource_ip_addressConnected Resource IP Address192.167.0.10
connected_resource_nameConnected Resource NamelbResourceName
connected_resource_typeConnected Resource TypeLB
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Service NameServiceName
service_ip_addressService IP Address192.167.0.5
statePrivateLink Service State
subnet_idSubnet Id023c57b14f11483689338d085e061492
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8

8.1.56.2 - 1.2

scp-cli vpc privatelink-service list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--subnet_id <value>]
[--service_ip_address <value>]
[--connected_resource_id <value>]
[--connected_resource_type <value>]
[--connected_resource_name <value>]
[--connected_resource_ip_address <value>]
[--state <value>]

Description

Get PrivateLink Service List.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
name
optional
stringPrivateLink Service NameServiceName
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
subnet_id
optional
stringSubnet Id023c57b14f11483689338d085e061492
service_ip_address
optional
stringService IP Address192.167.0.5
connected_resource_id
optional
stringConnected Resource IDa3e3a662a4f34442a94166df5ff9f577
connected_resource_type
optional
****Connected Resource TypeLB
connected_resource_name
optional
stringConnected Resource NamelbResourceName
connected_resource_ip_address
optional
stringConnected Resource IP Address192.167.0.10
state
optional
****PrivateLink Service StateACTIVE

Responses

NameDescriptionExample
idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
approval_typePrivateLink Service Approval TypeAUTO
connected_resource_idConnected Resource IDa3e3a662a4f34442a94166df5ff9f577
connected_resource_ip_addressConnected Resource IP Address192.167.0.10
connected_resource_nameConnected Resource NamelbResourceName
connected_resource_typeConnected Resource TypeLB
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Service NameServiceName
service_ip_addressService IP Address192.167.0.5
statePrivateLink Service State
subnet_idSubnet Id023c57b14f11483689338d085e061492
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8

8.1.56.3 - 1.1

scp-cli vpc privatelink-service list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--subnet_id <value>]
[--service_ip_address <value>]
[--connected_resource_id <value>]
[--connected_resource_type <value>]
[--connected_resource_name <value>]
[--connected_resource_ip_address <value>]
[--state <value>]

Description

Get PrivateLink Service List.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
name
optional
stringPrivateLink Service NameServiceName
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
subnet_id
optional
stringSubnet Id023c57b14f11483689338d085e061492
service_ip_address
optional
stringService IP Address192.167.0.5
connected_resource_id
optional
stringConnected Resource IDa3e3a662a4f34442a94166df5ff9f577
connected_resource_type
optional
****Connected Resource TypeLB
connected_resource_name
optional
stringConnected Resource NamelbResourceName
connected_resource_ip_address
optional
stringConnected Resource IP Address192.167.0.10
state
optional
****PrivateLink Service StateACTIVE

Responses

NameDescriptionExample
idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
approval_typePrivateLink Service Approval TypeAUTO
connected_resource_idConnected Resource IDa3e3a662a4f34442a94166df5ff9f577
connected_resource_ip_addressConnected Resource IP Address192.167.0.10
connected_resource_nameConnected Resource NamelbResourceName
connected_resource_typeConnected Resource TypeLB
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Service NameServiceName
service_ip_addressService IP Address192.167.0.5
statePrivateLink Service State
subnet_idSubnet Id023c57b14f11483689338d085e061492
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8

8.1.57 - List PublicIPs

8.1.57.1 - 1.3

scp-cli vpc public-ip list
[--size <value>]
[--page <value>]
[--sort <value>]
[--ip_address <value>]
[--state <value>]
[--attached_resource_type <value>]
[--attached_resource_id <value>]
[--attached_resource_name <value>]
[--vpc_id <value>]
[--type <value>]
[--zone <value>]

Description

Get PublicIP list.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
ip_address
optional
stringIP Address192.167.0.5
state
optional
stringPublicIP StateATTACHED
attached_resource_type
optional
stringPublicIP Attached Resource TypeNAT_GW
attached_resource_id
optional
stringPublicIP Attached Resource ID37e6db41f5124184a43251a63124cdc9
attached_resource_name
optional
stringPublicIP Attached Resource NameAttached NAT Gateway Name
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
type
optional
****PublicIP TypeIGW
zone
optional
arrayZonek

Responses

NameDescriptionExample
idPublicIP ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idPublicIP Attached Resource ID37e6db41f5124184a43251a63124cdc9
attached_resource_namePublicIP Attached Resource NameAttached NAT Gateway Name
attached_resource_typePublicIP Attached Resource TypeNAT_GW
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP DescriptionPublic IP Description
ip_addressIP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP StateATTACHED
typePublicIP TypeIGW
zoneZonekr-west1-a

8.1.57.2 - 1.2

scp-cli vpc public-ip list
[--size <value>]
[--page <value>]
[--sort <value>]
[--ip_address <value>]
[--state <value>]
[--attached_resource_type <value>]
[--attached_resource_id <value>]
[--attached_resource_name <value>]
[--vpc_id <value>]
[--type <value>]

Description

Get PublicIP list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
ip_address
optional
stringIP Address192.167.0.5
state
optional
stringPublicIP StateATTACHED
attached_resource_type
optional
stringPublicIP Attached Resource TypeNAT_GW
attached_resource_id
optional
stringPublicIP Attached Resource ID37e6db41f5124184a43251a63124cdc9
attached_resource_name
optional
stringPublicIP Attached Resource NameAttached NAT Gateway Name
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
type
optional
****PublicIP TypeIGW

Responses

NameDescriptionExample
idPublicIP ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idPublicIP Attached Resource ID37e6db41f5124184a43251a63124cdc9
attached_resource_namePublicIP Attached Resource NameAttached NAT Gateway Name
attached_resource_typePublicIP Attached Resource TypeNAT_GW
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP DescriptionPublic IP Description
ip_addressIP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP StateATTACHED
typePublicIP TypeIGW

8.1.57.3 - 1.1

scp-cli vpc public-ip list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--ip_address <value>]
[--state <value>]
[--attached_resource_type <value>]
[--attached_resource_id <value>]
[--attached_resource_name <value>]
[--vpc_id <value>]
[--type <value>]

Description

Get PublicIP list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
ip_address
optional
stringIP Address192.167.0.5
state
optional
stringPublicIP StateATTACHED
attached_resource_type
optional
stringPublicIP Attached Resource TypeNAT_GW
attached_resource_id
optional
stringPublicIP Attached Resource ID37e6db41f5124184a43251a63124cdc9
attached_resource_name
optional
stringPublicIP Attached Resource NameAttached NAT Gateway Name
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
type
optional
****PublicIP TypeIGW

Responses

NameDescriptionExample
idPublicIP ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idPublicIP Attached Resource ID37e6db41f5124184a43251a63124cdc9
attached_resource_namePublicIP Attached Resource NameAttached NAT Gateway Name
attached_resource_typePublicIP Attached Resource TypeNAT_GW
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP DescriptionPublic IP Description
ip_addressIP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP StateATTACHED
typePublicIP TypeIGW

8.1.57.4 - 1.0

scp-cli vpc public-ip list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--ip_address <value>]
[--state <value>]
[--attached_resource_type <value>]
[--attached_resource_id <value>]
[--attached_resource_name <value>]
[--vpc_id <value>]
[--type <value>]

Description

Get PublicIP 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.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
ip_address
optional
stringIP Address192.167.0.5
state
optional
stringPublicIP StateATTACHED
attached_resource_type
optional
stringPublicIP Attached Resource TypeNAT_GW
attached_resource_id
optional
stringPublicIP Attached Resource ID37e6db41f5124184a43251a63124cdc9
attached_resource_name
optional
stringPublicIP Attached Resource NameAttached NAT Gateway Name
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
type
optional
****PublicIP TypeIGW

Responses

NameDescriptionExample
idPublicIP ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idPublicIP Attached Resource ID37e6db41f5124184a43251a63124cdc9
attached_resource_namePublicIP Attached Resource NameAttached NAT Gateway Name
attached_resource_typePublicIP Attached Resource TypeNAT_GW
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP DescriptionPublic IP Description
ip_addressIP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP StateATTACHED
typePublicIP TypeIGW

8.1.58 - List Subnet Vips

8.1.58.1 - 1.3

scp-cli vpc subnet vip list
--subnet_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--virtual_ip_address <value>]
[--public_ip_address <value>]

Description

Get list Subnet Vip

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
virtual_ip_address
optional
stringVirtual IP Address192.168.20.6
public_ip_address
optional
stringPublic IP Address100.112.9.84

Responses

NameDescriptionExample
idSubnet Vip Id0466a9448d9a4411a86055939e451c8f
connected_port_countConnected Port Count2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
stateStateACTIVE
static_natStatic NAT Info
virtual_ip_addressVirtual IP Address192.168.20.6

8.1.58.2 - 1.2

scp-cli vpc subnet vip list
--subnet_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--virtual_ip_address <value>]
[--public_ip_address <value>]

Description

Get list Subnet Vip

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
virtual_ip_address
optional
stringVirtual IP Address192.168.20.6
public_ip_address
optional
stringPublic IP Address100.112.9.84

Responses

NameDescriptionExample
idSubnet Vip Id0466a9448d9a4411a86055939e451c8f
connected_port_countConnected Port Count2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
stateStateACTIVE
static_natStatic NAT Info
virtual_ip_addressVirtual IP Address192.168.20.6

8.1.59 - List Subnets

8.1.59.1 - 1.3

scp-cli vpc subnet list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--cidr <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--category <value>]
[--zone <value>]
[--primary_subnet_id <value>]

Description

Get subnet list.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringSubnet Id023c57b14f11483689338d085e061492
name
optional
stringSubnet NamesubnetName
type
optional
****Subnet Type-
cidr
optional
stringSubnet Cidr192.167.1.0/24
state
optional
****State-
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName
category
optional
****Subnet CategoryPRIMARY
zone
optional
stringSubnet Zone-
primary_subnet_id
optional
stringPrimary Subnet ID023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idSubnet Id023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
categorySubnet CategoryPRIMARY
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
gateway_ip_addressGateway IP Address192.167.1.1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
primary_subnet_idPrimary Subnet ID023c57b14f11483689338d085e061492
stateState
typeSubnet TypePUBLIC
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName
zonesSubnet Zone List[“kr-west1-a”, “kr-west1-b”, “kr-west1-c”]

8.1.59.2 - 1.2

scp-cli vpc subnet list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--cidr <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]

Description

Get subnet list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringSubnet Id023c57b14f11483689338d085e061492
name
optional
stringSubnet NamesubnetName
type
optional
****Subnet Type-
cidr
optional
stringSubnet Cidr192.167.1.0/24
state
optional
****State-
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName

Responses

NameDescriptionExample
idSubnet Id023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
gateway_ip_addressGateway IP Address192.167.1.1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
stateState
typeSubnet TypeGENERAL
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.59.3 - 1.1

scp-cli vpc subnet list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]

Description

Get subnet list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringSubnet Id023c57b14f11483689338d085e061492
name
optional
stringSubnet NamesubnetName
type
optional
****Subnet Type-
state
optional
****State-
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName

Responses

NameDescriptionExample
idSubnet Id023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
gateway_ip_addressGateway IP Address192.167.1.1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
stateState
typeSubnet TypeGENERAL
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.59.4 - 1.0

scp-cli vpc subnet list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]

Description

Get subnet 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.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringSubnet Id023c57b14f11483689338d085e061492
name
optional
stringSubnet NamesubnetName
type
optional
****Subnet Type-
state
optional
****State-
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName

Responses

NameDescriptionExample
idSubnet Id023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
gateway_ip_addressGateway IP Address192.167.1.1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
stateState
typeSubnet TypeGENERAL
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.60 - List Transit Gateway Rules

8.1.60.1 - 1.3

scp-cli vpc transit-gateway-rule list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--tgw_connection_vpc_id <value>]
[--tgw_connection_vpc_name <value>]
[--source_type <value>]
[--destination_type <value>]
[--destination_cidr <value>]
[--state <value>]
[--rule_type <value>]

Description

Get Transit Gateway Rule list.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
tgw_connection_vpc_id
optional
stringVPC ID Connected to Transit Gateway.ffeced8e191c478eabd66b6e2cab8e34
tgw_connection_vpc_name
optional
stringVPC Name Connected to Transit Gateway.ConnectedVpcName
source_type
optional
****Source TypeTGW
destination_type
optional
****Destination TypeVPC
destination_cidr
optional
stringDestination CIDR192.167.5.0/24
state
optional
****StateACTIVE
rule_type
optional
****Rule TypeTGW_VPC

Responses

NameDescriptionExample
idRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionRouting Rule Description
destination_cidrDestination CIDR192.167.5.0/24
destination_resource_idDestination Resource IDceb44ea5ecb34a49b16495f9a63b0718
destination_resource_nameDestination Resource NameVpcName
destination_typeDestination TypeVPC
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
rule_typeRule TypeTGW_VPC
source_resource_idSource Resource ID8582cc5d89994a42ad53282fd4a8d8be
source_resource_nameSource Resource NameTgwName
source_typeSource TypeTGW
stateStateACTIVE
tgw_connection_vpc_idVPC ID Connected to Transit Gateway.ffeced8e191c478eabd66b6e2cab8e34
tgw_connection_vpc_nameVPC Name Connected to Transit Gateway.ConnectedVpcName

8.1.60.2 - 1.2

scp-cli vpc transit-gateway-rule list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--tgw_connection_vpc_id <value>]
[--tgw_connection_vpc_name <value>]
[--source_type <value>]
[--destination_type <value>]
[--destination_cidr <value>]
[--state <value>]
[--rule_type <value>]

Description

Get Transit Gateway Rule list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
tgw_connection_vpc_id
optional
stringVPC ID Connected to Transit Gateway.ffeced8e191c478eabd66b6e2cab8e34
tgw_connection_vpc_name
optional
stringVPC Name Connected to Transit Gateway.ConnectedVpcName
source_type
optional
****Source TypeTGW
destination_type
optional
****Destination TypeVPC
destination_cidr
optional
stringDestination CIDR192.167.5.0/24
state
optional
****StateACTIVE
rule_type
optional
****Rule TypeTGW_VPC

Responses

NameDescriptionExample
idRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionRouting Rule Description
destination_cidrDestination CIDR192.167.5.0/24
destination_resource_idDestination Resource IDceb44ea5ecb34a49b16495f9a63b0718
destination_resource_nameDestination Resource NameVpcName
destination_typeDestination TypeVPC
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
rule_typeRule TypeTGW_VPC
source_resource_idSource Resource ID8582cc5d89994a42ad53282fd4a8d8be
source_resource_nameSource Resource NameTgwName
source_typeSource TypeTGW
stateStateACTIVE
tgw_connection_vpc_idVPC ID Connected to Transit Gateway.ffeced8e191c478eabd66b6e2cab8e34
tgw_connection_vpc_nameVPC Name Connected to Transit Gateway.ConnectedVpcName

8.1.60.3 - 1.1

scp-cli vpc transit-gateway-rule list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--tgw_connection_vpc_id <value>]
[--tgw_connection_vpc_name <value>]
[--source_type <value>]
[--destination_type <value>]
[--destination_cidr <value>]
[--state <value>]

Description

Get Transit Gateway Rule list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
tgw_connection_vpc_id
optional
stringVPC ID Connected to Transit Gateway.ffeced8e191c478eabd66b6e2cab8e34
tgw_connection_vpc_name
optional
stringVPC Name Connected to Transit Gateway.ConnectedVpcName
source_type
optional
****Source TypeTGW
destination_type
optional
****Destination TypeVPC
destination_cidr
optional
stringDestination CIDR192.167.5.0/24
state
optional
****StateACTIVE

Responses

NameDescriptionExample
idRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionRouting Rule Description
destination_cidrDestination CIDR192.167.5.0/24
destination_resource_idDestination Resource IDceb44ea5ecb34a49b16495f9a63b0718
destination_resource_nameDestination Resource NameVpcName
destination_typeDestination TypeVPC
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
source_resource_idSource Resource ID8582cc5d89994a42ad53282fd4a8d8be
source_resource_nameSource Resource NameTgwName
source_typeSource TypeTGW
stateStateACTIVE
tgw_connection_vpc_idVPC ID Connected to Transit Gateway.ffeced8e191c478eabd66b6e2cab8e34
tgw_connection_vpc_nameVPC Name Connected to Transit Gateway.ConnectedVpcName

8.1.60.4 - 1.0

scp-cli vpc transit-gateway-rule list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--tgw_connection_vpc_id <value>]
[--tgw_connection_vpc_name <value>]
[--source_type <value>]
[--destination_type <value>]
[--destination_cidr <value>]
[--state <value>]

Description

Get Transit Gateway Rule 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.020251231

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
tgw_connection_vpc_id
optional
stringVPC ID Connected to Transit Gateway.ffeced8e191c478eabd66b6e2cab8e34
tgw_connection_vpc_name
optional
stringVPC Name Connected to Transit Gateway.ConnectedVpcName
source_type
optional
****Source TypeTGW
destination_type
optional
****Destination TypeVPC
destination_cidr
optional
stringDestination CIDR192.167.5.0/24
state
optional
****StateACTIVE

Responses

NameDescriptionExample
idRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionRouting Rule Description
destination_cidrDestination CIDR192.167.5.0/24
destination_resource_idDestination Resource IDceb44ea5ecb34a49b16495f9a63b0718
destination_resource_nameDestination Resource NameVpcName
destination_typeDestination TypeVPC
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
source_resource_idSource Resource ID8582cc5d89994a42ad53282fd4a8d8be
source_resource_nameSource Resource NameTgwName
source_typeSource TypeTGW
stateStateACTIVE
tgw_connection_vpc_idVPC ID Connected to Transit Gateway.ffeced8e191c478eabd66b6e2cab8e34
tgw_connection_vpc_nameVPC Name Connected to Transit Gateway.ConnectedVpcName

8.1.61 - List Transit Gateway VPC Connections

8.1.61.1 - 1.3

scp-cli vpc transit-gateway-vpc-connection list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--state <value>]

Description

Get Transit Gateway VPC Connection list.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringTransit Gateway VPC Connection IDffeced8e191c478eabd66b6e2cab8e34
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName
state
optional
****StateACTIVE

Responses

NameDescriptionExample
idTransit Gateway VPC Connection IDffeced8e191c478eabd66b6e2cab8e34
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
stateStateACTIVE
transit_gateway_idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.61.2 - 1.2

scp-cli vpc transit-gateway-vpc-connection list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--state <value>]

Description

Get Transit Gateway VPC Connection list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringTransit Gateway VPC Connection IDffeced8e191c478eabd66b6e2cab8e34
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName
state
optional
****StateACTIVE

Responses

NameDescriptionExample
idTransit Gateway VPC Connection IDffeced8e191c478eabd66b6e2cab8e34
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
stateStateACTIVE
transit_gateway_idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.61.3 - 1.1

scp-cli vpc transit-gateway-vpc-connection list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--state <value>]

Description

Get Transit Gateway VPC Connection list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringTransit Gateway VPC Connection IDffeced8e191c478eabd66b6e2cab8e34
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName
state
optional
****StateACTIVE

Responses

NameDescriptionExample
idTransit Gateway VPC Connection IDffeced8e191c478eabd66b6e2cab8e34
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
stateStateACTIVE
transit_gateway_idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.61.4 - 1.0

scp-cli vpc transit-gateway-vpc-connection list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--state <value>]

Description

Get Transit Gateway VPC Connection 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.020251231

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringTransit Gateway VPC Connection IDffeced8e191c478eabd66b6e2cab8e34
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName
state
optional
****StateACTIVE

Responses

NameDescriptionExample
idTransit Gateway VPC Connection IDffeced8e191c478eabd66b6e2cab8e34
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
stateStateACTIVE
transit_gateway_idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.62 - List Transit Gateways

8.1.62.1 - 1.3

scp-cli vpc transit-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
[--firewall_connection_state <value>]
[--uplink_zone_state <value>]

Description

Get Transit Gateway list.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
name
optional
stringTransit Gateway NameTransitGatewayName
state
optional
****StateACTIVE
firewall_connection_state
optional
****Firewall Connection StateINACTIVE
uplink_zone_state
optional
****Uplink Zone Connect stateACTIVE

Responses

NameDescriptionExample
idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthTransit Gateway Port Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway DescriptionTransitGateway Description
firewall_connection_stateFirewall Connection StateINACTIVE
firewall_idsFirewall IDsbbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse

8.1.62.2 - 1.2

scp-cli vpc transit-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
[--firewall_connection_state <value>]
[--uplink_zone_state <value>]

Description

Get Transit Gateway list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
name
optional
stringTransit Gateway NameTransitGatewayName
state
optional
****StateACTIVE
firewall_connection_state
optional
****Firewall Connection StateINACTIVE
uplink_zone_state
optional
****Uplink Zone Connect stateACTIVE

Responses

NameDescriptionExample
idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthTransit Gateway Port Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway DescriptionTransitGateway Description
firewall_connection_stateFirewall Connection StateINACTIVE
firewall_idsFirewall IDsbbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse

8.1.62.3 - 1.1

scp-cli vpc transit-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]

Description

Get Transit Gateway list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
name
optional
stringTransit Gateway NameTransitGatewayName
state
optional
****StateACTIVE

Responses

NameDescriptionExample
idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthTransit Gateway Port Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway DescriptionTransitGateway Description
firewall_idsFirewall IDsbbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse

8.1.62.4 - 1.0

scp-cli vpc transit-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]

Description

Get Transit Gateway 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.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
name
optional
stringTransit Gateway NameTransitGatewayName
state
optional
****StateACTIVE

Responses

NameDescriptionExample
idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthTransit Gateway Port Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway DescriptionTransitGateway Description
firewall_idsFirewall IDsbbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse

8.1.63 - List VPC Endpoint

8.1.63.1 - 1.3

scp-cli vpc vpc-endpoint list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--subnet_id <value>]
[--resource_key <value>]
[--resource_type <value>]
[--endpoint_ip_address <value>]
[--state <value>]

Description

Get VPC Endpoint list.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
name
optional
stringVPC Endpoint NameVpcEndpointName
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName
subnet_id
optional
stringSubnet Id023c57b14f11483689338d085e061492
resource_key
optional
stringVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_type
optional
****VPC Endpoint Resource TypeFS
endpoint_ip_address
optional
stringVPC Endpoint IP Address192.167.0.5
state
optional
****VPC Endpoint StateACTIVE

Responses

NameDescriptionExample
idVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionVpcEndpoint Description
endpoint_ip_addressVPC Endpoint IP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint NameVpcEndpointName
resource_infoVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
resource_keyVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_typeVPC Endpoint Resource TypeFS
stateVPC Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.63.2 - 1.2

scp-cli vpc vpc-endpoint list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--subnet_id <value>]
[--resource_key <value>]
[--resource_type <value>]
[--endpoint_ip_address <value>]
[--state <value>]

Description

Get VPC Endpoint list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
name
optional
stringVPC Endpoint NameVpcEndpointName
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName
subnet_id
optional
stringSubnet Id023c57b14f11483689338d085e061492
resource_key
optional
stringVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_type
optional
****VPC Endpoint Resource TypeFS
endpoint_ip_address
optional
stringVPC Endpoint IP Address192.167.0.5
state
optional
****VPC Endpoint StateACTIVE

Responses

NameDescriptionExample
idVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionVpcEndpoint Description
endpoint_ip_addressVPC Endpoint IP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint NameVpcEndpointName
resource_infoVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
resource_keyVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_typeVPC Endpoint Resource TypeFS
stateVPC Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.63.3 - 1.1

scp-cli vpc vpc-endpoint list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--subnet_id <value>]
[--resource_key <value>]
[--resource_type <value>]
[--endpoint_ip_address <value>]
[--state <value>]

Description

Get VPC Endpoint list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
name
optional
stringVPC Endpoint NameVpcEndpointName
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName
subnet_id
optional
stringSubnet Id023c57b14f11483689338d085e061492
resource_key
optional
stringVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_type
optional
****VPC Endpoint Resource TypeFS
endpoint_ip_address
optional
stringVPC Endpoint IP Address192.167.0.5
state
optional
****VPC Endpoint StateACTIVE

Responses

NameDescriptionExample
idVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionVpcEndpoint Description
endpoint_ip_addressVPC Endpoint IP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint NameVpcEndpointName
resource_infoVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
resource_keyVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_typeVPC Endpoint Resource TypeFS
stateVPC Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.63.4 - 1.0

scp-cli vpc vpc-endpoint list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--subnet_id <value>]
[--resource_key <value>]
[--resource_type <value>]
[--endpoint_ip_address <value>]
[--state <value>]

Description

Get VPC Endpoint 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.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
name
optional
stringVPC Endpoint NameVpcEndpointName
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName
subnet_id
optional
stringSubnet Id023c57b14f11483689338d085e061492
resource_key
optional
stringVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_type
optional
****VPC Endpoint Resource TypeFS
endpoint_ip_address
optional
stringVPC Endpoint IP Address192.167.0.5
state
optional
****VPC Endpoint StateACTIVE

Responses

NameDescriptionExample
idVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionVpcEndpoint Description
endpoint_ip_addressVPC Endpoint IP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint NameVpcEndpointName
resource_infoVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
resource_keyVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_typeVPC Endpoint Resource TypeFS
stateVPC Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.64 - List VPC Endpoint Connectable Resources

8.1.64.1 - 1.3

scp-cli vpc vpc-endpoint-connectable-resource list
--resource_type <value>
[--vpc_id <value>]

Description

List VpcEndpoint connectable resources

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
resource_type
required
****VPC Endpoint Resource TypeFS
vpc_id
optional
stringVPC ID(required if resource_type is DNS)7df8abb4912e4709b1cb237daccca7a8

Responses

NameDescriptionExample
resource_infoVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
resource_keyVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_typeVPC Endpoint Resource TypeFS

8.1.64.2 - 1.2

scp-cli vpc vpc-endpoint-connectable-resource list
--resource_type <value>
[--vpc_id <value>]

Description

List VpcEndpoint connectable resources

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
resource_type
required
****VPC Endpoint Resource TypeFS
vpc_id
optional
stringVPC ID(required if resource_type is DNS)7df8abb4912e4709b1cb237daccca7a8

Responses

NameDescriptionExample
resource_infoVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
resource_keyVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_typeVPC Endpoint Resource TypeFS

8.1.64.3 - 1.1

scp-cli vpc vpc-endpoint-connectable-resource list
--resource_type <value>
[--vpc_id <value>]

Description

List VpcEndpoint connectable resources

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
resource_type
required
****VPC Endpoint Resource TypeFS
vpc_id
optional
stringVPC ID(required if resource_type is DNS)7df8abb4912e4709b1cb237daccca7a8

Responses

NameDescriptionExample
resource_infoVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
resource_keyVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_typeVPC Endpoint Resource TypeFS

8.1.64.4 - 1.0

scp-cli vpc vpc-endpoint-connectable-resource list
--resource_type <value>
[--vpc_id <value>]

Description

List VpcEndpoint connectable resources

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

Parameters

NameTypeDescriptionExample
resource_type
required
****VPC Endpoint Resource TypeFS
vpc_id
optional
stringVPC ID(required if resource_type is DNS)7df8abb4912e4709b1cb237daccca7a8

Responses

NameDescriptionExample
resource_infoVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
resource_keyVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_typeVPC Endpoint Resource TypeFS

8.1.65 - List VPC Peering

8.1.65.1 - 1.3

scp-cli vpc vpc-peering list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--requester_vpc_id <value>]
[--requester_vpc_name <value>]
[--approver_vpc_id <value>]
[--approver_vpc_name <value>]
[--account_type <value>]
[--state <value>]

Description

Get VPC Peering list.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Peering ID023c57b14f11483689338d085e061492
name
optional
stringVPC Peering NamevpcPeeringName
requester_vpc_id
optional
stringRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
requester_vpc_name
optional
stringRequester VPC NamevpcName
approver_vpc_id
optional
stringApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_name
optional
stringApprover VPC NamevpcName
account_type
optional
****Account Type-
state
optional
****State-

Responses

NameDescriptionExample
idVPC Peering ID023c57b14f11483689338d085e061492
account_typeAccount Type
approver_vpc_account_idApprover VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
approver_vpc_idApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_nameApprover VPC NamevpcName
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
descriptionVPC Peering DescriptionvpcPeering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering NamevpcPeeringName
requester_vpc_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
requester_vpc_idRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
requester_vpc_nameRequester VPC NamevpcName
stateState

8.1.65.2 - 1.2

scp-cli vpc vpc-peering list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--requester_vpc_id <value>]
[--requester_vpc_name <value>]
[--approver_vpc_id <value>]
[--approver_vpc_name <value>]
[--account_type <value>]
[--state <value>]

Description

Get VPC Peering list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Peering ID023c57b14f11483689338d085e061492
name
optional
stringVPC Peering NamevpcPeeringName
requester_vpc_id
optional
stringRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
requester_vpc_name
optional
stringRequester VPC NamevpcName
approver_vpc_id
optional
stringApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_name
optional
stringApprover VPC NamevpcName
account_type
optional
****Account Type-
state
optional
****State-

Responses

NameDescriptionExample
idVPC Peering ID023c57b14f11483689338d085e061492
account_typeAccount Type
approver_vpc_account_idApprover VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
approver_vpc_idApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_nameApprover VPC NamevpcName
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
descriptionVPC Peering DescriptionvpcPeering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering NamevpcPeeringName
requester_vpc_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
requester_vpc_idRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
requester_vpc_nameRequester VPC NamevpcName
stateState

8.1.65.3 - 1.1

scp-cli vpc vpc-peering list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--requester_vpc_id <value>]
[--requester_vpc_name <value>]
[--approver_vpc_id <value>]
[--approver_vpc_name <value>]
[--account_type <value>]
[--state <value>]

Description

Get VPC Peering list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Peering ID023c57b14f11483689338d085e061492
name
optional
stringVPC Peering NamevpcPeeringName
requester_vpc_id
optional
stringRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
requester_vpc_name
optional
stringRequester VPC NamevpcName
approver_vpc_id
optional
stringApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_name
optional
stringApprover VPC NamevpcName
account_type
optional
****Account Type-
state
optional
****State-

Responses

NameDescriptionExample
idVPC Peering ID023c57b14f11483689338d085e061492
account_typeAccount Type
approver_vpc_account_idApprover VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
approver_vpc_idApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_nameApprover VPC NamevpcName
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
descriptionVPC Peering DescriptionvpcPeering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering NamevpcPeeringName
requester_vpc_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
requester_vpc_idRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
requester_vpc_nameRequester VPC NamevpcName
stateState

8.1.65.4 - 1.0

scp-cli vpc vpc-peering list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--requester_vpc_id <value>]
[--requester_vpc_name <value>]
[--approver_vpc_id <value>]
[--approver_vpc_name <value>]
[--account_type <value>]
[--state <value>]

Description

Get VPC Peering 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.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Peering ID023c57b14f11483689338d085e061492
name
optional
stringVPC Peering NamevpcPeeringName
requester_vpc_id
optional
stringRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
requester_vpc_name
optional
stringRequester VPC NamevpcName
approver_vpc_id
optional
stringApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_name
optional
stringApprover VPC NamevpcName
account_type
optional
****Account Type-
state
optional
****State-

Responses

NameDescriptionExample
idVPC Peering ID023c57b14f11483689338d085e061492
account_typeAccount Type
approver_vpc_account_idApprover VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
approver_vpc_idApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_nameApprover VPC NamevpcName
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
descriptionVPC Peering DescriptionvpcPeering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering NamevpcPeeringName
requester_vpc_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
requester_vpc_idRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
requester_vpc_nameRequester VPC NamevpcName
stateState

8.1.66 - List VPC Peering Rules

8.1.66.1 - 1.3

scp-cli vpc vpc-peering-routing-rule list
--vpc_peering_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--source_vpc_id <value>]
[--source_vpc_type <value>]
[--destination_vpc_id <value>]
[--destination_vpc_type <value>]
[--destination_cidr <value>]
[--state <value>]

Description

Get VPC Peering Rule list.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Peering Rule ID-
source_vpc_id
optional
stringSource VPC ID-
source_vpc_type
optional
****Source VPC Type-
destination_vpc_id
optional
stringDestination VPC ID-
destination_vpc_type
optional
****Destination VPC Type-
destination_cidr
optional
stringDestination CIDR-
state
optional
****State-

Responses

NameDescriptionExample
idVPC Peering Rule ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
destination_cidrDestination CIDR
destination_vpc_idDestination VPC ID
destination_vpc_nameDestination VPC Name
destination_vpc_typeDestination VPC Type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
source_vpc_idSource VPC ID
source_vpc_nameSource VPC Name
source_vpc_typeSource VPC Type
stateState
vpc_peering_idVPC Peering ID

8.1.66.2 - 1.2

scp-cli vpc vpc-peering-routing-rule list
--vpc_peering_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--source_vpc_id <value>]
[--source_vpc_type <value>]
[--destination_vpc_id <value>]
[--destination_vpc_type <value>]
[--destination_cidr <value>]
[--state <value>]

Description

Get VPC Peering Rule list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Peering Rule ID-
source_vpc_id
optional
stringSource VPC ID-
source_vpc_type
optional
****Source VPC Type-
destination_vpc_id
optional
stringDestination VPC ID-
destination_vpc_type
optional
****Destination VPC Type-
destination_cidr
optional
stringDestination CIDR-
state
optional
****State-

Responses

NameDescriptionExample
idVPC Peering Rule ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
destination_cidrDestination CIDR
destination_vpc_idDestination VPC ID
destination_vpc_nameDestination VPC Name
destination_vpc_typeDestination VPC Type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
source_vpc_idSource VPC ID
source_vpc_nameSource VPC Name
source_vpc_typeSource VPC Type
stateState
vpc_peering_idVPC Peering ID

8.1.66.3 - 1.1

scp-cli vpc vpc-peering-routing-rule list
--vpc_peering_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--source_vpc_id <value>]
[--source_vpc_type <value>]
[--destination_vpc_id <value>]
[--destination_vpc_type <value>]
[--destination_cidr <value>]
[--state <value>]
[--name <value>]

Description

Get VPC Peering Rule list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Peering Rule ID-
source_vpc_id
optional
stringSource VPC ID-
source_vpc_type
optional
****Source VPC Type-
destination_vpc_id
optional
stringDestination VPC ID-
destination_vpc_type
optional
****Destination VPC Type-
destination_cidr
optional
stringDestination CIDR-
state
optional
****State-
name
optional
stringVPC Peering Name-

Responses

NameDescriptionExample
idVPC Peering Rule ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
destination_cidrDestination CIDR
destination_vpc_idDestination VPC ID
destination_vpc_nameDestination VPC Name
destination_vpc_typeDestination VPC Type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
source_vpc_idSource VPC ID
source_vpc_nameSource VPC Name
source_vpc_typeSource VPC Type
stateState
vpc_peering_idVPC Peering ID

8.1.66.4 - 1.0

scp-cli vpc vpc-peering-routing-rule list
--vpc_peering_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--source_vpc_id <value>]
[--source_vpc_type <value>]
[--destination_vpc_id <value>]
[--destination_vpc_type <value>]
[--destination_cidr <value>]
[--state <value>]
[--name <value>]

Description

Get VPC Peering Rule 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.020251231

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Peering Rule ID-
source_vpc_id
optional
stringSource VPC ID-
source_vpc_type
optional
****Source VPC Type-
destination_vpc_id
optional
stringDestination VPC ID-
destination_vpc_type
optional
****Destination VPC Type-
destination_cidr
optional
stringDestination CIDR-
state
optional
****State-
name
optional
stringVPC Peering Name-

Responses

NameDescriptionExample
idVPC Peering Rule ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
destination_cidrDestination CIDR
destination_vpc_idDestination VPC ID
destination_vpc_nameDestination VPC Name
destination_vpc_typeDestination VPC Type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
source_vpc_idSource VPC ID
source_vpc_nameSource VPC Name
source_vpc_typeSource VPC Type
stateState
vpc_peering_idVPC Peering ID

8.1.67 - List VPCs

8.1.67.1 - 1.3

scp-cli vpc vpc list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
[--cidr <value>]
[--zone <value>]

Description

Get VPC list.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
name
optional
stringVPC NamevpcName
state
optional
****State-
cidr
optional
stringVPC Cidr192.167.0.0/18
zone
optional
stringZonekr-west1-a

Responses

NameDescriptionExample
idVPC Id7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidr_countCidr Count20
cidrs
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionvpcDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC NamevpcName
stateState
zone_typeVpc Zone Type InformationPUBLIC
zonesVpc Zones Information[‘zone-a’, ‘zone-b’, ‘zone-c’]

8.1.67.2 - 1.2

scp-cli vpc vpc list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
[--cidr <value>]

Description

Get VPC list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
name
optional
stringVPC NamevpcName
state
optional
****State-
cidr
optional
stringVPC Cidr192.167.0.0/18

Responses

NameDescriptionExample
idVPC Id7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidr_countCidr Count20
cidrs
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionvpcDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC NamevpcName
stateState

8.1.67.3 - 1.1

scp-cli vpc vpc list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
[--cidr <value>]

Description

Get VPC list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
name
optional
stringVPC NamevpcName
state
optional
****State-
cidr
optional
stringVPC Cidr192.167.0.0/18

Responses

NameDescriptionExample
idVPC Id7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrVPC Cidr192.167.0.0/18
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionvpcDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC NamevpcName
stateState

8.1.67.4 - 1.0

scp-cli vpc vpc list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
[--cidr <value>]

Description

Get VPC 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.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
name
optional
stringVPC NamevpcName
state
optional
****State-
cidr
optional
stringVPC Cidr192.167.0.0/18

Responses

NameDescriptionExample
idVPC Id7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrVPC Cidr192.167.0.0/18
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionvpcDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC NamevpcName
stateState

8.1.68 - Request PrivateLink Endpoint

8.1.68.1 - 1.3

scp-cli vpc privatelink-endpoint request
--privatelink_endpoint_id <value>
--type <value>

Description

Request PrivateLink Endpoint

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
type
required
stringPrivateLink Endpoint Action TypeCANCEL

8.1.68.2 - 1.2

scp-cli vpc privatelink-endpoint request
--privatelink_endpoint_id <value>
--type <value>

Description

Request PrivateLink Endpoint

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
type
required
stringPrivateLink Endpoint Action TypeCANCEL

8.1.68.3 - 1.1

scp-cli vpc privatelink-endpoint request
--privatelink_endpoint_id <value>
--type <value>

Description

Request PrivateLink Endpoint

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
type
required
stringPrivateLink Endpoint Action TypeCANCEL

8.1.69 - Set Internet Gateway

8.1.69.1 - 1.3

scp-cli vpc internet-gateway set
--internet_gateway_id <value>
[--description <value>]
[--loggable <value>]

Description

Set Internet Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID023c57b14f11483689338d085e061492
description
optional
stringDescriptionInternet Gateway Description
loggable
optional
booleanNAT Loggable-

8.1.69.2 - 1.2

scp-cli vpc internet-gateway set
--internet_gateway_id <value>
[--description <value>]
[--loggable <value>]

Description

Set Internet Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID023c57b14f11483689338d085e061492
description
optional
stringDescriptionInternet Gateway Description
loggable
optional
booleanNAT Loggable-

8.1.69.3 - 1.1

scp-cli vpc internet-gateway set
--internet_gateway_id <value>
[--description <value>]
[--loggable <value>]

Description

Set Internet Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID023c57b14f11483689338d085e061492
description
optional
stringDescriptionInternet Gateway Description
loggable
optional
booleanNAT Loggable-

8.1.69.4 - 1.0

scp-cli vpc internet-gateway set
--internet_gateway_id <value>
[--description <value>]
[--loggable <value>]

Description

Set Internet Gateway.

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

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID023c57b14f11483689338d085e061492
description
optional
stringDescriptionInternet Gateway Description
loggable
optional
booleanNAT Loggable-

8.1.70 - Set NAT Gateway

8.1.70.1 - 1.3

scp-cli vpc nat-gateway set
--nat_gateway_id <value>
[--description <value>]

Description

Set NAT Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID12f56e27070248a6a240a497e43fbe18
description
optional
stringNAT Gateway DescriptionVpcEndpoint Description

8.1.70.2 - 1.2

scp-cli vpc nat-gateway set
--nat_gateway_id <value>
[--description <value>]

Description

Set NAT Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID12f56e27070248a6a240a497e43fbe18
description
optional
stringNAT Gateway DescriptionVpcEndpoint Description

8.1.70.3 - 1.1

scp-cli vpc nat-gateway set
--nat_gateway_id <value>
[--description <value>]

Description

Set NAT Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID12f56e27070248a6a240a497e43fbe18
description
optional
stringNAT Gateway DescriptionVpcEndpoint Description

8.1.70.4 - 1.0

scp-cli vpc nat-gateway set
--nat_gateway_id <value>
[--description <value>]

Description

Set NAT Gateway.

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

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID12f56e27070248a6a240a497e43fbe18
description
optional
stringNAT Gateway DescriptionVpcEndpoint Description

8.1.71 - Set Port

8.1.71.1 - 1.3

scp-cli vpc port set
--port_id <value>
[--description <value>]
[--security_groups <value>]

Description

Set port.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID023c57b1-4f11-4836-8933-8d085e061492
description
optional
stringDescriptionPort Description
security_groups
optional
arraySecurity Group List-

8.1.71.2 - 1.2

scp-cli vpc port set
--port_id <value>
[--description <value>]
[--security_groups <value>]

Description

Set port.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID023c57b1-4f11-4836-8933-8d085e061492
description
optional
stringDescriptionPort Description
security_groups
optional
arraySecurity Group List-

8.1.71.3 - 1.1

scp-cli vpc port set
--port_id <value>
[--description <value>]
[--security_groups <value>]

Description

Set port.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID023c57b1-4f11-4836-8933-8d085e061492
description
optional
stringDescriptionPort Description
security_groups
optional
arraySecurity Group List-

8.1.71.4 - 1.0

scp-cli vpc port set
--port_id <value>
[--description <value>]
[--security_groups <value>]

Description

Set port.

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

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID023c57b1-4f11-4836-8933-8d085e061492
description
optional
stringDescriptionPort Description
security_groups
optional
arraySecurity Group List-

8.1.72 - Set Private NAT

8.1.72.1 - 1.3

scp-cli vpc private-nat set
--private_nat_id <value>
[--description <value>]

Description

Set Private NAT.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18
description
optional
stringDescriptionPrivateNat Description

8.1.72.2 - 1.2

scp-cli vpc private-nat set
--private_nat_id <value>
[--description <value>]

Description

Set Private NAT.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18
description
optional
stringDescriptionPrivateNat Description

8.1.72.3 - 1.1

scp-cli vpc private-nat set
--private_nat_id <value>
[--description <value>]

Description

Set Private NAT.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18
description
optional
stringDescriptionPrivateNat Description

8.1.72.4 - 1.0

scp-cli vpc private-nat set
--private_nat_id <value>
[--description <value>]

Description

Set Private NAT.

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

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18
description
optional
stringDescriptionPrivateNat Description

8.1.73 - Set PrivateLink Endpoint

8.1.73.1 - 1.3

scp-cli vpc privatelink-endpoint set
--privatelink_endpoint_id <value>
[--description <value>]

Description

Set PrivateLink Endpoint.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
description
optional
stringDescriptionPrivateLink Endpoint Description

8.1.73.2 - 1.2

scp-cli vpc privatelink-endpoint set
--privatelink_endpoint_id <value>
[--description <value>]

Description

Set PrivateLink Endpoint.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
description
optional
stringDescriptionPrivateLink Endpoint Description

8.1.73.3 - 1.1

scp-cli vpc privatelink-endpoint set
--privatelink_endpoint_id <value>
[--description <value>]

Description

Set PrivateLink Endpoint.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
description
optional
stringDescriptionPrivateLink Endpoint Description

8.1.74 - Set PrivateLink Service

8.1.74.1 - 1.3

scp-cli vpc privatelink-service set
--privatelink_service_id <value>
[--description <value>]

Description

Set PrivateLink Service.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
description
optional
stringDescriptionPrivateLink Service Description

8.1.74.2 - 1.2

scp-cli vpc privatelink-service set
--privatelink_service_id <value>
[--description <value>]

Description

Set PrivateLink Service.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
description
optional
stringDescriptionPrivateLink Service Description

8.1.74.3 - 1.1

scp-cli vpc privatelink-service set
--privatelink_service_id <value>
[--description <value>]

Description

Set PrivateLink Service.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
description
optional
stringDescriptionPrivateLink Service Description

8.1.75 - Set PublicIP

8.1.75.1 - 1.3

scp-cli vpc public-ip set
--publicip_id <value>
--description <value>

Description

Set PublicIP.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID12f56e27070248a6a240a497e43fbe18
description
required
stringPublicIP DescriptionPublic IP Description

8.1.75.2 - 1.2

scp-cli vpc public-ip set
--publicip_id <value>
--description <value>

Description

Set PublicIP.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID12f56e27070248a6a240a497e43fbe18
description
required
stringPublicIP DescriptionPublic IP Description

8.1.75.3 - 1.1

scp-cli vpc public-ip set
--publicip_id <value>
--description <value>

Description

Set PublicIP.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID12f56e27070248a6a240a497e43fbe18
description
required
stringPublicIP DescriptionPublic IP Description

8.1.75.4 - 1.0

scp-cli vpc public-ip set
--publicip_id <value>
--description <value>

Description

Set PublicIP.

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

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID12f56e27070248a6a240a497e43fbe18
description
required
stringPublicIP DescriptionPublic IP Description

8.1.76 - Set Subnet

8.1.76.1 - 1.3

scp-cli vpc subnet set
--subnet_id <value>
[--description <value>]
[--dhcp_ip_address <value>]

Description

Set subnet.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
description
optional
stringDescriptionSubnet Description
dhcp_ip_address
optional
stringDHCP IP Address192.167.1.2

8.1.76.2 - 1.2

scp-cli vpc subnet set
--subnet_id <value>
[--description <value>]
[--dhcp_ip_address <value>]

Description

Set subnet.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
description
optional
stringDescriptionSubnet Description
dhcp_ip_address
optional
stringDHCP IP Address192.167.1.2

8.1.76.3 - 1.1

scp-cli vpc subnet set
--subnet_id <value>
--description <value>

Description

Set subnet.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
description
required
stringDescriptionSubnet Description

8.1.76.4 - 1.0

scp-cli vpc subnet set
--subnet_id <value>
--description <value>

Description

Set subnet.

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

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
description
required
stringDescriptionSubnet Description

8.1.77 - Set Subnet Vip

8.1.77.1 - 1.3

scp-cli vpc subnet vip set
--vip_id <value>
--subnet_id <value>
--description <value>

Description

Set Subnet Vip

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
vip_id
required
stringSubnet Vip Id0466a9448d9a4411a86055939e451c8f
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492
description
required
stringDescriptionSubnet VIP Description

8.1.77.2 - 1.2

scp-cli vpc subnet vip set
--vip_id <value>
--subnet_id <value>
--description <value>

Description

Set Subnet Vip

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
vip_id
required
stringSubnet Vip Id0466a9448d9a4411a86055939e451c8f
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492
description
required
stringDescriptionSubnet VIP Description

8.1.78 - Set Transit Gateway

8.1.78.1 - 1.3

scp-cli vpc transit-gateway set
--transit_gateway_id <value>
[--description <value>]

Description

Set Transit Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
description
optional
stringDescriptionTransitGateway Description

8.1.78.2 - 1.2

scp-cli vpc transit-gateway set
--transit_gateway_id <value>
[--description <value>]

Description

Set Transit Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
description
optional
stringDescriptionTransitGateway Description

8.1.78.3 - 1.1

scp-cli vpc transit-gateway set
--transit_gateway_id <value>
[--description <value>]

Description

Set Transit Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
description
optional
stringDescriptionTransitGateway Description

8.1.78.4 - 1.0

scp-cli vpc transit-gateway set
--transit_gateway_id <value>
[--description <value>]

Description

Set Transit Gateway.

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

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
description
optional
stringDescriptionTransitGateway Description

8.1.79 - Set VPC

8.1.79.1 - 1.3

scp-cli vpc vpc set
--vpc_id <value>
[--description <value>]

Description

Set VPC.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-
description
optional
stringDescriptionvpcDescription

8.1.79.2 - 1.2

scp-cli vpc vpc set
--vpc_id <value>
[--description <value>]

Description

Set VPC.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-
description
optional
stringDescriptionvpcDescription

8.1.79.3 - 1.1

scp-cli vpc vpc set
--vpc_id <value>
[--description <value>]

Description

Set VPC.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-
description
optional
stringDescriptionvpcDescription

8.1.79.4 - 1.0

scp-cli vpc vpc set
--vpc_id <value>
[--description <value>]

Description

Set VPC.

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

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-
description
optional
stringDescriptionvpcDescription

8.1.80 - Set VPC Endpoint

8.1.80.1 - 1.3

scp-cli vpc vpc-endpoint set
--vpc_endpoint_id <value>
[--description <value>]

Description

Set VPC Endpoint.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
description
optional
stringDescriptionVpcEndpoint Description

8.1.80.2 - 1.2

scp-cli vpc vpc-endpoint set
--vpc_endpoint_id <value>
[--description <value>]

Description

Set VPC Endpoint.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
description
optional
stringDescriptionVpcEndpoint Description

8.1.80.3 - 1.1

scp-cli vpc vpc-endpoint set
--vpc_endpoint_id <value>
[--description <value>]

Description

Set VPC Endpoint.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
description
optional
stringDescriptionVpcEndpoint Description

8.1.80.4 - 1.0

scp-cli vpc vpc-endpoint set
--vpc_endpoint_id <value>
[--description <value>]

Description

Set VPC Endpoint.

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

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
description
optional
stringDescriptionVpcEndpoint Description

8.1.81 - Set VPC Peering

8.1.81.1 - 1.3

scp-cli vpc vpc-peering set
--vpc_peering_id <value>
[--description <value>]

Description

Set VPC Peering.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492
description
optional
stringDescriptionvpcPeering Description

8.1.81.2 - 1.2

scp-cli vpc vpc-peering set
--vpc_peering_id <value>
[--description <value>]

Description

Set VPC Peering.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492
description
optional
stringDescriptionvpcPeering Description

8.1.81.3 - 1.1

scp-cli vpc vpc-peering set
--vpc_peering_id <value>
[--description <value>]

Description

Set VPC Peering.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492
description
optional
stringDescriptionvpcPeering Description

8.1.81.4 - 1.0

scp-cli vpc vpc-peering set
--vpc_peering_id <value>
[--description <value>]

Description

Set VPC Peering.

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

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492
description
optional
stringDescriptionvpcPeering Description

8.1.82 - Show Internet Gateway

8.1.82.1 - 1.3

scp-cli vpc internet-gateway show
--internet_gateway_id <value>

Description

Show Internet Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idInternet Gateway ID023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionInternet Gateway Description
firewall_idFirewall IDb156740b6335468d8354eb9ef8eddf5a
loggableNAT LoggableFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
multi_zone_enabledMulti Zone EnabledTrue
nameInternet Gateway NameIGW_VPCname
stateState
typeInternet Gateway Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.82.2 - 1.2

scp-cli vpc internet-gateway show
--internet_gateway_id <value>

Description

Show Internet Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idInternet Gateway ID023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionInternet Gateway Description
firewall_idFirewall IDb156740b6335468d8354eb9ef8eddf5a
loggableNAT LoggableFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway NameIGW_VPCname
stateState
typeInternet Gateway Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.82.3 - 1.1

scp-cli vpc internet-gateway show
--internet_gateway_id <value>

Description

Show Internet Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idInternet Gateway ID023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionInternet Gateway Description
firewall_idFirewall IDb156740b6335468d8354eb9ef8eddf5a
loggableNAT LoggableFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway NameIGW_VPCname
stateState
typeInternet Gateway Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.82.4 - 1.0

scp-cli vpc internet-gateway show
--internet_gateway_id <value>

Description

Show Internet Gateway.

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

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idInternet Gateway ID023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionInternet Gateway Description
firewall_idFirewall IDb156740b6335468d8354eb9ef8eddf5a
loggableNAT LoggableFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway NameIGW_VPCname
stateState
typeInternet Gateway Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.83 - Show NAT Gateway

8.1.83.1 - 1.3

scp-cli vpc nat-gateway show
--nat_gateway_id <value>

Description

Show NAT Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID12f56e27070248a6a240a497e43fbe18

Responses

NameDescriptionExample
idNAT Gateway ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway DescriptionVpcEndpoint Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
multi_zone_enabledMulti Zone Usetrue
nameNAT Gateway NameNatGatewayName
nat_gateway_ipsNAT Gateway IPs
stateNAT Gateway StateACTIVE
subnet_cidrSubnet Cidr192.167.1.0/24
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.83.2 - 1.2

scp-cli vpc nat-gateway show
--nat_gateway_id <value>

Description

Show NAT Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID12f56e27070248a6a240a497e43fbe18

Responses

NameDescriptionExample
idNAT Gateway ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway DescriptionVpcEndpoint Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway NameNatGatewayName
nat_gateway_ip_addressNAT Gateway IP Address192.167.0.5
publicip_idPublicIP ID12f56e27070248a6a240a497e43fbe18
stateNAT Gateway StateACTIVE
subnet_cidrSubnet Cidr192.167.1.0/24
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.83.3 - 1.1

scp-cli vpc nat-gateway show
--nat_gateway_id <value>

Description

Show NAT Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID12f56e27070248a6a240a497e43fbe18

Responses

NameDescriptionExample
idNAT Gateway ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway DescriptionVpcEndpoint Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway NameNatGatewayName
nat_gateway_ip_addressNAT Gateway IP Address192.167.0.5
publicip_idPublicIP ID12f56e27070248a6a240a497e43fbe18
stateNAT Gateway StateACTIVE
subnet_cidrSubnet Cidr192.167.1.0/24
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.83.4 - 1.0

scp-cli vpc nat-gateway show
--nat_gateway_id <value>

Description

Show NAT Gateway.

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

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID12f56e27070248a6a240a497e43fbe18

Responses

NameDescriptionExample
idNAT Gateway ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway DescriptionVpcEndpoint Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway NameNatGatewayName
nat_gateway_ip_addressNAT Gateway IP Address192.167.0.5
publicip_idPublicIP ID12f56e27070248a6a240a497e43fbe18
stateNAT Gateway StateACTIVE
subnet_cidrSubnet Cidr192.167.1.0/24
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.84 - Show Port

8.1.84.1 - 1.3

scp-cli vpc port show
--port_id <value>

Description

Show port.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID023c57b1-4f11-4836-8933-8d085e061492

Responses

NameDescriptionExample
idPort ID023c57b1-4f11-4836-8933-8d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idConnected resource ID9387e8f51de04a03994de8a9c3524935
attached_resource_typeConnected resource Type
created_atCreated date
descriptionDescriptionPort Description
fixed_ip_addressFixed IP192.168.1.100
mac_addressMAC Addressfa:16:3e:00:00:01
modified_atModified date
namePort NameportName
security_groupsSecurity Group List
stateState
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
virtual_ip_addressesVirtual IP Address
vpc_idVPC Id071bc63b767444c9afaab1c972d302d5
vpc_nameVPC NamevpcName

8.1.84.2 - 1.2

scp-cli vpc port show
--port_id <value>

Description

Show port.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID023c57b1-4f11-4836-8933-8d085e061492

Responses

NameDescriptionExample
idPort ID023c57b1-4f11-4836-8933-8d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idConnected resource ID9387e8f51de04a03994de8a9c3524935
attached_resource_typeConnected resource Type
created_atCreated date
descriptionDescriptionPort Description
fixed_ip_addressFixed IP192.168.1.100
mac_addressMAC Addressfa:16:3e:00:00:01
modified_atModified date
namePort NameportName
security_groupsSecurity Group List
stateState
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
virtual_ip_addressesVirtual IP Address
vpc_idVPC Id071bc63b767444c9afaab1c972d302d5
vpc_nameVPC NamevpcName

8.1.84.3 - 1.1

scp-cli vpc port show
--port_id <value>

Description

Show port.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID023c57b1-4f11-4836-8933-8d085e061492

Responses

NameDescriptionExample
idPort ID023c57b1-4f11-4836-8933-8d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idConnected resource ID9387e8f51de04a03994de8a9c3524935
attached_resource_typeConnected resource Type
created_atCreated date
descriptionDescriptionPort Description
fixed_ip_addressFixed IP192.168.1.100
mac_addressMAC Addressfa:16:3e:00:00:01
modified_atModified date
namePort NameportName
security_groupsSecurity Group List
stateState
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id071bc63b767444c9afaab1c972d302d5
vpc_nameVPC NamevpcName

8.1.84.4 - 1.0

scp-cli vpc port show
--port_id <value>

Description

Show port.

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

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID023c57b1-4f11-4836-8933-8d085e061492

Responses

NameDescriptionExample
idPort ID023c57b1-4f11-4836-8933-8d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idConnected resource ID9387e8f51de04a03994de8a9c3524935
attached_resource_typeConnected resource Type
created_atCreated date
descriptionDescriptionPort Description
fixed_ip_addressFixed IP192.168.1.100
mac_addressMAC Addressfa:16:3e:00:00:01
modified_atModified date
namePort NameportName
security_groupsSecurity Group List
stateState
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id071bc63b767444c9afaab1c972d302d5
vpc_nameVPC NamevpcName

8.1.85 - Show Private NAT

8.1.85.1 - 1.3

scp-cli vpc private-nat show
--private_nat_id <value>

Description

Show Private NAT.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18

Responses

NameDescriptionExample
idPrivate NAT ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrPrivate NAT IP range192.167.0.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateNat Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT NamePrivateNatName
service_resource_idPrivate NAT connected Service Resource ID3f342bf9a557405b997c2cf48c89cbc2
service_resource_namePrivate NAT connected Service Resource NamePrivateNatName
service_typePrivate NAT connected Service TypeDIRECT_CONNECT
statePrivate NAT StateACTIVE

8.1.85.2 - 1.2

scp-cli vpc private-nat show
--private_nat_id <value>

Description

Show Private NAT.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18

Responses

NameDescriptionExample
idPrivate NAT ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrPrivate NAT IP range192.167.0.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateNat Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT NamePrivateNatName
service_resource_idPrivate NAT connected Service Resource ID3f342bf9a557405b997c2cf48c89cbc2
service_resource_namePrivate NAT connected Service Resource NamePrivateNatName
service_typePrivate NAT connected Service TypeDIRECT_CONNECT
statePrivate NAT StateACTIVE

8.1.85.3 - 1.1

scp-cli vpc private-nat show
--private_nat_id <value>

Description

Show Private NAT.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18

Responses

NameDescriptionExample
idPrivate NAT ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrPrivate NAT IP range192.167.0.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateNat Description
direct_connect_idDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
direct_connect_nameDirect Connect NameDirectConnectName
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT NamePrivateNatName
statePrivate NAT StateACTIVE
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.85.4 - 1.0

scp-cli vpc private-nat show
--private_nat_id <value>

Description

Show Private NAT.

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

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18

Responses

NameDescriptionExample
idPrivate NAT ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrPrivate NAT IP range192.167.0.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateNat Description
direct_connect_idDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
direct_connect_nameDirect Connect NameDirectConnectName
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT NamePrivateNatName
statePrivate NAT StateACTIVE
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.86 - Show PrivateLink Endpoint

8.1.86.1 - 1.3

scp-cli vpc privatelink-endpoint show
--privatelink_endpoint_id <value>

Description

Show PrivateLink Endpoint.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02

Responses

NameDescriptionExample
idPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
approval_typePrivateLink Service Approval TypeAUTO
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateLink Endpoint Description
endpoint_ip_addressEndpoint IP Address192.167.1.5
endpoint_ip_port_idEndpoint IP Port IDb44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Endpoint NameEndpointName
privatelink_service_idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
security_group_idsSecurity Group List[‘17776b52-0a64-440d-9e93-b4fc37be935b’]
statePrivateLink Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8

8.1.86.2 - 1.2

scp-cli vpc privatelink-endpoint show
--privatelink_endpoint_id <value>

Description

Show PrivateLink Endpoint.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02

Responses

NameDescriptionExample
idPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
approval_typePrivateLink Service Approval TypeAUTO
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateLink Endpoint Description
endpoint_ip_addressEndpoint IP Address192.167.1.5
endpoint_ip_port_idEndpoint IP Port IDb44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Endpoint NameEndpointName
privatelink_service_idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
security_group_idsSecurity Group List[‘17776b52-0a64-440d-9e93-b4fc37be935b’]
statePrivateLink Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8

8.1.86.3 - 1.1

scp-cli vpc privatelink-endpoint show
--privatelink_endpoint_id <value>

Description

Show PrivateLink Endpoint.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02

Responses

NameDescriptionExample
idPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
approval_typePrivateLink Service Approval TypeAUTO
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateLink Endpoint Description
endpoint_ip_addressEndpoint IP Address192.167.1.5
endpoint_ip_port_idEndpoint IP Port IDb44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Endpoint NameEndpointName
privatelink_service_idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
security_group_idsSecurity Group List[‘17776b52-0a64-440d-9e93-b4fc37be935b’]
statePrivateLink Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8

8.1.87 - Show PrivateLink Service

8.1.87.1 - 1.3

scp-cli vpc privatelink-service show
--privatelink_service_id <value>

Description

Show PrivateLink Service.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d

Responses

NameDescriptionExample
idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
approval_typePrivateLink Service Approval TypeAUTO
connected_resource_idConnected Resource IDa3e3a662a4f34442a94166df5ff9f577
connected_resource_ip_addressConnected Resource IP Address192.167.0.10
connected_resource_nameConnected Resource NamelbResourceName
connected_resource_typeConnected Resource TypeLB
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateLink Service Description
high_speed_transferHigh Speed Data Transfer UseFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Service NameServiceName
security_group_idsSecurity Group List[‘00b6af37-73b5-4de2-b080-c295a1a0382e’]
service_ip_addressService IP Address192.167.0.5
service_ip_port_idService IP Port IDd21a4b81-f52a-43a8-b985-341e763458bb
statePrivateLink Service State
subnet_idSubnet Id023c57b14f11483689338d085e061492
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8

8.1.87.2 - 1.2

scp-cli vpc privatelink-service show
--privatelink_service_id <value>

Description

Show PrivateLink Service.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d

Responses

NameDescriptionExample
idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
approval_typePrivateLink Service Approval TypeAUTO
connected_resource_idConnected Resource IDa3e3a662a4f34442a94166df5ff9f577
connected_resource_ip_addressConnected Resource IP Address192.167.0.10
connected_resource_nameConnected Resource NamelbResourceName
connected_resource_typeConnected Resource TypeLB
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateLink Service Description
high_speed_transferHigh Speed Data Transfer UseFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Service NameServiceName
security_group_idsSecurity Group List[‘00b6af37-73b5-4de2-b080-c295a1a0382e’]
service_ip_addressService IP Address192.167.0.5
service_ip_port_idService IP Port IDd21a4b81-f52a-43a8-b985-341e763458bb
statePrivateLink Service State
subnet_idSubnet Id023c57b14f11483689338d085e061492
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8

8.1.87.3 - 1.1

scp-cli vpc privatelink-service show
--privatelink_service_id <value>

Description

Show PrivateLink Service.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d

Responses

NameDescriptionExample
idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
approval_typePrivateLink Service Approval TypeAUTO
connected_resource_idConnected Resource IDa3e3a662a4f34442a94166df5ff9f577
connected_resource_ip_addressConnected Resource IP Address192.167.0.10
connected_resource_nameConnected Resource NamelbResourceName
connected_resource_typeConnected Resource TypeLB
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateLink Service Description
high_speed_transferHigh Speed Data Transfer UseFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Service NameServiceName
security_group_idsSecurity Group List[‘00b6af37-73b5-4de2-b080-c295a1a0382e’]
service_ip_addressService IP Address192.167.0.5
service_ip_port_idService IP Port IDd21a4b81-f52a-43a8-b985-341e763458bb
statePrivateLink Service State
subnet_idSubnet Id023c57b14f11483689338d085e061492
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8

8.1.88 - Show PublicIP

8.1.88.1 - 1.3

scp-cli vpc public-ip show
--publicip_id <value>

Description

Show PublicIP.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID12f56e27070248a6a240a497e43fbe18

Responses

NameDescriptionExample
idPublicIP ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idPublicIP Attached Resource ID37e6db41f5124184a43251a63124cdc9
attached_resource_namePublicIP Attached Resource NameAttached NAT Gateway Name
attached_resource_typePublicIP Attached Resource TypeNAT_GW
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP DescriptionPublic IP Description
ip_addressIP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP StateATTACHED
typePublicIP TypeIGW
zoneZonekr-west1-a

8.1.88.2 - 1.2

scp-cli vpc public-ip show
--publicip_id <value>

Description

Show PublicIP.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID12f56e27070248a6a240a497e43fbe18

Responses

NameDescriptionExample
idPublicIP ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idPublicIP Attached Resource ID37e6db41f5124184a43251a63124cdc9
attached_resource_namePublicIP Attached Resource NameAttached NAT Gateway Name
attached_resource_typePublicIP Attached Resource TypeNAT_GW
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP DescriptionPublic IP Description
ip_addressIP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP StateATTACHED
typePublicIP TypeIGW

8.1.88.3 - 1.1

scp-cli vpc public-ip show
--publicip_id <value>

Description

Show PublicIP.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID12f56e27070248a6a240a497e43fbe18

Responses

NameDescriptionExample
idPublicIP ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idPublicIP Attached Resource ID37e6db41f5124184a43251a63124cdc9
attached_resource_namePublicIP Attached Resource NameAttached NAT Gateway Name
attached_resource_typePublicIP Attached Resource TypeNAT_GW
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP DescriptionPublic IP Description
ip_addressIP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP StateATTACHED
typePublicIP TypeIGW

8.1.88.4 - 1.0

scp-cli vpc public-ip show
--publicip_id <value>

Description

Show PublicIP.

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

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID12f56e27070248a6a240a497e43fbe18

Responses

NameDescriptionExample
idPublicIP ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idPublicIP Attached Resource ID37e6db41f5124184a43251a63124cdc9
attached_resource_namePublicIP Attached Resource NameAttached NAT Gateway Name
attached_resource_typePublicIP Attached Resource TypeNAT_GW
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP DescriptionPublic IP Description
ip_addressIP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP StateATTACHED
typePublicIP TypeIGW

8.1.89 - Show Subnet

8.1.89.1 - 1.3

scp-cli vpc subnet show
--subnet_id <value>

Description

Show subnet.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idSubnet Id023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
allocation_poolsAllocation Pools
categorySubnet CategoryPRIMARY
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionSubnet Description
dhcp_ip_addressDHCP IP Address
dns_nameserversDNS Name Servers
gateway_ip_addressGateway IP Address192.167.1.1
host_routesHost Routes
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
primary_subnet_idPrimary Subnet ID023c57b14f11483689338d085e061492
secondary_subnet_idsSecondary Subnet ID List[“522e102f680448a8804d18d4838baa78”, “aec40baf53c243c1bb8401a703a2c888”]
stateState
typeSubnet TypePUBLIC
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName
zonesSubnet Zone List[“kr-west1-a”, “kr-west1-b”, “kr-west1-c”]

8.1.89.2 - 1.2

scp-cli vpc subnet show
--subnet_id <value>

Description

Show subnet.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idSubnet Id023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
allocation_poolsAllocation Pools
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionSubnet Description
dhcp_ip_addressDHCP IP Address
dns_nameserversDNS Name Servers
gateway_ip_addressGateway IP Address192.167.1.1
host_routesHost Routes
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
stateState
typeSubnet TypeGENERAL
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.89.3 - 1.1

scp-cli vpc subnet show
--subnet_id <value>

Description

Show subnet.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idSubnet Id023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
allocation_poolsAllocation Pools
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionSubnet Description
dns_nameserversDNS Name Servers
gateway_ip_addressGateway IP Address192.167.1.1
host_routesHost Routes
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
stateState
typeSubnet TypeGENERAL
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.89.4 - 1.0

scp-cli vpc subnet show
--subnet_id <value>

Description

Show subnet.

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

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idSubnet Id023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
allocation_poolsAllocation Pools
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionSubnet Description
dns_nameserversDNS Name Servers
gateway_ip_addressGateway IP Address192.167.1.1
host_routesHost Routes
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
stateState
typeSubnet TypeGENERAL
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.90 - Show Subnet Vip

8.1.90.1 - 1.3

scp-cli vpc subnet vip show
--vip_id <value>
--subnet_id <value>

Description

Show Subnet Vip

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
vip_id
required
stringSubnet Vip Id0466a9448d9a4411a86055939e451c8f
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idSubnet Vip Id0466a9448d9a4411a86055939e451c8f
connected_ports
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionSubnet VIP Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
stateStateACTIVE
static_natStatic NAT Info
subnet_idSubnet ID023c57b14f11483689338d085e061492
vip_port_idVip Port Id35268a9f2eda4cde83b1d85c1f61f67d
virtual_ip_addressVirtual IP Address192.168.20.6

8.1.90.2 - 1.2

scp-cli vpc subnet vip show
--vip_id <value>
--subnet_id <value>

Description

Show Subnet Vip

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
vip_id
required
stringSubnet Vip Id0466a9448d9a4411a86055939e451c8f
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idSubnet Vip Id0466a9448d9a4411a86055939e451c8f
connected_ports
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionSubnet VIP Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
stateStateACTIVE
static_natStatic NAT Info
subnet_idSubnet ID023c57b14f11483689338d085e061492
vip_port_idVip Port Id35268a9f2eda4cde83b1d85c1f61f67d
virtual_ip_addressVirtual IP Address192.168.20.6

8.1.91 - Show Transit Gateway

8.1.91.1 - 1.3

scp-cli vpc transit-gateway show
--transit_gateway_id <value>

Description

Show Transit Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

Responses

NameDescriptionExample
idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthTransit Gateway Port Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway DescriptionTransitGateway Description
firewall_connection_stateFirewall Connection StateINACTIVE
firewall_idsFirewall IDsbbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_active_zoneUplink Active Zonekr-west1-a
uplink_enabledUplink EnabledFalse
uplink_standby_zoneUplink Standby Zonekr-west1-b
uplink_zone_stateUplink Zone Connect stateACTIVE

8.1.91.2 - 1.2

scp-cli vpc transit-gateway show
--transit_gateway_id <value>

Description

Show Transit Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

Responses

NameDescriptionExample
idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthTransit Gateway Port Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway DescriptionTransitGateway Description
firewall_connection_stateFirewall Connection StateINACTIVE
firewall_idsFirewall IDsbbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse

8.1.91.3 - 1.1

scp-cli vpc transit-gateway show
--transit_gateway_id <value>

Description

Show Transit Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

Responses

NameDescriptionExample
idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthTransit Gateway Port Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway DescriptionTransitGateway Description
firewall_idsFirewall IDsbbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse

8.1.91.4 - 1.0

scp-cli vpc transit-gateway show
--transit_gateway_id <value>

Description

Show Transit Gateway.

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

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

Responses

NameDescriptionExample
idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthTransit Gateway Port Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway DescriptionTransitGateway Description
firewall_idsFirewall IDsbbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse

8.1.92 - Show VPC

8.1.92.1 - 1.3

scp-cli vpc vpc show
--vpc_id <value>

Description

Show VPC.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-

Responses

NameDescriptionExample
idVPC Id7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidr_countCidr Count20
cidrs
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionvpcDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC NamevpcName
stateState
zone_typeVpc Zone Type InformationPUBLIC
zonesVpc Zones Information[‘zone-a’, ‘zone-b’, ‘zone-c’]

8.1.92.2 - 1.2

scp-cli vpc vpc show
--vpc_id <value>

Description

Show VPC.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-

Responses

NameDescriptionExample
idVPC Id7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidr_countCidr Count20
cidrs
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionvpcDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC NamevpcName
stateState

8.1.92.3 - 1.1

scp-cli vpc vpc show
--vpc_id <value>

Description

Show VPC.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-

Responses

NameDescriptionExample
idVPC Id7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrVPC Cidr192.167.0.0/18
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionvpcDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC NamevpcName
stateState

8.1.92.4 - 1.0

scp-cli vpc vpc show
--vpc_id <value>

Description

Show VPC.

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

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-

Responses

NameDescriptionExample
idVPC Id7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrVPC Cidr192.167.0.0/18
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionvpcDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC NamevpcName
stateState

8.1.93 - Show VPC Endpoint

8.1.93.1 - 1.3

scp-cli vpc vpc-endpoint show
--vpc_endpoint_id <value>

Description

Show VPC Endpoint.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID12f56e27070248a6a240a497e43fbe18

Responses

NameDescriptionExample
idVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionVpcEndpoint Description
endpoint_ip_addressVPC Endpoint IP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint NameVpcEndpointName
resource_infoVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
resource_keyVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_typeVPC Endpoint Resource TypeFS
stateVPC Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.93.2 - 1.2

scp-cli vpc vpc-endpoint show
--vpc_endpoint_id <value>

Description

Show VPC Endpoint.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID12f56e27070248a6a240a497e43fbe18

Responses

NameDescriptionExample
idVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionVpcEndpoint Description
endpoint_ip_addressVPC Endpoint IP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint NameVpcEndpointName
resource_infoVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
resource_keyVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_typeVPC Endpoint Resource TypeFS
stateVPC Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.93.3 - 1.1

scp-cli vpc vpc-endpoint show
--vpc_endpoint_id <value>

Description

Show VPC Endpoint.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID12f56e27070248a6a240a497e43fbe18

Responses

NameDescriptionExample
idVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionVpcEndpoint Description
endpoint_ip_addressVPC Endpoint IP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint NameVpcEndpointName
resource_infoVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
resource_keyVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_typeVPC Endpoint Resource TypeFS
stateVPC Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.93.4 - 1.0

scp-cli vpc vpc-endpoint show
--vpc_endpoint_id <value>

Description

Show VPC Endpoint.

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

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID12f56e27070248a6a240a497e43fbe18

Responses

NameDescriptionExample
idVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionVpcEndpoint Description
endpoint_ip_addressVPC Endpoint IP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint NameVpcEndpointName
resource_infoVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
resource_keyVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_typeVPC Endpoint Resource TypeFS
stateVPC Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.94 - Show VPC Peering

8.1.94.1 - 1.3

scp-cli vpc vpc-peering show
--vpc_peering_id <value>

Description

Show VPC Peering.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idVPC Peering ID023c57b14f11483689338d085e061492
account_typeAccount Type
approver_vpc_account_idApprover VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
approver_vpc_idApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_nameApprover VPC NamevpcName
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
descriptionVPC Peering DescriptionvpcPeering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering NamevpcPeeringName
requester_vpc_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
requester_vpc_idRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
requester_vpc_nameRequester VPC NamevpcName
stateState

8.1.94.2 - 1.2

scp-cli vpc vpc-peering show
--vpc_peering_id <value>

Description

Show VPC Peering.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idVPC Peering ID023c57b14f11483689338d085e061492
account_typeAccount Type
approver_vpc_account_idApprover VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
approver_vpc_idApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_nameApprover VPC NamevpcName
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
descriptionVPC Peering DescriptionvpcPeering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering NamevpcPeeringName
requester_vpc_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
requester_vpc_idRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
requester_vpc_nameRequester VPC NamevpcName
stateState

8.1.94.3 - 1.1

scp-cli vpc vpc-peering show
--vpc_peering_id <value>

Description

Show VPC Peering.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idVPC Peering ID023c57b14f11483689338d085e061492
account_typeAccount Type
approver_vpc_account_idApprover VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
approver_vpc_idApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_nameApprover VPC NamevpcName
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
descriptionVPC Peering DescriptionvpcPeering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering NamevpcPeeringName
requester_vpc_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
requester_vpc_idRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
requester_vpc_nameRequester VPC NamevpcName
stateState

8.1.94.4 - 1.0

scp-cli vpc vpc-peering show
--vpc_peering_id <value>

Description

Show VPC Peering.

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

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idVPC Peering ID023c57b14f11483689338d085e061492
account_typeAccount Type
approver_vpc_account_idApprover VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
approver_vpc_idApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_nameApprover VPC NamevpcName
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
descriptionVPC Peering DescriptionvpcPeering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering NamevpcPeeringName
requester_vpc_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
requester_vpc_idRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
requester_vpc_nameRequester VPC NamevpcName
stateState

9 - VPN

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 VPN service 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.1CURRENT-
1.0DEPRECATED20251231

CLI Version History

1.1

VPN CLI has been released.

Changes

  • [New] vpn vpn-gateway list - Command has been added.
  • [New] vpn vpn-gateway create - Command has been added.
  • [New] vpn vpn-gateway show - Command has been added.
  • [New] vpn vpn-gateway set - Command has been added.
  • [New] vpn vpn-gateway delete - Command has been added.
  • [New] vpn vpn-tunnel list - Command has been added.
  • [New] vpn vpn-tunnel create - Command has been added.
  • [New] vpn vpn-tunnel show - Command has been added.
  • [New] vpn vpn-tunnel set - Command has been added.
  • [New] vpn vpn-tunnel delete - Command has been added.

9.1 - CLIs

9.1.1 - Create VPN Gateway

9.1.1.1 - 1.1

scp-cli vpn vpn-gateway create
--vpc_id <value>
--name <value>
--ip_type <value>
--ip_id <value>
--ip_address <value>
[--description <value>]
[--tags <value>]

Description

Create VPN gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Idceb44ea5ecb34a49b16495f9a63b0718
name
required
stringVPN Gateway NameExampleVpnGW1
ip_type
required
stringVPN Gateway IP TypePUBLIC
ip_id
required
stringVPN Gateway IP IDfcde872f75c145a0893d656cc698f13e
ip_address
required
stringVPN Gateway IP Address123.0.0.1
description
optional
stringDescriptionExample Description for VPN Gateway
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Gateway
ip_addressVPN Gateway IP Address123.0.0.1
ip_idVPN Gateway IP IDfcde872f75c145a0893d656cc698f13e
ip_typeVPN Gateway IP TypePUBLIC
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Gateway NameExampleVpnGW1
stateStateACTIVE
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1

9.1.1.2 - 1.0

scp-cli vpn vpn-gateway create
--vpc_id <value>
--name <value>
--ip_type <value>
--ip_id <value>
--ip_address <value>
[--description <value>]
[--tags <value>]

Description

Create VPN gateway.

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

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Idceb44ea5ecb34a49b16495f9a63b0718
name
required
stringVPN Gateway NameExampleVpnGW1
ip_type
required
stringVPN Gateway IP TypePUBLIC
ip_id
required
stringVPN Gateway IP IDfcde872f75c145a0893d656cc698f13e
ip_address
required
stringVPN Gateway IP Address123.0.0.1
description
optional
stringDescriptionExample Description for VPN Gateway
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Gateway
ip_addressVPN Gateway IP Address123.0.0.1
ip_idVPN Gateway IP IDfcde872f75c145a0893d656cc698f13e
ip_typeVPN Gateway IP TypePUBLIC
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Gateway NameExampleVpnGW1
stateStateACTIVE
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1

9.1.2 - Create VPN Tunnel

9.1.2.1 - 1.1

scp-cli vpn vpn-tunnel create
--remote_subnets <value>
--phase2_life_time <value>
--phase2_encryptions <value>
--phase2_diffie_hellman_groups <value>
--perfect_forward_secrecy <value>
--pre_shared_key <value>
--phase1_life_time <value>
--phase1_encryptions <value>
--phase1_diffie_hellman_groups <value>
--peer_gateway_ip <value>
--ike_version <value>
--dpd_retry_interval <value>
--vpn_gateway_id <value>
--name <value>
[--description <value>]
[--tags <value>]

Description

Create VPN tunnel.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
remote_subnets
required
arrayVPN Tunnel IPSec Remote Subnet10.1.1.0/24
phase2_life_time
required
integerVPN Tunnel IPSec Lifetime (sec)43200
phase2_encryptions
required
arrayVPN Tunnel ISAKMP Proposal Listnull-md5
phase2_diffie_hellman_groups
required
arrayVPN Tunnel ISAKMP Diffie-Hellman Group List30
perfect_forward_secrecy
required
stringVPN Tunnel IPSec Perfect Forward Secrecy(PFS)ENABLE
pre_shared_key
required
stringVPN Tunnel ISAKMP Authentication : Pre-shared KeyPreSharedKey1
phase1_life_time
required
integerVPN Tunnel ISAKMP Lifetime (sec)86400
phase1_encryptions
required
arrayVPN Tunnel ISAKMP Proposal Listdes-md5
phase1_diffie_hellman_groups
required
arrayVPN Tunnel ISAKMP Diffie-Hellman Group List30
peer_gateway_ip
required
stringVPN Tunnel Peer Gateway IP Address123.0.0.2
ike_version
required
integerVPN Tunnel IKE Version2
dpd_retry_interval
required
integerVPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec)60
vpn_gateway_id
required
stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
name
required
stringVPN Tunnel NameExampleVpnTunnel1
description
optional
stringDescriptionExample Description for VPN Tunnel
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Tunnel
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Tunnel NameExampleVpnTunnel1
phase1VPN Tunnel Phase1
phase2VPN Tunnel Phase2
stateStateACTIVE
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1
vpn_gateway_idVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
vpn_gateway_ip_addressVPN Gateway IP Address123.0.0.1
vpn_gateway_nameVPN Gateway NameExampleVpnGW1

9.1.2.2 - 1.0

scp-cli vpn vpn-tunnel create
--remote_subnet <value>
--phase2_life_time <value>
--phase2_encryptions <value>
--phase2_diffie_hellman_groups <value>
--perfect_forward_secrecy <value>
--pre_shared_key <value>
--phase1_life_time <value>
--phase1_encryptions <value>
--phase1_diffie_hellman_groups <value>
--peer_gateway_ip <value>
--ike_version <value>
--dpd_retry_interval <value>
--vpn_gateway_id <value>
--name <value>
[--description <value>]
[--tags <value>]

Description

Create VPN tunnel.

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

Parameters

NameTypeDescriptionExample
remote_subnet
required
stringVPN Tunnel IPSec Remote Subnet10.1.0.0/16
phase2_life_time
required
integerVPN Tunnel IPSec Lifetime (sec)43200
phase2_encryptions
required
arrayVPN Tunnel ISAKMP Proposal Listnull-md5
phase2_diffie_hellman_groups
required
arrayVPN Tunnel ISAKMP Diffie-Hellman Group List30
perfect_forward_secrecy
required
stringVPN Tunnel IPSec Perfect Forward Secrecy(PFS)ENABLE
pre_shared_key
required
stringVPN Tunnel ISAKMP Authentication : Pre-shared KeyPreSharedKey1
phase1_life_time
required
integerVPN Tunnel ISAKMP Lifetime (sec)86400
phase1_encryptions
required
arrayVPN Tunnel ISAKMP Proposal Listdes-md5
phase1_diffie_hellman_groups
required
arrayVPN Tunnel ISAKMP Diffie-Hellman Group List30
peer_gateway_ip
required
stringVPN Tunnel Peer Gateway IP Address123.0.0.2
ike_version
required
integerVPN Tunnel IKE Version2
dpd_retry_interval
required
integerVPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec)60
vpn_gateway_id
required
stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
name
required
stringVPN Tunnel NameExampleVpnTunnel1
description
optional
stringDescriptionExample Description for VPN Tunnel
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Tunnel
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Tunnel NameExampleVpnTunnel1
phase1VPN Tunnel Phase1
phase2VPN Tunnel Phase2
stateStateACTIVE
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1
vpn_gateway_idVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
vpn_gateway_ip_addressVPN Gateway IP Address123.0.0.1
vpn_gateway_nameVPN Gateway NameExampleVpnGW1

9.1.3 - Delete VPN Gateway

9.1.3.1 - 1.1

scp-cli vpn vpn-gateway delete
--vpn_gateway_id <value>

Description

Delete VPN gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
vpn_gateway_id
required
stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a

9.1.3.2 - 1.0

scp-cli vpn vpn-gateway delete
--vpn_gateway_id <value>

Description

Delete VPN gateway.

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

Parameters

NameTypeDescriptionExample
vpn_gateway_id
required
stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a

9.1.4 - Delete VPN Tunnel

9.1.4.1 - 1.1

scp-cli vpn vpn-tunnel delete
--vpn_tunnel_id <value>

Description

Delete VPN tunnel.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
vpn_tunnel_id
required
stringVPN Tunnel ID2ade2919287040bc92e557fbbe6709c1

9.1.4.2 - 1.0

scp-cli vpn vpn-tunnel delete
--vpn_tunnel_id <value>

Description

Delete VPN tunnel.

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

Parameters

NameTypeDescriptionExample
vpn_tunnel_id
required
stringVPN Tunnel ID2ade2919287040bc92e557fbbe6709c1

9.1.5 - List VPN Gateways

9.1.5.1 - 1.1

scp-cli vpn vpn-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--ip_address <value>]
[--vpc_id <value>]
[--vpc_name <value>]

Description

Get VPN gateway list.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringVPN Gateway NameExampleVpnGW1
ip_address
optional
stringVPN Gateway IP Address123.0.0.1
vpc_id
optional
stringVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_name
optional
stringVPC NameExampleVPC1

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Gateway
ip_addressVPN Gateway IP Address123.0.0.1
ip_idVPN Gateway IP IDfcde872f75c145a0893d656cc698f13e
ip_typeVPN Gateway IP TypePUBLIC
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Gateway NameExampleVpnGW1
stateStateACTIVE
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1

9.1.5.2 - 1.0

scp-cli vpn vpn-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--ip_address <value>]
[--vpc_id <value>]
[--vpc_name <value>]

Description

Get VPN gateway 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.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringVPN Gateway NameExampleVpnGW1
ip_address
optional
stringVPN Gateway IP Address123.0.0.1
vpc_id
optional
stringVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_name
optional
stringVPC NameExampleVPC1

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Gateway
ip_addressVPN Gateway IP Address123.0.0.1
ip_idVPN Gateway IP IDfcde872f75c145a0893d656cc698f13e
ip_typeVPN Gateway IP TypePUBLIC
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Gateway NameExampleVpnGW1
stateStateACTIVE
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1

9.1.6 - List VPN Tunnels

9.1.6.1 - 1.1

scp-cli vpn vpn-tunnel list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--vpn_gateway_id <value>]
[--vpn_gateway_name <value>]

Description

Get VPN tunnel list.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringVPN Tunnel NameExampleVpnTunnel1
vpn_gateway_id
optional
stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
vpn_gateway_name
optional
stringVPN Gateway NameExampleVpnGW1

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Tunnel
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Tunnel NameExampleVpnTunnel1
phase1VPN Tunnel Phase1
phase2VPN Tunnel Phase2
stateStateACTIVE
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1
vpn_gateway_idVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
vpn_gateway_ip_addressVPN Gateway IP Address123.0.0.1
vpn_gateway_nameVPN Gateway NameExampleVpnGW1

9.1.6.2 - 1.0

scp-cli vpn vpn-tunnel list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--vpn_gateway_id <value>]
[--vpn_gateway_name <value>]
[--peer_gateway_ip <value>]
[--remote_subnet <value>]

Description

Get VPN tunnel 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.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringVPN Tunnel NameExampleVpnTunnel1
vpn_gateway_id
optional
stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
vpn_gateway_name
optional
stringVPN Gateway NameExampleVpnGW1
peer_gateway_ip
optional
stringVPN Tunnel Peer Gateway IP Address123.0.0.2
remote_subnet
optional
stringVPN Tunnel IPSec Remote Subnet10.1.0.0/16

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Tunnel
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Tunnel NameExampleVpnTunnel1
phase1VPN Tunnel Phase1
phase2VPN Tunnel Phase2
stateStateACTIVE
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1
vpn_gateway_idVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
vpn_gateway_ip_addressVPN Gateway IP Address123.0.0.1
vpn_gateway_nameVPN Gateway NameExampleVpnGW1

9.1.7 - Set VPN Gateway

9.1.7.1 - 1.1

scp-cli vpn vpn-gateway set
--vpn_gateway_id <value>
[--description <value>]

Description

Set VPN gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
vpn_gateway_id
required
stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
description
optional
stringDescriptionExample Description for VPN Gateway

9.1.7.2 - 1.0

scp-cli vpn vpn-gateway set
--vpn_gateway_id <value>
[--description <value>]

Description

Set VPN gateway.

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

Parameters

NameTypeDescriptionExample
vpn_gateway_id
required
stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
description
optional
stringDescriptionExample Description for VPN Gateway

9.1.8 - Set VPN Tunnel

9.1.8.1 - 1.1

scp-cli vpn vpn-tunnel set
--vpn_tunnel_id <value>
[--description <value>]
[--dpd_retry_interval <value>]
[--ike_version <value>]
[--peer_gateway_ip <value>]
[--phase1_diffie_hellman_groups <value>]
[--phase1_encryptions <value>]
[--phase1_life_time <value>]
[--pre_shared_key <value>]
[--perfect_forward_secrecy <value>]
[--phase2_diffie_hellman_groups <value>]
[--phase2_encryptions <value>]
[--phase2_life_time <value>]
[--remote_subnets <value>]

Description

Set VPN tunnel.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
vpn_tunnel_id
required
stringVPN Tunnel ID2ade2919287040bc92e557fbbe6709c1
description
optional
stringDescriptionExample Description for VPN Tunnel
dpd_retry_interval
optional
integerVPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec)60
ike_version
optional
integerVPN Tunnel IKE Version2
peer_gateway_ip
optional
stringVPN Tunnel Peer Gateway IP Address123.0.0.2
phase1_diffie_hellman_groups
optional
arrayVPN Tunnel ISAKMP Diffie-Hellman Group List30
phase1_encryptions
optional
arrayVPN Tunnel ISAKMP Proposal Listdes-md5
phase1_life_time
optional
integerVPN Tunnel ISAKMP Lifetime (sec)86400
pre_shared_key
optional
stringVPN Tunnel ISAKMP Authentication : Pre-shared KeyPreSharedKey1
perfect_forward_secrecy
optional
****VPN Tunnel IPSec Perfect Forward Secrecy(PFS)ENABLE
phase2_diffie_hellman_groups
optional
arrayVPN Tunnel ISAKMP Diffie-Hellman Group List30
phase2_encryptions
optional
arrayVPN Tunnel ISAKMP Proposal Listnull-md5
phase2_life_time
optional
integerVPN Tunnel IPSec Lifetime (sec)43200
remote_subnets
optional
arrayVPN Tunnel IPSec Remote Subnet10.1.1.0/24

9.1.8.2 - 1.0

scp-cli vpn vpn-tunnel set
--vpn_tunnel_id <value>
[--description <value>]
[--dpd_retry_interval <value>]
[--ike_version <value>]
[--peer_gateway_ip <value>]
[--phase1_diffie_hellman_groups <value>]
[--phase1_encryptions <value>]
[--phase1_life_time <value>]
[--pre_shared_key <value>]
[--perfect_forward_secrecy <value>]
[--phase2_diffie_hellman_groups <value>]
[--phase2_encryptions <value>]
[--phase2_life_time <value>]
[--remote_subnet <value>]

Description

Set VPN tunnel.

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

Parameters

NameTypeDescriptionExample
vpn_tunnel_id
required
stringVPN Tunnel ID2ade2919287040bc92e557fbbe6709c1
description
optional
stringDescriptionExample Description for VPN Tunnel
dpd_retry_interval
optional
integerVPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec)60
ike_version
optional
integerVPN Tunnel IKE Version2
peer_gateway_ip
optional
stringVPN Tunnel Peer Gateway IP Address123.0.0.2
phase1_diffie_hellman_groups
optional
arrayVPN Tunnel ISAKMP Diffie-Hellman Group List30
phase1_encryptions
optional
arrayVPN Tunnel ISAKMP Proposal Listdes-md5
phase1_life_time
optional
integerVPN Tunnel ISAKMP Lifetime (sec)86400
pre_shared_key
optional
stringVPN Tunnel ISAKMP Authentication : Pre-shared KeyPreSharedKey1
perfect_forward_secrecy
optional
****VPN Tunnel IPSec Perfect Forward Secrecy(PFS)ENABLE
phase2_diffie_hellman_groups
optional
arrayVPN Tunnel ISAKMP Diffie-Hellman Group List30
phase2_encryptions
optional
arrayVPN Tunnel ISAKMP Proposal Listnull-md5
phase2_life_time
optional
integerVPN Tunnel IPSec Lifetime (sec)43200
remote_subnet
optional
stringVPN Tunnel IPSec Remote Subnet10.1.0.0/16

9.1.9 - Show VPN Gateway

9.1.9.1 - 1.1

scp-cli vpn vpn-gateway show
--vpn_gateway_id <value>

Description

Show VPN gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
vpn_gateway_id
required
stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Gateway
ip_addressVPN Gateway IP Address123.0.0.1
ip_idVPN Gateway IP IDfcde872f75c145a0893d656cc698f13e
ip_typeVPN Gateway IP TypePUBLIC
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Gateway NameExampleVpnGW1
stateStateACTIVE
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1

9.1.9.2 - 1.0

scp-cli vpn vpn-gateway show
--vpn_gateway_id <value>

Description

Show VPN gateway.

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

Parameters

NameTypeDescriptionExample
vpn_gateway_id
required
stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Gateway
ip_addressVPN Gateway IP Address123.0.0.1
ip_idVPN Gateway IP IDfcde872f75c145a0893d656cc698f13e
ip_typeVPN Gateway IP TypePUBLIC
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Gateway NameExampleVpnGW1
stateStateACTIVE
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1

9.1.10 - Show VPN Tunnel

9.1.10.1 - 1.1

scp-cli vpn vpn-tunnel show
--vpn_tunnel_id <value>

Description

Show VPN tunnel.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
vpn_tunnel_id
required
stringVPN Tunnel ID2ade2919287040bc92e557fbbe6709c1

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Tunnel
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Tunnel NameExampleVpnTunnel1
phase1VPN Tunnel Phase1
phase2VPN Tunnel Phase2
stateStateACTIVE
statusVPN Tunnel StatusUP
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1
vpn_gateway_idVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
vpn_gateway_ip_addressVPN Gateway IP Address123.0.0.1
vpn_gateway_nameVPN Gateway NameExampleVpnGW1

9.1.10.2 - 1.0

scp-cli vpn vpn-tunnel show
--vpn_tunnel_id <value>

Description

Show VPN tunnel.

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

Parameters

NameTypeDescriptionExample
vpn_tunnel_id
required
stringVPN Tunnel ID2ade2919287040bc92e557fbbe6709c1

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Tunnel
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Tunnel NameExampleVpnTunnel1
phase1VPN Tunnel Phase1
phase2VPN Tunnel Phase2
stateStateACTIVE
statusVPN Tunnel StatusUP
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1
vpn_gateway_idVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
vpn_gateway_ip_addressVPN Gateway IP Address123.0.0.1
vpn_gateway_nameVPN Gateway NameExampleVpnGW1