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

Return to the regular view of this page.

CLIs

1 - Approval VPC Peering

1.1 - 1.1

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

Description

Approval VPC Peering.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID-
type
required
stringApproval Type-

2 - Approve PrivateLink Endpoint

2.1 - 1.1

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

Description

Approve PrivateLink Endpoint

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint ID-
type
required
stringPrivateLink Endpoint Action Type-

3 - Connect PrivateLink Endpoint

3.1 - 1.1

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

Description

Connect PrivateLink Endpoint

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint ID-
type
required
stringPrivateLink Endpoint Action Type-

4 - Create Internet Gateway

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

VersionSupported Until
1.1-

Parameters

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

Responses

NameDescriptionExample
idInternet Gateway ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
firewall_idFirewall ID
loggableNAT Loggable
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway Name
stateState
typeInternet Gateway Type
vpc_idVPC Id
vpc_nameVPC Name

4.2 - 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)

VersionSupported Until
1.020251231

Parameters

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

Responses

NameDescriptionExample
idInternet Gateway ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
firewall_idFirewall ID
loggableNAT Loggable
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway Name
stateState
typeInternet Gateway Type
vpc_idVPC Id
vpc_nameVPC Name

5 - Create NAT Gateway

5.1 - 1.1

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

Description

Create NAT Gateway.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet CIDR-
publicip_id
required
stringPublicIP ID-
description
optional
stringNAT Gateway Description-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idNAT Gateway ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway Name
nat_gateway_ip_addressNAT Gateway IP Address
publicip_idPublicIP ID
stateNAT Gateway State
subnet_cidrSubnet Cidr
subnet_idSubnet Id
subnet_nameSubnet Name
vpc_idVPC Id
vpc_nameVPC Name

5.2 - 1.0

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

Description

Create NAT Gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet CIDR-
publicip_id
required
stringPublicIP ID-
description
optional
stringNAT Gateway Description-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idNAT Gateway ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway Name
nat_gateway_ip_addressNAT Gateway IP Address
publicip_idPublicIP ID
stateNAT Gateway State
subnet_cidrSubnet Cidr
subnet_idSubnet Id
subnet_nameSubnet Name
vpc_idVPC Id
vpc_nameVPC Name

6 - Create Port

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

VersionSupported Until
1.1-

Parameters

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

Responses

NameDescriptionExample
port

6.2 - 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)

VersionSupported Until
1.020251231

Parameters

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

Responses

NameDescriptionExample
port

7 - Create Private NAT

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

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
name
required
stringPrivate NAT Name-
direct_connect_id
required
stringDirect Connect ID-
cidr
required
stringPrivate NAT IP range-
description
optional
stringDescription-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivate NAT ID
account_idAccount ID
cidrPrivate NAT IP range
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
direct_connect_idDirect Connect ID
direct_connect_nameDirect Connect Name
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT Name
statePrivate NAT State
vpc_idVPC Id
vpc_nameVPC Name

7.2 - 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)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
name
required
stringPrivate NAT Name-
direct_connect_id
required
stringDirect Connect ID-
cidr
required
stringPrivate NAT IP range-
description
optional
stringDescription-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivate NAT ID
account_idAccount ID
cidrPrivate NAT IP range
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
direct_connect_idDirect Connect ID
direct_connect_nameDirect Connect Name
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT Name
statePrivate NAT State
vpc_idVPC Id
vpc_nameVPC Name

8 - Create Private NAT IP

8.1 - 1.1

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

Description

Create Private NAT IP.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID-
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.2 - 1.0

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

Description

Create Private NAT IP.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID-
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

9 - Create PrivateLink Endpoint

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

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id-
name
required
stringPrivateLink Endpoint Name-
endpoint_ip_address
required
stringEndpoint IP Address-
description
optional
stringDescription-
privatelink_service_id
optional
stringPrivateLink Service ID-
security_group_ids
optional
arraySecurity Group List-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivateLink Endpoint ID
account_idAccount ID
approval_typePrivateLink Service Approval Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
endpoint_ip_addressEndpoint IP Address
endpoint_ip_port_idEndpoint IP Port ID
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Endpoint Name
privatelink_service_idPrivateLink Service ID
security_group_idsSecurity Group List
statePrivateLink Endpoint State
subnet_idSubnet Id
vpc_idVPC Id

10 - Create PrivateLink Service

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

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id-
service_ip_address
required
stringService IP Address-
name
required
stringPrivateLink Service Name-
connected_resource_type
required
stringConnected Resource Type-
approval_type
required
stringPrivateLink Service Approval Type-
connected_resource_id
optional
stringConnected Resource ID-
connected_resource_ip_address
optional
stringConnected Resource IP Address-
description
optional
stringDescription-
high_speed_transfer
optional
booleanHigh Speed Data Transfer Use-
security_group_ids
optional
arraySecurity Group List-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivateLink Service ID
account_idAccount ID
approval_typePrivateLink Service Approval Type
connected_resource_idConnected Resource ID
connected_resource_ip_addressConnected Resource IP Address
connected_resource_nameConnected Resource Name
connected_resource_typeConnected Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
high_speed_transferHigh Speed Data Transfer Use
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Service Name
security_group_idsSecurity Group List
service_ip_addressService IP Address
service_ip_port_idService IP Port ID
statePrivateLink Service State
subnet_idSubnet Id
vpc_idVPC Id

