1.2

1.2

get /v1/vpcs

Description

Get VPC list.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
queryid
optional
VPC Id
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
queryname
optional
VPC Name
Example : vpcName
any of [string, null]None
querystate
optional
State
Example :
enum (CREATING, ACTIVE, DELETED, ERROR)None
querycidr
optional
VPC Cidr
Example : 192.167.0.0/18
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKVpcListResponseV1Dot2
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpcs

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,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpcs": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "cidr_count": 20,
            "cidrs": [
                {
                    "cidr": "192.167.0.0/18",
                    "created_at": "2024-05-17T00:23:17Z",
                    "created_by": "7df8abb4912e4709b1cb237daccca7a8",
                    "id": "7df8abb4912e4709b1cb237daccca7a8"
                }
            ],
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "vpcDescription",
            "id": "7df8abb4912e4709b1cb237daccca7a8",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "vpcName",
            "state": "CREATING"
        }
    ]
}