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

Return to the regular view of this page.

List VPC Peering

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

1 - 1.3

get /v1/vpc-peerings

Description

Get VPC Peering 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	VPC Peering ID Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None
query	name optional	VPC Peering Name Example : `vpcPeeringName`	any of [string, null]	None
query	requester_vpc_id optional	Requester VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	requester_vpc_name optional	Requester VPC Name Example : `vpcName`	any of [string, null]	None
query	approver_vpc_id optional	Approver VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	approver_vpc_name optional	Approver VPC Name Example : `vpcName`	any of [string, null]	None
query	account_type optional	Account Type Example :	any of [enum (SAME, DIFFERENT), null]	None
query	state optional	State Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING, CREATING_REQUESTING, REJECTED, CANCELED, DELETING_REQUESTING), null]	None

Responses

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

Example HTTP request

Request path

/v1/vpc-peerings

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"
    ],
    "vpc_peerings": [
        {
            "account_type": "SAME",
            "approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "approver_vpc_name": "vpcName",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "description": "vpcPeering Description",
            "id": "023c57b14f11483689338d085e061492",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "vpcPeeringName",
            "requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "requester_vpc_name": "vpcName",
            "state": "CREATING"
        }
    ]
}

2 - 1.2

get /v1/vpc-peerings

Description

Get VPC Peering 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	id optional	VPC Peering ID Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None
query	name optional	VPC Peering Name Example : `vpcPeeringName`	any of [string, null]	None
query	requester_vpc_id optional	Requester VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	requester_vpc_name optional	Requester VPC Name Example : `vpcName`	any of [string, null]	None
query	approver_vpc_id optional	Approver VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	approver_vpc_name optional	Approver VPC Name Example : `vpcName`	any of [string, null]	None
query	account_type optional	Account Type Example :	any of [enum (SAME, DIFFERENT), null]	None
query	state optional	State Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING, CREATING_REQUESTING, REJECTED, CANCELED, DELETING_REQUESTING), null]	None

Responses

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

Example HTTP request

Request path

/v1/vpc-peerings

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"
    ],
    "vpc_peerings": [
        {
            "account_type": "SAME",
            "approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "approver_vpc_name": "vpcName",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "description": "vpcPeering Description",
            "id": "023c57b14f11483689338d085e061492",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "vpcPeeringName",
            "requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "requester_vpc_name": "vpcName",
            "state": "CREATING"
        }
    ]
}

3 - 1.1

get /v1/vpc-peerings

Description

Get VPC Peering list.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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 Peering ID Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None
query	name optional	VPC Peering Name Example : `vpcPeeringName`	any of [string, null]	None
query	requester_vpc_id optional	Requester VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	requester_vpc_name optional	Requester VPC Name Example : `vpcName`	any of [string, null]	None
query	approver_vpc_id optional	Approver VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	approver_vpc_name optional	Approver VPC Name Example : `vpcName`	any of [string, null]	None
query	account_type optional	Account Type Example :	any of [enum (SAME, DIFFERENT), null]	None
query	state optional	State Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING, CREATING_REQUESTING, REJECTED, CANCELED, DELETING_REQUESTING), null]	None

Responses

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

Example HTTP request

Request path

/v1/vpc-peerings

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,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpc_peerings": [
        {
            "account_type": "SAME",
            "approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "approver_vpc_name": "vpcName",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "description": "vpcPeering Description",
            "id": "023c57b14f11483689338d085e061492",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "vpcPeeringName",
            "requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "requester_vpc_name": "vpcName",
            "state": "CREATING"
        }
    ]
}

4 - 1.0

get /v1/vpc-peerings

Description

Get VPC Peering 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	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 Peering ID Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None
query	name optional	VPC Peering Name Example : `vpcPeeringName`	any of [string, null]	None
query	requester_vpc_id optional	Requester VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	requester_vpc_name optional	Requester VPC Name Example : `vpcName`	any of [string, null]	None
query	approver_vpc_id optional	Approver VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	approver_vpc_name optional	Approver VPC Name Example : `vpcName`	any of [string, null]	None
query	account_type optional	Account Type Example :	any of [enum (SAME, DIFFERENT), null]	None
query	state optional	State Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING, CREATING_REQUESTING, REJECTED, CANCELED, DELETING_REQUESTING), null]	None

Responses

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

Example HTTP request

Request path

/v1/vpc-peerings

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,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpc_peerings": [
        {
            "account_type": "SAME",
            "approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "approver_vpc_name": "vpcName",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "description": "vpcPeering Description",
            "id": "023c57b14f11483689338d085e061492",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "vpcPeeringName",
            "requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "requester_vpc_name": "vpcName",
            "state": "CREATING"
        }
    ]
}