Network Logging
Overview
Provides an Application Programming Interface (API) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of Network Logging service and how to call API.
The API is provided as a RESTful API, and it responds in JSON format.
Version
| Version | Status | Supported Until |
|---|
| 1.0 | CURRENT | - |
OpenAPI URL
https://network-logging.{region}.{environment}.samsungsdscloud.com
Environment and Region List
| environment | region |
|---|
| s | kr-west1 |
| s | kr-east1 |
| g | kr-south1 |
| g | kr-south2 |
| g | kr-south3 |
| e | kr-west1 |
| e | kr-east1 |
1.1.1 - 1.0
post /v1/network-logging/storages
Description
Create Network Logging Storage.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.0 | - |
Parameters
Responses
Example HTTP request
Request path
/v1/network-logging/storages
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = network-logging 1.0"
Request body
{
"bucket_name": "",
"resource_type": "FIREWALL"
}
Example HTTP response
Response 201
{
"network_logging_storage": {
"account_id": "",
"bucket_name": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"resource_type": "FIREWALL"
}
}
1.2.1 - 1.0
delete /v1/network-logging/storages/{network_logging_storage_id}
Description
Delete Network Logging Storage.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | network_logging_storage_id
required | Network Logging Storage ID
Example :
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/network-logging/storages/{network_logging_storage_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = network-logging 1.0"
Example HTTP response
Response 204
1.3.1 - 1.0
get /v1/network-logging/configurations
Description
Get Network Logging Configuration list.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.0 | - |
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 | resource_id
optional | Resource ID
Example :
| string | None |
| query | resource_name
optional | Resource Name
Example :
| string | None |
| query | resource_type
required | Resource Type
Example :
| enum (FIREWALL, SECURITY_GROUP, NAT) | None |
Responses
Example HTTP request
Request path
/v1/network-logging/configurations?resource_type={resource_type}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = network-logging 1.0"
Example HTTP response
Response 200
{
"count": 20,
"links": [
{
"href": "http://scp.samsungsdscloud.com/v1/notices",
"rel": "self"
}
],
"network_logging_configurations": [
{
"account_id": "",
"bucket_name": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"down_interface": "",
"id": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"resource_id": "",
"resource_name": "",
"resource_type": "FIREWALL",
"security_group_log_id": "",
"up_interface": ""
}
]
}
1.4.1 - 1.0
get /v1/network-logging/storages
Description
Get Network Logging Storage list.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.0 | - |
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 | resource_type
required | Resource Type
Example :
| enum (FIREWALL, SECURITY_GROUP, NAT) | None |
Responses
Example HTTP request
Request path
/v1/network-logging/storages?resource_type={resource_type}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = network-logging 1.0"
Example HTTP response
Response 200
{
"count": 20,
"links": [
{
"href": "http://scp.samsungsdscloud.com/v1/notices",
"rel": "self"
}
],
"network_logging_storages": [
{
"account_id": "",
"bucket_name": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"resource_type": "FIREWALL"
}
]
}