11 - Create PublicIP

11.1 - 1.1

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

Description

Create PublicIP.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
type
required
stringPublicIP Type-
description
optional
stringPublicIP Description-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPublicIP ID
account_idAccount ID
attached_resource_idPublicIP Attached Resource ID
attached_resource_namePublicIP Attached Resource Name
attached_resource_typePublicIP Attached Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP Description
ip_addressIP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP State
typePublicIP Type

11.2 - 1.0

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

Description

Create PublicIP.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
type
required
stringPublicIP Type-
description
optional
stringPublicIP Description-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPublicIP ID
account_idAccount ID
attached_resource_idPublicIP Attached Resource ID
attached_resource_namePublicIP Attached Resource Name
attached_resource_typePublicIP Attached Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP Description
ip_addressIP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP State
typePublicIP Type

12 - Create Subnet

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

VersionSupported Until
1.1-

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

12.2 - 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)

VersionSupported Until
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

13 - Create Transit Gateway

13.1 - 1.1

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

Description

Create Transit Gateway.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
name
required
stringTransit Gateway Name-
description
optional
stringDescription-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idTransit Gateway ID
account_idAccount ID
bandwidthTransit Gateway Port Bandwidth
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway Description
firewall_idsFirewall ID
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway Name
stateState
uplink_enabledUplink Enabled

13.2 - 1.0

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

Description

Create Transit Gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
name
required
stringTransit Gateway Name-
description
optional
stringDescription-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idTransit Gateway ID
account_idAccount ID
bandwidthTransit Gateway Port Bandwidth
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway Description
firewall_idsFirewall ID
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway Name
stateState
uplink_enabledUplink Enabled

14 - Create Transit Gateway Rule

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

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-
tgw_connection_vpc_id
required
stringVPC ID Connected to Transit Gateway.-
destination_type
required
stringDestination Type-
destination_cidr
required
stringDestination CIDR-
description
optional
stringDescription-

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
source_resource_idSource Resource ID
source_resource_nameSource Resource Name
source_typeSource Type
stateState
tgw_connection_vpc_idVPC ID Connected to Transit Gateway.
tgw_connection_vpc_nameVPC Name Connected to Transit Gateway.

14.2 - 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)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-
tgw_connection_vpc_id
required
stringVPC ID Connected to Transit Gateway.-
destination_type
required
stringDestination Type-
destination_cidr
required
stringDestination CIDR-
description
optional
stringDescription-

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
source_resource_idSource Resource ID
source_resource_nameSource Resource Name
source_typeSource Type
stateState
tgw_connection_vpc_idVPC ID Connected to Transit Gateway.
tgw_connection_vpc_nameVPC Name Connected to Transit Gateway.

15 - Create Transit Gateway VPC Connection

15.1 - 1.1

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

Description

Create Transit Gateway VPC Connection.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-
vpc_id
required
stringVPC Id-

Responses

NameDescriptionExample
idTransit Gateway VPC Connection ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
stateState
transit_gateway_idTransit Gateway ID
vpc_idVPC Id
vpc_nameVPC Name

15.2 - 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)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-
vpc_id
required
stringVPC Id-

Responses

NameDescriptionExample
idTransit Gateway VPC Connection ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
stateState
transit_gateway_idTransit Gateway ID
vpc_idVPC Id
vpc_nameVPC Name

16 - Create VPC

16.1 - 1.1

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

Description

Create VPC.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

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

16.2 - 1.0

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

Description

Create VPC.

State ACTIVE (DEPRECATED)

VersionSupported Until
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

17 - Create VPC Endpoint

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

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-
subnet_id
required
stringSubnet Id-
resource_type
required
stringVPC Endpoint Resource Type-
resource_key
required
stringVPC Endpoint Resource Key-
resource_info
required
stringVPC Endpoint Resource Key Info-
name
required
stringVPC Endpoint Name-
endpoint_ip_address
required
stringVPC Endpoint IP Address-
description
optional
stringDescription-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Endpoint ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
endpoint_ip_addressVPC Endpoint IP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint Name
resource_infoVPC Endpoint Resource Key Info
resource_keyVPC Endpoint Resource Key
resource_typeVPC Endpoint Resource Type
stateVPC Endpoint State
subnet_idSubnet Id
subnet_nameSubnet Name
vpc_idVPC Id
vpc_nameVPC Name

17.2 - 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)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-
subnet_id
required
stringSubnet Id-
resource_type
required
stringVPC Endpoint Resource Type-
resource_key
required
stringVPC Endpoint Resource Key-
resource_info
required
stringVPC Endpoint Resource Key Info-
name
required
stringVPC Endpoint Name-
endpoint_ip_address
required
stringVPC Endpoint IP Address-
description
optional
stringDescription-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Endpoint ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
endpoint_ip_addressVPC Endpoint IP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint Name
resource_infoVPC Endpoint Resource Key Info
resource_keyVPC Endpoint Resource Key
resource_typeVPC Endpoint Resource Type
stateVPC Endpoint State
subnet_idSubnet Id
subnet_nameSubnet Name
vpc_idVPC Id
vpc_nameVPC Name

