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

Return to the regular view of this page.

List Ports

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

1 - 1.3

get /v1/ports

Description

Get port list.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	Port Limit Example :	any of [integer, null]	None
query	marker optional	Port Marker Example :	any of [string, null]	None
query	sort optional	Port Sort Example :	any of [string, null]	None
query	name optional	Port Name Example : `portName`	any of [string, null]	None
query	subnet_id optional	Subnet Id Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None
query	subnet_name optional	Subnet Name Example : `subnetName`	any of [string, null]	None
query	id optional	Port ID Example : `023c57b1-4f11-4836-8933-8d085e061492`	any of [string, null]	None
query	attached_resource_id optional	Connected resource ID Example : `9387e8f51de04a03994de8a9c3524935`	any of [string, null]	None
query	fixed_ip_address optional	Fixed IP Example : `192.168.1.100`	any of [string, null]	None
query	mac_address optional	MAC Address Example : `fa:16:3e:00:00:01`	any of [string, null]	None
query	state optional	State Example :	any of [string, null]	None
query	security_groups optional	Security Group List Example :	any of [string, null]	None
query	attached_resource_types optional	Attached Resource Type Example :	any of [enum (VIRTUAL_SERVER, PRIVATELINKE, UNATTACHED), array[enum (VIRTUAL_SERVER, PRIVATELINKE, UNATTACHED)]]	None

Responses

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

Example HTTP request

Request path

/v1/ports

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,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "ports": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
            "attached_resource_type": "",
            "created_at": "2024-01-15T10:30:00.000Z",
            "description": "Port Description",
            "fixed_ip_address": "192.168.1.100",
            "id": "023c57b1-4f11-4836-8933-8d085e061492",
            "mac_address": "fa:16:3e:00:00:01",
            "modified_at": "2024-01-15T10:30:00.000Z",
            "name": "portName",
            "state": "",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "subnet_name": "subnetName",
            "vpc_id": "071bc63b767444c9afaab1c972d302d5",
            "vpc_name": "vpcName"
        }
    ]
}

2 - 1.2

get /v1/ports

Description

Get port list.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20270131

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	Port Limit Example :	any of [integer, null]	None
query	marker optional	Port Marker Example :	any of [string, null]	None
query	sort optional	Port Sort Example :	any of [string, null]	None
query	name optional	Port Name Example : `portName`	any of [string, null]	None
query	subnet_id optional	Subnet Id Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None
query	subnet_name optional	Subnet Name Example : `subnetName`	any of [string, null]	None
query	id optional	Port ID Example : `023c57b1-4f11-4836-8933-8d085e061492`	any of [string, null]	None
query	attached_resource_id optional	Connected resource ID Example : `9387e8f51de04a03994de8a9c3524935`	any of [string, null]	None
query	fixed_ip_address optional	Fixed IP Example : `192.168.1.100`	any of [string, null]	None
query	mac_address optional	MAC Address Example : `fa:16:3e:00:00:01`	any of [string, null]	None
query	state optional	State Example :	any of [string, null]	None
query	security_groups optional	Security Group List Example :	any of [string, null]	None
query	attached_resource_types optional	Attached Resource Type Example :	any of [enum (VIRTUAL_SERVER, PRIVATELINKE, UNATTACHED), array[enum (VIRTUAL_SERVER, PRIVATELINKE, UNATTACHED)]]	None

Responses

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

Example HTTP request

Request path

/v1/ports

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,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "ports": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
            "attached_resource_type": "",
            "created_at": "2024-01-15T10:30:00.000Z",
            "description": "Port Description",
            "fixed_ip_address": "192.168.1.100",
            "id": "023c57b1-4f11-4836-8933-8d085e061492",
            "mac_address": "fa:16:3e:00:00:01",
            "modified_at": "2024-01-15T10:30:00.000Z",
            "name": "portName",
            "state": "",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "subnet_name": "subnetName",
            "vpc_id": "071bc63b767444c9afaab1c972d302d5",
            "vpc_name": "vpcName"
        }
    ]
}

