This is the multi-page printable view of this section. Click here to print.
CLIs
- 1: Add VPC CIDR
- 1.1: 1.2
- 2: Approval VPC Peering
- 3: Approve PrivateLink Endpoint
- 4: Connect PrivateLink Endpoint
- 5: Connect Subnet VIP Port
- 5.1: 1.2
- 6: Create Internet Gateway
- 7: Create NAT Gateway
- 8: Create Port
- 9: Create Private NAT
- 10: Create Private NAT IP
- 11: Create PrivateLink Endpoint
- 12: Create PrivateLink Service
- 13: Create PublicIP
- 14: Create Subnet
- 15: Create Subnet VIP
- 15.1: 1.2
- 16: Create Subnet VIP NAT IP
- 16.1: 1.2
- 17: Create Transit Gateway
- 18: Create Transit Gateway Firewall
- 18.1: 1.2
- 19: Create Transit Gateway Firewall Connection
- 19.1: 1.2
- 20: Create Transit Gateway Rule
- 21: Create Transit Gateway Uplink Rule
- 22: Create Transit Gateway VPC Connection
- 23: Create VPC
- 24: Create VPC Endpoint
- 25: Create VPC Peering
- 26: Create Vpc Peering Rule
- 27: Delete Internet Gateway
- 28: Delete NAT Gateway
- 29: Delete Port
- 30: Delete Private NAT
- 31: Delete Private NAT IP
- 32: Delete PrivateLink Endpoint
- 33: Delete PrivateLink Service
- 34: Delete PublicIP
- 35: Delete Subnet
- 36: Delete Subnet Vip
- 36.1: 1.2
- 37: Delete Subnet Vip Connected Port
- 37.1: 1.2
- 38: Delete Subnet VIP NAT IP
- 38.1: 1.2
- 39: Delete Transit Gateway
- 40: Delete Transit Gateway Firewall
- 40.1: 1.2
- 41: Delete Transit Gateway Firewall Connection
- 41.1: 1.2
- 42: Delete Transit Gateway Rule
- 43: Delete Transit Gateway Uplink Rule
- 44: Delete Transit Gateway VPC Connection
- 45: Delete VPC
- 46: Delete VPC Endpoint
- 47: Delete VPC Peering
- 48: Delete VPC Peering Rule
- 49: List Connected PrivateLink Endpoints
- 50: List Internet Gateways
- 51: List NAT Gateways
- 52: List Ports
- 53: List Private NAT
- 54: List Private NAT IP
- 55: List PrivateLink Endpoint
- 56: List PrivateLink Service
- 57: List PublicIPs
- 58: List Subnet Vips
- 58.1: 1.2
- 59: List Subnets
- 60: List Transit Gateway Rules
- 61: List Transit Gateway VPC Connections
- 62: List Transit Gateways
- 63: List VPC Endpoint
- 64: List VPC Endpoint Connectable Resources
- 65: List VPC Peering
- 66: List VPC Peering Rules
- 67: List VPCs
- 68: Request PrivateLink Endpoint
- 69: Set Internet Gateway
- 70: Set NAT Gateway
- 71: Set Port
- 72: Set Private NAT
- 73: Set PrivateLink Endpoint
- 74: Set PrivateLink Service
- 75: Set PublicIP
- 76: Set Subnet
- 77: Set Subnet Vip
- 77.1: 1.2
- 78: Set Transit Gateway
- 79: Set VPC
- 80: Set VPC Endpoint
- 81: Set VPC Peering
- 82: Show Internet Gateway
- 83: Show NAT Gateway
- 84: Show Port
- 85: Show Private NAT
- 86: Show PrivateLink Endpoint
- 87: Show PrivateLink Service
- 88: Show PublicIP
- 89: Show Subnet
- 90: Show Subnet Vip
- 90.1: 1.2
- 91: Show Transit Gateway
- 92: Show VPC
- 93: Show VPC Endpoint
- 94: Show VPC Peering
1 - Add VPC CIDR
1.1 - 1.2
scpcli vpc vpc cidr create
--vpc_id <value>
--cidr <value>
Description
Add VPC CIDR.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | - |
| cidr required | string | VPC Cidr | 192.167.0.0/18 |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr_count | Cidr Count | 20 |
| cidrs | ||
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | vpcDescription |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Name | vpcName |
| state | State |
2 - Approval VPC Peering
2.1 - 1.2
scpcli vpc vpc-peering approval
--vpc_peering_id <value>
--type <value>
Description
Approval VPC Peering.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| type required | string | Approval Type | - |
2.2 - 1.1
scpcli vpc vpc-peering approval
--vpc_peering_id <value>
--type <value>
Description
Approval VPC Peering.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| type required | string | Approval Type | - |
3 - Approve PrivateLink Endpoint
3.1 - 1.2
scpcli vpc privatelink-endpoint approve
--privatelink_endpoint_id <value>
--type <value>
Description
Approve PrivateLink Endpoint
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| type required | string | PrivateLink Endpoint Action Type | APPROVE |
3.2 - 1.1
scpcli vpc privatelink-endpoint approve
--privatelink_endpoint_id <value>
--type <value>
Description
Approve PrivateLink Endpoint
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| type required | string | PrivateLink Endpoint Action Type | APPROVE |
4 - Connect PrivateLink Endpoint
4.1 - 1.2
scpcli vpc privatelink-endpoint connect
--privatelink_endpoint_id <value>
--type <value>
Description
Connect PrivateLink Endpoint
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| type required | string | PrivateLink Endpoint Action Type | DISCONNECT |
4.2 - 1.1
scpcli vpc privatelink-endpoint connect
--privatelink_endpoint_id <value>
--type <value>
Description
Connect PrivateLink Endpoint
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| type required | string | PrivateLink Endpoint Action Type | DISCONNECT |
5 - Connect Subnet VIP Port
5.1 - 1.2
scpcli vpc subnet vip port create
--vip_id <value>
--subnet_id <value>
--port_id <value>
Description
Connect Subnet Vip Port
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vip_id required | string | Subnet Vip Id | 0466a9448d9a4411a86055939e451c8f |
| subnet_id required | string | Subnet ID | 023c57b14f11483689338d085e061492 |
| port_id required | string | Port ID | 35268a9f2eda4cde83b1d85c1f61f67d |
Responses
| Name | Description | Example |
|---|---|---|
| id | Connected Port Id | 35268a9f2eda4cde83b1d85c1f61f67d |
| subnet_vip_id | Subnet Vip Id | 0466a9448d9a4411a86055939e451c8f |
6 - Create Internet Gateway
6.1 - 1.2
scpcli vpc internet-gateway create
--vpc_id <value>
--type <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_loggable <value>]
[--tags <value>]
Description
Create Internet Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| type required | string | Internet Gateway Type | - |
| description optional | string | Description | Internet Gateway Description |
| firewall_enabled optional | boolean | Firewall Enable | - |
| firewall_loggable optional | boolean | Firewall Loggable | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Internet Gateway Description |
| firewall_id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| loggable | NAT Loggable | False |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Internet Gateway Name | IGW_VPCname |
| state | State | |
| type | Internet Gateway Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
6.2 - 1.1
scpcli vpc internet-gateway create
--vpc_id <value>
--type <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_loggable <value>]
[--tags <value>]
Description
Create Internet Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| type required | string | Internet Gateway Type | - |
| description optional | string | Description | Internet Gateway Description |
| firewall_enabled optional | boolean | Firewall Enable | - |
| firewall_loggable optional | boolean | Firewall Loggable | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Internet Gateway Description |
| firewall_id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| loggable | NAT Loggable | False |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Internet Gateway Name | IGW_VPCname |
| state | State | |
| type | Internet Gateway Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
6.3 - 1.0
scpcli vpc internet-gateway create
--vpc_id <value>
--type <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_loggable <value>]
[--tags <value>]
Description
Create Internet Gateway.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| type required | string | Internet Gateway Type | - |
| description optional | string | Description | Internet Gateway Description |
| firewall_enabled optional | boolean | Firewall Enable | - |
| firewall_loggable optional | boolean | Firewall Loggable | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Internet Gateway Description |
| firewall_id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| loggable | NAT Loggable | False |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Internet Gateway Name | IGW_VPCname |
| state | State | |
| type | Internet Gateway Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
7 - Create NAT Gateway
7.1 - 1.2
scpcli vpc nat-gateway create
--subnet_id <value>
--publicip_id <value>
[--description <value>]
[--tags <value>]
Description
Create NAT Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet CIDR | 023c57b14f11483689338d085e061492 |
| publicip_id required | string | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| description optional | string | NAT Gateway Description | VpcEndpoint Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | NAT Gateway Description | VpcEndpoint Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | NAT Gateway Name | NatGatewayName |
| nat_gateway_ip_address | NAT Gateway IP Address | 192.167.0.5 |
| publicip_id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| state | NAT Gateway State | ACTIVE |
| subnet_cidr | Subnet Cidr | 192.167.1.0/24 |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
7.2 - 1.1
scpcli vpc nat-gateway create
--subnet_id <value>
--publicip_id <value>
[--description <value>]
[--tags <value>]
Description
Create NAT Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet CIDR | 023c57b14f11483689338d085e061492 |
| publicip_id required | string | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| description optional | string | NAT Gateway Description | VpcEndpoint Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | NAT Gateway Description | VpcEndpoint Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | NAT Gateway Name | NatGatewayName |
| nat_gateway_ip_address | NAT Gateway IP Address | 192.167.0.5 |
| publicip_id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| state | NAT Gateway State | ACTIVE |
| subnet_cidr | Subnet Cidr | 192.167.1.0/24 |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
7.3 - 1.0
scpcli vpc nat-gateway create
--subnet_id <value>
--publicip_id <value>
[--description <value>]
[--tags <value>]
Description
Create NAT Gateway.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet CIDR | 023c57b14f11483689338d085e061492 |
| publicip_id required | string | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| description optional | string | NAT Gateway Description | VpcEndpoint Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | NAT Gateway Description | VpcEndpoint Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | NAT Gateway Name | NatGatewayName |
| nat_gateway_ip_address | NAT Gateway IP Address | 192.167.0.5 |
| publicip_id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| state | NAT Gateway State | ACTIVE |
| subnet_cidr | Subnet Cidr | 192.167.1.0/24 |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
8 - Create Port
8.1 - 1.2
scpcli vpc port create
--subnet_id <value>
--name <value>
[--description <value>]
[--fixed_ip_address <value>]
[--security_groups <value>]
[--tags <value>]
Description
Create port.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | - |
| name required | string | Port Name | portName |
| description optional | string | Description | Port Description |
| fixed_ip_address optional | string | Fixed IP | - |
| security_groups optional | array | Security Group List | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| port |
8.2 - 1.1
scpcli vpc port create
--subnet_id <value>
--name <value>
[--description <value>]
[--fixed_ip_address <value>]
[--security_groups <value>]
[--tags <value>]
Description
Create port.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | - |
| name required | string | Port Name | portName |
| description optional | string | Description | Port Description |
| fixed_ip_address optional | string | Fixed IP | - |
| security_groups optional | array | Security Group List | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| port |
8.3 - 1.0
scpcli vpc port create
--subnet_id <value>
--name <value>
[--description <value>]
[--fixed_ip_address <value>]
[--security_groups <value>]
[--tags <value>]
Description
Create port.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | - |
| name required | string | Port Name | portName |
| description optional | string | Description | Port Description |
| fixed_ip_address optional | string | Fixed IP | - |
| security_groups optional | array | Security Group List | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| port |
9 - Create Private NAT
9.1 - 1.2
scpcli vpc private-nat create
--service_type <value>
--service_resource_id <value>
--name <value>
--cidr <value>
[--description <value>]
[--tags <value>]
Description
Create Private NAT.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| service_type required | string | Private NAT connected Service Type | DIRECT_CONNECT |
| service_resource_id required | string | Private NAT connected Service Resource ID | 3f342bf9a557405b997c2cf48c89cbc2 |
| name required | string | Private NAT Name | PrivateNatName |
| cidr required | string | Private NAT IP range | 192.167.0.0/24 |
| description optional | string | Description | PrivateNat Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | Private NAT IP range | 192.167.0.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateNat Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Private NAT Name | PrivateNatName |
| service_resource_id | Private NAT connected Service Resource ID | 3f342bf9a557405b997c2cf48c89cbc2 |
| service_resource_name | Private NAT connected Service Resource Name | PrivateNatName |
| service_type | Private NAT connected Service Type | DIRECT_CONNECT |
| state | Private NAT State | ACTIVE |
9.2 - 1.1
scpcli vpc private-nat create
--name <value>
--direct_connect_id <value>
--cidr <value>
[--description <value>]
[--tags <value>]
Description
Create Private NAT.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Private NAT Name | PrivateNatName |
| direct_connect_id required | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| cidr required | string | Private NAT IP range | 192.167.0.0/24 |
| description optional | string | Description | PrivateNat Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | Private NAT IP range | 192.167.0.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateNat Description |
| direct_connect_id | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| direct_connect_name | Direct Connect Name | DirectConnectName |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Private NAT Name | PrivateNatName |
| state | Private NAT State | ACTIVE |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
9.3 - 1.0
scpcli vpc private-nat create
--name <value>
--direct_connect_id <value>
--cidr <value>
[--description <value>]
[--tags <value>]
Description
Create Private NAT.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Private NAT Name | PrivateNatName |
| direct_connect_id required | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| cidr required | string | Private NAT IP range | 192.167.0.0/24 |
| description optional | string | Description | PrivateNat Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | Private NAT IP range | 192.167.0.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateNat Description |
| direct_connect_id | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| direct_connect_name | Direct Connect Name | DirectConnectName |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Private NAT Name | PrivateNatName |
| state | Private NAT State | ACTIVE |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
10 - Create Private NAT IP
10.1 - 1.2
scpcli vpc private-nat-ip create
--private_nat_id <value>
--ip_address <value>
Description
Create Private NAT IP.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| ip_address required | string | Private NAT IP Address | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT IP ID | |
| attached_resource_id | Private NAT IP Attached Resource ID | |
| attached_resource_name | Private NAT IP Attached Resource Name | |
| attached_resource_type | Private NAT IP Attached Resource Type | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| ip_address | Private NAT IP Address | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| private_nat_id | Private NAT ID | |
| state | Private NAT IP State |
10.2 - 1.1
scpcli vpc private-nat-ip create
--private_nat_id <value>
--ip_address <value>
Description
Create Private NAT IP.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| ip_address required | string | Private NAT IP Address | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT IP ID | |
| attached_resource_id | Private NAT IP Attached Resource ID | |
| attached_resource_name | Private NAT IP Attached Resource Name | |
| attached_resource_type | Private NAT IP Attached Resource Type | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| ip_address | Private NAT IP Address | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| private_nat_id | Private NAT ID | |
| state | Private NAT IP State |
10.3 - 1.0
scpcli vpc private-nat-ip create
--private_nat_id <value>
--ip_address <value>
Description
Create Private NAT IP.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| ip_address required | string | Private NAT IP Address | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT IP ID | |
| attached_resource_id | Private NAT IP Attached Resource ID | |
| attached_resource_name | Private NAT IP Attached Resource Name | |
| attached_resource_type | Private NAT IP Attached Resource Type | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| ip_address | Private NAT IP Address | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| private_nat_id | Private NAT ID | |
| state | Private NAT IP State |
11 - Create PrivateLink Endpoint
11.1 - 1.2
scpcli vpc privatelink-endpoint create
--subnet_id <value>
--name <value>
--endpoint_ip_address <value>
[--description <value>]
[--privatelink_service_id <value>]
[--security_group_ids <value>]
[--tags <value>]
Description
Create PrivateLink Endpoint.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| name required | string | PrivateLink Endpoint Name | EndpointName |
| endpoint_ip_address required | string | Endpoint IP Address | 192.167.1.5 |
| description optional | string | Description | PrivateLink Endpoint Description |
| privatelink_service_id optional | string | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| security_group_ids optional | array | Security Group List | [ |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approval_type | PrivateLink Service Approval Type | AUTO |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateLink Endpoint Description |
| endpoint_ip_address | Endpoint IP Address | 192.167.1.5 |
| endpoint_ip_port_id | Endpoint IP Port ID | b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | PrivateLink Endpoint Name | EndpointName |
| privatelink_service_id | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| security_group_ids | Security Group List | [‘17776b52-0a64-440d-9e93-b4fc37be935b’] |
| state | PrivateLink Endpoint State | ACTIVE |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
11.2 - 1.1
scpcli vpc privatelink-endpoint create
--subnet_id <value>
--name <value>
--endpoint_ip_address <value>
[--description <value>]
[--privatelink_service_id <value>]
[--security_group_ids <value>]
[--tags <value>]
Description
Create PrivateLink Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| name required | string | PrivateLink Endpoint Name | EndpointName |
| endpoint_ip_address required | string | Endpoint IP Address | 192.167.1.5 |
| description optional | string | Description | PrivateLink Endpoint Description |
| privatelink_service_id optional | string | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| security_group_ids optional | array | Security Group List | [ |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approval_type | PrivateLink Service Approval Type | AUTO |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateLink Endpoint Description |
| endpoint_ip_address | Endpoint IP Address | 192.167.1.5 |
| endpoint_ip_port_id | Endpoint IP Port ID | b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | PrivateLink Endpoint Name | EndpointName |
| privatelink_service_id | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| security_group_ids | Security Group List | [‘17776b52-0a64-440d-9e93-b4fc37be935b’] |
| state | PrivateLink Endpoint State | ACTIVE |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
12 - Create PrivateLink Service
12.1 - 1.2
scpcli vpc privatelink-service create
--subnet_id <value>
--service_ip_address <value>
--name <value>
--connected_resource_type <value>
--approval_type <value>
[--connected_resource_id <value>]
[--connected_resource_ip_address <value>]
[--description <value>]
[--high_speed_transfer <value>]
[--security_group_ids <value>]
[--tags <value>]
Description
Create PrivateLink Service.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| service_ip_address required | string | Service IP Address | 192.167.0.5 |
| name required | string | PrivateLink Service Name | ServiceName |
| connected_resource_type required | string | Connected Resource Type | LB |
| approval_type required | string | PrivateLink Service Approval Type | AUTO |
| connected_resource_id optional | string | Connected Resource ID | a3e3a662a4f34442a94166df5ff9f577 |
| connected_resource_ip_address optional | string | Connected Resource IP Address | 192.167.0.10 |
| description optional | string | Description | PrivateLink Service Description |
| high_speed_transfer optional | boolean | High Speed Data Transfer Use | False |
| security_group_ids optional | array | Security Group List | [ |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approval_type | PrivateLink Service Approval Type | AUTO |
| connected_resource_id | Connected Resource ID | a3e3a662a4f34442a94166df5ff9f577 |
| connected_resource_ip_address | Connected Resource IP Address | 192.167.0.10 |
| connected_resource_name | Connected Resource Name | lbResourceName |
| connected_resource_type | Connected Resource Type | LB |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateLink Service Description |
| high_speed_transfer | High Speed Data Transfer Use | False |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | PrivateLink Service Name | ServiceName |
| security_group_ids | Security Group List | [‘00b6af37-73b5-4de2-b080-c295a1a0382e’] |
| service_ip_address | Service IP Address | 192.167.0.5 |
| service_ip_port_id | Service IP Port ID | d21a4b81-f52a-43a8-b985-341e763458bb |
| state | PrivateLink Service State | |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
12.2 - 1.1
scpcli vpc privatelink-service create
--subnet_id <value>
--service_ip_address <value>
--name <value>
--connected_resource_type <value>
--approval_type <value>
[--connected_resource_id <value>]
[--connected_resource_ip_address <value>]
[--description <value>]
[--high_speed_transfer <value>]
[--security_group_ids <value>]
[--tags <value>]
Description
Create PrivateLink Service.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| service_ip_address required | string | Service IP Address | 192.167.0.5 |
| name required | string | PrivateLink Service Name | ServiceName |
| connected_resource_type required | string | Connected Resource Type | LB |
| approval_type required | string | PrivateLink Service Approval Type | AUTO |
| connected_resource_id optional | string | Connected Resource ID | a3e3a662a4f34442a94166df5ff9f577 |
| connected_resource_ip_address optional | string | Connected Resource IP Address | 192.167.0.10 |
| description optional | string | Description | PrivateLink Service Description |
| high_speed_transfer optional | boolean | High Speed Data Transfer Use | False |
| security_group_ids optional | array | Security Group List | [ |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approval_type | PrivateLink Service Approval Type | AUTO |
| connected_resource_id | Connected Resource ID | a3e3a662a4f34442a94166df5ff9f577 |
| connected_resource_ip_address | Connected Resource IP Address | 192.167.0.10 |
| connected_resource_name | Connected Resource Name | lbResourceName |
| connected_resource_type | Connected Resource Type | LB |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateLink Service Description |
| high_speed_transfer | High Speed Data Transfer Use | False |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | PrivateLink Service Name | ServiceName |
| security_group_ids | Security Group List | [‘00b6af37-73b5-4de2-b080-c295a1a0382e’] |
| service_ip_address | Service IP Address | 192.167.0.5 |
| service_ip_port_id | Service IP Port ID | d21a4b81-f52a-43a8-b985-341e763458bb |
| state | PrivateLink Service State | |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
13 - Create PublicIP
13.1 - 1.2
scpcli vpc public-ip create
--type <value>
[--description <value>]
[--tags <value>]
Description
Create PublicIP.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| type required | string | PublicIP Type | IGW |
| description optional | string | PublicIP Description | Public IP Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| attached_resource_id | PublicIP Attached Resource ID | 37e6db41f5124184a43251a63124cdc9 |
| attached_resource_name | PublicIP Attached Resource Name | Attached NAT Gateway Name |
| attached_resource_type | PublicIP Attached Resource Type | NAT_GW |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | PublicIP Description | Public IP Description |
| ip_address | IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | PublicIP State | ATTACHED |
| type | PublicIP Type | IGW |
13.2 - 1.1
scpcli vpc public-ip create
--type <value>
[--description <value>]
[--tags <value>]
Description
Create PublicIP.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| type required | string | PublicIP Type | IGW |
| description optional | string | PublicIP Description | Public IP Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| attached_resource_id | PublicIP Attached Resource ID | 37e6db41f5124184a43251a63124cdc9 |
| attached_resource_name | PublicIP Attached Resource Name | Attached NAT Gateway Name |
| attached_resource_type | PublicIP Attached Resource Type | NAT_GW |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | PublicIP Description | Public IP Description |
| ip_address | IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | PublicIP State | ATTACHED |
| type | PublicIP Type | IGW |
13.3 - 1.0
scpcli vpc public-ip create
--type <value>
[--description <value>]
[--tags <value>]
Description
Create PublicIP.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| type required | string | PublicIP Type | IGW |
| description optional | string | PublicIP Description | Public IP Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| attached_resource_id | PublicIP Attached Resource ID | 37e6db41f5124184a43251a63124cdc9 |
| attached_resource_name | PublicIP Attached Resource Name | Attached NAT Gateway Name |
| attached_resource_type | PublicIP Attached Resource Type | NAT_GW |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | PublicIP Description | Public IP Description |
| ip_address | IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | PublicIP State | ATTACHED |
| type | PublicIP Type | IGW |
14 - Create Subnet
14.1 - 1.2
scpcli vpc subnet create
--vpc_id <value>
--type <value>
--name <value>
--cidr <value>
[--allocation_pools <value>]
[--description <value>]
[--dns_nameservers <value>]
[--gateway_ip_address <value>]
[--host_routes <value>]
[--tags <value>]
Description
Create subnet.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| type required | string | Subnet Type | - |
| name required | string | Subnet Name | subnetName |
| cidr required | string | Subnet Cidr | 192.167.1.0/24 |
| allocation_pools optional | array | Allocation Pools | [ |
| description optional | string | Description | Subnet Description |
| dns_nameservers optional | array | DNS Name Servers | [ |
| gateway_ip_address optional | string | Gateway IP Address | 192.167.1.1 |
| host_routes optional | array | Host Routes | [ |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Subnet Id | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| allocation_pools | Allocation Pools | |
| cidr | Subnet Cidr | 192.167.1.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Subnet Description |
| dhcp_ip_address | DHCP IP Address | |
| dns_nameservers | DNS Name Servers | |
| gateway_ip_address | Gateway IP Address | 192.167.1.1 |
| host_routes | Host Routes | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Subnet Name | subnetName |
| state | State | |
| type | Subnet Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
14.2 - 1.1
scpcli vpc subnet create
--vpc_id <value>
--type <value>
--name <value>
--cidr <value>
[--allocation_pools <value>]
[--description <value>]
[--dns_nameservers <value>]
[--host_routes <value>]
[--tags <value>]
Description
Create subnet.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| type required | string | Subnet Type | - |
| name required | string | Subnet Name | subnetName |
| cidr required | string | Subnet Cidr | 192.167.1.0/24 |
| allocation_pools optional | array | Allocation Pools | [ |
| description optional | string | Description | Subnet Description |
| dns_nameservers optional | array | DNS Name Servers | [ |
| host_routes optional | array | Host Routes | [ |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Subnet Id | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| allocation_pools | Allocation Pools | |
| cidr | Subnet Cidr | 192.167.1.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Subnet Description |
| dns_nameservers | DNS Name Servers | |
| gateway_ip_address | Gateway IP Address | 192.167.1.1 |
| host_routes | Host Routes | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Subnet Name | subnetName |
| state | State | |
| type | Subnet Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
14.3 - 1.0
scpcli vpc subnet create
--vpc_id <value>
--type <value>
--name <value>
--cidr <value>
[--allocation_pools <value>]
[--description <value>]
[--dns_nameservers <value>]
[--host_routes <value>]
[--tags <value>]
Description
Create subnet.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| type required | string | Subnet Type | - |
| name required | string | Subnet Name | subnetName |
| cidr required | string | Subnet Cidr | 192.167.1.0/24 |
| allocation_pools optional | array | Allocation Pools | [ |
| description optional | string | Description | Subnet Description |
| dns_nameservers optional | array | DNS Name Servers | [ |
| host_routes optional | array | Host Routes | [ |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Subnet Id | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| allocation_pools | Allocation Pools | |
| cidr | Subnet Cidr | 192.167.1.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Subnet Description |
| dns_nameservers | DNS Name Servers | |
| gateway_ip_address | Gateway IP Address | 192.167.1.1 |
| host_routes | Host Routes | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Subnet Name | subnetName |
| state | State | |
| type | Subnet Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
15 - Create Subnet VIP
15.1 - 1.2
scpcli vpc subnet vip create
--subnet_id <value>
[--description <value>]
[--virtual_ip_address <value>]
Description
Create Subnet Vip
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| description optional | string | Description | Subnet VIP Description |
| virtual_ip_address optional | string | Virtual IP Address | 192.168.20.6 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Subnet Vip Id | 0466a9448d9a4411a86055939e451c8f |
| connected_ports | ||
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Subnet VIP Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | State | ACTIVE |
| static_nat | Static NAT Info | |
| subnet_id | Subnet ID | 023c57b14f11483689338d085e061492 |
| vip_port_id | Vip Port Id | 35268a9f2eda4cde83b1d85c1f61f67d |
| virtual_ip_address | Virtual IP Address | 192.168.20.6 |
16 - Create Subnet VIP NAT IP
16.1 - 1.2
scpcli vpc subnet vip nat create
--vip_id <value>
--subnet_id <value>
--publicip_id <value>
--nat_type <value>
Description
Create Subnet Vip Nat Ip
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vip_id required | string | Subnet Vip Id | 0466a9448d9a4411a86055939e451c8f |
| subnet_id required | string | Subnet ID | 023c57b14f11483689338d085e061492 |
| publicip_id required | string | Publicip ID | 12f56e27070248a6a240a497e43fbe18 |
| nat_type required | string | NAT Type | PUBLIC |
Responses
| Name | Description | Example |
|---|---|---|
| id | Static Nat Id | 0009e49548154745948e9722adefbf40 |
| publicip_id | Publicip ID | 12f56e27070248a6a240a497e43fbe18 |
| state | Static Nat State | ACTIVE |
17 - Create Transit Gateway
17.1 - 1.2
scpcli vpc transit-gateway create
--name <value>
[--description <value>]
[--tags <value>]
Description
Create Transit Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Transit Gateway Name | TransitGatewayName |
| description optional | string | Description | TransitGateway Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Transit Gateway Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Transit Gateway Description | TransitGateway Description |
| firewall_connection_state | Firewall Connection State | INACTIVE |
| firewall_ids | Firewall ID | [‘bbb93aca123f4bb2b2c0f206f4a86b2b’] |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Transit Gateway Name | TransitGatewayName |
| state | State | ACTIVE |
| uplink_enabled | Uplink Enabled | False |
17.2 - 1.1
scpcli vpc transit-gateway create
--name <value>
[--description <value>]
[--tags <value>]
Description
Create Transit Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Transit Gateway Name | TransitGatewayName |
| description optional | string | Description | TransitGateway Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Transit Gateway Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Transit Gateway Description | TransitGateway Description |
| firewall_ids | Firewall ID | [‘bbb93aca123f4bb2b2c0f206f4a86b2b’] |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Transit Gateway Name | TransitGatewayName |
| state | State | ACTIVE |
| uplink_enabled | Uplink Enabled | False |
17.3 - 1.0
scpcli vpc transit-gateway create
--name <value>
[--description <value>]
[--tags <value>]
Description
Create Transit Gateway.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | Transit Gateway Name | TransitGatewayName |
| description optional | string | Description | TransitGateway Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Transit Gateway Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Transit Gateway Description | TransitGateway Description |
| firewall_ids | Firewall ID | [‘bbb93aca123f4bb2b2c0f206f4a86b2b’] |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Transit Gateway Name | TransitGatewayName |
| state | State | ACTIVE |
| uplink_enabled | Uplink Enabled | False |
18 - Create Transit Gateway Firewall
18.1 - 1.2
scpcli vpc transit-gateway-firewall create
--transit_gateway_id <value>
--product_type <value>
Description
Create Transit Gateway Firewall.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| product_type required | string | Fw Product Type | TGW_DGW |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Transit Gateway Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Transit Gateway Description | TransitGateway Description |
| firewall_connection_state | Firewall Connection State | INACTIVE |
| firewall_ids | Firewall ID | [‘bbb93aca123f4bb2b2c0f206f4a86b2b’] |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Transit Gateway Name | TransitGatewayName |
| state | State | ACTIVE |
| uplink_enabled | Uplink Enabled | False |
19 - Create Transit Gateway Firewall Connection
19.1 - 1.2
scpcli vpc transit-gateway-firewall-connection create
--transit_gateway_id <value>
Description
Create Transit Gateway Firewall Connection.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Transit Gateway Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Transit Gateway Description | TransitGateway Description |
| firewall_connection_state | Firewall Connection State | INACTIVE |
| firewall_ids | Firewall ID | [‘bbb93aca123f4bb2b2c0f206f4a86b2b’] |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Transit Gateway Name | TransitGatewayName |
| state | State | ACTIVE |
| uplink_enabled | Uplink Enabled | False |
20 - Create Transit Gateway Rule
20.1 - 1.2
scpcli vpc transit-gateway-rule create
--transit_gateway_id <value>
--tgw_connection_vpc_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]
Description
Create Transit Gateway Rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| tgw_connection_vpc_id required | string | VPC ID Connected to Transit Gateway. | ffeced8e191c478eabd66b6e2cab8e34 |
| destination_type required | string | Destination Type | VPC |
| destination_cidr required | string | Destination CIDR | 192.167.5.0/24 |
| description optional | string | Description | Routing Rule Description |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| description | Description | Routing Rule Description |
| destination_cidr | Destination CIDR | 192.167.5.0/24 |
| destination_resource_id | Destination Resource ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| destination_resource_name | Destination Resource Name | VpcName |
| destination_type | Destination Type | VPC |
| source_resource_id | Source Resource ID | 8582cc5d89994a42ad53282fd4a8d8be |
| source_resource_name | Source Resource Name | TgwName |
| source_type | Source Type | TGW |
| state | State | ACTIVE |
| tgw_connection_vpc_id | VPC ID Connected to Transit Gateway. | ffeced8e191c478eabd66b6e2cab8e34 |
| tgw_connection_vpc_name | VPC Name Connected to Transit Gateway. | ConnectedVpcName |
20.2 - 1.1
scpcli vpc transit-gateway-rule create
--transit_gateway_id <value>
--tgw_connection_vpc_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]
Description
Create Transit Gateway Rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| tgw_connection_vpc_id required | string | VPC ID Connected to Transit Gateway. | ffeced8e191c478eabd66b6e2cab8e34 |
| destination_type required | string | Destination Type | VPC |
| destination_cidr required | string | Destination CIDR | 192.167.5.0/24 |
| description optional | string | Description | Routing Rule Description |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| description | Description | Routing Rule Description |
| destination_cidr | Destination CIDR | 192.167.5.0/24 |
| destination_resource_id | Destination Resource ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| destination_resource_name | Destination Resource Name | VpcName |
| destination_type | Destination Type | VPC |
| source_resource_id | Source Resource ID | 8582cc5d89994a42ad53282fd4a8d8be |
| source_resource_name | Source Resource Name | TgwName |
| source_type | Source Type | TGW |
| state | State | ACTIVE |
| tgw_connection_vpc_id | VPC ID Connected to Transit Gateway. | ffeced8e191c478eabd66b6e2cab8e34 |
| tgw_connection_vpc_name | VPC Name Connected to Transit Gateway. | ConnectedVpcName |
20.3 - 1.0
scpcli vpc transit-gateway-rule create
--transit_gateway_id <value>
--tgw_connection_vpc_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]
Description
Create Transit Gateway Rule.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| tgw_connection_vpc_id required | string | VPC ID Connected to Transit Gateway. | ffeced8e191c478eabd66b6e2cab8e34 |
| destination_type required | string | Destination Type | VPC |
| destination_cidr required | string | Destination CIDR | 192.167.5.0/24 |
| description optional | string | Description | Routing Rule Description |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| description | Description | Routing Rule Description |
| destination_cidr | Destination CIDR | 192.167.5.0/24 |
| destination_resource_id | Destination Resource ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| destination_resource_name | Destination Resource Name | VpcName |
| destination_type | Destination Type | VPC |
| source_resource_id | Source Resource ID | 8582cc5d89994a42ad53282fd4a8d8be |
| source_resource_name | Source Resource Name | TgwName |
| source_type | Source Type | TGW |
| state | State | ACTIVE |
| tgw_connection_vpc_id | VPC ID Connected to Transit Gateway. | ffeced8e191c478eabd66b6e2cab8e34 |
| tgw_connection_vpc_name | VPC Name Connected to Transit Gateway. | ConnectedVpcName |
21 - Create Transit Gateway Uplink Rule
21.1 - 1.2
scpcli vpc transit-gateway-uplink-rule create
--transit_gateway_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]
Description
Create Transit Gateway Uplink Rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| destination_type required | string | Destination Type | ON_PREMISE |
| destination_cidr required | string | Destination CIDR | 192.167.5.0/24 |
| description optional | string | Description | Routing Rule Description |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| description | Description | Routing Rule Description |
| destination_cidr | Destination CIDR | 192.167.5.0/24 |
| destination_type | Destination Type | ON_PREMISE |
| state | State | ACTIVE |
21.2 - 1.1
scpcli vpc transit-gateway-uplink-rule create
--transit_gateway_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]
Description
Create Transit Gateway Uplink Rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| destination_type required | string | Destination Type | ON_PREMISE |
| destination_cidr required | string | Destination CIDR | 192.167.5.0/24 |
| description optional | string | Description | Routing Rule Description |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| description | Description | Routing Rule Description |
| destination_cidr | Destination CIDR | 192.167.5.0/24 |
| destination_type | Destination Type | ON_PREMISE |
| state | State | ACTIVE |
21.3 - 1.0
scpcli vpc transit-gateway-uplink-rule create
--transit_gateway_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]
Description
Create Transit Gateway Uplink Rule.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| destination_type required | string | Destination Type | ON_PREMISE |
| destination_cidr required | string | Destination CIDR | 192.167.5.0/24 |
| description optional | string | Description | Routing Rule Description |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| description | Description | Routing Rule Description |
| destination_cidr | Destination CIDR | 192.167.5.0/24 |
| destination_type | Destination Type | ON_PREMISE |
| state | State | ACTIVE |
22 - Create Transit Gateway VPC Connection
22.1 - 1.2
scpcli vpc transit-gateway-vpc-connection create
--transit_gateway_id <value>
--vpc_id <value>
Description
Create Transit Gateway VPC Connection.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| vpc_id required | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway VPC Connection ID | ffeced8e191c478eabd66b6e2cab8e34 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | State | ACTIVE |
| transit_gateway_id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
22.2 - 1.1
scpcli vpc transit-gateway-vpc-connection create
--transit_gateway_id <value>
--vpc_id <value>
Description
Create Transit Gateway VPC Connection.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| vpc_id required | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway VPC Connection ID | ffeced8e191c478eabd66b6e2cab8e34 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | State | ACTIVE |
| transit_gateway_id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
22.3 - 1.0
scpcli vpc transit-gateway-vpc-connection create
--transit_gateway_id <value>
--vpc_id <value>
Description
Create Transit Gateway VPC Connection.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| vpc_id required | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway VPC Connection ID | ffeced8e191c478eabd66b6e2cab8e34 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | State | ACTIVE |
| transit_gateway_id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
23 - Create VPC
23.1 - 1.2
scpcli vpc vpc create
--name <value>
--cidr <value>
[--description <value>]
[--tags <value>]
Description
Create VPC.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | VPC Name | vpcName |
| cidr required | string | VPC Cidr | 192.167.0.0/18 |
| description optional | string | Description | VPC Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr_count | Cidr Count | 20 |
| cidrs | ||
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | vpcDescription |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Name | vpcName |
| state | State |
23.2 - 1.1
scpcli vpc vpc create
--name <value>
--cidr <value>
[--description <value>]
[--tags <value>]
Description
Create VPC.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | VPC Name | vpcName |
| cidr required | string | VPC Cidr | 192.167.0.0/18 |
| description optional | string | Description | VPC Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | VPC Cidr | 192.167.0.0/18 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | vpcDescription |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Name | vpcName |
| state | State |
23.3 - 1.0
scpcli vpc vpc create
--name <value>
--cidr <value>
[--description <value>]
[--tags <value>]
Description
Create VPC.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| name required | string | VPC Name | vpcName |
| cidr required | string | VPC Cidr | 192.167.0.0/18 |
| description optional | string | Description | VPC Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | VPC Cidr | 192.167.0.0/18 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | vpcDescription |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Name | vpcName |
| state | State |
24 - Create VPC Endpoint
24.1 - 1.2
scpcli vpc vpc-endpoint create
--vpc_id <value>
--subnet_id <value>
--resource_type <value>
--resource_key <value>
--resource_info <value>
--name <value>
--endpoint_ip_address <value>
[--description <value>]
[--tags <value>]
Description
Create VPC Endpoint.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| resource_type required | string | VPC Endpoint Resource Type | FS |
| resource_key required | string | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_info required | string | VPC Endpoint Resource Key Info | x.samsungsdscloud.com(Registry) |
| name required | string | VPC Endpoint Name | VpcEndpointName |
| endpoint_ip_address required | string | VPC Endpoint IP Address | 192.167.0.5 |
| description optional | string | Description | VpcEndpoint Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | VpcEndpoint Description |
| endpoint_ip_address | VPC Endpoint IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Endpoint Name | VpcEndpointName |
| resource_info | VPC Endpoint Resource Key Info | x.samsungsdscloud.com(Registry) |
| resource_key | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_type | VPC Endpoint Resource Type | FS |
| state | VPC Endpoint State | ACTIVE |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
24.2 - 1.1
scpcli vpc vpc-endpoint create
--vpc_id <value>
--subnet_id <value>
--resource_type <value>
--resource_key <value>
--resource_info <value>
--name <value>
--endpoint_ip_address <value>
[--description <value>]
[--tags <value>]
Description
Create VPC Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| resource_type required | string | VPC Endpoint Resource Type | FS |
| resource_key required | string | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_info required | string | VPC Endpoint Resource Key Info | x.samsungsdscloud.com(Registry) |
| name required | string | VPC Endpoint Name | VpcEndpointName |
| endpoint_ip_address required | string | VPC Endpoint IP Address | 192.167.0.5 |
| description optional | string | Description | VpcEndpoint Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | VpcEndpoint Description |
| endpoint_ip_address | VPC Endpoint IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Endpoint Name | VpcEndpointName |
| resource_info | VPC Endpoint Resource Key Info | x.samsungsdscloud.com(Registry) |
| resource_key | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_type | VPC Endpoint Resource Type | FS |
| state | VPC Endpoint State | ACTIVE |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
24.3 - 1.0
scpcli vpc vpc-endpoint create
--vpc_id <value>
--subnet_id <value>
--resource_type <value>
--resource_key <value>
--resource_info <value>
--name <value>
--endpoint_ip_address <value>
[--description <value>]
[--tags <value>]
Description
Create VPC Endpoint.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| resource_type required | string | VPC Endpoint Resource Type | FS |
| resource_key required | string | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_info required | string | VPC Endpoint Resource Key Info | x.samsungsdscloud.com(Registry) |
| name required | string | VPC Endpoint Name | VpcEndpointName |
| endpoint_ip_address required | string | VPC Endpoint IP Address | 192.167.0.5 |
| description optional | string | Description | VpcEndpoint Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | VpcEndpoint Description |
| endpoint_ip_address | VPC Endpoint IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Endpoint Name | VpcEndpointName |
| resource_info | VPC Endpoint Resource Key Info | x.samsungsdscloud.com(Registry) |
| resource_key | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_type | VPC Endpoint Resource Type | FS |
| state | VPC Endpoint State | ACTIVE |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
25 - Create VPC Peering
25.1 - 1.2
scpcli vpc vpc-peering create
--requester_vpc_id <value>
--name <value>
--approver_vpc_id <value>
--approver_vpc_account_id <value>
[--description <value>]
[--tags <value>]
Description
Create VPC Peering.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| requester_vpc_id required | string | Requester VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| name required | string | VPC Peering Name | vpcPeeringName |
| approver_vpc_id required | string | Approver VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| approver_vpc_account_id required | string | Approver VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| description optional | string | Description | vpcPeering Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| account_type | Account Type | |
| approver_vpc_account_id | Approver VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approver_vpc_id | Approver VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| approver_vpc_name | Approver VPC Name | vpcName |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| delete_requester_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| description | VPC Peering Description | vpcPeering Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Peering Name | vpcPeeringName |
| requester_vpc_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| requester_vpc_id | Requester VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| requester_vpc_name | Requester VPC Name | vpcName |
| state | State |
25.2 - 1.1
scpcli vpc vpc-peering create
--requester_vpc_id <value>
--name <value>
--approver_vpc_id <value>
--approver_vpc_account_id <value>
[--description <value>]
[--tags <value>]
Description
Create VPC Peering.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| requester_vpc_id required | string | Requester VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| name required | string | VPC Peering Name | vpcPeeringName |
| approver_vpc_id required | string | Approver VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| approver_vpc_account_id required | string | Approver VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| description optional | string | Description | vpcPeering Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| account_type | Account Type | |
| approver_vpc_account_id | Approver VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approver_vpc_id | Approver VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| approver_vpc_name | Approver VPC Name | vpcName |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| delete_requester_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| description | VPC Peering Description | vpcPeering Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Peering Name | vpcPeeringName |
| requester_vpc_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| requester_vpc_id | Requester VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| requester_vpc_name | Requester VPC Name | vpcName |
| state | State |
25.3 - 1.0
scpcli vpc vpc-peering create
--requester_vpc_id <value>
--name <value>
--approver_vpc_id <value>
--approver_vpc_account_id <value>
[--description <value>]
[--tags <value>]
Description
Create VPC Peering.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| requester_vpc_id required | string | Requester VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| name required | string | VPC Peering Name | vpcPeeringName |
| approver_vpc_id required | string | Approver VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| approver_vpc_account_id required | string | Approver VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| description optional | string | Description | vpcPeering Description |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| account_type | Account Type | |
| approver_vpc_account_id | Approver VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approver_vpc_id | Approver VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| approver_vpc_name | Approver VPC Name | vpcName |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| delete_requester_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| description | VPC Peering Description | vpcPeering Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Peering Name | vpcPeeringName |
| requester_vpc_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| requester_vpc_id | Requester VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| requester_vpc_name | Requester VPC Name | vpcName |
| state | State |
26 - Create Vpc Peering Rule
26.1 - 1.2
scpcli vpc vpc-peering-routing-rule create
--vpc_peering_id <value>
--destination_vpc_type <value>
--destination_cidr <value>
[--tags <value>]
Description
Create a VPC Peering Rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| destination_vpc_type required | string | Destination VPC Type | - |
| destination_cidr required | string | Destination CIDR | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering Rule ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| destination_cidr | Destination CIDR | |
| destination_vpc_id | Destination VPC ID | |
| destination_vpc_name | Destination VPC Name | |
| destination_vpc_type | Destination VPC Type | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| source_vpc_id | Source VPC ID | |
| source_vpc_name | Source VPC Name | |
| source_vpc_type | Source VPC Type | |
| state | State | |
| vpc_peering_id | VPC Peering ID |
26.2 - 1.1
scpcli vpc vpc-peering-routing-rule create
--vpc_peering_id <value>
--destination_vpc_type <value>
--destination_cidr <value>
[--tags <value>]
Description
Create a VPC Peering Rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| destination_vpc_type required | string | Destination VPC Type | - |
| destination_cidr required | string | Destination CIDR | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering Rule ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| destination_cidr | Destination CIDR | |
| destination_vpc_id | Destination VPC ID | |
| destination_vpc_name | Destination VPC Name | |
| destination_vpc_type | Destination VPC Type | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| source_vpc_id | Source VPC ID | |
| source_vpc_name | Source VPC Name | |
| source_vpc_type | Source VPC Type | |
| state | State | |
| vpc_peering_id | VPC Peering ID |
26.3 - 1.0
scpcli vpc vpc-peering-routing-rule create
--vpc_peering_id <value>
--destination_vpc_type <value>
--destination_cidr <value>
[--tags <value>]
Description
Create a VPC Peering Rule.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| destination_vpc_type required | string | Destination VPC Type | - |
| destination_cidr required | string | Destination CIDR | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering Rule ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| destination_cidr | Destination CIDR | |
| destination_vpc_id | Destination VPC ID | |
| destination_vpc_name | Destination VPC Name | |
| destination_vpc_type | Destination VPC Type | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| source_vpc_id | Source VPC ID | |
| source_vpc_name | Source VPC Name | |
| source_vpc_type | Source VPC Type | |
| state | State | |
| vpc_peering_id | VPC Peering ID |
27 - Delete Internet Gateway
27.1 - 1.2
scpcli vpc internet-gateway delete
--internet_gateway_id <value>
Description
Delete Internet Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| internet_gateway_id required | string | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
27.2 - 1.1
scpcli vpc internet-gateway delete
--internet_gateway_id <value>
Description
Delete Internet Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| internet_gateway_id required | string | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
27.3 - 1.0
scpcli vpc internet-gateway delete
--internet_gateway_id <value>
Description
Delete Internet Gateway.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| internet_gateway_id required | string | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
28 - Delete NAT Gateway
28.1 - 1.2
scpcli vpc nat-gateway delete
--nat_gateway_id <value>
Description
Delete NAT Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nat_gateway_id required | string | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
28.2 - 1.1
scpcli vpc nat-gateway delete
--nat_gateway_id <value>
Description
Delete NAT Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nat_gateway_id required | string | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
28.3 - 1.0
scpcli vpc nat-gateway delete
--nat_gateway_id <value>
Description
Delete NAT Gateway.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nat_gateway_id required | string | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
29 - Delete Port
29.1 - 1.2
scpcli vpc port delete
--port_id <value>
Description
Delete port.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
29.2 - 1.1
scpcli vpc port delete
--port_id <value>
Description
Delete port.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
29.3 - 1.0
scpcli vpc port delete
--port_id <value>
Description
Delete port.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
30 - Delete Private NAT
30.1 - 1.2
scpcli vpc private-nat delete
--private_nat_id <value>
Description
Delete Private NAT.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
30.2 - 1.1
scpcli vpc private-nat delete
--private_nat_id <value>
Description
Delete Private NAT.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
30.3 - 1.0
scpcli vpc private-nat delete
--private_nat_id <value>
Description
Delete Private NAT.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
31 - Delete Private NAT IP
31.1 - 1.2
scpcli vpc private-nat-ip delete
--private_nat_ip_id <value>
--private_nat_id <value>
Description
Delete Private NAT IP.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_ip_id required | string | Private NAT IP ID | - |
| private_nat_id required | string | Private NAT ID | - |
31.2 - 1.1
scpcli vpc private-nat-ip delete
--private_nat_ip_id <value>
--private_nat_id <value>
Description
Delete Private NAT IP.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_ip_id required | string | Private NAT IP ID | - |
| private_nat_id required | string | Private NAT ID | - |
31.3 - 1.0
scpcli vpc private-nat-ip delete
--private_nat_ip_id <value>
--private_nat_id <value>
Description
Delete Private NAT IP.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_ip_id required | string | Private NAT IP ID | - |
| private_nat_id required | string | Private NAT ID | - |
32 - Delete PrivateLink Endpoint
32.1 - 1.2
scpcli vpc privatelink-endpoint delete
--privatelink_endpoint_id <value>
Description
Delete PrivateLink Endpoint.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
32.2 - 1.1
scpcli vpc privatelink-endpoint delete
--privatelink_endpoint_id <value>
Description
Delete PrivateLink Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
33 - Delete PrivateLink Service
33.1 - 1.2
scpcli vpc privatelink-service delete
--privatelink_service_id <value>
Description
Delete PrivateLink Service.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_service_id required | string | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
33.2 - 1.1
scpcli vpc privatelink-service delete
--privatelink_service_id <value>
Description
Delete PrivateLink Service.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_service_id required | string | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
34 - Delete PublicIP
34.1 - 1.2
scpcli vpc public-ip delete
--publicip_id <value>
Description
Delete PublicIP.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| publicip_id required | string | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
34.2 - 1.1
scpcli vpc public-ip delete
--publicip_id <value>
Description
Delete PublicIP.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| publicip_id required | string | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
34.3 - 1.0
scpcli vpc public-ip delete
--publicip_id <value>
Description
Delete PublicIP.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| publicip_id required | string | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
35 - Delete Subnet
35.1 - 1.2
scpcli vpc subnet delete
--subnet_id <value>
Description
Delete subnet.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
35.2 - 1.1
scpcli vpc subnet delete
--subnet_id <value>
Description
Delete subnet.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
35.3 - 1.0
scpcli vpc subnet delete
--subnet_id <value>
Description
Delete subnet.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
36 - Delete Subnet Vip
36.1 - 1.2
scpcli vpc subnet vip delete
--vip_id <value>
--subnet_id <value>
Description
Delete Subnet Vip
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vip_id required | string | Subnet Vip Id | 0466a9448d9a4411a86055939e451c8f |
| subnet_id required | string | Subnet ID | 023c57b14f11483689338d085e061492 |
37 - Delete Subnet Vip Connected Port
37.1 - 1.2
scpcli vpc subnet vip port delete
--connected_port_id <value>
--vip_id <value>
--subnet_id <value>
Description
Delete Subnet Vip Connected Port
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| connected_port_id required | string | Subnet Vip Connected Port Id | 13e2a5a1acbe4713a9a2c70ce226e822 |
| vip_id required | string | Subnet Vip Id | 0466a9448d9a4411a86055939e451c8f |
| subnet_id required | string | Subnet ID | 023c57b14f11483689338d085e061492 |
38 - Delete Subnet VIP NAT IP
38.1 - 1.2
scpcli vpc subnet vip nat delete
--static_nat_id <value>
--vip_id <value>
--subnet_id <value>
Description
Delete Subnet Vip Nat Ip
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| static_nat_id required | string | Static NAT ID | 0009e49548154745948e9722adefbf40 |
| vip_id required | string | Subnet Vip Id | 0466a9448d9a4411a86055939e451c8f |
| subnet_id required | string | Subnet ID | 023c57b14f11483689338d085e061492 |
39 - Delete Transit Gateway
39.1 - 1.2
scpcli vpc transit-gateway delete
--transit_gateway_id <value>
Description
Delete Transit Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
39.2 - 1.1
scpcli vpc transit-gateway delete
--transit_gateway_id <value>
Description
Delete Transit Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
39.3 - 1.0
scpcli vpc transit-gateway delete
--transit_gateway_id <value>
Description
Delete Transit Gateway.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
40 - Delete Transit Gateway Firewall
40.1 - 1.2
scpcli vpc transit-gateway-firewall-delete
--firewall_id <value>
--transit_gateway_id <value>
Description
Delete Transit Gateway Firewall.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| firewall_id required | string | Firewall ID | bbb93aca123f4bb2b2c0f206f4a86b2b |
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
41 - Delete Transit Gateway Firewall Connection
41.1 - 1.2
scpcli vpc transit-gateway-firewall-connection delete
--transit_gateway_id <value>
Description
Delete Transit Gateway Firewall Connection.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
42 - Delete Transit Gateway Rule
42.1 - 1.2
scpcli vpc transit-gateway-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>
Description
Delete Transit Gateway Rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| routing_rule_id required | string | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
42.2 - 1.1
scpcli vpc transit-gateway-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>
Description
Delete Transit Gateway Rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| routing_rule_id required | string | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
42.3 - 1.0
scpcli vpc transit-gateway-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>
Description
Delete Transit Gateway Rule.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| routing_rule_id required | string | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
43 - Delete Transit Gateway Uplink Rule
43.1 - 1.2
scpcli vpc transit-gateway-uplink-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>
Description
Delete Transit Gateway Uplink Rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| routing_rule_id required | string | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
43.2 - 1.1
scpcli vpc transit-gateway-uplink-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>
Description
Delete Transit Gateway Uplink Rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| routing_rule_id required | string | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
43.3 - 1.0
scpcli vpc transit-gateway-uplink-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>
Description
Delete Transit Gateway Uplink Rule.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| routing_rule_id required | string | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
44 - Delete Transit Gateway VPC Connection
44.1 - 1.2
scpcli vpc transit-gateway-vpc-connection delete
--vpc_connection_id <value>
--transit_gateway_id <value>
Description
Delete Transit Gateway VPC Connection.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_connection_id required | string | Transit Gateway VPC Connection ID | ffeced8e191c478eabd66b6e2cab8e34 |
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
44.2 - 1.1
scpcli vpc transit-gateway-vpc-connection delete
--vpc_connection_id <value>
--transit_gateway_id <value>
Description
Delete Transit Gateway VPC Connection.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_connection_id required | string | Transit Gateway VPC Connection ID | ffeced8e191c478eabd66b6e2cab8e34 |
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
44.3 - 1.0
scpcli vpc transit-gateway-vpc-connection delete
--vpc_connection_id <value>
--transit_gateway_id <value>
Description
Delete Transit Gateway VPC Connection.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_connection_id required | string | Transit Gateway VPC Connection ID | ffeced8e191c478eabd66b6e2cab8e34 |
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
45 - Delete VPC
45.1 - 1.2
scpcli vpc vpc delete
--vpc_id <value>
Description
Delete VPC.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | - |
45.2 - 1.1
scpcli vpc vpc delete
--vpc_id <value>
Description
Delete VPC.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | - |
45.3 - 1.0
scpcli vpc vpc delete
--vpc_id <value>
Description
Delete VPC.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | - |
46 - Delete VPC Endpoint
46.1 - 1.2
scpcli vpc vpc-endpoint delete
--vpc_endpoint_id <value>
Description
Delete VPC Endpoint.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_endpoint_id required | string | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
46.2 - 1.1
scpcli vpc vpc-endpoint delete
--vpc_endpoint_id <value>
Description
Delete VPC Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_endpoint_id required | string | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
46.3 - 1.0
scpcli vpc vpc-endpoint delete
--vpc_endpoint_id <value>
Description
Delete VPC Endpoint.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_endpoint_id required | string | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
47 - Delete VPC Peering
47.1 - 1.2
scpcli vpc vpc-peering delete
--vpc_peering_id <value>
Description
Delete VPC Peering.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
47.2 - 1.1
scpcli vpc vpc-peering delete
--vpc_peering_id <value>
Description
Delete VPC Peering.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
47.3 - 1.0
scpcli vpc vpc-peering delete
--vpc_peering_id <value>
Description
Delete VPC Peering.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
48 - Delete VPC Peering Rule
48.1 - 1.2
scpcli vpc vpc-peering-rule delete
--routing_rule_id <value>
--vpc_peering_id <value>
Description
Delete a VPC Peering Rule.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| routing_rule_id required | string | Routing Rule ID | - |
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
48.2 - 1.1
scpcli vpc vpc-peering-rule delete
--routing_rule_id <value>
--vpc_peering_id <value>
Description
Delete a VPC Peering Rule.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| routing_rule_id required | string | Routing Rule ID | - |
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
48.3 - 1.0
scpcli vpc vpc-peering-rule delete
--routing_rule_id <value>
--vpc_peering_id <value>
Description
Delete a VPC Peering Rule.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| routing_rule_id required | string | Routing Rule ID | - |
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
49 - List Connected PrivateLink Endpoints
49.1 - 1.2
scpcli vpc privatelink-service-connected-endpoint list
--privatelink_service_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
Get Connected PrivateLink Endpoint List.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_service_id required | string | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| privatelink_service_id | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| state | PrivateLink Endpoint State | ACTIVE |
49.2 - 1.1
scpcli vpc privatelink-service-connected-endpoint list
--privatelink_service_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
Get Connected PrivateLink Endpoint List.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_service_id required | string | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| privatelink_service_id | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| state | PrivateLink Endpoint State | ACTIVE |
50 - List Internet Gateways
50.1 - 1.2
scpcli vpc internet-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]
Description
Get Internet Gateway list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
| name optional | string | Internet Gateway Name | IGW_VPCname |
| type optional | **** | Internet Gateway Type | - |
| state optional | string | State | - |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
Responses
| Name | Description | Example |
|---|---|---|
| id | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Internet Gateway Description |
| firewall_id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| loggable | NAT Loggable | False |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Internet Gateway Name | IGW_VPCname |
| state | State | |
| type | Internet Gateway Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
50.2 - 1.1
scpcli vpc internet-gateway list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]
Description
Get Internet Gateway list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
| name optional | string | Internet Gateway Name | IGW_VPCname |
| type optional | **** | Internet Gateway Type | - |
| state optional | string | State | - |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
Responses
| Name | Description | Example |
|---|---|---|
| id | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Internet Gateway Description |
| firewall_id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| loggable | NAT Loggable | False |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Internet Gateway Name | IGW_VPCname |
| state | State | |
| type | Internet Gateway Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
50.3 - 1.0
scpcli vpc internet-gateway list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]
Description
Get Internet Gateway list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
| name optional | string | Internet Gateway Name | IGW_VPCname |
| type optional | **** | Internet Gateway Type | - |
| state optional | string | State | - |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
Responses
| Name | Description | Example |
|---|---|---|
| id | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Internet Gateway Description |
| firewall_id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| loggable | NAT Loggable | False |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Internet Gateway Name | IGW_VPCname |
| state | State | |
| type | Internet Gateway Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
51 - List NAT Gateways
51.1 - 1.2
scpcli vpc nat-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--subnet_id <value>]
[--subnet_name <value>]
[--nat_gateway_ip_address <value>]
[--state <value>]
Description
Get NAT Gateway list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | NAT Gateway Name | NatGatewayName |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
| subnet_id optional | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name optional | string | Subnet Name | subnetName |
| nat_gateway_ip_address optional | string | NAT Gateway IP Address | 192.167.0.5 |
| state optional | **** | NAT Gateway State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | NAT Gateway Description | VpcEndpoint Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | NAT Gateway Name | NatGatewayName |
| nat_gateway_ip_address | NAT Gateway IP Address | 192.167.0.5 |
| publicip_id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| state | NAT Gateway State | ACTIVE |
| subnet_cidr | Subnet Cidr | 192.167.1.0/24 |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
51.2 - 1.1
scpcli vpc nat-gateway list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--name <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--subnet_id <value>]
[--subnet_name <value>]
[--nat_gateway_ip_address <value>]
[--state <value>]
Description
Get NAT Gateway list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| name optional | string | NAT Gateway Name | NatGatewayName |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
| subnet_id optional | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name optional | string | Subnet Name | subnetName |
| nat_gateway_ip_address optional | string | NAT Gateway IP Address | 192.167.0.5 |
| state optional | **** | NAT Gateway State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | NAT Gateway Description | VpcEndpoint Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | NAT Gateway Name | NatGatewayName |
| nat_gateway_ip_address | NAT Gateway IP Address | 192.167.0.5 |
| publicip_id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| state | NAT Gateway State | ACTIVE |
| subnet_cidr | Subnet Cidr | 192.167.1.0/24 |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
51.3 - 1.0
scpcli vpc nat-gateway list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--name <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--subnet_id <value>]
[--subnet_name <value>]
[--nat_gateway_ip_address <value>]
[--state <value>]
Description
Get NAT Gateway list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| name optional | string | NAT Gateway Name | NatGatewayName |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
| subnet_id optional | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name optional | string | Subnet Name | subnetName |
| nat_gateway_ip_address optional | string | NAT Gateway IP Address | 192.167.0.5 |
| state optional | **** | NAT Gateway State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | NAT Gateway Description | VpcEndpoint Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | NAT Gateway Name | NatGatewayName |
| nat_gateway_ip_address | NAT Gateway IP Address | 192.167.0.5 |
| publicip_id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| state | NAT Gateway State | ACTIVE |
| subnet_cidr | Subnet Cidr | 192.167.1.0/24 |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
52 - List Ports
52.1 - 1.2
scpcli vpc port list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--name <value>]
[--subnet_id <value>]
[--subnet_name <value>]
[--id <value>]
[--attached_resource_id <value>]
[--fixed_ip_address <value>]
[--mac_address <value>]
[--state <value>]
[--security_groups <value>]
[--attached_resource_types <value>]
Description
Get port list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | Port Limit | - |
| marker optional | string | Port Marker | - |
| sort optional | string | Port Sort | - |
| name optional | string | Port Name | portName |
| subnet_id optional | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name optional | string | Subnet Name | subnetName |
| id optional | string | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
| attached_resource_id optional | string | Connected resource ID | 9387e8f51de04a03994de8a9c3524935 |
| fixed_ip_address optional | string | Fixed IP | 192.168.1.100 |
| mac_address optional | string | MAC Address | fa:16:3e:00:00:01 |
| state optional | string | State | - |
| security_groups optional | string | Security Group List | - |
| attached_resource_types optional | **** | Attached Resource Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| attached_resource_id | Connected resource ID | 9387e8f51de04a03994de8a9c3524935 |
| attached_resource_type | Connected resource Type | |
| created_at | Created date | |
| description | Description | Port Description |
| fixed_ip_address | Fixed IP | 192.168.1.100 |
| mac_address | MAC Address | fa:16:3e:00:00:01 |
| modified_at | Modified date | |
| name | Port Name | portName |
| state | State | |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 071bc63b767444c9afaab1c972d302d5 |
| vpc_name | VPC Name | vpcName |
52.2 - 1.1
scpcli vpc port list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--name <value>]
[--subnet_id <value>]
[--subnet_name <value>]
[--id <value>]
[--attached_resource_id <value>]
[--fixed_ip_address <value>]
[--mac_address <value>]
[--state <value>]
[--security_groups <value>]
[--attached_resource_types <value>]
Description
Get port list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | Port Limit | - |
| marker optional | string | Port Marker | - |
| sort optional | string | Port Sort | - |
| name optional | string | Port Name | portName |
| subnet_id optional | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name optional | string | Subnet Name | subnetName |
| id optional | string | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
| attached_resource_id optional | string | Connected resource ID | 9387e8f51de04a03994de8a9c3524935 |
| fixed_ip_address optional | string | Fixed IP | 192.168.1.100 |
| mac_address optional | string | MAC Address | fa:16:3e:00:00:01 |
| state optional | string | State | - |
| security_groups optional | string | Security Group List | - |
| attached_resource_types optional | **** | Attached Resource Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| attached_resource_id | Connected resource ID | 9387e8f51de04a03994de8a9c3524935 |
| attached_resource_type | Connected resource Type | |
| created_at | Created date | |
| description | Description | Port Description |
| fixed_ip_address | Fixed IP | 192.168.1.100 |
| mac_address | MAC Address | fa:16:3e:00:00:01 |
| modified_at | Modified date | |
| name | Port Name | portName |
| state | State | |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 071bc63b767444c9afaab1c972d302d5 |
| vpc_name | VPC Name | vpcName |
52.3 - 1.0
scpcli vpc port list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--name <value>]
[--subnet_id <value>]
[--subnet_name <value>]
[--id <value>]
[--attached_resource_id <value>]
[--fixed_ip_address <value>]
[--mac_address <value>]
[--state <value>]
[--security_groups <value>]
[--attached_resource_types <value>]
Description
Get port list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | Port Limit | - |
| marker optional | string | Port Marker | - |
| sort optional | string | Port Sort | - |
| name optional | string | Port Name | portName |
| subnet_id optional | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name optional | string | Subnet Name | subnetName |
| id optional | string | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
| attached_resource_id optional | string | Connected resource ID | 9387e8f51de04a03994de8a9c3524935 |
| fixed_ip_address optional | string | Fixed IP | 192.168.1.100 |
| mac_address optional | string | MAC Address | fa:16:3e:00:00:01 |
| state optional | string | State | - |
| security_groups optional | string | Security Group List | - |
| attached_resource_types optional | **** | Attached Resource Type | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| attached_resource_id | Connected resource ID | 9387e8f51de04a03994de8a9c3524935 |
| attached_resource_type | Connected resource Type | |
| created_at | Created date | |
| description | Description | Port Description |
| fixed_ip_address | Fixed IP | 192.168.1.100 |
| mac_address | MAC Address | fa:16:3e:00:00:01 |
| modified_at | Modified date | |
| name | Port Name | portName |
| state | State | |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 071bc63b767444c9afaab1c972d302d5 |
| vpc_name | VPC Name | vpcName |
53 - List Private NAT
53.1 - 1.2
scpcli vpc private-nat list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--cidr <value>]
[--vpc_id <value>]
[--service_resource_id <value>]
[--service_type <value>]
[--service_resource_name <value>]
[--state <value>]
Description
Get Private NAT list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Private NAT Name | PrivateNatName |
| cidr optional | string | Private NAT IP range | 192.167.0.0/24 |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| service_resource_id optional | string | Private NAT connected Service Resource ID | 3f342bf9a557405b997c2cf48c89cbc2 |
| service_type optional | **** | Private NAT connected Service Type | DIRECT_CONNECT |
| service_resource_name optional | string | Private NAT connected Service Resource Name | Service Resource Name |
| state optional | **** | Private NAT State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | Private NAT IP range | 192.167.0.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateNat Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Private NAT Name | PrivateNatName |
| service_resource_id | Private NAT connected Service Resource ID | 3f342bf9a557405b997c2cf48c89cbc2 |
| service_resource_name | Private NAT connected Service Resource Name | PrivateNatName |
| service_type | Private NAT connected Service Type | DIRECT_CONNECT |
| state | Private NAT State | ACTIVE |
53.2 - 1.1
scpcli vpc private-nat list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--cidr <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--direct_connect_id <value>]
[--direct_connect_name <value>]
[--state <value>]
Description
Get Private NAT list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Private NAT Name | PrivateNatName |
| cidr optional | string | Private NAT IP range | 192.167.0.0/24 |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
| direct_connect_id optional | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| direct_connect_name optional | string | Direct Connect Name | DirectConnectName |
| state optional | **** | Private NAT State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | Private NAT IP range | 192.167.0.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateNat Description |
| direct_connect_id | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| direct_connect_name | Direct Connect Name | DirectConnectName |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Private NAT Name | PrivateNatName |
| state | Private NAT State | ACTIVE |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
53.3 - 1.0
scpcli vpc private-nat list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--cidr <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--direct_connect_id <value>]
[--direct_connect_name <value>]
[--state <value>]
Description
Get Private NAT list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Private NAT Name | PrivateNatName |
| cidr optional | string | Private NAT IP range | 192.167.0.0/24 |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
| direct_connect_id optional | string | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| direct_connect_name optional | string | Direct Connect Name | DirectConnectName |
| state optional | **** | Private NAT State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | Private NAT IP range | 192.167.0.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateNat Description |
| direct_connect_id | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| direct_connect_name | Direct Connect Name | DirectConnectName |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Private NAT Name | PrivateNatName |
| state | Private NAT State | ACTIVE |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
54 - List Private NAT IP
54.1 - 1.2
scpcli vpc private-nat-ip list
--private_nat_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--ip_address <value>]
[--state <value>]
[--attached_resource_type <value>]
[--attached_resource_id <value>]
[--attached_resource_name <value>]
Description
Get Private NAT IP list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| ip_address optional | string | Private NAT IP Address | - |
| state optional | **** | Private NAT IP State | - |
| attached_resource_type optional | **** | Private NAT IP Attached Resource Type | - |
| attached_resource_id optional | string | Private NAT IP Attached Resource ID | - |
| attached_resource_name optional | string | Private NAT IP Attached Resource Name | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT IP ID | |
| attached_resource_id | Private NAT IP Attached Resource ID | |
| attached_resource_name | Private NAT IP Attached Resource Name | |
| attached_resource_type | Private NAT IP Attached Resource Type | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| ip_address | Private NAT IP Address | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| private_nat_id | Private NAT ID | |
| state | Private NAT IP State |
54.2 - 1.1
scpcli vpc private-nat-ip list
--private_nat_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--ip_address <value>]
[--state <value>]
[--attached_resource_type <value>]
[--attached_resource_id <value>]
[--attached_resource_name <value>]
Description
Get Private NAT IP list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| ip_address optional | string | Private NAT IP Address | - |
| state optional | **** | Private NAT IP State | - |
| attached_resource_type optional | **** | Private NAT IP Attached Resource Type | - |
| attached_resource_id optional | string | Private NAT IP Attached Resource ID | - |
| attached_resource_name optional | string | Private NAT IP Attached Resource Name | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT IP ID | |
| attached_resource_id | Private NAT IP Attached Resource ID | |
| attached_resource_name | Private NAT IP Attached Resource Name | |
| attached_resource_type | Private NAT IP Attached Resource Type | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| ip_address | Private NAT IP Address | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| private_nat_id | Private NAT ID | |
| state | Private NAT IP State |
54.3 - 1.0
scpcli vpc private-nat-ip list
--private_nat_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--ip_address <value>]
[--state <value>]
[--attached_resource_type <value>]
[--attached_resource_id <value>]
[--attached_resource_name <value>]
Description
Get Private NAT IP list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| ip_address optional | string | Private NAT IP Address | - |
| state optional | **** | Private NAT IP State | - |
| attached_resource_type optional | **** | Private NAT IP Attached Resource Type | - |
| attached_resource_id optional | string | Private NAT IP Attached Resource ID | - |
| attached_resource_name optional | string | Private NAT IP Attached Resource Name | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT IP ID | |
| attached_resource_id | Private NAT IP Attached Resource ID | |
| attached_resource_name | Private NAT IP Attached Resource Name | |
| attached_resource_type | Private NAT IP Attached Resource Type | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| ip_address | Private NAT IP Address | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| private_nat_id | Private NAT ID | |
| state | Private NAT IP State |
55 - List PrivateLink Endpoint
55.1 - 1.2
scpcli vpc privatelink-endpoint list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--subnet_id <value>]
[--privatelink_service_id <value>]
[--endpoint_ip_address <value>]
[--state <value>]
Description
Get PrivateLink Endpoint List.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| name optional | string | PrivateLink Endpoint Name | EndpointName |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| subnet_id optional | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| privatelink_service_id optional | string | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| endpoint_ip_address optional | string | Endpoint IP Address | 192.167.1.5 |
| state optional | **** | PrivateLink Endpoint State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approval_type | PrivateLink Service Approval Type | AUTO |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| endpoint_ip_address | Endpoint IP Address | 192.167.1.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | PrivateLink Endpoint Name | EndpointName |
| privatelink_service_id | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| state | PrivateLink Endpoint State | ACTIVE |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
55.2 - 1.1
scpcli vpc privatelink-endpoint list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--subnet_id <value>]
[--privatelink_service_id <value>]
[--endpoint_ip_address <value>]
[--state <value>]
Description
Get PrivateLink Endpoint List.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| name optional | string | PrivateLink Endpoint Name | EndpointName |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| subnet_id optional | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| privatelink_service_id optional | string | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| endpoint_ip_address optional | string | Endpoint IP Address | 192.167.1.5 |
| state optional | **** | PrivateLink Endpoint State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approval_type | PrivateLink Service Approval Type | AUTO |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| endpoint_ip_address | Endpoint IP Address | 192.167.1.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | PrivateLink Endpoint Name | EndpointName |
| privatelink_service_id | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| state | PrivateLink Endpoint State | ACTIVE |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
56 - List PrivateLink Service
56.1 - 1.2
scpcli vpc privatelink-service list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--subnet_id <value>]
[--service_ip_address <value>]
[--connected_resource_id <value>]
[--connected_resource_type <value>]
[--connected_resource_name <value>]
[--connected_resource_ip_address <value>]
[--state <value>]
Description
Get PrivateLink Service List.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| name optional | string | PrivateLink Service Name | ServiceName |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| subnet_id optional | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| service_ip_address optional | string | Service IP Address | 192.167.0.5 |
| connected_resource_id optional | string | Connected Resource ID | a3e3a662a4f34442a94166df5ff9f577 |
| connected_resource_type optional | **** | Connected Resource Type | LB |
| connected_resource_name optional | string | Connected Resource Name | lbResourceName |
| connected_resource_ip_address optional | string | Connected Resource IP Address | 192.167.0.10 |
| state optional | **** | PrivateLink Service State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approval_type | PrivateLink Service Approval Type | AUTO |
| connected_resource_id | Connected Resource ID | a3e3a662a4f34442a94166df5ff9f577 |
| connected_resource_ip_address | Connected Resource IP Address | 192.167.0.10 |
| connected_resource_name | Connected Resource Name | lbResourceName |
| connected_resource_type | Connected Resource Type | LB |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | PrivateLink Service Name | ServiceName |
| service_ip_address | Service IP Address | 192.167.0.5 |
| state | PrivateLink Service State | |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
56.2 - 1.1
scpcli vpc privatelink-service list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--subnet_id <value>]
[--service_ip_address <value>]
[--connected_resource_id <value>]
[--connected_resource_type <value>]
[--connected_resource_name <value>]
[--connected_resource_ip_address <value>]
[--state <value>]
Description
Get PrivateLink Service List.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| name optional | string | PrivateLink Service Name | ServiceName |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| subnet_id optional | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| service_ip_address optional | string | Service IP Address | 192.167.0.5 |
| connected_resource_id optional | string | Connected Resource ID | a3e3a662a4f34442a94166df5ff9f577 |
| connected_resource_type optional | **** | Connected Resource Type | LB |
| connected_resource_name optional | string | Connected Resource Name | lbResourceName |
| connected_resource_ip_address optional | string | Connected Resource IP Address | 192.167.0.10 |
| state optional | **** | PrivateLink Service State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approval_type | PrivateLink Service Approval Type | AUTO |
| connected_resource_id | Connected Resource ID | a3e3a662a4f34442a94166df5ff9f577 |
| connected_resource_ip_address | Connected Resource IP Address | 192.167.0.10 |
| connected_resource_name | Connected Resource Name | lbResourceName |
| connected_resource_type | Connected Resource Type | LB |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | PrivateLink Service Name | ServiceName |
| service_ip_address | Service IP Address | 192.167.0.5 |
| state | PrivateLink Service State | |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
57 - List PublicIPs
57.1 - 1.2
scpcli vpc public-ip list
[--size <value>]
[--page <value>]
[--sort <value>]
[--ip_address <value>]
[--state <value>]
[--attached_resource_type <value>]
[--attached_resource_id <value>]
[--attached_resource_name <value>]
[--vpc_id <value>]
[--type <value>]
Description
Get PublicIP list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| ip_address optional | string | IP Address | 192.167.0.5 |
| state optional | string | PublicIP State | ATTACHED |
| attached_resource_type optional | string | PublicIP Attached Resource Type | NAT_GW |
| attached_resource_id optional | string | PublicIP Attached Resource ID | 37e6db41f5124184a43251a63124cdc9 |
| attached_resource_name optional | string | PublicIP Attached Resource Name | Attached NAT Gateway Name |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| type optional | **** | PublicIP Type | IGW |
Responses
| Name | Description | Example |
|---|---|---|
| id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| attached_resource_id | PublicIP Attached Resource ID | 37e6db41f5124184a43251a63124cdc9 |
| attached_resource_name | PublicIP Attached Resource Name | Attached NAT Gateway Name |
| attached_resource_type | PublicIP Attached Resource Type | NAT_GW |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | PublicIP Description | Public IP Description |
| ip_address | IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | PublicIP State | ATTACHED |
| type | PublicIP Type | IGW |
57.2 - 1.1
scpcli vpc public-ip list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--ip_address <value>]
[--state <value>]
[--attached_resource_type <value>]
[--attached_resource_id <value>]
[--attached_resource_name <value>]
[--vpc_id <value>]
[--type <value>]
Description
Get PublicIP list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| ip_address optional | string | IP Address | 192.167.0.5 |
| state optional | string | PublicIP State | ATTACHED |
| attached_resource_type optional | string | PublicIP Attached Resource Type | NAT_GW |
| attached_resource_id optional | string | PublicIP Attached Resource ID | 37e6db41f5124184a43251a63124cdc9 |
| attached_resource_name optional | string | PublicIP Attached Resource Name | Attached NAT Gateway Name |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| type optional | **** | PublicIP Type | IGW |
Responses
| Name | Description | Example |
|---|---|---|
| id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| attached_resource_id | PublicIP Attached Resource ID | 37e6db41f5124184a43251a63124cdc9 |
| attached_resource_name | PublicIP Attached Resource Name | Attached NAT Gateway Name |
| attached_resource_type | PublicIP Attached Resource Type | NAT_GW |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | PublicIP Description | Public IP Description |
| ip_address | IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | PublicIP State | ATTACHED |
| type | PublicIP Type | IGW |
57.3 - 1.0
scpcli vpc public-ip list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--ip_address <value>]
[--state <value>]
[--attached_resource_type <value>]
[--attached_resource_id <value>]
[--attached_resource_name <value>]
[--vpc_id <value>]
[--type <value>]
Description
Get PublicIP list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| ip_address optional | string | IP Address | 192.167.0.5 |
| state optional | string | PublicIP State | ATTACHED |
| attached_resource_type optional | string | PublicIP Attached Resource Type | NAT_GW |
| attached_resource_id optional | string | PublicIP Attached Resource ID | 37e6db41f5124184a43251a63124cdc9 |
| attached_resource_name optional | string | PublicIP Attached Resource Name | Attached NAT Gateway Name |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| type optional | **** | PublicIP Type | IGW |
Responses
| Name | Description | Example |
|---|---|---|
| id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| attached_resource_id | PublicIP Attached Resource ID | 37e6db41f5124184a43251a63124cdc9 |
| attached_resource_name | PublicIP Attached Resource Name | Attached NAT Gateway Name |
| attached_resource_type | PublicIP Attached Resource Type | NAT_GW |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | PublicIP Description | Public IP Description |
| ip_address | IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | PublicIP State | ATTACHED |
| type | PublicIP Type | IGW |
58 - List Subnet Vips
58.1 - 1.2
scpcli vpc subnet vip list
--subnet_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--virtual_ip_address <value>]
[--public_ip_address <value>]
Description
Get list Subnet Vip
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| virtual_ip_address optional | string | Virtual IP Address | 192.168.20.6 |
| public_ip_address optional | string | Public IP Address | 100.112.9.84 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Subnet Vip Id | 0466a9448d9a4411a86055939e451c8f |
| connected_port_count | Connected Port Count | 2 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | State | ACTIVE |
| static_nat | Static NAT Info | |
| virtual_ip_address | Virtual IP Address | 192.168.20.6 |
59 - List Subnets
59.1 - 1.2
scpcli vpc subnet list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--cidr <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]
Description
Get subnet list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| name optional | string | Subnet Name | subnetName |
| type optional | **** | Subnet Type | - |
| cidr optional | string | Subnet Cidr | 192.167.1.0/24 |
| state optional | **** | State | - |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
Responses
| Name | Description | Example |
|---|---|---|
| id | Subnet Id | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | Subnet Cidr | 192.167.1.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| gateway_ip_address | Gateway IP Address | 192.167.1.1 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Subnet Name | subnetName |
| state | State | |
| type | Subnet Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
59.2 - 1.1
scpcli vpc subnet list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]
Description
Get subnet list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| name optional | string | Subnet Name | subnetName |
| type optional | **** | Subnet Type | - |
| state optional | **** | State | - |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
Responses
| Name | Description | Example |
|---|---|---|
| id | Subnet Id | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | Subnet Cidr | 192.167.1.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| gateway_ip_address | Gateway IP Address | 192.167.1.1 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Subnet Name | subnetName |
| state | State | |
| type | Subnet Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
59.3 - 1.0
scpcli vpc subnet list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]
Description
Get subnet list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| name optional | string | Subnet Name | subnetName |
| type optional | **** | Subnet Type | - |
| state optional | **** | State | - |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
Responses
| Name | Description | Example |
|---|---|---|
| id | Subnet Id | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | Subnet Cidr | 192.167.1.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| gateway_ip_address | Gateway IP Address | 192.167.1.1 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Subnet Name | subnetName |
| state | State | |
| type | Subnet Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
60 - List Transit Gateway Rules
60.1 - 1.2
scpcli vpc transit-gateway-rule list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--tgw_connection_vpc_id <value>]
[--tgw_connection_vpc_name <value>]
[--source_type <value>]
[--destination_type <value>]
[--destination_cidr <value>]
[--state <value>]
[--rule_type <value>]
Description
Get Transit Gateway Rule list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| tgw_connection_vpc_id optional | string | VPC ID Connected to Transit Gateway. | ffeced8e191c478eabd66b6e2cab8e34 |
| tgw_connection_vpc_name optional | string | VPC Name Connected to Transit Gateway. | ConnectedVpcName |
| source_type optional | **** | Source Type | TGW |
| destination_type optional | **** | Destination Type | VPC |
| destination_cidr optional | string | Destination CIDR | 192.167.5.0/24 |
| state optional | **** | State | ACTIVE |
| rule_type optional | **** | Rule Type | TGW_VPC |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Routing Rule Description |
| destination_cidr | Destination CIDR | 192.167.5.0/24 |
| destination_resource_id | Destination Resource ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| destination_resource_name | Destination Resource Name | VpcName |
| destination_type | Destination Type | VPC |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| rule_type | Rule Type | TGW_VPC |
| source_resource_id | Source Resource ID | 8582cc5d89994a42ad53282fd4a8d8be |
| source_resource_name | Source Resource Name | TgwName |
| source_type | Source Type | TGW |
| state | State | ACTIVE |
| tgw_connection_vpc_id | VPC ID Connected to Transit Gateway. | ffeced8e191c478eabd66b6e2cab8e34 |
| tgw_connection_vpc_name | VPC Name Connected to Transit Gateway. | ConnectedVpcName |
60.2 - 1.1
scpcli vpc transit-gateway-rule list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--tgw_connection_vpc_id <value>]
[--tgw_connection_vpc_name <value>]
[--source_type <value>]
[--destination_type <value>]
[--destination_cidr <value>]
[--state <value>]
Description
Get Transit Gateway Rule list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| tgw_connection_vpc_id optional | string | VPC ID Connected to Transit Gateway. | ffeced8e191c478eabd66b6e2cab8e34 |
| tgw_connection_vpc_name optional | string | VPC Name Connected to Transit Gateway. | ConnectedVpcName |
| source_type optional | **** | Source Type | TGW |
| destination_type optional | **** | Destination Type | VPC |
| destination_cidr optional | string | Destination CIDR | 192.167.5.0/24 |
| state optional | **** | State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Routing Rule Description |
| destination_cidr | Destination CIDR | 192.167.5.0/24 |
| destination_resource_id | Destination Resource ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| destination_resource_name | Destination Resource Name | VpcName |
| destination_type | Destination Type | VPC |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| source_resource_id | Source Resource ID | 8582cc5d89994a42ad53282fd4a8d8be |
| source_resource_name | Source Resource Name | TgwName |
| source_type | Source Type | TGW |
| state | State | ACTIVE |
| tgw_connection_vpc_id | VPC ID Connected to Transit Gateway. | ffeced8e191c478eabd66b6e2cab8e34 |
| tgw_connection_vpc_name | VPC Name Connected to Transit Gateway. | ConnectedVpcName |
60.3 - 1.0
scpcli vpc transit-gateway-rule list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--tgw_connection_vpc_id <value>]
[--tgw_connection_vpc_name <value>]
[--source_type <value>]
[--destination_type <value>]
[--destination_cidr <value>]
[--state <value>]
Description
Get Transit Gateway Rule list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| tgw_connection_vpc_id optional | string | VPC ID Connected to Transit Gateway. | ffeced8e191c478eabd66b6e2cab8e34 |
| tgw_connection_vpc_name optional | string | VPC Name Connected to Transit Gateway. | ConnectedVpcName |
| source_type optional | **** | Source Type | TGW |
| destination_type optional | **** | Destination Type | VPC |
| destination_cidr optional | string | Destination CIDR | 192.167.5.0/24 |
| state optional | **** | State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Routing Rule Description |
| destination_cidr | Destination CIDR | 192.167.5.0/24 |
| destination_resource_id | Destination Resource ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| destination_resource_name | Destination Resource Name | VpcName |
| destination_type | Destination Type | VPC |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| source_resource_id | Source Resource ID | 8582cc5d89994a42ad53282fd4a8d8be |
| source_resource_name | Source Resource Name | TgwName |
| source_type | Source Type | TGW |
| state | State | ACTIVE |
| tgw_connection_vpc_id | VPC ID Connected to Transit Gateway. | ffeced8e191c478eabd66b6e2cab8e34 |
| tgw_connection_vpc_name | VPC Name Connected to Transit Gateway. | ConnectedVpcName |
61 - List Transit Gateway VPC Connections
61.1 - 1.2
scpcli vpc transit-gateway-vpc-connection list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--state <value>]
Description
Get Transit Gateway VPC Connection list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Transit Gateway VPC Connection ID | ffeced8e191c478eabd66b6e2cab8e34 |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
| state optional | **** | State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway VPC Connection ID | ffeced8e191c478eabd66b6e2cab8e34 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | State | ACTIVE |
| transit_gateway_id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
61.2 - 1.1
scpcli vpc transit-gateway-vpc-connection list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--state <value>]
Description
Get Transit Gateway VPC Connection list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Transit Gateway VPC Connection ID | ffeced8e191c478eabd66b6e2cab8e34 |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
| state optional | **** | State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway VPC Connection ID | ffeced8e191c478eabd66b6e2cab8e34 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | State | ACTIVE |
| transit_gateway_id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
61.3 - 1.0
scpcli vpc transit-gateway-vpc-connection list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--state <value>]
Description
Get Transit Gateway VPC Connection list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Transit Gateway VPC Connection ID | ffeced8e191c478eabd66b6e2cab8e34 |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
| state optional | **** | State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway VPC Connection ID | ffeced8e191c478eabd66b6e2cab8e34 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | State | ACTIVE |
| transit_gateway_id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
62 - List Transit Gateways
62.1 - 1.2
scpcli vpc transit-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
[--firewall_connection_state <value>]
Description
Get Transit Gateway list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| name optional | string | Transit Gateway Name | TransitGatewayName |
| state optional | **** | State | ACTIVE |
| firewall_connection_state optional | **** | Firewall Connection State | INACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Transit Gateway Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Transit Gateway Description | TransitGateway Description |
| firewall_connection_state | Firewall Connection State | INACTIVE |
| firewall_ids | Firewall ID | [‘bbb93aca123f4bb2b2c0f206f4a86b2b’] |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Transit Gateway Name | TransitGatewayName |
| state | State | ACTIVE |
| uplink_enabled | Uplink Enabled | False |
62.2 - 1.1
scpcli vpc transit-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
Description
Get Transit Gateway list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| name optional | string | Transit Gateway Name | TransitGatewayName |
| state optional | **** | State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Transit Gateway Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Transit Gateway Description | TransitGateway Description |
| firewall_ids | Firewall ID | [‘bbb93aca123f4bb2b2c0f206f4a86b2b’] |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Transit Gateway Name | TransitGatewayName |
| state | State | ACTIVE |
| uplink_enabled | Uplink Enabled | False |
62.3 - 1.0
scpcli vpc transit-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
Description
Get Transit Gateway list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| name optional | string | Transit Gateway Name | TransitGatewayName |
| state optional | **** | State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Transit Gateway Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Transit Gateway Description | TransitGateway Description |
| firewall_ids | Firewall ID | [‘bbb93aca123f4bb2b2c0f206f4a86b2b’] |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Transit Gateway Name | TransitGatewayName |
| state | State | ACTIVE |
| uplink_enabled | Uplink Enabled | False |
63 - List VPC Endpoint
63.1 - 1.2
scpcli vpc vpc-endpoint list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--subnet_id <value>]
[--resource_key <value>]
[--resource_type <value>]
[--endpoint_ip_address <value>]
[--state <value>]
Description
Get VPC Endpoint list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
| name optional | string | VPC Endpoint Name | VpcEndpointName |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
| subnet_id optional | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| resource_key optional | string | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_type optional | **** | VPC Endpoint Resource Type | FS |
| endpoint_ip_address optional | string | VPC Endpoint IP Address | 192.167.0.5 |
| state optional | **** | VPC Endpoint State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | VpcEndpoint Description |
| endpoint_ip_address | VPC Endpoint IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Endpoint Name | VpcEndpointName |
| resource_info | VPC Endpoint Resource Key Info | x.samsungsdscloud.com(Registry) |
| resource_key | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_type | VPC Endpoint Resource Type | FS |
| state | VPC Endpoint State | ACTIVE |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
63.2 - 1.1
scpcli vpc vpc-endpoint list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--subnet_id <value>]
[--resource_key <value>]
[--resource_type <value>]
[--endpoint_ip_address <value>]
[--state <value>]
Description
Get VPC Endpoint list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| id optional | string | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
| name optional | string | VPC Endpoint Name | VpcEndpointName |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
| subnet_id optional | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| resource_key optional | string | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_type optional | **** | VPC Endpoint Resource Type | FS |
| endpoint_ip_address optional | string | VPC Endpoint IP Address | 192.167.0.5 |
| state optional | **** | VPC Endpoint State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | VpcEndpoint Description |
| endpoint_ip_address | VPC Endpoint IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Endpoint Name | VpcEndpointName |
| resource_info | VPC Endpoint Resource Key Info | x.samsungsdscloud.com(Registry) |
| resource_key | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_type | VPC Endpoint Resource Type | FS |
| state | VPC Endpoint State | ACTIVE |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
63.3 - 1.0
scpcli vpc vpc-endpoint list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--subnet_id <value>]
[--resource_key <value>]
[--resource_type <value>]
[--endpoint_ip_address <value>]
[--state <value>]
Description
Get VPC Endpoint list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| id optional | string | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
| name optional | string | VPC Endpoint Name | VpcEndpointName |
| vpc_id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name optional | string | VPC Name | vpcName |
| subnet_id optional | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| resource_key optional | string | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_type optional | **** | VPC Endpoint Resource Type | FS |
| endpoint_ip_address optional | string | VPC Endpoint IP Address | 192.167.0.5 |
| state optional | **** | VPC Endpoint State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | VpcEndpoint Description |
| endpoint_ip_address | VPC Endpoint IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Endpoint Name | VpcEndpointName |
| resource_info | VPC Endpoint Resource Key Info | x.samsungsdscloud.com(Registry) |
| resource_key | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_type | VPC Endpoint Resource Type | FS |
| state | VPC Endpoint State | ACTIVE |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
64 - List VPC Endpoint Connectable Resources
64.1 - 1.2
scpcli vpc vpc-endpoint-connectable-resource list
--resource_type <value>
[--vpc_id <value>]
Description
List VpcEndpoint connectable resources
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_type required | **** | VPC Endpoint Resource Type | FS |
| vpc_id optional | string | VPC ID(required if resource_type is DNS) | 7df8abb4912e4709b1cb237daccca7a8 |
Responses
| Name | Description | Example |
|---|---|---|
| resource_info | VPC Endpoint Resource Key Info | x.samsungsdscloud.com(Registry) |
| resource_key | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_type | VPC Endpoint Resource Type | FS |
64.2 - 1.1
scpcli vpc vpc-endpoint-connectable-resource list
--resource_type <value>
[--vpc_id <value>]
Description
List VpcEndpoint connectable resources
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_type required | **** | VPC Endpoint Resource Type | FS |
| vpc_id optional | string | VPC ID(required if resource_type is DNS) | 7df8abb4912e4709b1cb237daccca7a8 |
Responses
| Name | Description | Example |
|---|---|---|
| resource_info | VPC Endpoint Resource Key Info | x.samsungsdscloud.com(Registry) |
| resource_key | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_type | VPC Endpoint Resource Type | FS |
64.3 - 1.0
scpcli vpc vpc-endpoint-connectable-resource list
--resource_type <value>
[--vpc_id <value>]
Description
List VpcEndpoint connectable resources
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| resource_type required | **** | VPC Endpoint Resource Type | FS |
| vpc_id optional | string | VPC ID(required if resource_type is DNS) | 7df8abb4912e4709b1cb237daccca7a8 |
Responses
| Name | Description | Example |
|---|---|---|
| resource_info | VPC Endpoint Resource Key Info | x.samsungsdscloud.com(Registry) |
| resource_key | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_type | VPC Endpoint Resource Type | FS |
65 - List VPC Peering
65.1 - 1.2
scpcli vpc vpc-peering list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--requester_vpc_id <value>]
[--requester_vpc_name <value>]
[--approver_vpc_id <value>]
[--approver_vpc_name <value>]
[--account_type <value>]
[--state <value>]
Description
Get VPC Peering list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| name optional | string | VPC Peering Name | vpcPeeringName |
| requester_vpc_id optional | string | Requester VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| requester_vpc_name optional | string | Requester VPC Name | vpcName |
| approver_vpc_id optional | string | Approver VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| approver_vpc_name optional | string | Approver VPC Name | vpcName |
| account_type optional | **** | Account Type | - |
| state optional | **** | State | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| account_type | Account Type | |
| approver_vpc_account_id | Approver VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approver_vpc_id | Approver VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| approver_vpc_name | Approver VPC Name | vpcName |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| delete_requester_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| description | VPC Peering Description | vpcPeering Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Peering Name | vpcPeeringName |
| requester_vpc_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| requester_vpc_id | Requester VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| requester_vpc_name | Requester VPC Name | vpcName |
| state | State |
65.2 - 1.1
scpcli vpc vpc-peering list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--requester_vpc_id <value>]
[--requester_vpc_name <value>]
[--approver_vpc_id <value>]
[--approver_vpc_name <value>]
[--account_type <value>]
[--state <value>]
Description
Get VPC Peering list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| name optional | string | VPC Peering Name | vpcPeeringName |
| requester_vpc_id optional | string | Requester VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| requester_vpc_name optional | string | Requester VPC Name | vpcName |
| approver_vpc_id optional | string | Approver VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| approver_vpc_name optional | string | Approver VPC Name | vpcName |
| account_type optional | **** | Account Type | - |
| state optional | **** | State | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| account_type | Account Type | |
| approver_vpc_account_id | Approver VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approver_vpc_id | Approver VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| approver_vpc_name | Approver VPC Name | vpcName |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| delete_requester_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| description | VPC Peering Description | vpcPeering Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Peering Name | vpcPeeringName |
| requester_vpc_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| requester_vpc_id | Requester VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| requester_vpc_name | Requester VPC Name | vpcName |
| state | State |
65.3 - 1.0
scpcli vpc vpc-peering list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--requester_vpc_id <value>]
[--requester_vpc_name <value>]
[--approver_vpc_id <value>]
[--approver_vpc_name <value>]
[--account_type <value>]
[--state <value>]
Description
Get VPC Peering list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| name optional | string | VPC Peering Name | vpcPeeringName |
| requester_vpc_id optional | string | Requester VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| requester_vpc_name optional | string | Requester VPC Name | vpcName |
| approver_vpc_id optional | string | Approver VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| approver_vpc_name optional | string | Approver VPC Name | vpcName |
| account_type optional | **** | Account Type | - |
| state optional | **** | State | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| account_type | Account Type | |
| approver_vpc_account_id | Approver VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approver_vpc_id | Approver VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| approver_vpc_name | Approver VPC Name | vpcName |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| delete_requester_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| description | VPC Peering Description | vpcPeering Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Peering Name | vpcPeeringName |
| requester_vpc_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| requester_vpc_id | Requester VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| requester_vpc_name | Requester VPC Name | vpcName |
| state | State |
66 - List VPC Peering Rules
66.1 - 1.2
scpcli vpc vpc-peering-routing-rule list
--vpc_peering_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--source_vpc_id <value>]
[--source_vpc_type <value>]
[--destination_vpc_id <value>]
[--destination_vpc_type <value>]
[--destination_cidr <value>]
[--state <value>]
Description
Get VPC Peering Rule list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | VPC Peering Rule ID | - |
| source_vpc_id optional | string | Source VPC ID | - |
| source_vpc_type optional | **** | Source VPC Type | - |
| destination_vpc_id optional | string | Destination VPC ID | - |
| destination_vpc_type optional | **** | Destination VPC Type | - |
| destination_cidr optional | string | Destination CIDR | - |
| state optional | **** | State | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering Rule ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| destination_cidr | Destination CIDR | |
| destination_vpc_id | Destination VPC ID | |
| destination_vpc_name | Destination VPC Name | |
| destination_vpc_type | Destination VPC Type | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| source_vpc_id | Source VPC ID | |
| source_vpc_name | Source VPC Name | |
| source_vpc_type | Source VPC Type | |
| state | State | |
| vpc_peering_id | VPC Peering ID |
66.2 - 1.1
scpcli vpc vpc-peering-routing-rule list
--vpc_peering_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--source_vpc_id <value>]
[--source_vpc_type <value>]
[--destination_vpc_id <value>]
[--destination_vpc_type <value>]
[--destination_cidr <value>]
[--state <value>]
[--name <value>]
Description
Get VPC Peering Rule list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | VPC Peering Rule ID | - |
| source_vpc_id optional | string | Source VPC ID | - |
| source_vpc_type optional | **** | Source VPC Type | - |
| destination_vpc_id optional | string | Destination VPC ID | - |
| destination_vpc_type optional | **** | Destination VPC Type | - |
| destination_cidr optional | string | Destination CIDR | - |
| state optional | **** | State | - |
| name optional | string | VPC Peering Name | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering Rule ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| destination_cidr | Destination CIDR | |
| destination_vpc_id | Destination VPC ID | |
| destination_vpc_name | Destination VPC Name | |
| destination_vpc_type | Destination VPC Type | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| source_vpc_id | Source VPC ID | |
| source_vpc_name | Source VPC Name | |
| source_vpc_type | Source VPC Type | |
| state | State | |
| vpc_peering_id | VPC Peering ID |
66.3 - 1.0
scpcli vpc vpc-peering-routing-rule list
--vpc_peering_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--source_vpc_id <value>]
[--source_vpc_type <value>]
[--destination_vpc_id <value>]
[--destination_vpc_type <value>]
[--destination_cidr <value>]
[--state <value>]
[--name <value>]
Description
Get VPC Peering Rule list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | VPC Peering Rule ID | - |
| source_vpc_id optional | string | Source VPC ID | - |
| source_vpc_type optional | **** | Source VPC Type | - |
| destination_vpc_id optional | string | Destination VPC ID | - |
| destination_vpc_type optional | **** | Destination VPC Type | - |
| destination_cidr optional | string | Destination CIDR | - |
| state optional | **** | State | - |
| name optional | string | VPC Peering Name | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering Rule ID | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| destination_cidr | Destination CIDR | |
| destination_vpc_id | Destination VPC ID | |
| destination_vpc_name | Destination VPC Name | |
| destination_vpc_type | Destination VPC Type | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| source_vpc_id | Source VPC ID | |
| source_vpc_name | Source VPC Name | |
| source_vpc_type | Source VPC Type | |
| state | State | |
| vpc_peering_id | VPC Peering ID |
67 - List VPCs
67.1 - 1.2
scpcli vpc vpc list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
[--cidr <value>]
Description
Get VPC list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| name optional | string | VPC Name | vpcName |
| state optional | **** | State | - |
| cidr optional | string | VPC Cidr | 192.167.0.0/18 |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr_count | Cidr Count | 20 |
| cidrs | ||
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | vpcDescription |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Name | vpcName |
| state | State |
67.2 - 1.1
scpcli vpc vpc list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
[--cidr <value>]
Description
Get VPC list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| name optional | string | VPC Name | vpcName |
| state optional | **** | State | - |
| cidr optional | string | VPC Cidr | 192.167.0.0/18 |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | VPC Cidr | 192.167.0.0/18 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | vpcDescription |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Name | vpcName |
| state | State |
67.3 - 1.0
scpcli vpc vpc list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
[--cidr <value>]
Description
Get VPC list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | string | with count | true |
| limit optional | integer | limit | 20 |
| marker optional | string | marker | 607e0938521643b5b4b266f343fae693 |
| sort optional | string | sort | created_at:desc |
| id optional | string | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| name optional | string | VPC Name | vpcName |
| state optional | **** | State | - |
| cidr optional | string | VPC Cidr | 192.167.0.0/18 |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | VPC Cidr | 192.167.0.0/18 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | vpcDescription |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Name | vpcName |
| state | State |
68 - Request PrivateLink Endpoint
68.1 - 1.2
scpcli vpc privatelink-endpoint request
--privatelink_endpoint_id <value>
--type <value>
Description
Request PrivateLink Endpoint
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| type required | string | PrivateLink Endpoint Action Type | CANCEL |
68.2 - 1.1
scpcli vpc privatelink-endpoint request
--privatelink_endpoint_id <value>
--type <value>
Description
Request PrivateLink Endpoint
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| type required | string | PrivateLink Endpoint Action Type | CANCEL |
69 - Set Internet Gateway
69.1 - 1.2
scpcli vpc internet-gateway set
--internet_gateway_id <value>
[--description <value>]
[--loggable <value>]
Description
Set Internet Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| internet_gateway_id required | string | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
| description optional | string | Description | Internet Gateway Description |
| loggable optional | boolean | NAT Loggable | - |
69.2 - 1.1
scpcli vpc internet-gateway set
--internet_gateway_id <value>
[--description <value>]
[--loggable <value>]
Description
Set Internet Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| internet_gateway_id required | string | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
| description optional | string | Description | Internet Gateway Description |
| loggable optional | boolean | NAT Loggable | - |
69.3 - 1.0
scpcli vpc internet-gateway set
--internet_gateway_id <value>
[--description <value>]
[--loggable <value>]
Description
Set Internet Gateway.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| internet_gateway_id required | string | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
| description optional | string | Description | Internet Gateway Description |
| loggable optional | boolean | NAT Loggable | - |
70 - Set NAT Gateway
70.1 - 1.2
scpcli vpc nat-gateway set
--nat_gateway_id <value>
[--description <value>]
Description
Set NAT Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nat_gateway_id required | string | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
| description optional | string | NAT Gateway Description | VpcEndpoint Description |
70.2 - 1.1
scpcli vpc nat-gateway set
--nat_gateway_id <value>
[--description <value>]
Description
Set NAT Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nat_gateway_id required | string | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
| description optional | string | NAT Gateway Description | VpcEndpoint Description |
70.3 - 1.0
scpcli vpc nat-gateway set
--nat_gateway_id <value>
[--description <value>]
Description
Set NAT Gateway.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nat_gateway_id required | string | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
| description optional | string | NAT Gateway Description | VpcEndpoint Description |
71 - Set Port
71.1 - 1.2
scpcli vpc port set
--port_id <value>
[--description <value>]
[--security_groups <value>]
Description
Set port.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
| description optional | string | Description | Port Description |
| security_groups optional | array | Security Group List | - |
71.2 - 1.1
scpcli vpc port set
--port_id <value>
[--description <value>]
[--security_groups <value>]
Description
Set port.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
| description optional | string | Description | Port Description |
| security_groups optional | array | Security Group List | - |
71.3 - 1.0
scpcli vpc port set
--port_id <value>
[--description <value>]
[--security_groups <value>]
Description
Set port.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
| description optional | string | Description | Port Description |
| security_groups optional | array | Security Group List | - |
72 - Set Private NAT
72.1 - 1.2
scpcli vpc private-nat set
--private_nat_id <value>
[--description <value>]
Description
Set Private NAT.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| description optional | string | Description | PrivateNat Description |
72.2 - 1.1
scpcli vpc private-nat set
--private_nat_id <value>
[--description <value>]
Description
Set Private NAT.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| description optional | string | Description | PrivateNat Description |
72.3 - 1.0
scpcli vpc private-nat set
--private_nat_id <value>
[--description <value>]
Description
Set Private NAT.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| description optional | string | Description | PrivateNat Description |
73 - Set PrivateLink Endpoint
73.1 - 1.2
scpcli vpc privatelink-endpoint set
--privatelink_endpoint_id <value>
[--description <value>]
Description
Set PrivateLink Endpoint.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| description optional | string | Description | PrivateLink Endpoint Description |
73.2 - 1.1
scpcli vpc privatelink-endpoint set
--privatelink_endpoint_id <value>
[--description <value>]
Description
Set PrivateLink Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| description optional | string | Description | PrivateLink Endpoint Description |
74 - Set PrivateLink Service
74.1 - 1.2
scpcli vpc privatelink-service set
--privatelink_service_id <value>
[--description <value>]
Description
Set PrivateLink Service.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_service_id required | string | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| description optional | string | Description | PrivateLink Service Description |
74.2 - 1.1
scpcli vpc privatelink-service set
--privatelink_service_id <value>
[--description <value>]
Description
Set PrivateLink Service.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_service_id required | string | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| description optional | string | Description | PrivateLink Service Description |
75 - Set PublicIP
75.1 - 1.2
scpcli vpc public-ip set
--publicip_id <value>
--description <value>
Description
Set PublicIP.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| publicip_id required | string | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| description required | string | PublicIP Description | Public IP Description |
75.2 - 1.1
scpcli vpc public-ip set
--publicip_id <value>
--description <value>
Description
Set PublicIP.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| publicip_id required | string | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| description required | string | PublicIP Description | Public IP Description |
75.3 - 1.0
scpcli vpc public-ip set
--publicip_id <value>
--description <value>
Description
Set PublicIP.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| publicip_id required | string | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| description required | string | PublicIP Description | Public IP Description |
76 - Set Subnet
76.1 - 1.2
scpcli vpc subnet set
--subnet_id <value>
[--description <value>]
[--dhcp_ip_address <value>]
Description
Set subnet.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| description optional | string | Description | Subnet Description |
| dhcp_ip_address optional | string | DHCP IP Address | - |
76.2 - 1.1
scpcli vpc subnet set
--subnet_id <value>
--description <value>
Description
Set subnet.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| description required | string | Description | Subnet Description |
76.3 - 1.0
scpcli vpc subnet set
--subnet_id <value>
--description <value>
Description
Set subnet.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| description required | string | Description | Subnet Description |
77 - Set Subnet Vip
77.1 - 1.2
scpcli vpc subnet vip set
--vip_id <value>
--subnet_id <value>
--description <value>
Description
Set Subnet Vip
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vip_id required | string | Subnet Vip Id | 0466a9448d9a4411a86055939e451c8f |
| subnet_id required | string | Subnet ID | 023c57b14f11483689338d085e061492 |
| description required | string | Description | Subnet VIP Description |
78 - Set Transit Gateway
78.1 - 1.2
scpcli vpc transit-gateway set
--transit_gateway_id <value>
[--description <value>]
Description
Set Transit Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| description optional | string | Description | TransitGateway Description |
78.2 - 1.1
scpcli vpc transit-gateway set
--transit_gateway_id <value>
[--description <value>]
Description
Set Transit Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| description optional | string | Description | TransitGateway Description |
78.3 - 1.0
scpcli vpc transit-gateway set
--transit_gateway_id <value>
[--description <value>]
Description
Set Transit Gateway.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| description optional | string | Description | TransitGateway Description |
79 - Set VPC
79.1 - 1.2
scpcli vpc vpc set
--vpc_id <value>
[--description <value>]
Description
Set VPC.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | - |
| description optional | string | Description | vpcDescription |
79.2 - 1.1
scpcli vpc vpc set
--vpc_id <value>
[--description <value>]
Description
Set VPC.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | - |
| description optional | string | Description | vpcDescription |
79.3 - 1.0
scpcli vpc vpc set
--vpc_id <value>
[--description <value>]
Description
Set VPC.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | - |
| description optional | string | Description | vpcDescription |
80 - Set VPC Endpoint
80.1 - 1.2
scpcli vpc vpc-endpoint set
--vpc_endpoint_id <value>
[--description <value>]
Description
Set VPC Endpoint.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_endpoint_id required | string | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
| description optional | string | Description | VpcEndpoint Description |
80.2 - 1.1
scpcli vpc vpc-endpoint set
--vpc_endpoint_id <value>
[--description <value>]
Description
Set VPC Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_endpoint_id required | string | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
| description optional | string | Description | VpcEndpoint Description |
80.3 - 1.0
scpcli vpc vpc-endpoint set
--vpc_endpoint_id <value>
[--description <value>]
Description
Set VPC Endpoint.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_endpoint_id required | string | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
| description optional | string | Description | VpcEndpoint Description |
81 - Set VPC Peering
81.1 - 1.2
scpcli vpc vpc-peering set
--vpc_peering_id <value>
[--description <value>]
Description
Set VPC Peering.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| description optional | string | Description | vpcPeering Description |
81.2 - 1.1
scpcli vpc vpc-peering set
--vpc_peering_id <value>
[--description <value>]
Description
Set VPC Peering.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| description optional | string | Description | vpcPeering Description |
81.3 - 1.0
scpcli vpc vpc-peering set
--vpc_peering_id <value>
[--description <value>]
Description
Set VPC Peering.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| description optional | string | Description | vpcPeering Description |
82 - Show Internet Gateway
82.1 - 1.2
scpcli vpc internet-gateway show
--internet_gateway_id <value>
Description
Show Internet Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| internet_gateway_id required | string | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Internet Gateway Description |
| firewall_id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| loggable | NAT Loggable | False |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Internet Gateway Name | IGW_VPCname |
| state | State | |
| type | Internet Gateway Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
82.2 - 1.1
scpcli vpc internet-gateway show
--internet_gateway_id <value>
Description
Show Internet Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| internet_gateway_id required | string | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Internet Gateway Description |
| firewall_id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| loggable | NAT Loggable | False |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Internet Gateway Name | IGW_VPCname |
| state | State | |
| type | Internet Gateway Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
82.3 - 1.0
scpcli vpc internet-gateway show
--internet_gateway_id <value>
Description
Show Internet Gateway.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| internet_gateway_id required | string | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Internet Gateway ID | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Internet Gateway Description |
| firewall_id | Firewall ID | b156740b6335468d8354eb9ef8eddf5a |
| loggable | NAT Loggable | False |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Internet Gateway Name | IGW_VPCname |
| state | State | |
| type | Internet Gateway Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
83 - Show NAT Gateway
83.1 - 1.2
scpcli vpc nat-gateway show
--nat_gateway_id <value>
Description
Show NAT Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nat_gateway_id required | string | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
Responses
| Name | Description | Example |
|---|---|---|
| id | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | NAT Gateway Description | VpcEndpoint Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | NAT Gateway Name | NatGatewayName |
| nat_gateway_ip_address | NAT Gateway IP Address | 192.167.0.5 |
| publicip_id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| state | NAT Gateway State | ACTIVE |
| subnet_cidr | Subnet Cidr | 192.167.1.0/24 |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
83.2 - 1.1
scpcli vpc nat-gateway show
--nat_gateway_id <value>
Description
Show NAT Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nat_gateway_id required | string | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
Responses
| Name | Description | Example |
|---|---|---|
| id | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | NAT Gateway Description | VpcEndpoint Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | NAT Gateway Name | NatGatewayName |
| nat_gateway_ip_address | NAT Gateway IP Address | 192.167.0.5 |
| publicip_id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| state | NAT Gateway State | ACTIVE |
| subnet_cidr | Subnet Cidr | 192.167.1.0/24 |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
83.3 - 1.0
scpcli vpc nat-gateway show
--nat_gateway_id <value>
Description
Show NAT Gateway.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| nat_gateway_id required | string | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
Responses
| Name | Description | Example |
|---|---|---|
| id | NAT Gateway ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | NAT Gateway Description | VpcEndpoint Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | NAT Gateway Name | NatGatewayName |
| nat_gateway_ip_address | NAT Gateway IP Address | 192.167.0.5 |
| publicip_id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| state | NAT Gateway State | ACTIVE |
| subnet_cidr | Subnet Cidr | 192.167.1.0/24 |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
84 - Show Port
84.1 - 1.2
scpcli vpc port show
--port_id <value>
Description
Show port.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
Responses
| Name | Description | Example |
|---|---|---|
| port |
84.2 - 1.1
scpcli vpc port show
--port_id <value>
Description
Show port.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
Responses
| Name | Description | Example |
|---|---|---|
| port |
84.3 - 1.0
scpcli vpc port show
--port_id <value>
Description
Show port.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| port_id required | string | Port ID | 023c57b1-4f11-4836-8933-8d085e061492 |
Responses
| Name | Description | Example |
|---|---|---|
| port |
85 - Show Private NAT
85.1 - 1.2
scpcli vpc private-nat show
--private_nat_id <value>
Description
Show Private NAT.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | Private NAT IP range | 192.167.0.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateNat Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Private NAT Name | PrivateNatName |
| service_resource_id | Private NAT connected Service Resource ID | 3f342bf9a557405b997c2cf48c89cbc2 |
| service_resource_name | Private NAT connected Service Resource Name | PrivateNatName |
| service_type | Private NAT connected Service Type | DIRECT_CONNECT |
| state | Private NAT State | ACTIVE |
85.2 - 1.1
scpcli vpc private-nat show
--private_nat_id <value>
Description
Show Private NAT.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | Private NAT IP range | 192.167.0.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateNat Description |
| direct_connect_id | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| direct_connect_name | Direct Connect Name | DirectConnectName |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Private NAT Name | PrivateNatName |
| state | Private NAT State | ACTIVE |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
85.3 - 1.0
scpcli vpc private-nat show
--private_nat_id <value>
Description
Show Private NAT.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| private_nat_id required | string | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Private NAT ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | Private NAT IP range | 192.167.0.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateNat Description |
| direct_connect_id | Direct Connect ID | fe860e0af0c04dcd8182b84f907f31f4 |
| direct_connect_name | Direct Connect Name | DirectConnectName |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Private NAT Name | PrivateNatName |
| state | Private NAT State | ACTIVE |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
86 - Show PrivateLink Endpoint
86.1 - 1.2
scpcli vpc privatelink-endpoint show
--privatelink_endpoint_id <value>
Description
Show PrivateLink Endpoint.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approval_type | PrivateLink Service Approval Type | AUTO |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateLink Endpoint Description |
| endpoint_ip_address | Endpoint IP Address | 192.167.1.5 |
| endpoint_ip_port_id | Endpoint IP Port ID | b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | PrivateLink Endpoint Name | EndpointName |
| privatelink_service_id | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| security_group_ids | Security Group List | [‘17776b52-0a64-440d-9e93-b4fc37be935b’] |
| state | PrivateLink Endpoint State | ACTIVE |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
86.2 - 1.1
scpcli vpc privatelink-endpoint show
--privatelink_endpoint_id <value>
Description
Show PrivateLink Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_endpoint_id required | string | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approval_type | PrivateLink Service Approval Type | AUTO |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateLink Endpoint Description |
| endpoint_ip_address | Endpoint IP Address | 192.167.1.5 |
| endpoint_ip_port_id | Endpoint IP Port ID | b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | PrivateLink Endpoint Name | EndpointName |
| privatelink_service_id | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| security_group_ids | Security Group List | [‘17776b52-0a64-440d-9e93-b4fc37be935b’] |
| state | PrivateLink Endpoint State | ACTIVE |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
87 - Show PrivateLink Service
87.1 - 1.2
scpcli vpc privatelink-service show
--privatelink_service_id <value>
Description
Show PrivateLink Service.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_service_id required | string | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approval_type | PrivateLink Service Approval Type | AUTO |
| connected_resource_id | Connected Resource ID | a3e3a662a4f34442a94166df5ff9f577 |
| connected_resource_ip_address | Connected Resource IP Address | 192.167.0.10 |
| connected_resource_name | Connected Resource Name | lbResourceName |
| connected_resource_type | Connected Resource Type | LB |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateLink Service Description |
| high_speed_transfer | High Speed Data Transfer Use | False |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | PrivateLink Service Name | ServiceName |
| security_group_ids | Security Group List | [‘00b6af37-73b5-4de2-b080-c295a1a0382e’] |
| service_ip_address | Service IP Address | 192.167.0.5 |
| service_ip_port_id | Service IP Port ID | d21a4b81-f52a-43a8-b985-341e763458bb |
| state | PrivateLink Service State | |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
87.2 - 1.1
scpcli vpc privatelink-service show
--privatelink_service_id <value>
Description
Show PrivateLink Service.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| privatelink_service_id required | string | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approval_type | PrivateLink Service Approval Type | AUTO |
| connected_resource_id | Connected Resource ID | a3e3a662a4f34442a94166df5ff9f577 |
| connected_resource_ip_address | Connected Resource IP Address | 192.167.0.10 |
| connected_resource_name | Connected Resource Name | lbResourceName |
| connected_resource_type | Connected Resource Type | LB |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateLink Service Description |
| high_speed_transfer | High Speed Data Transfer Use | False |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | PrivateLink Service Name | ServiceName |
| security_group_ids | Security Group List | [‘00b6af37-73b5-4de2-b080-c295a1a0382e’] |
| service_ip_address | Service IP Address | 192.167.0.5 |
| service_ip_port_id | Service IP Port ID | d21a4b81-f52a-43a8-b985-341e763458bb |
| state | PrivateLink Service State | |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
88 - Show PublicIP
88.1 - 1.2
scpcli vpc public-ip show
--publicip_id <value>
Description
Show PublicIP.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| publicip_id required | string | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
Responses
| Name | Description | Example |
|---|---|---|
| id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| attached_resource_id | PublicIP Attached Resource ID | 37e6db41f5124184a43251a63124cdc9 |
| attached_resource_name | PublicIP Attached Resource Name | Attached NAT Gateway Name |
| attached_resource_type | PublicIP Attached Resource Type | NAT_GW |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | PublicIP Description | Public IP Description |
| ip_address | IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | PublicIP State | ATTACHED |
| type | PublicIP Type | IGW |
88.2 - 1.1
scpcli vpc public-ip show
--publicip_id <value>
Description
Show PublicIP.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| publicip_id required | string | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
Responses
| Name | Description | Example |
|---|---|---|
| id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| attached_resource_id | PublicIP Attached Resource ID | 37e6db41f5124184a43251a63124cdc9 |
| attached_resource_name | PublicIP Attached Resource Name | Attached NAT Gateway Name |
| attached_resource_type | PublicIP Attached Resource Type | NAT_GW |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | PublicIP Description | Public IP Description |
| ip_address | IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | PublicIP State | ATTACHED |
| type | PublicIP Type | IGW |
88.3 - 1.0
scpcli vpc public-ip show
--publicip_id <value>
Description
Show PublicIP.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| publicip_id required | string | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
Responses
| Name | Description | Example |
|---|---|---|
| id | PublicIP ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| attached_resource_id | PublicIP Attached Resource ID | 37e6db41f5124184a43251a63124cdc9 |
| attached_resource_name | PublicIP Attached Resource Name | Attached NAT Gateway Name |
| attached_resource_type | PublicIP Attached Resource Type | NAT_GW |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | PublicIP Description | Public IP Description |
| ip_address | IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | PublicIP State | ATTACHED |
| type | PublicIP Type | IGW |
89 - Show Subnet
89.1 - 1.2
scpcli vpc subnet show
--subnet_id <value>
Description
Show subnet.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Subnet Id | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| allocation_pools | Allocation Pools | |
| cidr | Subnet Cidr | 192.167.1.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Subnet Description |
| dhcp_ip_address | DHCP IP Address | |
| dns_nameservers | DNS Name Servers | |
| gateway_ip_address | Gateway IP Address | 192.167.1.1 |
| host_routes | Host Routes | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Subnet Name | subnetName |
| state | State | |
| type | Subnet Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
89.2 - 1.1
scpcli vpc subnet show
--subnet_id <value>
Description
Show subnet.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Subnet Id | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| allocation_pools | Allocation Pools | |
| cidr | Subnet Cidr | 192.167.1.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Subnet Description |
| dns_nameservers | DNS Name Servers | |
| gateway_ip_address | Gateway IP Address | 192.167.1.1 |
| host_routes | Host Routes | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Subnet Name | subnetName |
| state | State | |
| type | Subnet Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
89.3 - 1.0
scpcli vpc subnet show
--subnet_id <value>
Description
Show subnet.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Subnet Id | 023c57b14f11483689338d085e061492 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| allocation_pools | Allocation Pools | |
| cidr | Subnet Cidr | 192.167.1.0/24 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Subnet Description |
| dns_nameservers | DNS Name Servers | |
| gateway_ip_address | Gateway IP Address | 192.167.1.1 |
| host_routes | Host Routes | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Subnet Name | subnetName |
| state | State | |
| type | Subnet Type | |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
90 - Show Subnet Vip
90.1 - 1.2
scpcli vpc subnet vip show
--vip_id <value>
--subnet_id <value>
Description
Show Subnet Vip
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vip_id required | string | Subnet Vip Id | 0466a9448d9a4411a86055939e451c8f |
| subnet_id required | string | Subnet ID | 023c57b14f11483689338d085e061492 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Subnet Vip Id | 0466a9448d9a4411a86055939e451c8f |
| connected_ports | ||
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Subnet VIP Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| state | State | ACTIVE |
| static_nat | Static NAT Info | |
| subnet_id | Subnet ID | 023c57b14f11483689338d085e061492 |
| vip_port_id | Vip Port Id | 35268a9f2eda4cde83b1d85c1f61f67d |
| virtual_ip_address | Virtual IP Address | 192.168.20.6 |
91 - Show Transit Gateway
91.1 - 1.2
scpcli vpc transit-gateway show
--transit_gateway_id <value>
Description
Show Transit Gateway.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Transit Gateway Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Transit Gateway Description | TransitGateway Description |
| firewall_connection_state | Firewall Connection State | INACTIVE |
| firewall_ids | Firewall ID | [‘bbb93aca123f4bb2b2c0f206f4a86b2b’] |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Transit Gateway Name | TransitGatewayName |
| state | State | ACTIVE |
| uplink_enabled | Uplink Enabled | False |
91.2 - 1.1
scpcli vpc transit-gateway show
--transit_gateway_id <value>
Description
Show Transit Gateway.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Transit Gateway Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Transit Gateway Description | TransitGateway Description |
| firewall_ids | Firewall ID | [‘bbb93aca123f4bb2b2c0f206f4a86b2b’] |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Transit Gateway Name | TransitGatewayName |
| state | State | ACTIVE |
| uplink_enabled | Uplink Enabled | False |
91.3 - 1.0
scpcli vpc transit-gateway show
--transit_gateway_id <value>
Description
Show Transit Gateway.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| bandwidth | Transit Gateway Port Bandwidth | 1 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Transit Gateway Description | TransitGateway Description |
| firewall_ids | Firewall ID | [‘bbb93aca123f4bb2b2c0f206f4a86b2b’] |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Transit Gateway Name | TransitGatewayName |
| state | State | ACTIVE |
| uplink_enabled | Uplink Enabled | False |
92 - Show VPC
92.1 - 1.2
scpcli vpc vpc show
--vpc_id <value>
Description
Show VPC.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr_count | Cidr Count | 20 |
| cidrs | ||
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | vpcDescription |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Name | vpcName |
| state | State |
92.2 - 1.1
scpcli vpc vpc show
--vpc_id <value>
Description
Show VPC.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | VPC Cidr | 192.167.0.0/18 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | vpcDescription |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Name | vpcName |
| state | State |
92.3 - 1.0
scpcli vpc vpc show
--vpc_id <value>
Description
Show VPC.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_id required | string | VPC Id | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| cidr | VPC Cidr | 192.167.0.0/18 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | vpcDescription |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Name | vpcName |
| state | State |
93 - Show VPC Endpoint
93.1 - 1.2
scpcli vpc vpc-endpoint show
--vpc_endpoint_id <value>
Description
Show VPC Endpoint.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_endpoint_id required | string | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | VpcEndpoint Description |
| endpoint_ip_address | VPC Endpoint IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Endpoint Name | VpcEndpointName |
| resource_info | VPC Endpoint Resource Key Info | x.samsungsdscloud.com(Registry) |
| resource_key | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_type | VPC Endpoint Resource Type | FS |
| state | VPC Endpoint State | ACTIVE |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
93.2 - 1.1
scpcli vpc vpc-endpoint show
--vpc_endpoint_id <value>
Description
Show VPC Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_endpoint_id required | string | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | VpcEndpoint Description |
| endpoint_ip_address | VPC Endpoint IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Endpoint Name | VpcEndpointName |
| resource_info | VPC Endpoint Resource Key Info | x.samsungsdscloud.com(Registry) |
| resource_key | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_type | VPC Endpoint Resource Type | FS |
| state | VPC Endpoint State | ACTIVE |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
93.3 - 1.0
scpcli vpc vpc-endpoint show
--vpc_endpoint_id <value>
Description
Show VPC Endpoint.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_endpoint_id required | string | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Endpoint ID | 12f56e27070248a6a240a497e43fbe18 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | VpcEndpoint Description |
| endpoint_ip_address | VPC Endpoint IP Address | 192.167.0.5 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Endpoint Name | VpcEndpointName |
| resource_info | VPC Endpoint Resource Key Info | x.samsungsdscloud.com(Registry) |
| resource_key | VPC Endpoint Resource Key | 07c5364702384471b650147321b52173 |
| resource_type | VPC Endpoint Resource Type | FS |
| state | VPC Endpoint State | ACTIVE |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| subnet_name | Subnet Name | subnetName |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
| vpc_name | VPC Name | vpcName |
94 - Show VPC Peering
94.1 - 1.2
scpcli vpc vpc-peering show
--vpc_peering_id <value>
Description
Show VPC Peering.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| account_type | Account Type | |
| approver_vpc_account_id | Approver VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approver_vpc_id | Approver VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| approver_vpc_name | Approver VPC Name | vpcName |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| delete_requester_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| description | VPC Peering Description | vpcPeering Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Peering Name | vpcPeeringName |
| requester_vpc_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| requester_vpc_id | Requester VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| requester_vpc_name | Requester VPC Name | vpcName |
| state | State |
94.2 - 1.1
scpcli vpc vpc-peering show
--vpc_peering_id <value>
Description
Show VPC Peering.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| account_type | Account Type | |
| approver_vpc_account_id | Approver VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approver_vpc_id | Approver VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| approver_vpc_name | Approver VPC Name | vpcName |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| delete_requester_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| description | VPC Peering Description | vpcPeering Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Peering Name | vpcPeeringName |
| requester_vpc_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| requester_vpc_id | Requester VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| requester_vpc_name | Requester VPC Name | vpcName |
| state | State |
94.3 - 1.0
scpcli vpc vpc-peering show
--vpc_peering_id <value>
Description
Show VPC Peering.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vpc_peering_id required | string | VPC Peering ID | 023c57b14f11483689338d085e061492 |
Responses
| Name | Description | Example |
|---|---|---|
| id | VPC Peering ID | 023c57b14f11483689338d085e061492 |
| account_type | Account Type | |
| approver_vpc_account_id | Approver VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approver_vpc_id | Approver VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| approver_vpc_name | Approver VPC Name | vpcName |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| delete_requester_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| description | VPC Peering Description | vpcPeering Description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | VPC Peering Name | vpcPeeringName |
| requester_vpc_account_id | Requester VPC Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| requester_vpc_id | Requester VPC ID | 7df8abb4912e4709b1cb237daccca7a8 |
| requester_vpc_name | Requester VPC Name | vpcName |
| state | State |