18 - Create VPC Peering

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

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
requester_vpc_id
required
stringRequester VPC ID-
name
required
stringVPC Peering Name-
approver_vpc_id
required
stringApprover VPC ID-
approver_vpc_account_id
required
stringApprover VPC Account ID-
description
optional
stringDescription-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Peering ID
account_typeAccount Type
approver_vpc_account_idApprover VPC Account ID
approver_vpc_idApprover VPC ID
approver_vpc_nameApprover VPC Name
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account ID
descriptionVPC Peering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering Name
requester_vpc_account_idRequester VPC Account ID
requester_vpc_idRequester VPC ID
requester_vpc_nameRequester VPC Name
stateState

18.2 - 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)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
requester_vpc_id
required
stringRequester VPC ID-
name
required
stringVPC Peering Name-
approver_vpc_id
required
stringApprover VPC ID-
approver_vpc_account_id
required
stringApprover VPC Account ID-
description
optional
stringDescription-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Peering ID
account_typeAccount Type
approver_vpc_account_idApprover VPC Account ID
approver_vpc_idApprover VPC ID
approver_vpc_nameApprover VPC Name
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account ID
descriptionVPC Peering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering Name
requester_vpc_account_idRequester VPC Account ID
requester_vpc_idRequester VPC ID
requester_vpc_nameRequester VPC Name
stateState

19 - Create Vpc Peering Rule

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

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID-
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

19.2 - 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)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID-
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

20 - Delete Internet Gateway

20.1 - 1.1

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

Description

Delete Internet Gateway.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID-

20.2 - 1.0

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

Description

Delete Internet Gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID-

21 - Delete NAT Gateway

21.1 - 1.1

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

Description

Delete NAT Gateway.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID-

21.2 - 1.0

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

Description

Delete NAT Gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID-

22 - Delete Port

22.1 - 1.1

scpcli vpc port delete
--port_id <value>

Description

Delete port.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID-

22.2 - 1.0

scpcli vpc port delete
--port_id <value>

Description

Delete port.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID-

23 - Delete Private NAT

23.1 - 1.1

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

Description

Delete Private NAT.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID-

23.2 - 1.0

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

Description

Delete Private NAT.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID-

24 - Delete Private NAT IP

24.1 - 1.1

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

Description

Delete Private NAT IP.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

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

24.2 - 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)

VersionSupported Until
1.020251231

Parameters

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

25 - Delete PrivateLink Endpoint

25.1 - 1.1

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

Description

Delete PrivateLink Endpoint.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint ID-

26 - Delete PrivateLink Service

26.1 - 1.1

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

Description

Delete PrivateLink Service.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service ID-

27 - Delete PublicIP

27.1 - 1.1

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

Description

Delete PublicIP.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID-

27.2 - 1.0

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

Description

Delete PublicIP.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID-

28 - Delete Subnet

28.1 - 1.1

scpcli vpc subnet delete
--subnet_id <value>

Description

Delete subnet.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492

28.2 - 1.0

scpcli vpc subnet delete
--subnet_id <value>

Description

Delete subnet.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492

29 - Delete Transit Gateway

29.1 - 1.1

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

Description

Delete Transit Gateway.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-

29.2 - 1.0

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

Description

Delete Transit Gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-

30 - Delete Transit Gateway Rule

30.1 - 1.1

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

Description

Delete Transit Gateway Rule.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule ID-
transit_gateway_id
required
stringTransit Gateway ID-

30.2 - 1.0

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

Description

Delete Transit Gateway Rule.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule ID-
transit_gateway_id
required
stringTransit Gateway ID-

31 - Delete Transit Gateway VPC Connection

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

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpc_connection_id
required
stringTransit Gateway VPC Connection ID-
transit_gateway_id
required
stringTransit Gateway ID-

31.2 - 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)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpc_connection_id
required
stringTransit Gateway VPC Connection ID-
transit_gateway_id
required
stringTransit Gateway ID-

32 - Delete VPC

32.1 - 1.1

scpcli vpc vpc delete
--vpc_id <value>

Description

Delete VPC.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-

32.2 - 1.0

scpcli vpc vpc delete
--vpc_id <value>

Description

Delete VPC.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-

33 - Delete VPC Endpoint

33.1 - 1.1

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

Description

Delete VPC Endpoint.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID-

33.2 - 1.0

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

Description

Delete VPC Endpoint.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID-

34 - Delete VPC Peering

34.1 - 1.1

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

Description

Delete VPC Peering.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID-

34.2 - 1.0

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

Description

Delete VPC Peering.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID-

35 - Delete VPC Peering Rule

35.1 - 1.1

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

Description

Delete a VPC Peering Rule.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

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

35.2 - 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)

VersionSupported Until
1.020251231

Parameters

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

36 - List Connected PrivateLink Endpoints

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

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idPrivateLink Endpoint ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
privatelink_service_idPrivateLink Service ID
statePrivateLink Endpoint State

37 - List Internet Gateways

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

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringInternet Gateway ID-
name
optional
stringInternet Gateway Name-
type
optional
****Internet Gateway Type-
state
optional
stringState-
vpc_id
optional
stringVPC Id-
vpc_name
optional
stringVPC Name-

Responses

NameDescriptionExample
idInternet Gateway ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
firewall_idFirewall ID
loggableNAT Loggable
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway Name
stateState
typeInternet Gateway Type
vpc_idVPC Id
vpc_nameVPC Name

37.2 - 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)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringInternet Gateway ID-
name
optional
stringInternet Gateway Name-
type
optional
****Internet Gateway Type-
state
optional
stringState-
vpc_id
optional
stringVPC Id-
vpc_name
optional
stringVPC Name-

