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

Return to the regular view of this page.

List VPC Endpoint

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

1 - 1.3

get /v1/vpc-endpoints

Description

Get VPC Endpoint 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 Endpoint ID Example : `12f56e27070248a6a240a497e43fbe18`	any of [string, null]	None
query	name optional	VPC Endpoint Name Example : `VpcEndpointName`	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	resource_key optional	VPC Endpoint Resource Key Example : `07c5364702384471b650147321b52173`	any of [string, null]	None
query	resource_type optional	VPC Endpoint Resource Type Example : `FS`	any of [enum (FS, OBS, SCR, DNS), null]	None
query	endpoint_ip_address optional	VPC Endpoint IP Address Example : `192.167.0.5`	any of [string, null]	None
query	state optional	VPC Endpoint State Example : `ACTIVE`	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]	None

Responses

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

Example HTTP request

Request path

/v1/vpc-endpoints

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_endpoints": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "VpcEndpoint Description",
            "endpoint_ip_address": "192.167.0.5",
            "id": "12f56e27070248a6a240a497e43fbe18",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "VpcEndpointName",
            "resource_info": "x.samsungsdscloud.com(Registry)",
            "resource_key": "07c5364702384471b650147321b52173",
            "resource_type": "FS",
            "state": "ACTIVE",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "subnet_name": "subnetName",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ]
}

2 - 1.2

get /v1/vpc-endpoints

Description

Get VPC Endpoint 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 Endpoint ID Example : `12f56e27070248a6a240a497e43fbe18`	any of [string, null]	None
query	name optional	VPC Endpoint Name Example : `VpcEndpointName`	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	resource_key optional	VPC Endpoint Resource Key Example : `07c5364702384471b650147321b52173`	any of [string, null]	None
query	resource_type optional	VPC Endpoint Resource Type Example : `FS`	any of [enum (FS, OBS, SCR, DNS), null]	None
query	endpoint_ip_address optional	VPC Endpoint IP Address Example : `192.167.0.5`	any of [string, null]	None
query	state optional	VPC Endpoint State Example : `ACTIVE`	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]	None

Responses

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

Example HTTP request

Request path

/v1/vpc-endpoints

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_endpoints": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "VpcEndpoint Description",
            "endpoint_ip_address": "192.167.0.5",
            "id": "12f56e27070248a6a240a497e43fbe18",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "VpcEndpointName",
            "resource_info": "x.samsungsdscloud.com(Registry)",
            "resource_key": "07c5364702384471b650147321b52173",
            "resource_type": "FS",
            "state": "ACTIVE",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "subnet_name": "subnetName",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ]
}

3 - 1.1

get /v1/vpc-endpoints

Description

Get VPC Endpoint 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	id optional	VPC Endpoint ID Example : `12f56e27070248a6a240a497e43fbe18`	any of [string, null]	None
query	name optional	VPC Endpoint Name Example : `VpcEndpointName`	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	resource_key optional	VPC Endpoint Resource Key Example : `07c5364702384471b650147321b52173`	any of [string, null]	None
query	resource_type optional	VPC Endpoint Resource Type Example : `FS`	any of [enum (FS, OBS, SCR, DNS), null]	None
query	endpoint_ip_address optional	VPC Endpoint IP Address Example : `192.167.0.5`	any of [string, null]	None
query	state optional	VPC Endpoint State Example : `ACTIVE`	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]	None

Responses

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

Example HTTP request

Request path

/v1/vpc-endpoints

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"
        }
    ],
    "vpc_endpoints": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "VpcEndpoint Description",
            "endpoint_ip_address": "192.167.0.5",
            "id": "12f56e27070248a6a240a497e43fbe18",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "VpcEndpointName",
            "resource_info": "x.samsungsdscloud.com(Registry)",
            "resource_key": "07c5364702384471b650147321b52173",
            "resource_type": "FS",
            "state": "ACTIVE",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "subnet_name": "subnetName",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ]
}

4 - 1.0

get /v1/vpc-endpoints

Description

Get VPC Endpoint 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	id optional	VPC Endpoint ID Example : `12f56e27070248a6a240a497e43fbe18`	any of [string, null]	None
query	name optional	VPC Endpoint Name Example : `VpcEndpointName`	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	resource_key optional	VPC Endpoint Resource Key Example : `07c5364702384471b650147321b52173`	any of [string, null]	None
query	resource_type optional	VPC Endpoint Resource Type Example : `FS`	any of [enum (FS, OBS, SCR, DNS), null]	None
query	endpoint_ip_address optional	VPC Endpoint IP Address Example : `192.167.0.5`	any of [string, null]	None
query	state optional	VPC Endpoint State Example : `ACTIVE`	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]	None

Responses

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

Example HTTP request

Request path

/v1/vpc-endpoints

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"
        }
    ],
    "vpc_endpoints": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "VpcEndpoint Description",
            "endpoint_ip_address": "192.167.0.5",
            "id": "12f56e27070248a6a240a497e43fbe18",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "VpcEndpointName",
            "resource_info": "x.samsungsdscloud.com(Registry)",
            "resource_key": "07c5364702384471b650147321b52173",
            "resource_type": "FS",
            "state": "ACTIVE",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "subnet_name": "subnetName",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ]
}