1.3

get /v1/subnets

Description

Get subnet 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	id optional	Subnet Id Example : `023c57b14f11483689338d085e061492`	string
query	name optional	Subnet Name Example : `subnetName`	string
query	type optional	Subnet Type Example :	any of [enum (PUBLIC, PRIVATE, LOCAL, VPC_ENDPOINT), array[enum (PUBLIC, PRIVATE, LOCAL, VPC_ENDPOINT)]]
query	cidr optional	Subnet Cidr Example : `192.167.1.0/24`	any of [string, null]	None
query	state optional	State Example :	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
query	vpc_id optional	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	string
query	vpc_name optional	VPC Name Example : `vpcName`	string
query	category optional	Subnet Category Example : `PRIMARY`	enum (PRIMARY, SECONDARY)
query	zone optional	Subnet Zone Example :	string
query	primary_subnet_id optional	Primary Subnet ID Example : `023c57b14f11483689338d085e061492`	string

Responses

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

Example HTTP request

Request path

/v1/subnets

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,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "subnets": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "category": "PRIMARY",
            "cidr": "192.167.1.0/24",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "gateway_ip_address": "192.167.1.1",
            "id": "023c57b14f11483689338d085e061492",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "subnetName",
            "primary_subnet_id": "023c57b14f11483689338d085e061492",
            "state": "CREATING",
            "type": "PUBLIC",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName",
            "zones": "[\"kr-west1-a\", \"kr-west1-b\", \"kr-west1-c\"]"
        }
    ]
}