Responses

NameDescriptionExample
idInternet Gateway ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
firewall_idFirewall ID
loggableNAT Loggable
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway Name
stateState
typeInternet Gateway Type
vpc_idVPC Id
vpc_nameVPC Name

38 - List NAT Gateways

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

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
name
optional
stringNAT Gateway Name-
vpc_id
optional
stringVPC Id-
vpc_name
optional
stringVPC Name-
subnet_id
optional
stringSubnet Id-
subnet_name
optional
stringSubnet Name-
nat_gateway_ip_address
optional
stringNAT Gateway IP Address-
state
optional
****NAT Gateway State-

Responses

NameDescriptionExample
idNAT Gateway ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway Name
nat_gateway_ip_addressNAT Gateway IP Address
publicip_idPublicIP ID
stateNAT Gateway State
subnet_cidrSubnet Cidr
subnet_idSubnet Id
subnet_nameSubnet Name
vpc_idVPC Id
vpc_nameVPC Name

38.2 - 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)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
name
optional
stringNAT Gateway Name-
vpc_id
optional
stringVPC Id-
vpc_name
optional
stringVPC Name-
subnet_id
optional
stringSubnet Id-
subnet_name
optional
stringSubnet Name-
nat_gateway_ip_address
optional
stringNAT Gateway IP Address-
state
optional
****NAT Gateway State-

Responses

NameDescriptionExample
idNAT Gateway ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway Name
nat_gateway_ip_addressNAT Gateway IP Address
publicip_idPublicIP ID
stateNAT Gateway State
subnet_cidrSubnet Cidr
subnet_idSubnet Id
subnet_nameSubnet Name
vpc_idVPC Id
vpc_nameVPC Name

39 - List Ports

39.1 - 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>]

Description

Get port list.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerPort Limit-
marker
optional
stringPort Marker-
sort
optional
stringPort Sort-
name
optional
stringPort Name-
subnet_id
optional
stringSubnet Id-
subnet_name
optional
stringSubnet Name-
id
optional
stringPort ID-
attached_resource_id
optional
stringConnected resource ID-
fixed_ip_address
optional
stringFixed IP-
mac_address
optional
stringMAC Address-
state
optional
stringState-
security_groups
optional
stringSecurity Group List-

Responses

NameDescriptionExample
idPort ID
account_idAccount ID
attached_resource_idConnected resource ID
attached_resource_typeConnected resource Type
created_atCreated date
descriptionDescription
fixed_ip_addressFixed IP
mac_addressMAC Address
modified_atModified date
namePort Name
stateState
subnet_idSubnet Id
subnet_nameSubnet Name
vpc_idVPC Id
vpc_nameVPC Name

39.2 - 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>]

Description

Get port list.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerPort Limit-
marker
optional
stringPort Marker-
sort
optional
stringPort Sort-
name
optional
stringPort Name-
subnet_id
optional
stringSubnet Id-
subnet_name
optional
stringSubnet Name-
id
optional
stringPort ID-
attached_resource_id
optional
stringConnected resource ID-
fixed_ip_address
optional
stringFixed IP-
mac_address
optional
stringMAC Address-
state
optional
stringState-
security_groups
optional
stringSecurity Group List-

Responses

NameDescriptionExample
idPort ID
account_idAccount ID
attached_resource_idConnected resource ID
attached_resource_typeConnected resource Type
created_atCreated date
descriptionDescription
fixed_ip_addressFixed IP
mac_addressMAC Address
modified_atModified date
namePort Name
stateState
subnet_idSubnet Id
subnet_nameSubnet Name
vpc_idVPC Id
vpc_nameVPC Name

40 - List Private NAT

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

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringPrivate NAT Name-
cidr
optional
stringPrivate NAT IP range-
vpc_id
optional
stringVPC Id-
vpc_name
optional
stringVPC Name-
direct_connect_id
optional
stringDirect Connect ID-
direct_connect_name
optional
stringDirect Connect Name-
state
optional
****Private NAT State-

Responses

NameDescriptionExample
idPrivate NAT ID
account_idAccount ID
cidrPrivate NAT IP range
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
direct_connect_idDirect Connect ID
direct_connect_nameDirect Connect Name
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT Name
statePrivate NAT State
vpc_idVPC Id
vpc_nameVPC Name

40.2 - 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)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringPrivate NAT Name-
cidr
optional
stringPrivate NAT IP range-
vpc_id
optional
stringVPC Id-
vpc_name
optional
stringVPC Name-
direct_connect_id
optional
stringDirect Connect ID-
direct_connect_name
optional
stringDirect Connect Name-
state
optional
****Private NAT State-

Responses

NameDescriptionExample
idPrivate NAT ID
account_idAccount ID
cidrPrivate NAT IP range
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
direct_connect_idDirect Connect ID
direct_connect_nameDirect Connect Name
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT Name
statePrivate NAT State
vpc_idVPC Id
vpc_nameVPC Name

41 - List Private NAT IP

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

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID-
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

41.2 - 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)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID-
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

42 - List PrivateLink Endpoint

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

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPrivateLink Endpoint ID-
name
optional
stringPrivateLink Endpoint Name-
vpc_id
optional
stringVPC Id-
subnet_id
optional
stringSubnet Id-
privatelink_service_id
optional
stringPrivateLink Service ID-
endpoint_ip_address
optional
stringEndpoint IP Address-
state
optional
****PrivateLink Endpoint State-