3 - 1.1

get /v1/ports

Description

Get port 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	Port Limit Example :	any of [integer, null]	None
query	marker optional	Port Marker Example :	any of [string, null]	None
query	sort optional	Port Sort Example :	any of [string, null]	None
query	name optional	Port Name Example : `portName`	any of [string, null]	None
query	subnet_id optional	Subnet Id Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None
query	subnet_name optional	Subnet Name Example : `subnetName`	any of [string, null]	None
query	id optional	Port ID Example : `023c57b1-4f11-4836-8933-8d085e061492`	any of [string, null]	None
query	attached_resource_id optional	Connected resource ID Example : `9387e8f51de04a03994de8a9c3524935`	any of [string, null]	None
query	fixed_ip_address optional	Fixed IP Example : `192.168.1.100`	any of [string, null]	None
query	mac_address optional	MAC Address Example : `fa:16:3e:00:00:01`	any of [string, null]	None
query	state optional	State Example :	any of [string, null]	None
query	security_groups optional	Security Group List Example :	any of [string, null]	None
query	attached_resource_types optional	Attached Resource Type Example :	any of [enum (VIRTUAL_SERVER, PRIVATELINKE, UNATTACHED), array[enum (VIRTUAL_SERVER, PRIVATELINKE, UNATTACHED)]]	None

Responses

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

Example HTTP request

Request path

/v1/ports

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"
        }
    ],
    "ports": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
            "attached_resource_type": "",
            "created_at": "2024-01-15T10:30:00.000Z",
            "description": "Port Description",
            "fixed_ip_address": "192.168.1.100",
            "id": "023c57b1-4f11-4836-8933-8d085e061492",
            "mac_address": "fa:16:3e:00:00:01",
            "modified_at": "2024-01-15T10:30:00.000Z",
            "name": "portName",
            "state": "",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "subnet_name": "subnetName",
            "vpc_id": "071bc63b767444c9afaab1c972d302d5",
            "vpc_name": "vpcName"
        }
    ]
}

4 - 1.0

get /v1/ports

Description

Get port 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	Port Limit Example :	any of [integer, null]	None
query	marker optional	Port Marker Example :	any of [string, null]	None
query	sort optional	Port Sort Example :	any of [string, null]	None
query	name optional	Port Name Example : `portName`	any of [string, null]	None
query	subnet_id optional	Subnet Id Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None
query	subnet_name optional	Subnet Name Example : `subnetName`	any of [string, null]	None
query	id optional	Port ID Example : `023c57b1-4f11-4836-8933-8d085e061492`	any of [string, null]	None
query	attached_resource_id optional	Connected resource ID Example : `9387e8f51de04a03994de8a9c3524935`	any of [string, null]	None
query	fixed_ip_address optional	Fixed IP Example : `192.168.1.100`	any of [string, null]	None
query	mac_address optional	MAC Address Example : `fa:16:3e:00:00:01`	any of [string, null]	None
query	state optional	State Example :	any of [string, null]	None
query	security_groups optional	Security Group List Example :	any of [string, null]	None
query	attached_resource_types optional	Attached Resource Type Example :	any of [enum (VIRTUAL_SERVER, PRIVATELINKE, UNATTACHED), array[enum (VIRTUAL_SERVER, PRIVATELINKE, UNATTACHED)]]	None

Responses

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

Example HTTP request

Request path

/v1/ports

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"
        }
    ],
    "ports": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
            "attached_resource_type": "",
            "created_at": "2024-01-15T10:30:00.000Z",
            "description": "Port Description",
            "fixed_ip_address": "192.168.1.100",
            "id": "023c57b1-4f11-4836-8933-8d085e061492",
            "mac_address": "fa:16:3e:00:00:01",
            "modified_at": "2024-01-15T10:30:00.000Z",
            "name": "portName",
            "state": "",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "subnet_name": "subnetName",
            "vpc_id": "071bc63b767444c9afaab1c972d302d5",
            "vpc_name": "vpcName"
        }
    ]
}