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

Return to the regular view of this page.

List NAT Gateways

1: 1.3
2: 1.2
3: 1.1
4: 1.0

1 - 1.3

get /v1/nat-gateways

Description

Get NAT Gateway list.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	NAT Gateway Name Example : `NatGatewayName`	any of [string, null]	None
query	vpc_id optional	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	vpc_name optional	VPC Name Example : `vpcName`	any of [string, null]	None
query	subnet_id optional	Subnet Id Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None
query	subnet_name optional	Subnet Name Example : `subnetName`	any of [string, null]	None
query	nat_gateway_ip_address optional	NAT Gateway IP Address Example : `192.167.0.5`	any of [string, null]	None
query	state optional	NAT Gateway State Example : `ACTIVE`	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]	None
query	multi_zone_enabled optional	Multi Zone Use Example : `true`	any of [boolean, null]	None

Responses

HTTP Code	Description	Schema
200	OK	NatGatewayListResponseV1Dot3
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/nat-gateways

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.3"

Example HTTP response

Response 200

{
    "count": 20,
    "nat_gateways": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "VpcEndpoint Description",
            "id": "12f56e27070248a6a240a497e43fbe18",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "multi_zone_enabled": "true",
            "name": "NatGatewayName",
            "nat_gateway_ips": [
                {
                    "ip_address": "192.167.0.5",
                    "publicip_id": "12f56e27070248a6a240a497e43fbe18"
                }
            ],
            "state": "ACTIVE",
            "subnet_cidr": "192.167.1.0/24",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "subnet_name": "subnetName",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

2 - 1.2

get /v1/nat-gateways

Description

Get NAT Gateway list.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20270131

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	NAT Gateway Name Example : `NatGatewayName`	any of [string, null]	None
query	vpc_id optional	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	vpc_name optional	VPC Name Example : `vpcName`	any of [string, null]	None
query	subnet_id optional	Subnet Id Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None
query	subnet_name optional	Subnet Name Example : `subnetName`	any of [string, null]	None
query	nat_gateway_ip_address optional	NAT Gateway IP Address Example : `192.167.0.5`	any of [string, null]	None
query	state optional	NAT Gateway State Example : `ACTIVE`	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]	None

Responses

HTTP Code	Description	Schema
200	OK	NatGatewayListResponseV1Dot2
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/nat-gateways

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.2"

Example HTTP response

Response 200

{
    "count": 20,
    "nat_gateways": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "VpcEndpoint Description",
            "id": "12f56e27070248a6a240a497e43fbe18",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "NatGatewayName",
            "nat_gateway_ip_address": "192.167.0.5",
            "publicip_id": "12f56e27070248a6a240a497e43fbe18",
            "state": "ACTIVE",
            "subnet_cidr": "192.167.1.0/24",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "subnet_name": "subnetName",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

3 - 1.1

get /v1/nat-gateways

Description

Get NAT Gateway list.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	limit Example : `20`	any of [integer, null]	None
query	marker optional	marker Example : `607e0938521643b5b4b266f343fae693`	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	NAT Gateway Name Example : `NatGatewayName`	any of [string, null]	None
query	vpc_id optional	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	vpc_name optional	VPC Name Example : `vpcName`	any of [string, null]	None
query	subnet_id optional	Subnet Id Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None
query	subnet_name optional	Subnet Name Example : `subnetName`	any of [string, null]	None
query	nat_gateway_ip_address optional	NAT Gateway IP Address Example : `192.167.0.5`	any of [string, null]	None
query	state optional	NAT Gateway State Example : `ACTIVE`	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]	None

Responses

HTTP Code	Description	Schema
200	OK	NatGatewayListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/nat-gateways

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "nat_gateways": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "VpcEndpoint Description",
            "id": "12f56e27070248a6a240a497e43fbe18",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "NatGatewayName",
            "nat_gateway_ip_address": "192.167.0.5",
            "publicip_id": "12f56e27070248a6a240a497e43fbe18",
            "state": "ACTIVE",
            "subnet_cidr": "192.167.1.0/24",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "subnet_name": "subnetName",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ]
}

4 - 1.0

get /v1/nat-gateways

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

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	limit Example : `20`	any of [integer, null]	None
query	marker optional	marker Example : `607e0938521643b5b4b266f343fae693`	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	NAT Gateway Name Example : `NatGatewayName`	any of [string, null]	None
query	vpc_id optional	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	vpc_name optional	VPC Name Example : `vpcName`	any of [string, null]	None
query	subnet_id optional	Subnet Id Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None
query	subnet_name optional	Subnet Name Example : `subnetName`	any of [string, null]	None
query	nat_gateway_ip_address optional	NAT Gateway IP Address Example : `192.167.0.5`	any of [string, null]	None
query	state optional	NAT Gateway State Example : `ACTIVE`	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]	None

Responses

HTTP Code	Description	Schema
200	OK	NatGatewayListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/nat-gateways

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "nat_gateways": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "VpcEndpoint Description",
            "id": "12f56e27070248a6a240a497e43fbe18",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "NatGatewayName",
            "nat_gateway_ip_address": "192.167.0.5",
            "publicip_id": "12f56e27070248a6a240a497e43fbe18",
            "state": "ACTIVE",
            "subnet_cidr": "192.167.1.0/24",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "subnet_name": "subnetName",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ]
}