Responses

NameDescriptionExample
idPrivateLink Endpoint ID
account_idAccount ID
approval_typePrivateLink Service Approval Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
endpoint_ip_addressEndpoint IP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Endpoint Name
privatelink_service_idPrivateLink Service ID
statePrivateLink Endpoint State
subnet_idSubnet Id
vpc_idVPC Id

43 - List PrivateLink Service

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

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPrivateLink Service ID-
name
optional
stringPrivateLink Service Name-
vpc_id
optional
stringVPC Id-
subnet_id
optional
stringSubnet Id-
service_ip_address
optional
stringService IP Address-
connected_resource_id
optional
stringConnected Resource ID-
connected_resource_type
optional
stringConnected Resource Type-
connected_resource_name
optional
stringConnected Resource Name-
connected_resource_ip_address
optional
stringConnected Resource IP Address-
state
optional
****PrivateLink Service State-

Responses

NameDescriptionExample
idPrivateLink Service ID
account_idAccount ID
approval_typePrivateLink Service Approval Type
connected_resource_idConnected Resource ID
connected_resource_ip_addressConnected Resource IP Address
connected_resource_nameConnected Resource Name
connected_resource_typeConnected Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Service Name
service_ip_addressService IP Address
statePrivateLink Service State
subnet_idSubnet Id
vpc_idVPC Id

44 - List PublicIPs

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

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
ip_address
optional
stringIP Address-
state
optional
stringPublicIP State-
attached_resource_type
optional
stringPublicIP Attached Resource Type-
attached_resource_id
optional
stringPublicIP Attached Resource ID-
attached_resource_name
optional
stringPublicIP Attached Resource Name-
vpc_id
optional
stringVPC Id-
type
optional
****PublicIP Type-

Responses

NameDescriptionExample
idPublicIP ID
account_idAccount ID
attached_resource_idPublicIP Attached Resource ID
attached_resource_namePublicIP Attached Resource Name
attached_resource_typePublicIP Attached Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP Description
ip_addressIP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP State
typePublicIP Type

44.2 - 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)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
ip_address
optional
stringIP Address-
state
optional
stringPublicIP State-
attached_resource_type
optional
stringPublicIP Attached Resource Type-
attached_resource_id
optional
stringPublicIP Attached Resource ID-
attached_resource_name
optional
stringPublicIP Attached Resource Name-
vpc_id
optional
stringVPC Id-
type
optional
****PublicIP Type-

Responses

NameDescriptionExample
idPublicIP ID
account_idAccount ID
attached_resource_idPublicIP Attached Resource ID
attached_resource_namePublicIP Attached Resource Name
attached_resource_typePublicIP Attached Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP Description
ip_addressIP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP State
typePublicIP Type

45 - List Subnets

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

VersionSupported Until
1.1-

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

45.2 - 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)

VersionSupported Until
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

46 - List Transit Gateway Rules

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

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringRouting Rule ID-
tgw_connection_vpc_id
optional
stringVPC ID Connected to Transit Gateway.-
tgw_connection_vpc_name
optional
stringVPC Name Connected to Transit Gateway.-
source_type
optional
****Source Type-
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
source_resource_idSource Resource ID
source_resource_nameSource Resource Name
source_typeSource Type
stateState
tgw_connection_vpc_idVPC ID Connected to Transit Gateway.
tgw_connection_vpc_nameVPC Name Connected to Transit Gateway.

46.2 - 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)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringRouting Rule ID-
tgw_connection_vpc_id
optional
stringVPC ID Connected to Transit Gateway.-
tgw_connection_vpc_name
optional
stringVPC Name Connected to Transit Gateway.-
source_type
optional
****Source Type-
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
source_resource_idSource Resource ID
source_resource_nameSource Resource Name
source_typeSource Type
stateState
tgw_connection_vpc_idVPC ID Connected to Transit Gateway.
tgw_connection_vpc_nameVPC Name Connected to Transit Gateway.

47 - List Transit Gateway VPC Connections

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

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringTransit Gateway VPC Connection ID-
vpc_id
optional
stringVPC Id-
vpc_name
optional
stringVPC Name-
state
optional
****State-

Responses

NameDescriptionExample
idTransit Gateway VPC Connection ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
stateState
transit_gateway_idTransit Gateway ID
vpc_idVPC Id
vpc_nameVPC Name

47.2 - 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)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringTransit Gateway VPC Connection ID-
vpc_id
optional
stringVPC Id-
vpc_name
optional
stringVPC Name-
state
optional
****State-

Responses

NameDescriptionExample
idTransit Gateway VPC Connection ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
stateState
transit_gateway_idTransit Gateway ID
vpc_idVPC Id
vpc_nameVPC Name

48 - List Transit Gateways

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

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringTransit Gateway ID-
name
optional
stringTransit Gateway Name-
state
optional
****State-

Responses

NameDescriptionExample
idTransit Gateway ID
account_idAccount ID
bandwidthTransit Gateway Port Bandwidth
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway Description
firewall_idsFirewall ID
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway Name
stateState
uplink_enabledUplink Enabled

48.2 - 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)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringTransit Gateway ID-
name
optional
stringTransit Gateway Name-
state
optional
****State-

Responses

NameDescriptionExample
idTransit Gateway ID
account_idAccount ID
bandwidthTransit Gateway Port Bandwidth
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway Description
firewall_idsFirewall ID
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway Name
stateState
uplink_enabledUplink Enabled

49 - List VPC Endpoint

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

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Endpoint ID-
name
optional
stringVPC Endpoint Name-
vpc_id
optional
stringVPC Id-
vpc_name
optional
stringVPC Name-
subnet_id
optional
stringSubnet Id-
resource_key
optional
stringVPC Endpoint Resource Key-
resource_type
optional
****VPC Endpoint Resource Type-
endpoint_ip_address
optional
stringVPC Endpoint IP Address-
state
optional
****VPC Endpoint State-

Responses

NameDescriptionExample
idVPC Endpoint ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
endpoint_ip_addressVPC Endpoint IP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint Name
resource_infoVPC Endpoint Resource Key Info
resource_keyVPC Endpoint Resource Key
resource_typeVPC Endpoint Resource Type
stateVPC Endpoint State
subnet_idSubnet Id
subnet_nameSubnet Name
vpc_idVPC Id
vpc_nameVPC Name

49.2 - 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)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Endpoint ID-
name
optional
stringVPC Endpoint Name-
vpc_id
optional
stringVPC Id-
vpc_name
optional
stringVPC Name-
subnet_id
optional
stringSubnet Id-
resource_key
optional
stringVPC Endpoint Resource Key-
resource_type
optional
****VPC Endpoint Resource Type-
endpoint_ip_address
optional
stringVPC Endpoint IP Address-
state
optional
****VPC Endpoint State-

Responses

NameDescriptionExample
idVPC Endpoint ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
endpoint_ip_addressVPC Endpoint IP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint Name
resource_infoVPC Endpoint Resource Key Info
resource_keyVPC Endpoint Resource Key
resource_typeVPC Endpoint Resource Type
stateVPC Endpoint State
subnet_idSubnet Id
subnet_nameSubnet Name
vpc_idVPC Id
vpc_nameVPC Name

50 - List VPC Endpoint Connectable Resources

50.1 - 1.1

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

Description

List VpcEndpoint connectable resources

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
resource_type
required
****VPC Endpoint Resource Type-
vpc_id
optional
stringVPC ID(required if resource_type is DNS)-

Responses

NameDescriptionExample
resource_infoVPC Endpoint Resource Key Info
resource_keyVPC Endpoint Resource Key
resource_typeVPC Endpoint Resource Type

50.2 - 1.0

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

Description

List VpcEndpoint connectable resources

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
resource_type
required
****VPC Endpoint Resource Type-
vpc_id
optional
stringVPC ID(required if resource_type is DNS)-

Responses

NameDescriptionExample
resource_infoVPC Endpoint Resource Key Info
resource_keyVPC Endpoint Resource Key
resource_typeVPC Endpoint Resource Type

51 - List VPC Peering

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

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Peering ID-
name
optional
stringVPC Peering Name-
requester_vpc_id
optional
stringRequester VPC ID-
requester_vpc_name
optional
stringRequester VPC Name-
approver_vpc_id
optional
stringApprover VPC ID-
approver_vpc_name
optional
stringApprover VPC Name-
account_type
optional
****Account Type-
state
optional
****State-

Responses

NameDescriptionExample
idVPC Peering ID
account_typeAccount Type
approver_vpc_account_idApprover VPC Account ID
approver_vpc_idApprover VPC ID
approver_vpc_nameApprover VPC Name
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account ID
descriptionVPC Peering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering Name
requester_vpc_account_idRequester VPC Account ID
requester_vpc_idRequester VPC ID
requester_vpc_nameRequester VPC Name
stateState

51.2 - 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)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Peering ID-
name
optional
stringVPC Peering Name-
requester_vpc_id
optional
stringRequester VPC ID-
requester_vpc_name
optional
stringRequester VPC Name-
approver_vpc_id
optional
stringApprover VPC ID-
approver_vpc_name
optional
stringApprover VPC Name-
account_type
optional
****Account Type-
state
optional
****State-

Responses

NameDescriptionExample
idVPC Peering ID
account_typeAccount Type
approver_vpc_account_idApprover VPC Account ID
approver_vpc_idApprover VPC ID
approver_vpc_nameApprover VPC Name
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account ID
descriptionVPC Peering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering Name
requester_vpc_account_idRequester VPC Account ID
requester_vpc_idRequester VPC ID
requester_vpc_nameRequester VPC Name
stateState

52 - List VPC Peering Rules

52.1 - 1.1

scpcli vpc vpc-peering-routing-rule list
--vpc_peering_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <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)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Peering Rule ID-
name
optional
stringVPC Peering Name-
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

52.2 - 1.0

scpcli vpc vpc-peering-routing-rule list
--vpc_peering_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <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 (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Peering Rule ID-
name
optional
stringVPC Peering Name-
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

53 - List VPCs

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

VersionSupported Until
1.1-

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

53.2 - 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)

VersionSupported Until
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

54 - Request PrivateLink Endpoint

54.1 - 1.1

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

Description

Request PrivateLink Endpoint

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint ID-
type
required
stringPrivateLink Endpoint Action Type-

55 - Set Internet Gateway

55.1 - 1.1

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

Description

