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.1CURRENT-
1.0SUPPORTED20261130

1.1 - CLIs

1.1.1 - Create Direct Connect

1.1.1.1 - 1.1

scpcli 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 (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
name
required
stringDirect Connect NameDirectConnectName
bandwidth
required
integerPort Bandwidth1
description
optional
stringDirect Connect DescriptionTransitGateway 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.2 - 1.0

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

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

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

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

scpcli direct-connect direct-connect delete
--direct_connect_id <value>

Description

Delete direct connect.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
direct_connect_id
required
stringDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4

1.1.3.2 - 1.0

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

scpcli direct-connect routing-rule delete
--routing_rule_id <value>
--direct_connect_id <value>

Description

Delete a routing rule.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule IDc8980aa2bf1e43c9998682f7baaf1c46
direct_connect_id
required
stringDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4

1.1.4.2 - 1.0

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

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

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

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

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

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

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

scpcli direct-connect direct-connect set
--direct_connect_id <value>
--description <value>

Description

Set direct connect.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
direct_connect_id
required
stringDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
description
required
stringDirect Connect DescriptionTransitGateway Description

1.1.7.2 - 1.0

scpcli 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 DescriptionTransitGateway Description

1.1.8 - Show Direct Connect

1.1.8.1 - 1.1

scpcli direct-connect direct-connect show
--direct_connect_id <value>

Description

Show direct connect.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

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.2 - 1.0

scpcli 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-
1.2DEPRECATED20260331
1.1DEPRECATED20260331

2.1 - CLIs

2.1.1 - Activate Private DNS

2.1.1.1 - 1.3

scpcli dns private-dns activate
--name <value>

Description

Activate Private DNS

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
name
required
stringPrivate DNS Nameprivate-dns01

Responses

NameDescriptionExample
idPrivate DNS ID10fjkewefprivatedns3193rud543
auth_dns_nameAuth DNS Name
connected_vpc_idsConnected VPC ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate DNS Nameprivate-dns01
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
pool_namePool Name
registered_regionRegistered RegionKR-WEST1
resolver_ipPrivate DNS Resolver IP198.19.0.101
resolver_namePrivate DNS Resolver Name
stateState

2.1.1.2 - 1.2

scpcli dns private-dns activate
--name <value>

Description

Activate Private DNS

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

Parameters

NameTypeDescriptionExample
name
required
stringPrivate DNS Nameprivate-dns01

Responses

NameDescriptionExample
idPrivate DNS ID10fjkewefprivatedns3193rud543
auth_dns_nameAuth DNS Name
connected_vpc_idsConnected VPC ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate DNS Nameprivate-dns01
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
pool_namePool Name
registered_regionRegistered RegionKR-WEST1
resolver_ipPrivate DNS Resolver IP198.19.0.101
resolver_namePrivate DNS Resolver Name
stateState

2.1.1.3 - 1.1

scpcli dns private-dns activate
--name <value>

Description

Activate Private DNS

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

Parameters

NameTypeDescriptionExample
name
required
stringPrivate DNS Nameprivate-dns01

Responses

NameDescriptionExample
idPrivate DNS ID10fjkewefprivatedns3193rud543
auth_dns_nameAuth DNS Name
connected_vpc_idsConnected VPC ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate DNS Nameprivate-dns01
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
pool_namePool Name
registered_regionRegistered RegionKR-WEST1
resolver_ipPrivate DNS Resolver IP198.19.0.101
resolver_namePrivate DNS Resolver Name
stateState

2.1.2 - Create Hosted Zone

2.1.2.1 - 1.3

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

Description

Create a new hosted zone.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
type
required
stringType of zoneprivate
name
required
stringnamemy-zone.com
description
optional
stringdescriptionThis is description
private_dns_id
optional
stringPrivate DNS ID10fjkewefprivatedns3193rud543
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idHosted Zone ID3432012nfdksdf03ktrld9234lgfg
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
hosted_zone_typeHosted Zone type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameHosted Zone Namemy-zone.com
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
private_dns_idPrivate DNS ID10fjkewefprivatedns3193rud543
private_dns_namePrivate DNS Nameprivate-dns01
statusState
ttlTTL for the zone.3600

2.1.2.2 - 1.2

scpcli dns hosted-zone create
--name <value>
--email <value>
[--description <value>]
[--private_dns_id <value>]
[--tags <value>]
[--type <value>]

Description

Create a new hosted zone.

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

Parameters

NameTypeDescriptionExample
name
required
stringnamemy-zone.com
email
required
stringemailtest@samsung.com
description
optional
stringdescriptionThis is description
private_dns_id
optional
stringPrivate DNS ID-
tags
optional
arrayTag List'{"key": "", "value": ""}'
type
optional
stringType of zonepublic

Responses

NameDescriptionExample
idId3432012nfdksdf03ktrld9234lgfg
actioncurrent action in progress
attributesKey:Value pairs of information about this zone
created_atCreated Date2025-09-08T03:43:57Z
descriptiondescriptionThis is description
emailemailtest@samsung.com
hosted_zone_typeHosted Zone typepublic
linksLinks to resource
mastersThe servers to slave from to get DNS information
namenamemy-zone.com
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
private_dns_idPrivate DNS ID10fjkewefprivatedns3193rud543
private_dns_namePrivate DNS Nameprivate-dns01
project_idProjectID
serialserial number
sharedTrue if the zone is shared with another account
statusThe statusACTIVE
transferred_atThe last time an update was retrieved from the master servers
ttlTTL for the zone.3600
typeType of zone
updated_atUpdated Date
versionVersion

2.1.2.3 - 1.1

scpcli dns hosted-zone create
--name <value>
--email <value>
[--description <value>]
[--tags <value>]
[--type <value>]

Description

Create a new hosted zone.

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

Parameters

NameTypeDescriptionExample
name
required
stringnamemy-zone.com
email
required
stringemailtest@samsung.com
description
optional
stringdescriptionThis is description
tags
optional
arrayTag List'{"key": "", "value": ""}'
type
optional
stringType of zonepublic

Responses

NameDescriptionExample
idId3432012nfdksdf03ktrld9234lgfg
actioncurrent action in progress
attributesKey:Value pairs of information about this zone
created_atCreated Date2025-09-08T03:43:57Z
descriptiondescriptionThis is description
emailemailtest@samsung.com
hosted_zone_typeHosted Zone typepublic
linksLinks to resource
mastersThe servers to slave from to get DNS information
namenamemy-zone.com
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
project_idProjectID
serialserial number
sharedTrue if the zone is shared with another account
statusThe statusACTIVE
transferred_atThe last time an update was retrieved from the master servers
ttlTTL for the zone.3600
typeType of zone
updated_atUpdated Date
versionVersion

2.1.3 - Create Hosted Zone Record

2.1.3.1 - 1.3

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

Description

Create a new recordset in the hosted zone

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId3432012nfdksdf03ktrld9234lgfg
type
required
stringType of the recordA
records
required
arrayA list of data for this record12345.ns.private.kr-west1.dev2.samsungsdscloud.com
name
required
stringnametest.app
description
optional
stringdescriptionThis is description
ttl
optional
integerTTL for the zone.3600

Responses

NameDescriptionExample
idRecord ID6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
actioncurrent action in progressCREATE
created_atCreated Date2025-09-08T03:43:57Z
descriptiondescriptionThis is description
linksLinks to resource
namenametest.app
project_idProjectID003dffc50eb123a1cbf4f2e5c71d4f15
recordsA list of data for this record[‘12345.ns.private.kr-west1.dev2.samsungsdscloud.com’]
statusThe statusACTIVE
ttlTTL for the zone.3600
typeType of the recordA
updated_atUpdated Date2026-02-09T08:00:40Z
versionVersion1
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

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

Description

Create Private DNS

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
name
required
stringPrivate DNS Nameprivate-dns01
connected_vpc_ids
optional
arrayConnected VPC ID-
description
optional
stringdescriptionThis is description
tags
optional
array'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivate DNS ID10fjkewefprivatedns3193rud543
auth_dns_nameAuth DNS Name
connected_vpc_idsConnected VPC ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate DNS Nameprivate-dns01
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
pool_namePool Name
registered_regionRegistered RegionKR-WEST1
resolver_ipPrivate DNS Resolver IP198.19.0.101
resolver_namePrivate DNS Resolver Name
stateState

2.1.4.2 - 1.2

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

Description

Create Private DNS

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

Parameters

NameTypeDescriptionExample
name
required
stringPrivate DNS Nameprivate-dns01
connected_vpc_ids
optional
arrayConnected VPC ID-
description
optional
stringdescriptionThis is description
tags
optional
array'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivate DNS ID10fjkewefprivatedns3193rud543
auth_dns_nameAuth DNS Name
connected_vpc_idsConnected VPC ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate DNS Nameprivate-dns01
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
pool_namePool Name
registered_regionRegistered RegionKR-WEST1
resolver_ipPrivate DNS Resolver IP198.19.0.101
resolver_namePrivate DNS Resolver Name
stateState

2.1.4.3 - 1.1

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

Description

Create Private DNS

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

Parameters

NameTypeDescriptionExample
name
required
stringPrivate DNS Nameprivate-dns01
connected_vpc_ids
optional
arrayConnected VPC ID-
description
optional
stringdescriptionThis is description
tags
optional
array'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivate DNS ID10fjkewefprivatedns3193rud543
auth_dns_nameAuth DNS Name
connected_vpc_idsConnected VPC ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate DNS Nameprivate-dns01
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
pool_namePool Name
registered_regionRegistered RegionKR-WEST1
resolver_ipPrivate DNS Resolver IP198.19.0.101
resolver_namePrivate DNS Resolver Name
stateState

2.1.5 - Create Public Domain

2.1.5.1 - 1.2

scpcli 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 new Public Domain record

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

Parameters

NameTypeDescriptionExample
register_telno
required
stringRegister telephone number010-1234-5678
register_name_ko
required
stringRegister Name Domestic홍길동
register_name_en
required
stringRegister Name OverseasHong Gildong
register_email
required
stringRegister emailadmin@example.com
postal_code
required
stringPostal code12345
overseas_third_address
required
stringOverseas address - State & CountryNY 10001
overseas_second_address
required
stringOverseas address - CityNew York
overseas_first_address
required
stringOverseas address - Address123 Main St
name
required
stringPublic Domain Nameexample.com
domestic_second_address_ko
required
stringDomestic second address (KO)서관 1층
domestic_second_address_en
required
stringDomestic second address (EN)West Campus 1F
domestic_first_address_ko
required
stringDomestic first address (KO)서울특별시 송파구 올림픽로35길 125 (신천동)
domestic_first_address_en
required
stringDomestic first address (EN)125 Olympic-ro 35-gil, Songpa-gu, Seoul
address_type
required
stringAddress typeDOMESTIC
auto_extension
optional
booleanAuto extension flag-
description
optional
stringdescriptionThis is description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID10fjkeweffpublicdomain3193rud543
address_typeAddress typeDOMESTIC
auto_extensionAuto extension flagTrue
created_atCreated Date2025-09-08T03:43:57Z
created_byCreated By_504f24f8111e42e0578f367acd2a149f
descriptiondescriptionThis is description
domestic_address_enDomestic Address (EN)West Campus 1F, 125 Olympic-ro 35-gil, Songpa-gu, Seoul
domestic_address_koDomestic Address (KO)서울특별시 송파구 올림픽로35길 125 (신천동), 서관 1층
domestic_first_address_enDomestic first address (EN)125 Olympic-ro 35-gil, Songpa-gu, Seoul
domestic_first_address_koDomestic first address (KO)서울특별시 송파구 올림픽로35길 125 (신천동)
domestic_second_address_enDomestic second address (EN)West Campus 1F
domestic_second_address_koDomestic second address (KO)서관 1층
expired_dateExpired date2026-09-09T00:00:00Z
modified_atModified Date2026-02-09T08:00:40Z
modified_byModified By_504f24f8111e42e0578f367acd2a149f
namePublic Domain Nameexample.com
overseas_addressOverseas Address123 Main St, New York, NY 10001
overseas_first_addressOverseas address - Address123 Main St
overseas_second_addressOverseas address - CityNew York
overseas_third_addressOverseas address - State & CountryNY 10001
postal_codePostal code12345
register_emailRegister emailadmin@example.com
register_name_enRegister Name OverseasHong Gildong
register_name_koRegister Name Domestic홍길동
register_telnoRegister telephone number010-1234-5678
start_dateStart date2025-09-09T00:00:00Z
statusThe statusREGISTERED

2.1.5.2 - 1.1

scpcli 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 new Public Domain record

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

Parameters

NameTypeDescriptionExample
register_telno
required
stringRegister telephone number010-1234-5678
register_name_ko
required
stringRegister Name Domestic홍길동
register_name_en
required
stringRegister Name OverseasHong Gildong
register_email
required
stringRegister emailadmin@example.com
postal_code
required
stringPostal code12345
overseas_third_address
required
stringOverseas address - State & CountryNY 10001
overseas_second_address
required
stringOverseas address - CityNew York
overseas_first_address
required
stringOverseas address - Address123 Main St
name
required
stringPublic Domain Nameexample.com
domestic_second_address_ko
required
stringDomestic second address (KO)서관 1층
domestic_second_address_en
required
stringDomestic second address (EN)West Campus 1F
domestic_first_address_ko
required
stringDomestic first address (KO)서울특별시 송파구 올림픽로35길 125 (신천동)
domestic_first_address_en
required
stringDomestic first address (EN)125 Olympic-ro 35-gil, Songpa-gu, Seoul
address_type
required
stringAddress typeDOMESTIC
auto_extension
optional
booleanAuto extension flag-
description
optional
stringdescriptionThis is description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID10fjkeweffpublicdomain3193rud543
address_typeAddress typeDOMESTIC
auto_extensionAuto extension flagTrue
created_atCreated Date2025-09-08T03:43:57Z
created_byCreated By_504f24f8111e42e0578f367acd2a149f
descriptiondescriptionThis is description
domestic_address_enDomestic Address (EN)West Campus 1F, 125 Olympic-ro 35-gil, Songpa-gu, Seoul
domestic_address_koDomestic Address (KO)서울특별시 송파구 올림픽로35길 125 (신천동), 서관 1층
domestic_first_address_enDomestic first address (EN)125 Olympic-ro 35-gil, Songpa-gu, Seoul
domestic_first_address_koDomestic first address (KO)서울특별시 송파구 올림픽로35길 125 (신천동)
domestic_second_address_enDomestic second address (EN)West Campus 1F
domestic_second_address_koDomestic second address (KO)서관 1층
expired_dateExpired date2026-09-09T00:00:00Z
modified_atModified Date2026-02-09T08:00:40Z
modified_byModified By_504f24f8111e42e0578f367acd2a149f
namePublic Domain Nameexample.com
overseas_addressOverseas Address123 Main St, New York, NY 10001
overseas_first_addressOverseas address - Address123 Main St
overseas_second_addressOverseas address - CityNew York
overseas_third_addressOverseas address - State & CountryNY 10001
postal_codePostal code12345
register_emailRegister emailadmin@example.com
register_name_enRegister Name OverseasHong Gildong
register_name_koRegister Name Domestic홍길동
register_telnoRegister telephone number010-1234-5678
start_dateStart date2025-09-09T00:00:00Z
statusThe statusREGISTERED

2.1.6 - Create Public Domain Name

2.1.6.1 - 1.3

scpcli 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 new Public Domain Name

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
register_telno
required
stringRegister telephone number010-1234-5678
register_name_ko
required
stringRegister Name Domestic홍길동
register_name_en
required
stringRegister Name OverseasHong Gildong
register_email
required
stringRegister emailadmin@example.com
postal_code
required
stringPostal code12345
overseas_third_address
required
stringOverseas address - State & CountryNY 10001
overseas_second_address
required
stringOverseas address - CityNew York
overseas_first_address
required
stringOverseas address - Address123 Main St
name
required
stringPublic Domain Nameexample.com
domestic_second_address_ko
required
stringDomestic second address (KO)서관 1층
domestic_second_address_en
required
stringDomestic second address (EN)West Campus 1F
domestic_first_address_ko
required
stringDomestic first address (KO)서울특별시 송파구 올림픽로35길 125 (신천동)
domestic_first_address_en
required
stringDomestic first address (EN)125 Olympic-ro 35-gil, Songpa-gu, Seoul
address_type
required
stringAddress typeDOMESTIC
auto_extension
optional
booleanAuto extension flag-
description
optional
stringdescriptionThis is description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID10fjkeweffpublicdomain3193rud543
address_typeAddress typeDOMESTIC
auto_extensionAuto extension flagTrue
created_atCreated Date2025-09-08T03:43:57Z
created_byCreated By_504f24f8111e42e0578f367acd2a149f
descriptiondescriptionThis is description
domestic_address_enDomestic Address (EN)West Campus 1F, 125 Olympic-ro 35-gil, Songpa-gu, Seoul
domestic_address_koDomestic Address (KO)서울특별시 송파구 올림픽로35길 125 (신천동), 서관 1층
domestic_first_address_enDomestic first address (EN)125 Olympic-ro 35-gil, Songpa-gu, Seoul
domestic_first_address_koDomestic first address (KO)서울특별시 송파구 올림픽로35길 125 (신천동)
domestic_second_address_enDomestic second address (EN)West Campus 1F
domestic_second_address_koDomestic second address (KO)서관 1층
expired_dateExpired date2026-09-09T00:00:00Z
modified_atModified Date2026-02-09T08:00:40Z
modified_byModified By_504f24f8111e42e0578f367acd2a149f
namePublic Domain Nameexample.com
overseas_addressOverseas Address123 Main St, New York, NY 10001
overseas_first_addressOverseas address - Address123 Main St
overseas_second_addressOverseas address - CityNew York
overseas_third_addressOverseas address - State & CountryNY 10001
postal_codePostal code12345
register_emailRegister emailadmin@example.com
register_name_enRegister Name OverseasHong Gildong
register_name_koRegister Name Domestic홍길동
register_telnoRegister telephone number010-1234-5678
start_dateStart date2025-09-09T00:00:00Z
statusThe statusREGISTERED

2.1.7 - Create Record

2.1.7.1 - 1.2

scpcli dns record create
--hosted_zone_id <value>
--type <value>
--records <value>
--name <value>
[--description <value>]
[--ttl <value>]

Description

Create a new recordset in the hosted zone

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

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId3432012nfdksdf03ktrld9234lgfg
type
required
stringType of the recordA
records
required
arrayA list of data for this record12345.ns.private.kr-west1.dev2.samsungsdscloud.com
name
required
stringnametest.app
description
optional
stringdescriptionThis is description
ttl
optional
integerTTL for the zone.3600

Responses

NameDescriptionExample
idRecord ID6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
actioncurrent action in progressCREATE
created_atCreated Date2025-09-08T03:43:57Z
descriptiondescriptionThis is description
linksLinks to resource
namenametest.app
project_idProjectID003dffc50eb123a1cbf4f2e5c71d4f15
recordsA list of data for this record[‘12345.ns.private.kr-west1.dev2.samsungsdscloud.com’]
statusThe statusACTIVE
ttlTTL for the zone.3600
typeType of the recordA
updated_atUpdated Date2026-02-09T08:00:40Z
versionVersion1
zone_idID for the zone that contains this record3432012nfdksdf03ktrld9234lgfg
zone_nameThe name of the zone that contains this recordmy-zone.com

2.1.7.2 - 1.1

scpcli dns record create
--hosted_zone_id <value>
--type <value>
--records <value>
--name <value>
[--description <value>]
[--ttl <value>]

Description

Create a new recordset in the hosted zone

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

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId3432012nfdksdf03ktrld9234lgfg
type
required
stringType of the recordA
records
required
arrayA list of data for this record12345.ns.private.kr-west1.dev2.samsungsdscloud.com
name
required
stringnametest.app
description
optional
stringdescriptionThis is description
ttl
optional
integerTTL for the zone.3600

Responses

NameDescriptionExample
idRecord ID6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
actioncurrent action in progressCREATE
created_atCreated Date2025-09-08T03:43:57Z
descriptiondescriptionThis is description
linksLinks to resource
namenametest.app
project_idProjectID003dffc50eb123a1cbf4f2e5c71d4f15
recordsA list of data for this record[‘12345.ns.private.kr-west1.dev2.samsungsdscloud.com’]
statusThe statusACTIVE
ttlTTL for the zone.3600
typeType of the recordA
updated_atUpdated Date2026-02-09T08:00:40Z
versionVersion1
zone_idID for the zone that contains this record3432012nfdksdf03ktrld9234lgfg
zone_nameThe name of the zone that contains this recordmy-zone.com

2.1.8 - Delete Hosted Zone

2.1.8.1 - 1.3

scpcli dns hosted-zone delete
--hosted_zone_id <value>

Description

Delete a hosted zone

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId3432012nfdksdf03ktrld9234lgfg

2.1.8.2 - 1.2

scpcli dns hosted-zone delete
--hosted_zone_id <value>

Description

Delete a hosted zone

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

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId3432012nfdksdf03ktrld9234lgfg

2.1.8.3 - 1.1

scpcli dns hosted-zone delete
--hosted_zone_id <value>

Description

Delete a hosted zone

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

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId3432012nfdksdf03ktrld9234lgfg

2.1.9 - Delete Hosted Zone Record

2.1.9.1 - 1.3

scpcli dns hosted-zone-record delete
--record_id <value>
--hosted_zone_id <value>

Description

Delete hosted zone record

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
record_id
required
stringRecord ID6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
hosted_zone_id
required
stringHosted Zone ID3432012nfdksdf03ktrld9234lgfg

2.1.10 - Delete Private DNS

2.1.10.1 - 1.3

scpcli dns private-dns delete
--private_dns_id <value>

Description

Delete Private DNS

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
private_dns_id
required
stringPrivate DNS ID10fjkewefprivatedns3193rud543

2.1.10.2 - 1.2

scpcli dns private-dns delete
--private_dns_id <value>

Description

Delete Private DNS

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

Parameters

NameTypeDescriptionExample
private_dns_id
required
stringPrivate DNS ID10fjkewefprivatedns3193rud543

2.1.10.3 - 1.1

scpcli dns private-dns delete
--private_dns_id <value>

Description

Delete Private DNS

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

Parameters

NameTypeDescriptionExample
private_dns_id
required
stringPrivate DNS ID10fjkewefprivatedns3193rud543

2.1.11 - Delete Record

2.1.11.1 - 1.2

scpcli dns record delete
--record_id <value>
--hosted_zone_id <value>

Description

Delete a recordset

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

Parameters

NameTypeDescriptionExample
record_id
required
stringRecord ID6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
hosted_zone_id
required
stringHosted Zone ID3432012nfdksdf03ktrld9234lgfg

2.1.11.2 - 1.1

scpcli dns record delete
--record_id <value>
--hosted_zone_id <value>

Description

Delete a recordset

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

Parameters

NameTypeDescriptionExample
record_id
required
stringRecord ID6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
hosted_zone_id
required
stringHosted Zone ID3432012nfdksdf03ktrld9234lgfg

2.1.12 - Get Public Domain Detail

2.1.12.1 - 1.2

scpcli dns public-domain-name show
--public_domain_id <value>

Description

Retrieve detailed information for a specific public domain by ID

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

Parameters

NameTypeDescriptionExample
public_domain_id
required
stringID10fjkeweffpublicdomain3193rud543

Responses

NameDescriptionExample
idID10fjkeweffpublicdomain3193rud543
address_typeAddress typeDOMESTIC
auto_extensionAuto extension flagTrue
created_atCreated Date2025-09-08T03:43:57Z
created_byCreated By_504f24f8111e42e0578f367acd2a149f
descriptiondescriptionThis is description
domestic_address_enDomestic Address (EN)West Campus 1F, 125 Olympic-ro 35-gil, Songpa-gu, Seoul
domestic_address_koDomestic Address (KO)서울특별시 송파구 올림픽로35길 125 (신천동), 서관 1층
domestic_first_address_enDomestic first address (EN)125 Olympic-ro 35-gil, Songpa-gu, Seoul
domestic_first_address_koDomestic first address (KO)서울특별시 송파구 올림픽로35길 125 (신천동)
domestic_second_address_enDomestic second address (EN)West Campus 1F
domestic_second_address_koDomestic second address (KO)서관 1층
expired_dateExpired date2026-09-09T00:00:00Z
modified_atModified Date2026-02-09T08:00:40Z
modified_byModified By_504f24f8111e42e0578f367acd2a149f
namePublic Domain Nameexample.com
overseas_addressOverseas Address123 Main St, New York, NY 10001
overseas_first_addressOverseas address - Address123 Main St
overseas_second_addressOverseas address - CityNew York
overseas_third_addressOverseas address - State & CountryNY 10001
postal_codePostal code12345
register_emailRegister emailadmin@example.com
register_name_enRegister Name OverseasHong Gildong
register_name_koRegister Name Domestic홍길동
register_telnoRegister telephone number010-1234-5678
start_dateStart date2025-09-09T00:00:00Z
statusThe statusREGISTERED

2.1.12.2 - 1.1

scpcli dns public-domain-name show
--public_domain_id <value>

Description

Retrieve detailed information for a specific public domain by ID

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

Parameters

NameTypeDescriptionExample
public_domain_id
required
stringID10fjkeweffpublicdomain3193rud543

Responses

NameDescriptionExample
idID10fjkeweffpublicdomain3193rud543
address_typeAddress typeDOMESTIC
auto_extensionAuto extension flagTrue
created_atCreated Date2025-09-08T03:43:57Z
created_byCreated By_504f24f8111e42e0578f367acd2a149f
descriptiondescriptionThis is description
domestic_address_enDomestic Address (EN)West Campus 1F, 125 Olympic-ro 35-gil, Songpa-gu, Seoul
domestic_address_koDomestic Address (KO)서울특별시 송파구 올림픽로35길 125 (신천동), 서관 1층
domestic_first_address_enDomestic first address (EN)125 Olympic-ro 35-gil, Songpa-gu, Seoul
domestic_first_address_koDomestic first address (KO)서울특별시 송파구 올림픽로35길 125 (신천동)
domestic_second_address_enDomestic second address (EN)West Campus 1F
domestic_second_address_koDomestic second address (KO)서관 1층
expired_dateExpired date2026-09-09T00:00:00Z
modified_atModified Date2026-02-09T08:00:40Z
modified_byModified By_504f24f8111e42e0578f367acd2a149f
namePublic Domain Nameexample.com
overseas_addressOverseas Address123 Main St, New York, NY 10001
overseas_first_addressOverseas address - Address123 Main St
overseas_second_addressOverseas address - CityNew York
overseas_third_addressOverseas address - State & CountryNY 10001
postal_codePostal code12345
register_emailRegister emailadmin@example.com
register_name_enRegister Name OverseasHong Gildong
register_name_koRegister Name Domestic홍길동
register_telnoRegister telephone number010-1234-5678
start_dateStart date2025-09-09T00:00:00Z
statusThe statusREGISTERED

2.1.13 - List Hosted Zone Records

2.1.13.1 - 1.3

scpcli 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

Get record list in a hosted zone

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId3432012nfdksdf03ktrld9234lgfg
limit
optional
integerlimit-
marker
optional
stringmarker-
sort_dir
optional
stringsort direction-
sort_key
optional
stringsort key-
name
optional
stringnametest.app
exact_name
optional
stringnametest.app
type
optional
stringType of the recordA
data
optional
stringRecord data12345.ns.private.kr-west1.dev2.samsungsdscloud.com
status
optional
stringThe statusACTIVE
description
optional
stringdescriptionThis is description
ttl
optional
integerTTL for the zone.3600

Responses

NameDescriptionExample
idRecord ID6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
actioncurrent action in progressCREATE
created_atCreated Date2025-09-08T03:43:57Z
descriptiondescriptionThis is description
linksLinks to resource
namenametest.app
project_idProjectID003dffc50eb123a1cbf4f2e5c71d4f15
recordsA list of data for this record[‘12345.ns.private.kr-west1.dev2.samsungsdscloud.com’]
statusThe statusACTIVE
ttlTTL for the zone.3600
typeType of the recordA
updated_atUpdated Date2026-02-09T08:00:40Z
versionVersion1
zone_idID for the zone that contains this record3432012nfdksdf03ktrld9234lgfg
zone_nameThe name of the zone that contains this recordmy-zone.com

2.1.14 - List Hosted Zones

2.1.14.1 - 1.3

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

Description

Return 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
stringnamemy-zone.com
type
optional
****Type of zone-
status
optional
****The status-

Responses

NameDescriptionExample
idHosted Zone ID3432012nfdksdf03ktrld9234lgfg
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
hosted_zone_typeHosted Zone type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameHosted Zone Namemy-zone.com
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
private_dns_idPrivate DNS ID10fjkewefprivatedns3193rud543
private_dns_namePrivate DNS Nameprivate-dns01
statusState
ttlTTL for the zone.3600

2.1.14.2 - 1.2

scpcli dns hosted-zone list
[--name <value>]
[--exact_name <value>]
[--type <value>]
[--email <value>]
[--status <value>]
[--description <value>]
[--ttl <value>]
[--page <value>]
[--size <value>]
[--sort <value>]

Description

Return list of hosted zones

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

Parameters

NameTypeDescriptionExample
name
optional
stringnamemy-zone.com
exact_name
optional
stringnamemy-zone.com
type
optional
stringType of zonepublic
email
optional
stringemailtest@samsung.com
status
optional
stringThe statusACTIVE
description
optional
stringdescriptionThis is description
ttl
optional
integerTTL for the zone.3600
page
optional
integerPage-
size
optional
integerSize-
sort
optional
stringSort-

Responses

NameDescriptionExample
idId3432012nfdksdf03ktrld9234lgfg
actioncurrent action in progress
attributesKey:Value pairs of information about this zone
created_atCreated Date2025-09-08T03:43:57Z
descriptiondescriptionThis is description
emailemailtest@samsung.com
hosted_zone_typeHosted Zone typepublic
linksLinks to resource
mastersThe servers to slave from to get DNS information
namenamemy-zone.com
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
private_dns_idPrivate DNS ID10fjkewefprivatedns3193rud543
private_dns_namePrivate DNS Nameprivate-dns01
project_idProjectID
serialserial number
sharedTrue if the zone is shared with another account
statusThe statusACTIVE
transferred_atThe last time an update was retrieved from the master servers
ttlTTL for the zone.3600
typeType of zone
updated_atUpdated Date
versionVersion

2.1.14.3 - 1.1

scpcli dns hosted-zone list
[--name <value>]
[--exact_name <value>]
[--type <value>]
[--email <value>]
[--status <value>]
[--description <value>]
[--ttl <value>]
[--page <value>]
[--size <value>]
[--sort <value>]

Description

Return list of hosted zones

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

Parameters

NameTypeDescriptionExample
name
optional
stringnamemy-zone.com
exact_name
optional
stringnamemy-zone.com
type
optional
stringType of zonepublic
email
optional
stringemailtest@samsung.com
status
optional
stringThe statusACTIVE
description
optional
stringdescriptionThis is description
ttl
optional
integerTTL for the zone.3600
page
optional
integerPage-
size
optional
integerSize-
sort
optional
stringSort-

Responses

NameDescriptionExample
idId3432012nfdksdf03ktrld9234lgfg
actioncurrent action in progress
attributesKey:Value pairs of information about this zone
created_atCreated Date2025-09-08T03:43:57Z
descriptiondescriptionThis is description
emailemailtest@samsung.com
hosted_zone_typeHosted Zone typepublic
linksLinks to resource
mastersThe servers to slave from to get DNS information
namenamemy-zone.com
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
project_idProjectID
serialserial number
sharedTrue if the zone is shared with another account
statusThe statusACTIVE
transferred_atThe last time an update was retrieved from the master servers
ttlTTL for the zone.3600
typeType of zone
updated_atUpdated Date
versionVersion

2.1.15 - List Private DNS

2.1.15.1 - 1.3

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

Description

List all Private DNS

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPrivate DNS ID10fjkewefprivatedns3193rud543
name
optional
stringPrivate DNS Name-
vpc_id
optional
stringConnected VPC ID7df8abb4912e4709b1cb237daccca7a8
state
optional
****StateACTIVE

Responses

NameDescriptionExample
idPrivate DNS ID10fjkewefprivatedns3193rud543
auth_dns_nameAuth DNS Name
connected_vpc_idsConnected VPC ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate DNS Nameprivate-dns01
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
pool_namePool Name
registered_regionRegistered RegionKR-WEST1
resolver_ipPrivate DNS Resolver IP198.19.0.101
resolver_namePrivate DNS Resolver Name
stateState

2.1.15.2 - 1.2

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

Description

List all Private DNS

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

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPrivate DNS ID10fjkewefprivatedns3193rud543
name
optional
stringPrivate DNS Name-
vpc_id
optional
stringConnected VPC ID7df8abb4912e4709b1cb237daccca7a8
state
optional
****StateACTIVE

Responses

NameDescriptionExample
idPrivate DNS ID10fjkewefprivatedns3193rud543
auth_dns_nameAuth DNS Name
connected_vpc_idsConnected VPC ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate DNS Nameprivate-dns01
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
pool_namePool Name
registered_regionRegistered RegionKR-WEST1
resolver_ipPrivate DNS Resolver IP198.19.0.101
resolver_namePrivate DNS Resolver Name
stateState

2.1.15.3 - 1.1

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

Description

List all Private DNS

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

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPrivate DNS ID10fjkewefprivatedns3193rud543
name
optional
stringPrivate DNS Name-
vpc_id
optional
stringConnected VPC ID7df8abb4912e4709b1cb237daccca7a8
state
optional
****StateACTIVE

Responses

NameDescriptionExample
idPrivate DNS ID10fjkewefprivatedns3193rud543
auth_dns_nameAuth DNS Name
connected_vpc_idsConnected VPC ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate DNS Nameprivate-dns01
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
pool_namePool Name
registered_regionRegistered RegionKR-WEST1
resolver_ipPrivate DNS Resolver IP198.19.0.101
resolver_namePrivate DNS Resolver Name
stateState

2.1.16 - List Public Domain Names

2.1.16.1 - 1.3

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

Description

Return 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
stringPublic Domain Nameexample.com
created_by
optional
stringCreated By_504f24f8111e42e0578f367acd2a149f

Responses

NameDescriptionExample
idID10fjkeweffpublicdomain3193rud543
created_atCreated Date2025-09-08T03:43:57Z
created_byStart date504f24f8111e42e0578f367acd2a149f
expired_dateExpired date2026-09-09T00:00:00Z
modified_atModified Date2026-02-09T08:00:40Z
modified_byModified By_504f24f8111e42e0578f367acd2a149f
namePublic Domain Nameexample.com
register_emailRegister emailadmin@example.com
start_dateStart date2025-09-09T00:00:00Z
statusThe statusREGISTERED

2.1.17 - List Public Domains

2.1.17.1 - 1.2

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

Description

List all Public Domains

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

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringPublic Domain Nameexample.com
created_by
optional
stringCreated By_504f24f8111e42e0578f367acd2a149f

Responses

NameDescriptionExample
idID10fjkeweffpublicdomain3193rud543
created_atCreated Date2025-09-08T03:43:57Z
created_byStart date504f24f8111e42e0578f367acd2a149f
expired_dateExpired date2026-09-09T00:00:00Z
modified_atModified Date2026-02-09T08:00:40Z
modified_byModified By_504f24f8111e42e0578f367acd2a149f
namePublic Domain Nameexample.com
register_emailRegister emailadmin@example.com
start_dateStart date2025-09-09T00:00:00Z
statusThe statusREGISTERED

2.1.17.2 - 1.1

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

Description

List all Public Domains

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

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringPublic Domain Nameexample.com
created_by
optional
stringCreated By_504f24f8111e42e0578f367acd2a149f

Responses

NameDescriptionExample
idID10fjkeweffpublicdomain3193rud543
created_atCreated Date2025-09-08T03:43:57Z
created_byStart date504f24f8111e42e0578f367acd2a149f
expired_dateExpired date2026-09-09T00:00:00Z
modified_atModified Date2026-02-09T08:00:40Z
modified_byModified By_504f24f8111e42e0578f367acd2a149f
namePublic Domain Nameexample.com
register_emailRegister emailadmin@example.com
start_dateStart date2025-09-09T00:00:00Z
statusThe statusREGISTERED

2.1.18 - List Records

2.1.18.1 - 1.2

scpcli dns 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

Get recordset list in a hosted zone

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

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId3432012nfdksdf03ktrld9234lgfg
limit
optional
integerlimit-
marker
optional
stringmarker-
sort_dir
optional
stringsort direction-
sort_key
optional
stringsort key-
name
optional
stringnametest.app
exact_name
optional
stringnametest.app
type
optional
stringType of the recordA
data
optional
stringRecord data12345.ns.private.kr-west1.dev2.samsungsdscloud.com
status
optional
stringThe statusACTIVE
description
optional
stringdescriptionThis is description
ttl
optional
integerTTL for the zone.3600

Responses

NameDescriptionExample
idRecord ID6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
actioncurrent action in progressCREATE
created_atCreated Date2025-09-08T03:43:57Z
descriptiondescriptionThis is description
linksLinks to resource
namenametest.app
project_idProjectID003dffc50eb123a1cbf4f2e5c71d4f15
recordsA list of data for this record[‘12345.ns.private.kr-west1.dev2.samsungsdscloud.com’]
statusThe statusACTIVE
ttlTTL for the zone.3600
typeType of the recordA
updated_atUpdated Date2026-02-09T08:00:40Z
versionVersion1
zone_idID for the zone that contains this record3432012nfdksdf03ktrld9234lgfg
zone_nameThe name of the zone that contains this recordmy-zone.com

2.1.18.2 - 1.1

scpcli dns 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

Get recordset list in a hosted zone

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

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId3432012nfdksdf03ktrld9234lgfg
limit
optional
integerlimit-
marker
optional
stringmarker-
sort_dir
optional
stringsort direction-
sort_key
optional
stringsort key-
name
optional
stringnametest.app
exact_name
optional
stringnametest.app
type
optional
stringType of the recordA
data
optional
stringRecord data12345.ns.private.kr-west1.dev2.samsungsdscloud.com
status
optional
stringThe statusACTIVE
description
optional
stringdescriptionThis is description
ttl
optional
integerTTL for the zone.3600

Responses

NameDescriptionExample
idRecord ID6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
actioncurrent action in progressCREATE
created_atCreated Date2025-09-08T03:43:57Z
descriptiondescriptionThis is description
linksLinks to resource
namenametest.app
project_idProjectID003dffc50eb123a1cbf4f2e5c71d4f15
recordsA list of data for this record[‘12345.ns.private.kr-west1.dev2.samsungsdscloud.com’]
statusThe statusACTIVE
ttlTTL for the zone.3600
typeType of the recordA
updated_atUpdated Date2026-02-09T08:00:40Z
versionVersion1
zone_idID for the zone that contains this record3432012nfdksdf03ktrld9234lgfg
zone_nameThe name of the zone that contains this recordmy-zone.com

2.1.19 - Set Hosted Zone Record

2.1.19.1 - 1.3

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

Description

Update Hosted Zone record

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
record_id
required
stringRecord ID6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
hosted_zone_id
required
stringHosted Zone ID3432012nfdksdf03ktrld9234lgfg
records
optional
arrayA list of data for this record12345.ns.private.kr-west1.dev2.samsungsdscloud.com
ttl
optional
integerTTL for the zone.3600

2.1.20 - Set Private DNS

2.1.20.1 - 1.3

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

Description

Update Private DNS

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
private_dns_id
required
stringPrivate DNS ID10fjkewefprivatedns3193rud543
connected_vpc_ids
optional
arrayConnected VPC ID-
description
optional
stringdescriptionThis is description

2.1.20.2 - 1.2

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

Description

Update Private DNS

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

Parameters

NameTypeDescriptionExample
private_dns_id
required
stringPrivate DNS ID10fjkewefprivatedns3193rud543
connected_vpc_ids
optional
arrayConnected VPC ID-
description
optional
stringdescriptionThis is description

2.1.20.3 - 1.1

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

Description

Update Private DNS

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

Parameters

NameTypeDescriptionExample
private_dns_id
required
stringPrivate DNS ID10fjkewefprivatedns3193rud543
connected_vpc_ids
optional
arrayConnected VPC ID-
description
optional
stringdescriptionThis is description

2.1.21 - Set Public Domain Name

2.1.21.1 - 1.3

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

Description

Update Public Domain Name

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
public_domain_id
required
stringID10fjkeweffpublicdomain3193rud543
auto_extension
optional
booleanAuto extension flagTrue
description
optional
stringdescriptionThis is description

2.1.22 - Set Public Domain Name Whois Info

2.1.22.1 - 1.3

scpcli 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
stringID10fjkeweffpublicdomain3193rud543
register_telno
required
stringRegister telephone number010-1234-5678
register_email
required
stringRegister emailadmin@example.com
postal_code
required
stringPostal code12345
overseas_third_address
required
stringOverseas address - State & CountryNY 10001
overseas_second_address
required
stringOverseas address - CityNew York
overseas_first_address
required
stringOverseas address - Address123 Main St
domestic_second_address_ko
required
stringDomestic second address (KO)서관 1층
domestic_second_address_en
required
stringDomestic second address (EN)West Campus 1F
domestic_first_address_ko
required
stringDomestic first address (KO)서울특별시 송파구 올림픽로35길 125 (신천동)
domestic_first_address_en
required
stringDomestic first address (EN)125 Olympic-ro 35-gil, Songpa-gu, Seoul
address_type
required
stringAddress typeDOMESTIC

2.1.23 - Show Hosted Zone

2.1.23.1 - 1.3

scpcli dns hosted-zone show
--hosted_zone_id <value>

Description

Return details of a hosted zone.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId3432012nfdksdf03ktrld9234lgfg

Responses

NameDescriptionExample
idHosted Zone ID3432012nfdksdf03ktrld9234lgfg
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
hosted_zone_typeHosted Zone type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameHosted Zone Namemy-zone.com
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
private_dns_idPrivate DNS ID10fjkewefprivatedns3193rud543
private_dns_namePrivate DNS Nameprivate-dns01
statusState
ttlTTL for the zone.3600

2.1.23.2 - 1.2

scpcli dns hosted-zone show
--hosted_zone_id <value>

Description

Return details of a hosted zone.

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

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId3432012nfdksdf03ktrld9234lgfg

Responses

NameDescriptionExample
idId3432012nfdksdf03ktrld9234lgfg
actioncurrent action in progress
attributesKey:Value pairs of information about this zone
created_atCreated Date2025-09-08T03:43:57Z
descriptiondescriptionThis is description
emailemailtest@samsung.com
hosted_zone_typeHosted Zone typepublic
linksLinks to resource
mastersThe servers to slave from to get DNS information
namenamemy-zone.com
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
private_dns_idPrivate DNS ID10fjkewefprivatedns3193rud543
private_dns_namePrivate DNS Nameprivate-dns01
project_idProjectID
serialserial number
sharedTrue if the zone is shared with another account
statusThe statusACTIVE
transferred_atThe last time an update was retrieved from the master servers
ttlTTL for the zone.3600
typeType of zone
updated_atUpdated Date
versionVersion

2.1.23.3 - 1.1

scpcli dns hosted-zone show
--hosted_zone_id <value>

Description

Return details of a hosted zone.

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

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId3432012nfdksdf03ktrld9234lgfg

Responses

NameDescriptionExample
idId3432012nfdksdf03ktrld9234lgfg
actioncurrent action in progress
attributesKey:Value pairs of information about this zone
created_atCreated Date2025-09-08T03:43:57Z
descriptiondescriptionThis is description
emailemailtest@samsung.com
hosted_zone_typeHosted Zone typepublic
linksLinks to resource
mastersThe servers to slave from to get DNS information
namenamemy-zone.com
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
project_idProjectID
serialserial number
sharedTrue if the zone is shared with another account
statusThe statusACTIVE
transferred_atThe last time an update was retrieved from the master servers
ttlTTL for the zone.3600
typeType of zone
updated_atUpdated Date
versionVersion

2.1.24 - Show Hosted Zone Record

2.1.24.1 - 1.3

scpcli dns hosted-zone-record show
--record_id <value>
--hosted_zone_id <value>

Description

Get details of a hosted zone record

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
record_id
required
stringRecord ID6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
hosted_zone_id
required
stringHosted Zone ID3432012nfdksdf03ktrld9234lgfg

Responses

NameDescriptionExample
idRecord ID6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
actioncurrent action in progressCREATE
created_atCreated Date2025-09-08T03:43:57Z
descriptiondescriptionThis is description
linksLinks to resource
namenametest.app
project_idProjectID003dffc50eb123a1cbf4f2e5c71d4f15
recordsA list of data for this record[‘12345.ns.private.kr-west1.dev2.samsungsdscloud.com’]
statusThe statusACTIVE
ttlTTL for the zone.3600
typeType of the recordA
updated_atUpdated Date2026-02-09T08:00:40Z
versionVersion1
zone_idID for the zone that contains this record3432012nfdksdf03ktrld9234lgfg
zone_nameThe name of the zone that contains this recordmy-zone.com

2.1.25 - Show Private DNS

2.1.25.1 - 1.3

scpcli dns private-dns show
--private_dns_id <value>

Description

Show Private DNS

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
private_dns_id
required
stringPrivate DNS ID10fjkewefprivatedns3193rud543

Responses

NameDescriptionExample
idPrivate DNS ID10fjkewefprivatedns3193rud543
auth_dns_nameAuth DNS Name
connected_vpc_idsConnected VPC ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate DNS Nameprivate-dns01
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
pool_namePool Name
registered_regionRegistered RegionKR-WEST1
resolver_ipPrivate DNS Resolver IP198.19.0.101
resolver_namePrivate DNS Resolver Name
stateState

2.1.25.2 - 1.2

scpcli dns private-dns show
--private_dns_id <value>

Description

Show Private DNS

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

Parameters

NameTypeDescriptionExample
private_dns_id
required
stringPrivate DNS ID10fjkewefprivatedns3193rud543

Responses

NameDescriptionExample
idPrivate DNS ID10fjkewefprivatedns3193rud543
auth_dns_nameAuth DNS Name
connected_vpc_idsConnected VPC ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate DNS Nameprivate-dns01
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
pool_namePool Name
registered_regionRegistered RegionKR-WEST1
resolver_ipPrivate DNS Resolver IP198.19.0.101
resolver_namePrivate DNS Resolver Name
stateState

2.1.25.3 - 1.1

scpcli dns private-dns show
--private_dns_id <value>

Description

Show Private DNS

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

Parameters

NameTypeDescriptionExample
private_dns_id
required
stringPrivate DNS ID10fjkewefprivatedns3193rud543

Responses

NameDescriptionExample
idPrivate DNS ID10fjkewefprivatedns3193rud543
auth_dns_nameAuth DNS Name
connected_vpc_idsConnected VPC ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate DNS Nameprivate-dns01
pool_idDesignate Pool ID10fjksdpooliddfsi12389esfdslkdsr32
pool_namePool Name
registered_regionRegistered RegionKR-WEST1
resolver_ipPrivate DNS Resolver IP198.19.0.101
resolver_namePrivate DNS Resolver Name
stateState

2.1.26 - Show Public Domain Name

2.1.26.1 - 1.3

scpcli dns public-domain-name show
--public_domain_id <value>

Description

Return details of a public domain name

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
public_domain_id
required
stringID10fjkeweffpublicdomain3193rud543

Responses

NameDescriptionExample
idID10fjkeweffpublicdomain3193rud543
address_typeAddress typeDOMESTIC
auto_extensionAuto extension flagTrue
created_atCreated Date2025-09-08T03:43:57Z
created_byCreated By_504f24f8111e42e0578f367acd2a149f
descriptiondescriptionThis is description
domestic_address_enDomestic Address (EN)West Campus 1F, 125 Olympic-ro 35-gil, Songpa-gu, Seoul
domestic_address_koDomestic Address (KO)서울특별시 송파구 올림픽로35길 125 (신천동), 서관 1층
domestic_first_address_enDomestic first address (EN)125 Olympic-ro 35-gil, Songpa-gu, Seoul
domestic_first_address_koDomestic first address (KO)서울특별시 송파구 올림픽로35길 125 (신천동)
domestic_second_address_enDomestic second address (EN)West Campus 1F
domestic_second_address_koDomestic second address (KO)서관 1층
expired_dateExpired date2026-09-09T00:00:00Z
modified_atModified Date2026-02-09T08:00:40Z
modified_byModified By_504f24f8111e42e0578f367acd2a149f
namePublic Domain Nameexample.com
overseas_addressOverseas Address123 Main St, New York, NY 10001
overseas_first_addressOverseas address - Address123 Main St
overseas_second_addressOverseas address - CityNew York
overseas_third_addressOverseas address - State & CountryNY 10001
postal_codePostal code12345
register_emailRegister emailadmin@example.com
register_name_enRegister Name OverseasHong Gildong
register_name_koRegister Name Domestic홍길동
register_telnoRegister telephone number010-1234-5678
start_dateStart date2025-09-09T00:00:00Z
statusThe statusREGISTERED

2.1.27 - Show Record

2.1.27.1 - 1.2

scpcli dns record show
--record_id <value>
--hosted_zone_id <value>

Description

Get details of a recordset

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

Parameters

NameTypeDescriptionExample
record_id
required
stringRecord ID6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
hosted_zone_id
required
stringHosted Zone ID3432012nfdksdf03ktrld9234lgfg

Responses

NameDescriptionExample
idRecord ID6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
actioncurrent action in progressCREATE
created_atCreated Date2025-09-08T03:43:57Z
descriptiondescriptionThis is description
linksLinks to resource
namenametest.app
project_idProjectID003dffc50eb123a1cbf4f2e5c71d4f15
recordsA list of data for this record[‘12345.ns.private.kr-west1.dev2.samsungsdscloud.com’]
statusThe statusACTIVE
ttlTTL for the zone.3600
typeType of the recordA
updated_atUpdated Date2026-02-09T08:00:40Z
versionVersion1
zone_idID for the zone that contains this record3432012nfdksdf03ktrld9234lgfg
zone_nameThe name of the zone that contains this recordmy-zone.com

2.1.27.2 - 1.1

scpcli dns record show
--record_id <value>
--hosted_zone_id <value>

Description

Get details of a recordset

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

Parameters

NameTypeDescriptionExample
record_id
required
stringRecord ID6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
hosted_zone_id
required
stringHosted Zone ID3432012nfdksdf03ktrld9234lgfg

Responses

NameDescriptionExample
idRecord ID6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
actioncurrent action in progressCREATE
created_atCreated Date2025-09-08T03:43:57Z
descriptiondescriptionThis is description
linksLinks to resource
namenametest.app
project_idProjectID003dffc50eb123a1cbf4f2e5c71d4f15
recordsA list of data for this record[‘12345.ns.private.kr-west1.dev2.samsungsdscloud.com’]
statusThe statusACTIVE
ttlTTL for the zone.3600
typeType of the recordA
updated_atUpdated Date2026-02-09T08:00:40Z
versionVersion1
zone_idID for the zone that contains this record3432012nfdksdf03ktrld9234lgfg
zone_nameThe name of the zone that contains this recordmy-zone.com

2.1.28 - Transfer Public Domain Name

2.1.28.1 - 1.3

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

Description

Transfer Public Domain Name

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
public_domain_id
required
stringID10fjkeweffpublicdomain3193rud543
type
required
stringTransfer operation typeREQUEST
target_account_id
optional
stringTarget account id (required when type=REQUEST)003dffc50eb123a1cbf4f2e5c71d4f15

Responses

NameDescriptionExample
idID10fjkeweffpublicdomain3193rud543
auto_extensionAuto extension flagTrue
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptiondescriptionThis is description
expired_dateExpired date2026-09-09T00:00:00Z
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePublic Domain Nameexample.com
start_dateStart date2025-09-09T00:00:00Z
stateStateTRANSFER_REQUESTED

2.1.29 - Update auto_extension or description

2.1.29.1 - 1.2

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

Description

Update auto_extension or description of a Public Domain

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

Parameters

NameTypeDescriptionExample
public_domain_id
required
stringID10fjkeweffpublicdomain3193rud543
auto_extension
optional
booleanAuto extension flagTrue
description
optional
stringdescriptionThis is description

2.1.29.2 - 1.1

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

Description

Update auto_extension or description of a Public Domain

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

Parameters

NameTypeDescriptionExample
public_domain_id
required
stringID10fjkeweffpublicdomain3193rud543
auto_extension
optional
booleanAuto extension flagTrue
description
optional
stringdescriptionThis is description

2.1.30 - Update Hosted Zone

2.1.30.1 - 1.3

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

Description

Update Hosted Zone

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId3432012nfdksdf03ktrld9234lgfg
description
optional
stringdescriptionThis is description

2.1.30.2 - 1.2

scpcli dns hosted-zone update
--hosted_zone_id <value>
[--description <value>]
[--email <value>]

Description

Update Hosted Zone

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

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId3432012nfdksdf03ktrld9234lgfg
description
optional
stringdescriptionThis is description
email
optional
stringemailtest@samsung.com

2.1.30.3 - 1.1

scpcli dns hosted-zone update
--hosted_zone_id <value>
[--description <value>]
[--email <value>]

Description

Update Hosted Zone

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

Parameters

NameTypeDescriptionExample
hosted_zone_id
required
stringId3432012nfdksdf03ktrld9234lgfg
description
optional
stringdescriptionThis is description
email
optional
stringemailtest@samsung.com

2.1.31 - Update Record

2.1.31.1 - 1.2

scpcli dns record update
--record_id <value>
--hosted_zone_id <value>
[--records <value>]
[--ttl <value>]

Description

Update a recordset

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

Parameters

NameTypeDescriptionExample
record_id
required
stringRecord ID6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
hosted_zone_id
required
stringHosted Zone ID3432012nfdksdf03ktrld9234lgfg
records
optional
arrayA list of data for this record12345.ns.private.kr-west1.dev2.samsungsdscloud.com
ttl
optional
integerTTL for the zone.3600

2.1.31.2 - 1.1

scpcli dns record update
--record_id <value>
--hosted_zone_id <value>
[--records <value>]
[--ttl <value>]

Description

Update a recordset

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

Parameters

NameTypeDescriptionExample
record_id
required
stringRecord ID6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
hosted_zone_id
required
stringHosted Zone ID3432012nfdksdf03ktrld9234lgfg
records
optional
arrayA list of data for this record12345.ns.private.kr-west1.dev2.samsungsdscloud.com
ttl
optional
integerTTL for the zone.3600

2.1.32 - Update WHOIS info for Public Domain

2.1.32.1 - 1.2

scpcli 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 WHOIS information and sync with DB for a public domain

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

Parameters

NameTypeDescriptionExample
public_domain_id
required
stringID10fjkeweffpublicdomain3193rud543
register_telno
required
stringRegister telephone number010-1234-5678
register_email
required
stringRegister emailadmin@example.com
postal_code
required
stringPostal code12345
overseas_third_address
required
stringOverseas address - State & CountryNY 10001
overseas_second_address
required
stringOverseas address - CityNew York
overseas_first_address
required
stringOverseas address - Address123 Main St
domestic_second_address_ko
required
stringDomestic second address (KO)서관 1층
domestic_second_address_en
required
stringDomestic second address (EN)West Campus 1F
domestic_first_address_ko
required
stringDomestic first address (KO)서울특별시 송파구 올림픽로35길 125 (신천동)
domestic_first_address_en
required
stringDomestic first address (EN)125 Olympic-ro 35-gil, Songpa-gu, Seoul
address_type
required
stringAddress typeDOMESTIC

2.1.32.2 - 1.1

scpcli 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 WHOIS information and sync with DB for a public domain

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

Parameters

NameTypeDescriptionExample
public_domain_id
required
stringID10fjkeweffpublicdomain3193rud543
register_telno
required
stringRegister telephone number010-1234-5678
register_email
required
stringRegister emailadmin@example.com
postal_code
required
stringPostal code12345
overseas_third_address
required
stringOverseas address - State & CountryNY 10001
overseas_second_address
required
stringOverseas address - CityNew York
overseas_first_address
required
stringOverseas address - Address123 Main St
domestic_second_address_ko
required
stringDomestic second address (KO)서관 1층
domestic_second_address_en
required
stringDomestic second address (EN)West Campus 1F
domestic_first_address_ko
required
stringDomestic first address (KO)서울특별시 송파구 올림픽로35길 125 (신천동)
domestic_first_address_en
required
stringDomestic first address (EN)125 Olympic-ro 35-gil, Songpa-gu, Seoul
address_type
required
stringAddress typeDOMESTIC

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

3.1 - CLIs

3.1.1 - Create Firewall Rule

3.1.1.1 - 1.0

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

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

scpcli firewall firewall-rule delete
--firewall_rule_id <value>

Description

Delete firewall rule.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
firewall_rule_id
required
stringFirewall Rule IDb156740b6335468d8354eb9ef8eddf5a

3.1.3 - List Firewall Rules

3.1.3.1 - 1.0

scpcli 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 (CURRENT)

VersionNot Before
1.0-

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

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

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

scpcli firewall firewall set
--firewall_id <value>
[--flavor_name <value>]
[--loggable <value>]

Description

Set firewall.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

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

scpcli 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 (CURRENT)

VersionNot Before
1.0-

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

scpcli firewall firewall show
--firewall_id <value>

Description

Show firewall.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

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

scpcli firewall firewall-rule show
--firewall_rule_id <value>

Description

Show firewall rule.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

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-

4.1 - CLIs

4.1.1 - Create Cdn Service

4.1.1.1 - 1.0

scpcli 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

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
range_request_allowed
required
booleanrange request allowed-
query_string_ignored
required
booleanquery string ignored-
origin_hostname_type
required
stringorigin hostname type-
name
required
stringcdn service nametest1
forward_host_header
required
stringforward host header-
content_policy
required
stringcontent policy-
cdn_service_domain_prefix
required
stringcdn service domain prefixglobal1
cdn_origin_protocol
required
stringcdn service origin protocol-
cdn_origin_port
required
integercdn service origin port-
cdn_origin_hostname
required
stringcdn service origin host nametest.example.com
caching_option
required
stringcaching option-
cache_key_hostname
required
stringcache key hostname-
cache_expiry_time
required
integercache expiry time-
cdn_service_origin_path
optional
stringcdn service origin path/test/global/
custom_forward_host_header
optional
stringcustom forward host header-
description
optional
stringDescription-
request_custom_headers
optional
objectrequest custom headers-
response_custom_headers
optional
objectresponse custom header-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
account_idAccount ID
resource_idresource id
workflow_idworkflow id

4.1.2 - Delete Cdn Service

4.1.2.1 - 1.0

scpcli cdn cdn service delete
--id <value>

Description

delete cdn service

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
id
required
stringcdn service id-

4.1.3 - Detail Cdn Service

4.1.3.1 - 1.0

scpcli cdn cdn service detail
--id <value>

Description

detail cdn service

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
id
required
stringcdn service id-

Responses

NameDescriptionExample
idcdn service id
account_idAccount ID
cache_expiry_timecache expiry time
cache_key_hostnamecache key hostname
caching_optioncaching option
cdn_origin_hostnamecdn service origin host name
cdn_origin_portcdn service origin port
cdn_origin_protocolcdn service origin protocol
cdn_service_activation_statecdn service activation state
cdn_service_config_versioncdn service config version
cdn_service_domaincdn service domain
cdn_service_origin_pathcdn service origin path
cdn_service_statecdn service state
content_policycontent policy
created_atcreate at
created_bycreate by
custom_forward_host_headercustom forward host header
descriptionDescription
forward_host_headerforward host header
modified_atmodified at
modified_bymodified by
namecdn service name
origin_hostname_typeorigin hostname type
query_string_ignoredquery string ignored
range_request_allowedrange request allowed
regionregion
request_custom_headersrequest custom headers
response_custom_headersresponse custom header

4.1.4 - List Cdn Service

4.1.4.1 - 1.0

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

Description

list cdn service

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
created_by
optional
stringcreate by-
name
optional
stringcdn service name-
cdn_service_domain
optional
stringcdn service domain-
cdn_origin_hostname
optional
stringcdn service origin host name-

Responses

NameDescriptionExample
idcdn service id
account_idAccount ID
cdn_origin_hostnamecdn service origin host name
cdn_service_domaincdn service domain
cdn_service_statecdn service state
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namecdn service name
regionregion

4.1.5 - Purge Cdn Service

4.1.5.1 - 1.0

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

Description

purge cdn service

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
id
required
stringcdn service id-
target_url
required
stringtarget url-
target_content
required
stringtarget content-
custom_url
optional
stringcustom url/test/

Responses

NameDescriptionExample
account_idAccount ID
resource_idresource id
workflow_idworkflow id

4.1.6 - Start Cdn Service

4.1.6.1 - 1.0

scpcli cdn cdn service start
--id <value>

Description

start cdn service

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
id
required
stringcdn service id-

Responses

NameDescriptionExample
account_idAccount ID
resource_idresource id
workflow_idworkflow id

4.1.7 - Stop Cdn Service

4.1.7.1 - 1.0

scpcli cdn cdn service stop
--id <value>

Description

stop cdn service

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
id
required
stringcdn service id-

Responses

NameDescriptionExample
account_idAccount ID
resource_idresource id
workflow_idworkflow id

4.1.8 - Update Cdn Service

4.1.8.1 - 1.0

scpcli 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 cdn service

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
id
required
stringcdn service id-
range_request_allowed
required
booleanrange request allowed-
query_string_ignored
required
booleanquery string ignored-
origin_hostname_type
required
stringorigin hostname type-
forward_host_header
required
stringforward host header-
content_policy
required
stringcontent policy-
cdn_origin_protocol
required
stringcdn service origin protocol-
cdn_origin_port
required
integercdn service origin port-
cdn_origin_hostname
required
stringcdn service origin host nametest.example.com
caching_option
required
stringcaching option-
cache_key_hostname
required
stringcache key hostname-
cache_expiry_time
required
integercache expiry time-
cdn_service_origin_path
optional
stringcdn service origin path/test/global/
custom_forward_host_header
optional
stringcustom forward host header-
request_custom_headers
optional
objectrequest custom headers-
response_custom_headers
optional
objectresponse custom header-

4.1.9 - Update Description of Cdn Service

4.1.9.1 - 1.0

scpcli cdn description update
--id <value>
--description <value>

Description

Update description of cdn service

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
id
required
stringcdn service id-
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

5.1 - CLIs

5.1.1 - CreateGslb

5.1.1.1 - 1.1

scpcli 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

The GSLB Create.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
protocol
required
stringThe GSLB Health Check Protocol.-
resources
required
arrayThe GSLB Resource List.'{"description": "", "destination": "", "region": "", "weight": 0}'
name
required
stringThe Name of the gslb.example.gslb.e.samsungsdscloud.com
env_usage
required
stringThe GSLB Environment Usage.PUBLIC
algorithm
required
stringThe GSLB Algorithm.ROUND_ROBIN
description
optional
stringDescriptionExample Description for GSLB
tags
optional
arrayTag List'{"key": "", "value": ""}'
health_check_interval
optional
integerThe GSLB Health Check Interval.-
health_check_probe_timeout
optional
integerThe GSLB Health Check Probe Timeout.-
health_check_user_id
optional
stringThe GSLB Health Check User Name.-
health_check_user_password
optional
stringThe GSLB Health Check Password.-
receive_string
optional
stringThe GSLB Health Check Receive String.-
send_string
optional
stringThe GSLB Health Check Send String.-
service_port
optional
integerThe GSLB Health Check Service Port.-
timeout
optional
integerThe GSLB Health Check Timeout.-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe GSLB Algorithm.ROUND_ROBIN
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for GSLB
env_usageThe GSLB Environment Usage.PUBLIC
health_checkThe GSLB Health Check.
linked_resource_countThe GSLB Linked Resource Count.2
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe Name of the gslb.example.gslb.e.samsungsdscloud.com
stateThe GSLB State.ACTIVE

5.1.1.2 - 1.0

scpcli 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

The GSLB Create.

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 GSLB Health Check Protocol.-
resources
required
array'{"description": "", "destination": "", "disabled": false, "region": "", "weight": 0}'
name
required
stringThe Name of the gslb.-
env_usage
required
stringThe GSLB Environment Usage.-
algorithm
required
stringThe GSLB Algorithm.-
description
optional
stringDescription-
tags
optional
arrayTag List'{"key": "", "value": ""}'
health_check_interval
optional
integerThe GSLB Health Check Interval.-
health_check_probe_timeout
optional
integerThe GSLB Health Check Probe Timeout.-
health_check_user_id
optional
stringThe GSLB Health Check User Name.-
health_check_user_password
optional
stringThe GSLB Health Check Password.-
receive_string
optional
stringThe GSLB Health Check Receive String.-
send_string
optional
stringThe GSLB Health Check Send String.-
service_port
optional
integerThe GSLB Health Check Service Port.-
timeout
optional
integerThe GSLB Health Check Timeout.-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe GSLB Algorithm.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
env_usageThe GSLB Environment Usage.
health_check
linked_resource_countThe GSLB Linked Resource Count.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe Name of the gslb.
stateThe GSLB State.

5.1.2 - DeleteGslb

5.1.2.1 - 1.1

scpcli gslb gslb delete
--gslb_id <value>

Description

The GSLB Delete.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
gslb_id
required
stringThe GSLB ID.-

5.1.2.2 - 1.0

scpcli gslb gslb delete
--gslb_id <value>

Description

The GSLB Delete.

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 GSLB ID.-

5.1.3 - ListGslbResources

5.1.3.1 - 1.1

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

Description

The GSLB Resource List.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
gslb_id
required
stringThe GSLB ID.-
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 GSLB Resource Destination.
health_check_statusThe GSLB Resource Health Check Status.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
regionThe GSLB Resource Region.
statusThe GSLB Resource Status.
weightThe GSLB Resource Weight.

5.1.3.2 - 1.0

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

Description

The GSLB Resource List.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
gslb_id
required
stringThe GSLB ID.-
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 GSLB Resource Destination.
disabledThe GSLB Resource disabled.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
regionThe GSLB Resource Region.
weightThe GSLB Resource Weight.

5.1.4 - ListGslbs

5.1.4.1 - 1.1

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

Description

The GSLB List.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
state
optional
stringThe GSLB State.-
name
optional
stringThe Name of the gslb.-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe GSLB Algorithm.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
env_usageThe GSLB Environment Usage.
linked_resource_countThe GSLB Linked Resource Count.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe Name of the gslb.
stateThe GSLB State.

5.1.4.2 - 1.0

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

Description

The GSLB List.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
state
optional
stringThe GSLB State.-
name
optional
stringThe Name of the gslb.-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe GSLB Algorithm.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
env_usageThe GSLB Environment Usage.
linked_resource_countThe GSLB Linked Resource Count.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe Name of the gslb.
stateThe GSLB State.

5.1.5 - ListGslbsRegionalRoutingControl

5.1.5.1 - 1.1

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

Description

The GSLB Regional Resource List.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
region
optional
stringThe GSLB Resource Region.-
status
optional
****The GSLB Resource Status.-
name
optional
stringThe Name of the gslb.-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe GSLB Algorithm.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
env_usageThe GSLB Environment Usage.
linked_regional_resource_countThe GSLB Linked Resource Count Per Region.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe Name of the gslb.
regionThe GSLB Resource Region.
statusThe GSLB Resource Status.

5.1.6 - SetGslb

5.1.6.1 - 1.1

scpcli gslb gslb update
--gslb_id <value>
[--algorithm <value>]
[--description <value>]

Description

The GSLB Set.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
gslb_id
required
stringThe GSLB ID.-
algorithm
optional
stringThe GSLB Algorithm.-
description
optional
stringDescription-

5.1.6.2 - 1.0

scpcli gslb gslb update
--gslb_id <value>
[--algorithm <value>]
[--description <value>]

Description

The GSLB Set.

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 GSLB ID.-
algorithm
optional
stringThe GSLB Algorithm.-
description
optional
stringDescription-

5.1.7 - SetGslbHealthCheck

5.1.7.1 - 1.1

scpcli 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 GSLB ID.-
protocol
required
stringThe GSLB Health Check Protocol.-
health_check_interval
optional
integerThe GSLB Health Check Interval.-
health_check_probe_timeout
optional
integerThe GSLB Health Check Probe Timeout.-
health_check_user_id
optional
stringThe GSLB Health Check User Name.-
health_check_user_password
optional
stringThe GSLB Health Check Password.-
receive_string
optional
stringThe GSLB Health Check Receive String.-
send_string
optional
stringThe GSLB Health Check Send String.-
service_port
optional
integerThe GSLB Health Check Service Port.-
timeout
optional
integerThe GSLB Health Check Timeout.-

5.1.7.2 - 1.0

scpcli 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 GSLB ID.-
protocol
required
stringThe GSLB Health Check Protocol.-
health_check_interval
optional
integerThe GSLB Health Check Interval.-
health_check_probe_timeout
optional
integerThe GSLB Health Check Probe Timeout.-
health_check_user_id
optional
stringThe GSLB Health Check User Name.-
health_check_user_password
optional
stringThe GSLB Health Check Password.-
receive_string
optional
stringThe GSLB Health Check Receive String.-
send_string
optional
stringThe GSLB Health Check Send String.-
service_port
optional
integerThe GSLB Health Check Service Port.-
timeout
optional
integerThe GSLB Health Check Timeout.-

5.1.8 - SetGslbRegionalRoutingControl

5.1.8.1 - 1.1

scpcli gslb gslb-regional-routing-set
--gslb_id <value>
--status <value>
--region <value>

Description

Set GSLB Regional Routing.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
gslb_id
required
stringThe GSLB ID.-
status
required
stringThe GSLB Resource Status.-
region
required
stringThe GSLB Resource Region.-

5.1.9 - SetGslbResources

5.1.9.1 - 1.1

scpcli 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 GSLB ID.-
resources
required
array'{"description": "", "destination": "", "region": "", "weight": 0}'

5.1.9.2 - 1.0

scpcli 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 GSLB ID.-
resources
required
array'{"description": "", "destination": "", "disabled": false, "region": "", "weight": 0}'

5.1.10 - ShowGslb

5.1.10.1 - 1.1

scpcli gslb gslb show
--gslb_id <value>

Description

The GSLB Show.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
gslb_id
required
stringThe GSLB ID.-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe GSLB Algorithm.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
env_usageThe GSLB Environment Usage.
health_check
linked_resource_countThe GSLB Linked Resource Count.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe Name of the gslb.
stateThe GSLB State.

5.1.10.2 - 1.0

scpcli gslb gslb show
--gslb_id <value>

Description

The GSLB Show.

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 GSLB ID.-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe GSLB Algorithm.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
env_usageThe GSLB Environment Usage.
health_check
linked_resource_countThe GSLB Linked Resource Count.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe Name of the gslb.
stateThe GSLB State.

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.3CURRENT-
1.2DEPRECATED20260319
1.1DEPRECATED20260319
1.0DEPRECATED20251023

6.1 - CLIs

6.1.1 - AddLbServerGroupMembers

6.1.1.1 - 1.3

scpcli 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.3-

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

scpcli loadbalancer lb-server-group-members add
--lb_server_group_id <value>
--members <value>

Description

Add Lb Server Group Member bulk

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

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
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.1.3 - 1.1

scpcli loadbalancer lb-server-group-members add
--lb_server_group_id <value>
--members <value>

Description

Add Lb Server Group Member bulk

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

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
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.2 - CreateLBHealthCheck

6.1.2.1 - 1.3

scpcli 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.3-

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

scpcli 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 (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.220260319

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.3 - 1.1

scpcli 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 (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.120260319

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

scpcli 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 (CURRENT)

VersionNot Before
1.3-

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": "", "not_after_dt": "", "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.3.2 - 1.2

scpcli loadbalancer lb-listener create
--listener_protocol <value>
--service_port <value>
--routing_action <value>
--name <value>
--loadbalancer_id <value>
[--condition_type <value>]
[--description <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 (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.220260319

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-
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": "", "not_after_dt": "", "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
https_redirectionThe https redirection 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.3.3 - 1.1

scpcli loadbalancer lb-listener create
--listener_protocol <value>
--service_port <value>
--name <value>
--loadbalancer_id <value>
[--condition_type <value>]
[--description <value>]
[--insert_client_ip <value>]
[--persistence <value>]
[--response_timeout <value>]
[--routing_action <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 (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.120260319

Parameters

NameTypeDescriptionExample
listener_protocol
required
stringprotocol-
service_port
required
integerThe port 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-
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.-
routing_action
optional
****The routing action 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": "", "not_after_dt": "", "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
https_redirectionThe https redirection 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.3

scpcli 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.3-

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

scpcli 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 (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.220260319

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.3 - 1.1

scpcli 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 (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.120260319

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

scpcli 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 (CURRENT)

VersionNot Before
1.3-

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.5.2 - 1.2

scpcli 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 (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.220260319

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.5.3 - 1.1

scpcli 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 (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.120260319

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

scpcli 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.3-

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

scpcli 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.3-

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

scpcli loadbalancer loadbalancer-public-nat-ip create
--loadbalancer_id <value>
--publicip_id <value>

Description

create Load Balancer Public 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.220260319

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.3 - 1.1

scpcli loadbalancer loadbalancer-public-nat-ip create
--loadbalancer_id <value>
--publicip_id <value>

Description

create Load Balancer Public 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.120260319

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

scpcli loadbalancer lb-health-check delete
--lb_health_check_id <value>

Description

Delete LB Health Check

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
lb_health_check_id
required
stringLB Health Check IDe3cd678b11784734bc366148aa37580e

6.1.8.2 - 1.2

scpcli loadbalancer lb-health-check delete
--lb_health_check_id <value>

Description

Delete LB Health Check

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

Parameters

NameTypeDescriptionExample
lb_health_check_id
required
stringLB Health Check IDe3cd678b11784734bc366148aa37580e

6.1.8.3 - 1.1

scpcli loadbalancer lb-health-check delete
--lb_health_check_id <value>

Description

Delete LB Health Check

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

Parameters

NameTypeDescriptionExample
lb_health_check_id
required
stringLB Health Check IDe3cd678b11784734bc366148aa37580e

6.1.9 - DeleteLbListener

6.1.9.1 - 1.3

scpcli loadbalancer lb-listener delete
--listener_id <value>

Description

delete LB listener

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
listener_id
required
stringThe ID of the listener.-

6.1.9.2 - 1.2

scpcli loadbalancer lb-listener delete
--listener_id <value>

Description

delete LB listener

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

Parameters

NameTypeDescriptionExample
listener_id
required
stringThe ID of the listener.-

6.1.9.3 - 1.1

scpcli loadbalancer lb-listener delete
--listener_id <value>

Description

delete LB listener

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

Parameters

NameTypeDescriptionExample
listener_id
required
stringThe ID of the listener.-

6.1.10 - DeleteLBServerGroup

6.1.10.1 - 1.3

scpcli loadbalancer lb-server-group delete
--lb_server_group_id <value>

Description

Delete LB Server Group

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringLB Server Group ID3d8d8754d0d54683a29f3dcc3dd95d5b

6.1.10.2 - 1.2

scpcli loadbalancer lb-server-group delete
--lb_server_group_id <value>

Description

Delete LB Server Group

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

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringLB Server Group ID3d8d8754d0d54683a29f3dcc3dd95d5b

6.1.10.3 - 1.1

scpcli loadbalancer lb-server-group delete
--lb_server_group_id <value>

Description

Delete LB Server Group

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

Parameters

NameTypeDescriptionExample
lb_server_group_id
required
stringLB Server Group ID3d8d8754d0d54683a29f3dcc3dd95d5b

6.1.11 - DeleteLoadbalancer

6.1.11.1 - 1.3

scpcli loadbalancer loadbalancer delete
--loadbalancer_id <value>

Description

delete Load Balancer

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-

6.1.11.2 - 1.2

scpcli loadbalancer loadbalancer delete
--loadbalancer_id <value>

Description

delete 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.220260319

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-

6.1.11.3 - 1.1

scpcli loadbalancer loadbalancer delete
--loadbalancer_id <value>

Description

delete 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.120260319

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-

6.1.12 - DeleteLoadbalancerPrivateNatIp

6.1.12.1 - 1.3

scpcli loadbalancer loadbalancer-private-nat-ip delete
--loadbalancer_id <value>

Description

delete Load Balancer Private NAT IP

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-

6.1.13 - DeleteLoadbalancerPublicNatIp

6.1.13.1 - 1.3

scpcli loadbalancer loadbalancer-public-nat-ip delete
--loadbalancer_id <value>

Description

delete Load Balancer Public NAT IP

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-

6.1.13.2 - 1.2

scpcli loadbalancer loadbalancer-public-nat-ip delete
--loadbalancer_id <value>

Description

delete Load Balancer Public 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.220260319

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-

6.1.13.3 - 1.1

scpcli loadbalancer loadbalancer-public-nat-ip delete
--loadbalancer_id <value>

Description

delete Load Balancer Public 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.120260319

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-

6.1.14 - ListLBHealthChecks

6.1.14.1 - 1.3

scpcli 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.3-

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

scpcli 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 (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.220260319

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.3 - 1.1

scpcli 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 (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.120260319

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

scpcli 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.3-

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

scpcli 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 (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.220260319

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.3 - 1.1

scpcli 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 (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.120260319

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

scpcli 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.3-

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.16.2 - 1.2

scpcli 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 (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.220260319

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.16.3 - 1.1

scpcli 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 (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.120260319

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

scpcli loadbalancer lb-server-group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <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.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringLB Server Group nameServerGroup01
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.2

scpcli loadbalancer lb-server-group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <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 (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.220260319

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringLB Server Group nameServerGroup01
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.3 - 1.1

scpcli loadbalancer lb-server-group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <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 (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.120260319

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringLB Server Group nameServerGroup01
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.3

scpcli loadbalancer loadbalancer-certificate list

Description

get Load Balancer certificate list

State ACTIVE (CURRENT)

VersionNot Before
1.3-

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

scpcli loadbalancer loadbalancer-certificate list

Description

get Load Balancer certificate 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.220260319

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.3 - 1.1

scpcli loadbalancer loadbalancer-certificate list

Description

get Load Balancer certificate 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.120260319

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

scpcli 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.3-

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.19.2 - 1.2

scpcli 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 (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.220260319

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.19.3 - 1.1

scpcli 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 (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.120260319

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

scpcli 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.3-

Parameters

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

6.1.20.2 - 1.2

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

Description

Remove Lb Server Group Member

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

Parameters

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

6.1.20.3 - 1.1

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

Description

Remove Lb Server Group Member

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

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

scpcli 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.3-

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

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

Description

Remove Lb Server Group Members

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

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

scpcli 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.3-

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

scpcli 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 (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.220260319

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.3 - 1.1

scpcli 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 (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.120260319

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

scpcli 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 (CURRENT)

VersionNot Before
1.3-

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": "", "not_after_dt": "", "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.23.2 - 1.2

scpcli loadbalancer lb-listener update
--listener_id <value>
[--condition_type <value>]
[--description <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 (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.220260319

Parameters

NameTypeDescriptionExample
listener_id
required
stringThe ID of the listener.-
condition_type
optional
****The condition type of the listener.-
description
optional
stringdescription-
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": "", "not_after_dt": "", "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.23.3 - 1.1

scpcli loadbalancer lb-listener update
--listener_id <value>
[--condition_type <value>]
[--description <value>]
[--insert_client_ip <value>]
[--persistence <value>]
[--response_timeout <value>]
[--routing_action <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 (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.120260319

Parameters

NameTypeDescriptionExample
listener_id
required
stringThe ID of the listener.-
condition_type
optional
****The condition type of the listener.-
description
optional
stringdescription-
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.-
routing_action
optional
****The routing action 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": "", "not_after_dt": "", "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 - SetLBServerGroup

6.1.24.1 - 1.3

scpcli 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.3-

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.24.2 - 1.2

scpcli 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 (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.220260319

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.24.3 - 1.1

scpcli 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 (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.120260319

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.25 - SetLbServerGroupMember

6.1.25.1 - 1.3

scpcli 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.3-

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.25.2 - 1.2

scpcli 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 (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.220260319

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.25.3 - 1.1

scpcli 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 (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.120260319

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.26 - SetLoadbalancer

6.1.26.1 - 1.3

scpcli loadbalancer loadbalancer update
--loadbalancer_id <value>
--description <value>

Description

Set Load Balancer

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-
description
required
stringdescription-

6.1.26.2 - 1.2

scpcli loadbalancer loadbalancer update
--loadbalancer_id <value>
--description <value>

Description

Set 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.220260319

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-
description
required
stringdescription-

6.1.26.3 - 1.1

scpcli loadbalancer loadbalancer update
--loadbalancer_id <value>
--description <value>

Description

Set 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.120260319

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-
description
required
stringdescription-

6.1.27 - ShowLBHealthCheck

6.1.27.1 - 1.3

scpcli loadbalancer lb-health-check read
--lb_health_check_id <value>

Description

Get LB Health Check

State ACTIVE (CURRENT)

VersionNot Before
1.3-

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.27.2 - 1.2

scpcli loadbalancer lb-health-check read
--lb_health_check_id <value>

Description

Get LB Health Check

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

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.27.3 - 1.1

scpcli loadbalancer lb-health-check read
--lb_health_check_id <value>

Description

Get LB Health Check

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

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.28 - ShowLbListener

6.1.28.1 - 1.3

scpcli loadbalancer lb-listener show
--listener_id <value>

Description

show LB listener

State ACTIVE (CURRENT)

VersionNot Before
1.3-

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.28.2 - 1.2

scpcli loadbalancer lb-listener show
--listener_id <value>

Description

show LB listener

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

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
https_redirectionThe https redirection 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.28.3 - 1.1

scpcli loadbalancer lb-listener show
--listener_id <value>

Description

show LB listener

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

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
https_redirectionThe https redirection 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.29 - ShowLBServerGroup

6.1.29.1 - 1.3

scpcli loadbalancer lb-server-group read
--lb_server_group_id <value>

Description

Show LB Server Group

State ACTIVE (CURRENT)

VersionNot Before
1.3-

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.29.2 - 1.2

scpcli loadbalancer lb-server-group read
--lb_server_group_id <value>

Description

Show LB Server Group

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

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.29.3 - 1.1

scpcli loadbalancer lb-server-group read
--lb_server_group_id <value>

Description

Show LB Server Group

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

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.30 - ShowLbServerGroupMember

6.1.30.1 - 1.3

scpcli 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.3-

Parameters

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

Responses

NameDescriptionExample
member

6.1.30.2 - 1.2

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

Description

Show Lb Server Group Member

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

Parameters

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

Responses

NameDescriptionExample
member

6.1.30.3 - 1.1

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

Description

Show Lb Server Group Member

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

Parameters

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

Responses

NameDescriptionExample
member

6.1.31 - ShowLoadbalancer

6.1.31.1 - 1.3

scpcli loadbalancer loadbalancer show
--loadbalancer_id <value>

Description

show Load Balancer

State ACTIVE (CURRENT)

VersionNot Before
1.3-

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.31.2 - 1.2

scpcli loadbalancer loadbalancer show
--loadbalancer_id <value>

Description

show 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.220260319

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.31.3 - 1.1

scpcli loadbalancer loadbalancer show
--loadbalancer_id <value>

Description

show 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.120260319

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.32 - ShowLoadbalancerCertificate

6.1.32.1 - 1.3

scpcli loadbalancer loadbalancer-certificate show
--lb_certificate_id <value>

Description

show Load Balancer certificate

State ACTIVE (CURRENT)

VersionNot Before
1.3-

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.32.2 - 1.2

scpcli loadbalancer loadbalancer-certificate show
--lb_certificate_id <value>

Description

show Load Balancer certificate

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

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.32.3 - 1.1

scpcli loadbalancer loadbalancer-certificate show
--lb_certificate_id <value>

Description

show Load Balancer certificate

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

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.33 - ShowLoadbalancerPrivateNatIp

6.1.33.1 - 1.3

scpcli loadbalancer loadbalancer-private-nat-ip show
--loadbalancer_id <value>

Description

Show Load Balancer Private NAT IP

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-

Responses

NameDescriptionExample
static_nat

6.1.34 - ShowLoadbalancerPublicNatIp

6.1.34.1 - 1.3

scpcli loadbalancer loadbalancer-public-nat-ip show
--loadbalancer_id <value>

Description

Show Load Balancer Public NAT IP

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-

Responses

NameDescriptionExample
external_ip_addressStatic Nat External Ip Address
publicip_idPublicip ID
stateStatic Nat State

6.1.34.2 - 1.2

scpcli loadbalancer loadbalancer-public-nat-ip show
--loadbalancer_id <value>

Description

Show Load Balancer Public 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.220260319

Parameters

NameTypeDescriptionExample
loadbalancer_id
required
stringID-

Responses

NameDescriptionExample
external_ip_addressStatic Nat External Ip Address
publicip_idPublicip ID
stateStatic Nat State

6.1.34.3 - 1.1

scpcli loadbalancer loadbalancer-public-nat-ip show
--loadbalancer_id <value>

Description

Show Load Balancer Public 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.120260319

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

7.1 - CLIs

7.1.1 - Create Security Group

7.1.1.1 - 1.0

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

Description

Create Security Group.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
name
required
stringSecurity Group Name-
description
optional
stringSecurity Group Description-
loggable
optional
booleanSecurity Group Loggable-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idSecurity Group ID
account_idSecurity Group Account ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionSecurity Group Description
loggableSecurity Group Loggable
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSecurity Group Name
rule_countSecurity Group Rule Count
stateSecurity Group State

7.1.2 - Create Security Group Rule

7.1.2.1 - 1.0

scpcli 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 (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
security_group_id
required
stringSecurity Group ID-
direction
required
stringSecurity Group Rule Direction (Ingress, Egress)-
description
optional
stringSecurity Group Rule Description-
ethertype
optional
stringSecurity Group Rule Ethertype (IPV4, IPV6)-
port_range_max
optional
integerSecurity Group Rule Port Range Max-
port_range_min
optional
integerSecurity Group Rule Port Range Min-
protocol
optional
stringSecurity Group Rule Protocol-
remote_group_id
optional
stringSecurity Group Rule Remote Group ID-
remote_ip_prefix
optional
stringSecurity Group Rule Remote IP Address-

Responses

NameDescriptionExample
idSecurity Group Rule ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionSecurity Group Rule Description
directionSecurity Group Rule Direction (Ingress, Egress)
ethertypeSecurity Group Rule Ethertype (IPV4, IPV6)
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
port_range_maxSecurity Group Rule Port Range Max
port_range_minSecurity Group Rule Port Range Min
protocolSecurity Group Rule Protocol
remote_group_idSecurity Group Rule Remote Group ID
remote_group_nameSecurity Group Rule Remote Group Name
remote_ip_prefixSecurity Group Rule Remote IP Address
security_group_idSecurity Group ID

7.1.3 - Delete Security Group

7.1.3.1 - 1.0

scpcli security-group security-group delete
--security_group_id <value>

Description

Delete Security Group.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
security_group_id
required
stringSecurity Group ID-

7.1.4 - Delete Security Group Rule

7.1.4.1 - 1.0

scpcli security-group security-group-rule delete
--security_group_rule_id <value>

Description

Delete Security Group rule.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
security_group_rule_id
required
stringSecurity Group Rule ID-

7.1.5 - List Security Group Rules

7.1.5.1 - 1.0

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

Parameters

NameTypeDescriptionExample
security_group_id
required
stringSecurity Group ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringSecurity Group Rule ID-
remote_ip_prefix
optional
stringSecurity Group Rule Remote IP Address-
remote_group_id
optional
stringSecurity Group Rule Remote Group ID-
description
optional
stringSecurity Group Rule Description-
direction
optional
stringSecurity Group Rule Direction (Ingress, Egress)-
service
optional
stringSecurity Group Rule Service-

Responses

NameDescriptionExample
idSecurity Group Rule ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionSecurity Group Rule Description
directionSecurity Group Rule Direction (Ingress, Egress)
ethertypeSecurity Group Rule Ethertype (IPV4, IPV6)
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
port_range_maxSecurity Group Rule Port Range Max
port_range_minSecurity Group Rule Port Range Min
protocolSecurity Group Rule Protocol
remote_group_idSecurity Group Rule Remote Group ID
remote_group_nameSecurity Group Rule Remote Group Name
remote_ip_prefixSecurity Group Rule Remote IP Address
security_group_idSecurity Group ID

7.1.6 - List Security Groups

7.1.6.1 - 1.0

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

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 ID
account_idSecurity Group Account ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionSecurity Group Description
loggableSecurity Group Loggable
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSecurity Group Name
rule_countSecurity Group Rule Count
stateSecurity Group State

7.1.7 - Set Security Group

7.1.7.1 - 1.0

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

Description

Set Security Group.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
security_group_id
required
stringSecurity Group ID-
description
optional
stringSecurity Group Description-
loggable
optional
booleanSecurity Group Loggable-

7.1.8 - Show Security Group

7.1.8.1 - 1.0

scpcli security-group security-group show
--security_group_id <value>

Description

Show Security Group.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
security_group_id
required
stringSecurity Group ID-

Responses

NameDescriptionExample
idSecurity Group ID
account_idSecurity Group Account ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionSecurity Group Description
loggableSecurity Group Loggable
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSecurity Group Name
rule_countSecurity Group Rule Count
stateSecurity Group State

7.1.9 - Show Security Group Rule

7.1.9.1 - 1.0

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

Description

Show Security Group rule.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
security_group_rule_id
required
stringSecurity Group Rule ID-
fields
optional
arrayField Name-

Responses

NameDescriptionExample
idSecurity Group Rule ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionSecurity Group Rule Description
directionSecurity Group Rule Direction (Ingress, Egress)
ethertypeSecurity Group Rule Ethertype (IPV4, IPV6)
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
port_range_maxSecurity Group Rule Port Range Max
port_range_minSecurity Group Rule Port Range Min
protocolSecurity Group Rule Protocol
remote_group_idSecurity Group Rule Remote Group ID
remote_group_nameSecurity Group Rule Remote Group Name
remote_ip_prefixSecurity Group Rule Remote IP Address
security_group_idSecurity Group ID

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.2CURRENT-
1.1SUPPORTED20261130
1.0DEPRECATED20251231

8.1 - CLIs

8.1.1 - Add VPC CIDR

8.1.1.1 - 1.2

scpcli vpc vpc cidr create
--vpc_id <value>
--cidr <value>

Description

Add VPC CIDR.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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

scpcli vpc vpc-peering approval
--vpc_peering_id <value>
--type <value>

Description

Approval VPC Peering.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492
type
required
stringApproval Type-

8.1.2.2 - 1.1

scpcli 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.2

scpcli vpc privatelink-endpoint approve
--privatelink_endpoint_id <value>
--type <value>

Description

Approve PrivateLink Endpoint

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

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

8.1.3.2 - 1.1

scpcli 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.2

scpcli vpc privatelink-endpoint connect
--privatelink_endpoint_id <value>
--type <value>

Description

Connect PrivateLink Endpoint

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

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

8.1.4.2 - 1.1

scpcli 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.2

scpcli 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.2-

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

scpcli 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.2-

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.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

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

Description

Create NAT Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli 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.2-

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
port

8.1.8.2 - 1.1

scpcli 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
port

8.1.8.3 - 1.0

scpcli 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
port

8.1.9 - Create Private NAT

8.1.9.1 - 1.2

scpcli 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.2-

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

scpcli 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.3 - 1.0

scpcli 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.2

scpcli vpc private-nat-ip create
--private_nat_id <value>
--ip_address <value>

Description

Create Private NAT IP.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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

scpcli 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.3 - 1.0

scpcli 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.2

scpcli 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.2-

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

scpcli 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.2

scpcli 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.2-

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

scpcli 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.2

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

Description

Create PublicIP.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli 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 (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
type
required
stringSubnet Type-
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 Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.14.2 - 1.1

scpcli 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 Type-
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 Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.14.3 - 1.0

scpcli 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 Type-
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 Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.15 - Create Subnet VIP

8.1.15.1 - 1.2

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

Description

Create Subnet Vip

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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

scpcli 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.2-

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

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

Description

Create Transit Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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 ID[‘bbb93aca123f4bb2b2c0f206f4a86b2b’]
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse

8.1.17.2 - 1.1

scpcli 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 ID[‘bbb93aca123f4bb2b2c0f206f4a86b2b’]
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse

8.1.17.3 - 1.0

scpcli 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 ID[‘bbb93aca123f4bb2b2c0f206f4a86b2b’]
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.2

scpcli vpc transit-gateway-firewall create
--transit_gateway_id <value>
--product_type <value>

Description

Create Transit Gateway Firewall.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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 ID[‘bbb93aca123f4bb2b2c0f206f4a86b2b’]
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.2

scpcli vpc transit-gateway-firewall-connection create
--transit_gateway_id <value>

Description

Create Transit Gateway Firewall Connection.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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 ID[‘bbb93aca123f4bb2b2c0f206f4a86b2b’]
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.2

scpcli 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.2-

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

scpcli 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.3 - 1.0

scpcli 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.2

scpcli 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.2-

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

scpcli 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.3 - 1.0

scpcli 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.2

scpcli 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.2-

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

scpcli 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.3 - 1.0

scpcli 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.2

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

Description

Create VPC.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli 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.2-

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

scpcli 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.3 - 1.0

scpcli 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.2

scpcli 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.2-

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

scpcli 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.3 - 1.0

scpcli 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.2

scpcli 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.2-

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

scpcli 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.3 - 1.0

scpcli 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.2

scpcli vpc internet-gateway delete
--internet_gateway_id <value>

Description

Delete Internet Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID023c57b14f11483689338d085e061492

8.1.27.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli vpc nat-gateway delete
--nat_gateway_id <value>

Description

Delete NAT Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID12f56e27070248a6a240a497e43fbe18

8.1.28.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli vpc port delete
--port_id <value>

Description

Delete port.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

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

8.1.29.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli vpc private-nat delete
--private_nat_id <value>

Description

Delete Private NAT.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18

8.1.30.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli 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.2-

Parameters

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

8.1.31.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli vpc privatelink-endpoint delete
--privatelink_endpoint_id <value>

Description

Delete PrivateLink Endpoint.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02

8.1.32.2 - 1.1

scpcli 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.2

scpcli vpc privatelink-service delete
--privatelink_service_id <value>

Description

Delete PrivateLink Service.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d

8.1.33.2 - 1.1

scpcli 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.2

scpcli vpc public-ip delete
--publicip_id <value>

Description

Delete PublicIP.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID12f56e27070248a6a240a497e43fbe18

8.1.34.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli vpc subnet delete
--subnet_id <value>

Description

Delete subnet.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492

8.1.35.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli vpc subnet vip delete
--vip_id <value>
--subnet_id <value>

Description

Delete Subnet Vip

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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

scpcli 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.2-

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

scpcli 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.2-

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

scpcli vpc transit-gateway delete
--transit_gateway_id <value>

Description

Delete Transit Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

8.1.39.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli vpc transit-gateway-firewall-delete
--firewall_id <value>
--transit_gateway_id <value>

Description

Delete Transit Gateway Firewall.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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

scpcli vpc transit-gateway-firewall-connection delete
--transit_gateway_id <value>

Description

Delete Transit Gateway Firewall Connection.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

8.1.42 - Delete Transit Gateway Rule

8.1.42.1 - 1.2

scpcli vpc transit-gateway-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>

Description

Delete Transit Gateway Rule.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

8.1.42.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli 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.2-

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

8.1.43.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli 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.2-

Parameters

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

8.1.44.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli vpc vpc delete
--vpc_id <value>

Description

Delete VPC.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-

8.1.45.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli vpc vpc-endpoint delete
--vpc_endpoint_id <value>

Description

Delete VPC Endpoint.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID12f56e27070248a6a240a497e43fbe18

8.1.46.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli vpc vpc-peering delete
--vpc_peering_id <value>

Description

Delete VPC Peering.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492

8.1.47.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli 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.2-

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule ID-
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492

8.1.48.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli 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.2-

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

scpcli 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.2

scpcli 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.2-

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.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli 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 (CURRENT)

VersionNot Before
1.2-

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.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli 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.2-

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

scpcli 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.3 - 1.0

scpcli 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.2

scpcli 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.2-

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

scpcli 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.3 - 1.0

scpcli 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.2

scpcli 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.2-

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

scpcli 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.3 - 1.0

scpcli 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.2

scpcli 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.2-

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

scpcli 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.2

scpcli 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.2-

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

scpcli 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.2

scpcli 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 (CURRENT)

VersionNot Before
1.2-

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.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli 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.2-

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

scpcli 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 (CURRENT)

VersionNot Before
1.2-

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 Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.59.2 - 1.1

scpcli 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 Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.59.3 - 1.0

scpcli 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 Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.60 - List Transit Gateway Rules

8.1.60.1 - 1.2

scpcli 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.2-

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

scpcli 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.3 - 1.0

scpcli 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.2

scpcli 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.2-

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

scpcli 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.3 - 1.0

scpcli 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.2

scpcli vpc transit-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
[--firewall_connection_state <value>]

Description

Get Transit Gateway list.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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

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 ID[‘bbb93aca123f4bb2b2c0f206f4a86b2b’]
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse

8.1.62.2 - 1.1

scpcli 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 ID[‘bbb93aca123f4bb2b2c0f206f4a86b2b’]
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse

8.1.62.3 - 1.0

scpcli 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 ID[‘bbb93aca123f4bb2b2c0f206f4a86b2b’]
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.2

scpcli 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.2-

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

scpcli 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.3 - 1.0

scpcli 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.2

scpcli vpc vpc-endpoint-connectable-resource list
--resource_type <value>
[--vpc_id <value>]

Description

List VpcEndpoint connectable resources

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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

scpcli 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.3 - 1.0

scpcli 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.2

scpcli 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.2-

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

scpcli 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.3 - 1.0

scpcli 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.2

scpcli 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.2-

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

scpcli 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.3 - 1.0

scpcli 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.2

scpcli vpc vpc list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
[--cidr <value>]

Description

Get VPC list.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli vpc privatelink-endpoint request
--privatelink_endpoint_id <value>
--type <value>

Description

Request PrivateLink Endpoint

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

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

8.1.68.2 - 1.1

scpcli 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.2

scpcli vpc internet-gateway set
--internet_gateway_id <value>
[--description <value>]
[--loggable <value>]

Description

Set Internet Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID023c57b14f11483689338d085e061492
description
optional
stringDescriptionInternet Gateway Description
loggable
optional
booleanNAT Loggable-

8.1.69.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli vpc nat-gateway set
--nat_gateway_id <value>
[--description <value>]

Description

Set NAT Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID12f56e27070248a6a240a497e43fbe18
description
optional
stringNAT Gateway DescriptionVpcEndpoint Description

8.1.70.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli vpc port set
--port_id <value>
[--description <value>]
[--security_groups <value>]

Description

Set port.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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

scpcli 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.3 - 1.0

scpcli 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.2

scpcli vpc private-nat set
--private_nat_id <value>
[--description <value>]

Description

Set Private NAT.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18
description
optional
stringDescriptionPrivateNat Description

8.1.72.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli vpc privatelink-endpoint set
--privatelink_endpoint_id <value>
[--description <value>]

Description

Set PrivateLink Endpoint.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
description
optional
stringDescriptionPrivateLink Endpoint Description

8.1.73.2 - 1.1

scpcli 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.2

scpcli vpc privatelink-service set
--privatelink_service_id <value>
[--description <value>]

Description

Set PrivateLink Service.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
description
optional
stringDescriptionPrivateLink Service Description

8.1.74.2 - 1.1

scpcli 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.2

scpcli vpc public-ip set
--publicip_id <value>
--description <value>

Description

Set PublicIP.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID12f56e27070248a6a240a497e43fbe18
description
required
stringPublicIP DescriptionPublic IP Description

8.1.75.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli vpc subnet set
--subnet_id <value>
[--description <value>]
[--dhcp_ip_address <value>]

Description

Set subnet.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
description
optional
stringDescriptionSubnet Description
dhcp_ip_address
optional
stringDHCP IP Address-

8.1.76.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli vpc subnet vip set
--vip_id <value>
--subnet_id <value>
--description <value>

Description

Set Subnet Vip

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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

scpcli vpc transit-gateway set
--transit_gateway_id <value>
[--description <value>]

Description

Set Transit Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
description
optional
stringDescriptionTransitGateway Description

8.1.78.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli vpc vpc set
--vpc_id <value>
[--description <value>]

Description

Set VPC.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-
description
optional
stringDescriptionvpcDescription

8.1.79.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli vpc vpc-endpoint set
--vpc_endpoint_id <value>
[--description <value>]

Description

Set VPC Endpoint.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
description
optional
stringDescriptionVpcEndpoint Description

8.1.80.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli vpc vpc-peering set
--vpc_peering_id <value>
[--description <value>]

Description

Set VPC Peering.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492
description
optional
stringDescriptionvpcPeering Description

8.1.81.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli vpc internet-gateway show
--internet_gateway_id <value>

Description

Show Internet Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli vpc nat-gateway show
--nat_gateway_id <value>

Description

Show NAT Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli vpc port show
--port_id <value>

Description

Show port.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

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

Responses

NameDescriptionExample
port

8.1.84.2 - 1.1

scpcli 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
port

8.1.84.3 - 1.0

scpcli 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
port

8.1.85 - Show Private NAT

8.1.85.1 - 1.2

scpcli vpc private-nat show
--private_nat_id <value>

Description

Show Private NAT.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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

scpcli 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.3 - 1.0

scpcli 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.2

scpcli vpc privatelink-endpoint show
--privatelink_endpoint_id <value>

Description

Show PrivateLink Endpoint.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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

scpcli 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.2

scpcli vpc privatelink-service show
--privatelink_service_id <value>

Description

Show PrivateLink Service.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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

scpcli 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.2

scpcli vpc public-ip show
--publicip_id <value>

Description

Show PublicIP.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli vpc subnet show
--subnet_id <value>

Description

Show subnet.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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 Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.89.2 - 1.1

scpcli 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 Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.89.3 - 1.0

scpcli 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 Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

8.1.90 - Show Subnet Vip

8.1.90.1 - 1.2

scpcli vpc subnet vip show
--vip_id <value>
--subnet_id <value>

Description

Show Subnet Vip

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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

scpcli vpc transit-gateway show
--transit_gateway_id <value>

Description

Show Transit Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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 ID[‘bbb93aca123f4bb2b2c0f206f4a86b2b’]
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse

8.1.91.2 - 1.1

scpcli 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 ID[‘bbb93aca123f4bb2b2c0f206f4a86b2b’]
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse

8.1.91.3 - 1.0

scpcli 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 ID[‘bbb93aca123f4bb2b2c0f206f4a86b2b’]
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.2

scpcli vpc vpc show
--vpc_id <value>

Description

Show VPC.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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.2 - 1.1

scpcli 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.3 - 1.0

scpcli 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.2

scpcli vpc vpc-endpoint show
--vpc_endpoint_id <value>

Description

Show VPC Endpoint.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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

scpcli 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.3 - 1.0

scpcli 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.2

scpcli vpc vpc-peering show
--vpc_peering_id <value>

Description

Show VPC Peering.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

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

scpcli 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.3 - 1.0

scpcli 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

9.1 - CLIs

9.1.1 - Create VPN Gateway

9.1.1.1 - 1.1

scpcli 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

scpcli 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

scpcli 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

scpcli 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

scpcli 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

scpcli 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

scpcli 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

scpcli 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

scpcli 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

scpcli 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

scpcli 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

scpcli 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

scpcli 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

scpcli 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

scpcli 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

scpcli 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

scpcli 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

scpcli 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

scpcli 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

scpcli 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