1.2
1.2
get /v1/vpcs
Description
Get VPC list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
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 | VPC Id Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] | None |
| query | name optional | VPC Name Example : vpcName | any of [string, null] | None |
| query | state optional | State Example : | enum (CREATING, ACTIVE, DELETED, ERROR) | None |
| query | cidr optional | VPC Cidr Example : 192.167.0.0/18 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | VpcListResponseV1Dot2 |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
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"
}
]
}