Set Internet Gateway.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID-
description
optional
stringDescription-
loggable
optional
booleanNAT Loggable-

55.2 - 1.0

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

Description

Set Internet Gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID-
description
optional
stringDescription-
loggable
optional
booleanNAT Loggable-

56 - Set NAT Gateway

56.1 - 1.1

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

Description

Set NAT Gateway.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID-
description
optional
stringNAT Gateway Description-

56.2 - 1.0

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

Description

Set NAT Gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID-
description
optional
stringNAT Gateway Description-

57 - Set Port

57.1 - 1.1

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

Description

Set port.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID-
description
optional
stringDescription-
security_groups
optional
arraySecurity Group List-

57.2 - 1.0

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

Description

Set port.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID-
description
optional
stringDescription-
security_groups
optional
arraySecurity Group List-

58 - Set Private NAT

58.1 - 1.1

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

Description

Set Private NAT.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID-
description
optional
stringDescription-

58.2 - 1.0

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

Description

Set Private NAT.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID-
description
optional
stringDescription-

59 - Set PrivateLink Endpoint

59.1 - 1.1

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

Description

Set PrivateLink Endpoint.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint ID-
description
optional
stringDescription-

60 - Set PrivateLink Service

60.1 - 1.1

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

Description

Set PrivateLink Service.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service ID-
description
optional
stringDescription-

61 - Set PublicIP

61.1 - 1.1

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

Description

Set PublicIP.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID-
description
required
stringPublicIP Description-

61.2 - 1.0

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

Description

Set PublicIP.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID-
description
required
stringPublicIP Description-

62 - Set Subnet

62.1 - 1.1

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

Description

Set subnet.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
description
required
stringDescriptionSubnet Description

62.2 - 1.0

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

Description

Set subnet.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
description
required
stringDescriptionSubnet Description

63 - Set Transit Gateway

63.1 - 1.1

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

Description

Set Transit Gateway.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-
description
optional
stringDescription-

63.2 - 1.0

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

Description

Set Transit Gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-
description
optional
stringDescription-

64 - Set VPC

64.1 - 1.1

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

Description

Set VPC.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-
description
optional
stringDescriptionvpcDescription

64.2 - 1.0

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

Description

Set VPC.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-
description
optional
stringDescriptionvpcDescription

65 - Set VPC Endpoint

65.1 - 1.1

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

Description

Set VPC Endpoint.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID-
description
optional
stringDescription-

65.2 - 1.0

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

Description

Set VPC Endpoint.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID-
description
optional
stringDescription-

66 - Set VPC Peering

66.1 - 1.1

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

Description

Set VPC Peering.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID-
description
optional
stringDescription-

66.2 - 1.0

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

Description

Set VPC Peering.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID-
description
optional
stringDescription-

67 - Show Internet Gateway

67.1 - 1.1

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

Description

Show Internet Gateway.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID-

Responses

NameDescriptionExample
idInternet Gateway ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
firewall_idFirewall ID
loggableNAT Loggable
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway Name
stateState
typeInternet Gateway Type
vpc_idVPC Id
vpc_nameVPC Name

67.2 - 1.0

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

Description

Show Internet Gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID-

Responses

NameDescriptionExample
idInternet Gateway ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
firewall_idFirewall ID
loggableNAT Loggable
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway Name
stateState
typeInternet Gateway Type
vpc_idVPC Id
vpc_nameVPC Name

68 - Show NAT Gateway

68.1 - 1.1

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

Description

Show NAT Gateway.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID-

Responses

NameDescriptionExample
idNAT Gateway ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway Name
nat_gateway_ip_addressNAT Gateway IP Address
publicip_idPublicIP ID
stateNAT Gateway State
subnet_cidrSubnet Cidr
subnet_idSubnet Id
subnet_nameSubnet Name
vpc_idVPC Id
vpc_nameVPC Name

68.2 - 1.0

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

Description

Show NAT Gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID-

Responses

NameDescriptionExample
idNAT Gateway ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway Name
nat_gateway_ip_addressNAT Gateway IP Address
publicip_idPublicIP ID
stateNAT Gateway State
subnet_cidrSubnet Cidr
subnet_idSubnet Id
subnet_nameSubnet Name
vpc_idVPC Id
vpc_nameVPC Name

69 - Show Port

69.1 - 1.1

scpcli vpc port show
--port_id <value>

Description

Show port.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID-

Responses

NameDescriptionExample
port

69.2 - 1.0

scpcli vpc port show
--port_id <value>

Description

Show port.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID-

Responses

NameDescriptionExample
port

70 - Show Private NAT

70.1 - 1.1

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

Description

Show Private NAT.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID-

Responses

NameDescriptionExample
idPrivate NAT ID
account_idAccount ID
cidrPrivate NAT IP range
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
direct_connect_idDirect Connect ID
direct_connect_nameDirect Connect Name
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT Name
statePrivate NAT State
vpc_idVPC Id
vpc_nameVPC Name

70.2 - 1.0

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

Description

Show Private NAT.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID-

Responses

NameDescriptionExample
idPrivate NAT ID
account_idAccount ID
cidrPrivate NAT IP range
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
direct_connect_idDirect Connect ID
direct_connect_nameDirect Connect Name
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT Name
statePrivate NAT State
vpc_idVPC Id
vpc_nameVPC Name

