This is the multi-page printable view of this section. Click here to print.
CLIs
1 - Create Direct Connect
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)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| name required | string | Direct Connect Name | DirectConnectName |
| bandwidth required | integer | Port Bandwidth | 1 |
| description optional | string | Direct Connect Description | TransitGateway Description |
| firewall_enabled optional | boolean | Firewall Use | True |
| firewall_loggable optional | boolean | Firewall Loggable | True |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Direct Connect Description | fe860e0af0c04dcd8182b84f907f31f4 |
| firewall_id | Firewall ID | dffc455f1bd14e0594e4faa638aac3a1 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Direct Connect Name | DirectConnectName |
| state | State | ACTIVE |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
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)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| name required | string | Direct Connect Name | DirectConnectName |
| bandwidth required | integer | Port Bandwidth | 1 |
| description optional | string | Direct Connect Description | TransitGateway Description |
| firewall_enabled optional | boolean | Firewall Use | True |
| firewall_loggable optional | boolean | Firewall Loggable | True |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Direct Connect Description | fe860e0af0c04dcd8182b84f907f31f4 |
| firewall_id | Firewall ID | dffc455f1bd14e0594e4faa638aac3a1 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Direct Connect Name | DirectConnectName |
| state | State | ACTIVE |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
2 - Create Routing Rule
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)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| direct_connect_id required | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| destination_type required | string | Destination Type | ON_PREMISE |
| destination_cidr required | string | Destination CIDR | 11.11.11.0/24 |
| description optional | string | Description | TransitGateway Description |
| destination_resource_id optional | string | Destination Resource ID | be3c84238562488e81e4e0675f86be62 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | c8980aa2bf1e43c9998682f7baaf1c46 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | TransitGateway Description |
| destination_cidr | Destination CIDR | 11.11.11.0/24 |
| destination_resource_id | Destination Resource ID | be3c84238562488e81e4e0675f86be62 |
| destination_resource_name | Destination Resource Name | ResourceName |
| destination_type | Destination Type | ON_PREMISE |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| owner_id | Routing Rule Owner ID | cd1610830b9046418e4bc67831c533e6 |
| owner_type | Routing Rule Owner Type | DIRECT_CONNECT |
| state | State | ACTIVE |
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)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| direct_connect_id required | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| destination_type required | string | Destination Type | ON_PREMISE |
| destination_cidr required | string | Destination CIDR | 11.11.11.0/24 |
| description optional | string | Description | TransitGateway Description |
| destination_resource_id optional | string | Destination Resource ID | be3c84238562488e81e4e0675f86be62 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | c8980aa2bf1e43c9998682f7baaf1c46 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | TransitGateway Description |
| destination_cidr | Destination CIDR | 11.11.11.0/24 |
| destination_resource_id | Destination Resource ID | be3c84238562488e81e4e0675f86be62 |
| destination_resource_name | Destination Resource Name | ResourceName |
| destination_type | Destination Type | ON_PREMISE |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| owner_id | Routing Rule Owner ID | cd1610830b9046418e4bc67831c533e6 |
| owner_type | Routing Rule Owner Type | DIRECT_CONNECT |
| state | State | ACTIVE |
3 - Delete Direct Connect
3.1 - 1.1
scpcli direct-connect direct-connect delete
--direct_connect_id <value>
Description
Delete direct connect.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| direct_connect_id required | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
3.2 - 1.0
scpcli direct-connect direct-connect delete
--direct_connect_id <value>
Description
Delete direct connect.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| direct_connect_id required | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
4 - Delete Routing Rule
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)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| routing_rule_id required | string | Routing Rule ID | c8980aa2bf1e43c9998682f7baaf1c46 |
| direct_connect_id required | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
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)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| routing_rule_id required | string | Routing Rule ID | c8980aa2bf1e43c9998682f7baaf1c46 |
| direct_connect_id required | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
5 - List Direct Connects
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)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| name optional | string | Direct Connect Name | DirectConnectName |
| state optional | **** | State | ACTIVE |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
Responses
| Name | Description | Example |
|---|---|---|
| id | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Direct Connect Description | fe860e0af0c04dcd8182b84f907f31f4 |
| firewall_id | Firewall ID | dffc455f1bd14e0594e4faa638aac3a1 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Direct Connect Name | DirectConnectName |
| state | State | ACTIVE |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
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)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| name optional | string | Direct Connect Name | DirectConnectName |
| state optional | **** | State | ACTIVE |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
Responses
| Name | Description | Example |
|---|---|---|
| id | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Direct Connect Description | fe860e0af0c04dcd8182b84f907f31f4 |
| firewall_id | Firewall ID | dffc455f1bd14e0594e4faa638aac3a1 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Direct Connect Name | DirectConnectName |
| state | State | ACTIVE |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
6 - List Routing Rules
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)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| direct_connect_id required | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Routing Rule ID | c8980aa2bf1e43c9998682f7baaf1c46 |
| destination_type optional | **** | Destination Type | ON_PREMISE |
| destination_cidr optional | string | Destination CIDR | 11.11.11.0/24 |
| state optional | **** | State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | c8980aa2bf1e43c9998682f7baaf1c46 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | TransitGateway Description |
| destination_cidr | Destination CIDR | 11.11.11.0/24 |
| destination_resource_id | Destination Resource ID | be3c84238562488e81e4e0675f86be62 |
| destination_resource_name | Destination Resource Name | ResourceName |
| destination_type | Destination Type | ON_PREMISE |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| owner_id | Routing Rule Owner ID | cd1610830b9046418e4bc67831c533e6 |
| owner_type | Routing Rule Owner Type | DIRECT_CONNECT |
| state | State | ACTIVE |
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)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| direct_connect_id required | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Routing Rule ID | c8980aa2bf1e43c9998682f7baaf1c46 |
| destination_type optional | **** | Destination Type | ON_PREMISE |
| destination_cidr optional | string | Destination CIDR | 11.11.11.0/24 |
| state optional | **** | State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | c8980aa2bf1e43c9998682f7baaf1c46 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | TransitGateway Description |
| destination_cidr | Destination CIDR | 11.11.11.0/24 |
| destination_resource_id | Destination Resource ID | be3c84238562488e81e4e0675f86be62 |
| destination_resource_name | Destination Resource Name | ResourceName |
| destination_type | Destination Type | ON_PREMISE |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| owner_id | Routing Rule Owner ID | cd1610830b9046418e4bc67831c533e6 |
| owner_type | Routing Rule Owner Type | DIRECT_CONNECT |
| state | State | ACTIVE |
7 - Set Direct Connect
7.1 - 1.1
scpcli direct-connect direct-connect set
--direct_connect_id <value>
--description <value>
Description
Set direct connect.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| direct_connect_id required | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| description required | string | Direct Connect Description | TransitGateway Description |
7.2 - 1.0
scpcli direct-connect direct-connect set
--direct_connect_id <value>
--description <value>
Description
Set direct connect.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| direct_connect_id required | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| description required | string | Direct Connect Description | TransitGateway Description |
8 - Show Direct Connect
8.1 - 1.1
scpcli direct-connect direct-connect show
--direct_connect_id <value>
Description
Show direct connect.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| direct_connect_id required | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Direct Connect Description | fe860e0af0c04dcd8182b84f907f31f4 |
| firewall_id | Firewall ID | dffc455f1bd14e0594e4faa638aac3a1 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Direct Connect Name | DirectConnectName |
| state | State | ACTIVE |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8.2 - 1.0
scpcli direct-connect direct-connect show
--direct_connect_id <value>
Description
Show direct connect.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.0 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| direct_connect_id required | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Direct Connect Description | fe860e0af0c04dcd8182b84f907f31f4 |
| firewall_id | Firewall ID | dffc455f1bd14e0594e4faa638aac3a1 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Direct Connect Name | DirectConnectName |
| state | State | ACTIVE |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |