This is the multi-page printable view of this section. Click here to print.
Create NAT Gateway
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 |
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 |
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 |