71 - Show PrivateLink Endpoint

71.1 - 1.1

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

Description

Show PrivateLink Endpoint.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint ID-

Responses

NameDescriptionExample
idPrivateLink Endpoint ID
account_idAccount ID
approval_typePrivateLink Service Approval Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
endpoint_ip_addressEndpoint IP Address
endpoint_ip_port_idEndpoint IP Port ID
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Endpoint Name
privatelink_service_idPrivateLink Service ID
security_group_idsSecurity Group List
statePrivateLink Endpoint State
subnet_idSubnet Id
vpc_idVPC Id

72 - Show PrivateLink Service

72.1 - 1.1

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

Description

Show PrivateLink Service.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service ID-

Responses

NameDescriptionExample
idPrivateLink Service ID
account_idAccount ID
approval_typePrivateLink Service Approval Type
connected_resource_idConnected Resource ID
connected_resource_ip_addressConnected Resource IP Address
connected_resource_nameConnected Resource Name
connected_resource_typeConnected Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
high_speed_transferHigh Speed Data Transfer Use
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Service Name
security_group_idsSecurity Group List
service_ip_addressService IP Address
service_ip_port_idService IP Port ID
statePrivateLink Service State
subnet_idSubnet Id
vpc_idVPC Id

73 - Show PublicIP

73.1 - 1.1

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

Description

Show PublicIP.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID-

Responses

NameDescriptionExample
idPublicIP ID
account_idAccount ID
attached_resource_idPublicIP Attached Resource ID
attached_resource_namePublicIP Attached Resource Name
attached_resource_typePublicIP Attached Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP Description
ip_addressIP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP State
typePublicIP Type

73.2 - 1.0

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

Description

Show PublicIP.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID-

Responses

NameDescriptionExample
idPublicIP ID
account_idAccount ID
attached_resource_idPublicIP Attached Resource ID
attached_resource_namePublicIP Attached Resource Name
attached_resource_typePublicIP Attached Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP Description
ip_addressIP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP State
typePublicIP Type

74 - Show Subnet

74.1 - 1.1

scpcli vpc subnet show
--subnet_id <value>

Description

Show subnet.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

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

74.2 - 1.0

scpcli vpc subnet show
--subnet_id <value>

Description

Show subnet.

State ACTIVE (DEPRECATED)

VersionSupported Until
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

75 - Show Transit Gateway

75.1 - 1.1

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

Description

Show Transit Gateway.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-

Responses

NameDescriptionExample
idTransit Gateway ID
account_idAccount ID
bandwidthTransit Gateway Port Bandwidth
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway Description
firewall_idsFirewall ID
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway Name
stateState
uplink_enabledUplink Enabled

75.2 - 1.0

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

Description

Show Transit Gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway ID-

Responses

NameDescriptionExample
idTransit Gateway ID
account_idAccount ID
bandwidthTransit Gateway Port Bandwidth
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway Description
firewall_idsFirewall ID
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway Name
stateState
uplink_enabledUplink Enabled

76 - Show VPC

76.1 - 1.1

scpcli vpc vpc show
--vpc_id <value>

Description

Show VPC.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

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

76.2 - 1.0

scpcli vpc vpc show
--vpc_id <value>

Description

Show VPC.

State ACTIVE (DEPRECATED)

VersionSupported Until
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

77 - Show VPC Endpoint

77.1 - 1.1

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

Description

Show VPC Endpoint.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID-

Responses

NameDescriptionExample
idVPC Endpoint ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
endpoint_ip_addressVPC Endpoint IP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint Name
resource_infoVPC Endpoint Resource Key Info
resource_keyVPC Endpoint Resource Key
resource_typeVPC Endpoint Resource Type
stateVPC Endpoint State
subnet_idSubnet Id
subnet_nameSubnet Name
vpc_idVPC Id
vpc_nameVPC Name

77.2 - 1.0

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

Description

Show VPC Endpoint.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID-

Responses

NameDescriptionExample
idVPC Endpoint ID
account_idAccount ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
endpoint_ip_addressVPC Endpoint IP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint Name
resource_infoVPC Endpoint Resource Key Info
resource_keyVPC Endpoint Resource Key
resource_typeVPC Endpoint Resource Type
stateVPC Endpoint State
subnet_idSubnet Id
subnet_nameSubnet Name
vpc_idVPC Id
vpc_nameVPC Name

78 - Show VPC Peering

78.1 - 1.1

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

Description

Show VPC Peering.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID-

Responses

NameDescriptionExample
idVPC Peering ID
account_typeAccount Type
approver_vpc_account_idApprover VPC Account ID
approver_vpc_idApprover VPC ID
approver_vpc_nameApprover VPC Name
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account ID
descriptionVPC Peering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering Name
requester_vpc_account_idRequester VPC Account ID
requester_vpc_idRequester VPC ID
requester_vpc_nameRequester VPC Name
stateState

78.2 - 1.0

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

Description

Show VPC Peering.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID-

Responses

NameDescriptionExample
idVPC Peering ID
account_typeAccount Type
approver_vpc_account_idApprover VPC Account ID
approver_vpc_idApprover VPC ID
approver_vpc_nameApprover VPC Name
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account ID
descriptionVPC Peering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering Name
requester_vpc_account_idRequester VPC Account ID
requester_vpc_idRequester VPC ID
requester_vpc_nameRequester VPC Name
stateState