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

Return to the regular view of this page.

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

VersionStatusSupported Until
1.0CURRENT-

1 - CLIs

1.1 - Create Direct Connect

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

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
vpc_id
required		stringVPC Id-
name
required		stringDirect Connect Name-
bandwidth
required		integerPort Bandwidth-
description
optional		stringDirect Connect Description-
firewall_enabled
optional		booleanFirewall Use-
firewall_loggable
optional		booleanFirewall Loggable-
tags
optional		arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idDirect Connect ID
account_idAccount ID
bandwidthPort Bandwidth
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDirect Connect Description
firewall_idFirewall ID
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameDirect Connect Name
stateState
vpc_idVPC Id
vpc_nameVPC Name

1.2 - Create Routing Rule

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

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
direct_connect_id
required		stringDirect Connect ID-
destination_type
required		stringDestination Type-
destination_cidr
required		stringDestination CIDR-
description
optional		stringDescription-
destination_resource_id
optional		stringDestination Resource ID-

Responses

NameDescriptionExample
idRouting Rule ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
destination_cidrDestination CIDR
destination_resource_idDestination Resource ID
destination_resource_nameDestination Resource Name
destination_typeDestination Type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
owner_idRouting Rule Owner ID
owner_typeRouting Rule Owner Type
stateState

1.3 - Delete Direct Connect

1.3.1 - 1.0

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

Description

Delete direct connect.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
direct_connect_id
required		stringDirect Connect ID-

1.4 - Delete Routing Rule

1.4.1 - 1.0

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

Description

Delete a routing rule.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
routing_rule_id
required		stringRouting Rule ID-
direct_connect_id
required		stringDirect Connect ID-

1.5 - List Direct Connects

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

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
with_count
optional		stringwith counttrue
limit
optional		integerlimit20
marker
optional		stringmarker607e0938521643b5b4b266f343fae693
sort
optional		stringsortcreated_at:desc
id
optional		stringDirect Connect ID-
name
optional		stringDirect Connect Name-
state
optional		****State-
vpc_id
optional		stringVPC Id-
vpc_name
optional		stringVPC Name-

Responses

NameDescriptionExample
idDirect Connect ID
account_idAccount ID
bandwidthPort Bandwidth
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDirect Connect Description
firewall_idFirewall ID
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameDirect Connect Name
stateState
vpc_idVPC Id
vpc_nameVPC Name

1.6 - List Routing Rules

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

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
direct_connect_id
required		stringDirect Connect ID-
with_count
optional		stringwith counttrue
limit
optional		integerlimit20
marker
optional		stringmarker607e0938521643b5b4b266f343fae693
sort
optional		stringsortcreated_at:desc
id
optional		stringRouting Rule ID-
destination_type
optional		****Destination Type-
destination_cidr
optional		stringDestination CIDR-
state
optional		****State-

Responses

NameDescriptionExample
idRouting Rule ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
destination_cidrDestination CIDR
destination_resource_idDestination Resource ID
destination_resource_nameDestination Resource Name
destination_typeDestination Type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
owner_idRouting Rule Owner ID
owner_typeRouting Rule Owner Type
stateState

1.7 - Set Direct Connect

1.7.1 - 1.0

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

Description

Set direct connect.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
direct_connect_id
required		stringDirect Connect ID-
description
required		stringDirect Connect Description-

1.8 - Show Direct Connect

1.8.1 - 1.0

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

Description

Show direct connect.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
direct_connect_id
required		stringDirect Connect ID-

Responses

NameDescriptionExample
idDirect Connect ID
account_idAccount ID
bandwidthPort Bandwidth
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDirect Connect Description
firewall_idFirewall ID
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameDirect Connect Name
stateState
vpc_idVPC Id
vpc_nameVPC Name