이 섹션의 다중 페이지 출력 화면임. 여기를 클릭하여 프린트.

이 페이지의 일반 화면으로 돌아가기.

Firewall

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다. 본 가이드는 Firewall 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

VersionStatusNot Before
1.1CURRENT-
1.0SUPPORTED20270131

OpenAPI URL

https://firewall.{region}.{environment}.samsungsdscloud.com

Environment and Region List

environmentregion
skr-west1
skr-east1
gkr-south1
gkr-south2
gkr-south3
ekr-west1
ekr-east1

API Version History

1.1

Firewall API 버전 1.1이 출시되었습니다.

변경사항

  • [변경] GET /v1/firewalls - List Firewalls API가 변경되었습니다.
    • 응답 모델이 FirewallListResponseV1Dot1 로 변경되었습니다.
      • 응답 시, 아래와 같은 필드가 추가됩니다.
        • zone_resources
      • 응답 시, 아래와 같은 필드가 삭제됩니다.
        • fw_resource_id
  • [변경] GET /v1/firewalls/{firewall_id} - Show Firewall API가 변경되었습니다.
    • 응답 모델이 FirewallShowResponseV1Dot1 로 변경되었습니다.
      • 응답 시, 아래와 같은 필드가 추가됩니다.
        • zone_resources
      • 응답 시, 아래와 같은 필드가 삭제됩니다.
        • fw_resource_id
  • [변경] PUT /v1/firewalls/{firewall_id} - Set Firewall API가 변경되었습니다.
    • 응답 모델이 FirewallShowResponseV1Dot1 로 변경되었습니다.
      • 응답 시, 아래와 같은 필드가 추가됩니다.
        • zone_resources
      • 응답 시, 아래와 같은 필드가 삭제됩니다.
        • fw_resource_id
  • [변경] GET /v1/firewalls/rules - List Firewall Rules API가 변경되었습니다.
    • 요청 시, 아래와 같은 쿼리 파라미터가 삭제됩니다.
      • fetch_all
    • 응답 모델이 FirewallRuleListResponseV1Dot1 로 변경되었습니다.
      • 응답 시, 아래와 같은 필드가 삭제됩니다.
        • destination_interface, name, source_interface, vendor_rule_id
  • [변경] GET /v1/firewalls/rules/{firewall_rule_id} - Show Firewall Rule API가 변경되었습니다.
    • 응답 모델이 FirewallRuleShowResponseV1Dot1 로 변경되었습니다.
      • 응답 시, 아래와 같은 필드가 삭제됩니다.
        • destination_interface, name, source_interface, vendor_rule_id
  • [변경] POST /v1/firewalls/rules - Create Firewall Rule API가 변경되었습니다.
    • 비동기 처리로 변경되었습니다.
    • 응답 코드가 201 Created에서 202 Accepted로 변경되어 응답 본문이 반환되지 않습니다.
    • 요청 모델이 FirewallRuleCreateSingleRequest 로 변경되었습니다.
      • 요청 시, 아래와 같은 필드가 삭제됩니다.
        • destination_interface, name, source_interface
  • [변경] PUT /v1/firewalls/rules/{firewall_rule_id} - Set Firewall Rule API가 변경되었습니다.
    • 비동기 처리로 변경되었습니다.
    • 응답 코드가 200 OK에서 202 Accepted로 변경되어 응답 본문이 반환되지 않습니다.
    • 요청 모델이 FirewallRuleUpdateSingleRequest 로 변경되었습니다.
      • 요청 시, 아래와 같은 필드가 추가됩니다.
        • order_direction, order_rule_id, status
  • [변경] DELETE /v1/firewalls/rules/{firewall_rule_id} - Delete Firewall Rule API가 변경되었습니다.
    • 비동기 처리로 변경되었습니다.
    • 응답 코드가 204 No Content에서 202 Accepted로 변경되었습니다.

1.0

Firewall API가 출시되었습니다.

변경사항

  • [신규] GET /v1/firewalls - API가 추가되었습니다.
  • [신규] GET /v1/firewalls/{firewall_id} - API가 추가되었습니다.
  • [신규] PUT /v1/firewalls/{firewall_id} - API가 추가되었습니다.
  • [신규] GET /v1/firewalls/rules - API가 추가되었습니다.
  • [신규] POST /v1/firewalls/rules - API가 추가되었습니다.
  • [신규] GET /v1/firewalls/rules/{firewall_rule_id} - API가 추가되었습니다.
  • [신규] PUT /v1/firewalls/rules/{firewall_rule_id} - API가 추가되었습니다.
  • [신규] DELETE /v1/firewalls/rules/{firewall_rule_id} - API가 추가되었습니다.

1 - APIs

1.1 - Create Firewall Rule

1.1.1 - 1.1

post /v1/firewalls/rules

Description

firewall rule 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
FirewallRuleCreateSingleRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/firewalls/rules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = firewall 1.1"

Request body

{
    "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
    "firewall_rule": {
        "action": "ALLOW",
        "description": "Firewall rule description example",
        "destination_address": [
            "10.0.0.1",
            "10.0.0.2"
        ],
        "direction": "INBOUND",
        "order_direction": "BEFORE",
        "order_rule_id": "043aa63459da466faad71fe4fe587031",
        "service": [
            {
                "service_type": "TCP",
                "service_value": "443"
            }
        ],
        "source_address": [
            "192.168.1.1",
            "192.168.1.2"
        ],
        "status": "ENABLE"
    }
}

Example HTTP response

Response 202

1.1.2 - 1.0

post /v1/firewalls/rules

Description

firewall rule 생성한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020270131

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
FirewallRuleCreateSingleRequest

Responses

HTTP CodeDescriptionSchema
201CreatedFirewallRuleShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/firewalls/rules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = firewall 1.0"

Request body

{
    "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
    "firewall_rule": {
        "action": "ALLOW",
        "description": "Firewall rule description example",
        "destination_address": [
            "10.0.0.1",
            "10.0.0.2"
        ],
        "direction": "INBOUND",
        "order_direction": "BEFORE",
        "order_rule_id": "043aa63459da466faad71fe4fe587031",
        "service": [
            {
                "service_type": "TCP",
                "service_value": "443"
            }
        ],
        "source_address": [
            "192.168.1.1",
            "192.168.1.2"
        ],
        "status": "ENABLE"
    }
}

Example HTTP response

Response 201

{
    "firewall_rule": {
        "action": "ALLOW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Firewall rule description example",
        "destination_address": [
            "10.0.0.1",
            "10.0.0.2"
        ],
        "destination_interface": "IFW1-v1001dn",
        "direction": "INBOUND",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "b156740b6335468d8354eb9ef8eddf5a",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "b156740b6335468d8354eb9ef8eddf5a",
        "sequence": 100,
        "service": [
            {
                "service_type": "TCP",
                "service_value": "443"
            }
        ],
        "source_address": [
            "192.168.1.1",
            "192.168.1.2"
        ],
        "source_interface": "IFW1-v2501up",
        "state": "CREATING",
        "status": "ENABLE",
        "vendor_rule_id": "72"
    }
}

1.2 - Delete Firewall Rule

1.2.1 - 1.1

delete /v1/firewalls/rules/{firewall_rule_id}

Description

firewall rule 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathfirewall_rule_id
required		Firewall rule ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/firewalls/rules/{firewall_rule_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = firewall 1.1"

Example HTTP response

Response 202

1.2.2 - 1.0

delete /v1/firewalls/rules/{firewall_rule_id}

Description

firewall rule 삭제한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020270131

Parameters

TypeNameDescriptionSchemaDefault
pathfirewall_rule_id
required		Firewall rule ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/firewalls/rules/{firewall_rule_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = firewall 1.0"

Example HTTP response

Response 204

1.3 - List Firewall Rules

1.3.1 - 1.1

get /v1/firewalls/rules

Description

firewall rule 목록 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryfirewall_id
required		Firewall ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone
querysrc_ip
optional		출발지 IP
Example : 192.168.1.1
stringNone
querydst_ip
optional		목적지 IP
Example : 192.168.1.1
stringNone
querydescription
optional		Firewall rule 설명
Example : Firewall rule description example
stringNone
querystate
optional		Firewall rule 상태
array[enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)][]
querystatus
optional		Firewall rule 사용 여부
Example :
enum (ENABLE, DISABLE)None

Responses

HTTP CodeDescriptionSchema
200OKFirewallRuleListResponseV1Dot1
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/firewalls/rules?firewall_id={firewall_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = firewall 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "firewall_rules": [
        {
            "action": "ALLOW",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Firewall rule description example",
            "destination_address": [
                "10.0.0.1",
                "10.0.0.2"
            ],
            "direction": "INBOUND",
            "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
            "id": "b156740b6335468d8354eb9ef8eddf5a",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "sequence": 100,
            "service": [
                {
                    "service_type": "TCP",
                    "service_value": "443"
                }
            ],
            "source_address": [
                "192.168.1.1",
                "192.168.1.2"
            ],
            "state": "CREATING",
            "status": "ENABLE"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.3.2 - 1.0

get /v1/firewalls/rules

Description

firewall rule 목록 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020270131

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryfirewall_id
required		Firewall ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone
querysrc_ip
optional		출발지 IP
Example : 192.168.1.1
stringNone
querydst_ip
optional		목적지 IP
Example : 192.168.1.1
stringNone
querydescription
optional		Firewall rule 설명
Example : Firewall rule description example
stringNone
querystate
optional		Firewall rule 상태
array[enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)][]
querystatus
optional		Firewall rule 사용 여부
Example :
enum (ENABLE, DISABLE)None
queryfetch_all
optional		Firewall rule 전체 조회
Example : False
booleanFalse

Responses

HTTP CodeDescriptionSchema
200OKFirewallRuleListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/firewalls/rules?firewall_id={firewall_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = firewall 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "firewall_rules": [
        {
            "action": "ALLOW",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Firewall rule description example",
            "destination_address": [
                "10.0.0.1",
                "10.0.0.2"
            ],
            "destination_interface": "IFW1-v1001dn",
            "direction": "INBOUND",
            "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
            "id": "b156740b6335468d8354eb9ef8eddf5a",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "b156740b6335468d8354eb9ef8eddf5a",
            "sequence": 100,
            "service": [
                {
                    "service_type": "TCP",
                    "service_value": "443"
                }
            ],
            "source_address": [
                "192.168.1.1",
                "192.168.1.2"
            ],
            "source_interface": "IFW1-v2501up",
            "state": "CREATING",
            "status": "ENABLE",
            "vendor_rule_id": "72"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.4 - List Firewalls

1.4.1 - 1.1

get /v1/firewalls

Description

firewall 목록 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryname
optional		Firewall 이름
Example : FW_IGW_secuVPC
stringNone
queryvpc_name
optional		VPC 명
Example : secuVPC
stringNone
queryproduct_type
optional		Firewall 상품 유형
array[enum (IGW, GGW, DGW, LB, SIGW, TGW_IGW, TGW_GGW, TGW_DGW, TGW_SIGW, TGW_BM)][]
querystate
optional		Firewall 상태
array[enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR, DEPLOYING)][]

Responses

HTTP CodeDescriptionSchema
200OKFirewallListResponseV1Dot1
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/firewalls

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = firewall 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "firewalls": [
        {
            "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "flavor_name": "SMALL",
            "flavor_rule_quota": 100,
            "id": "b156740b6335468d8354eb9ef8eddf5a",
            "loggable": false,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "FW_IGW_secuVPC",
            "pre_product_id": "76479b7ffee1431198d9beb4502cda08",
            "product_type": "IGW",
            "state": "CREATING",
            "status": "ENABLE",
            "total_rule_count": 8,
            "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
            "vpc_name": "secuVPC",
            "zone_resources": [
                {
                    "allocate_state": "SUCCESS",
                    "fw_resource_id": "005fd1d30dea11f08a2c56773bef875b",
                    "zone": "kr-west1-a"
                }
            ]
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.4.2 - 1.0

get /v1/firewalls

Description

firewall 목록 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020270131

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryname
optional		Firewall 이름
Example : FW_IGW_secuVPC
stringNone
queryvpc_name
optional		VPC 명
Example : secuVPC
stringNone
queryproduct_type
optional		Firewall 상품 유형
array[enum (IGW, GGW, DGW, LB, SIGW, TGW_IGW, TGW_GGW, TGW_DGW, TGW_SIGW, TGW_BM)][]
querystate
optional		Firewall 상태
array[enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR, DEPLOYING)][]

Responses

HTTP CodeDescriptionSchema
200OKFirewallListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/firewalls

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = firewall 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "firewalls": [
        {
            "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "flavor_name": "SMALL",
            "flavor_rule_quota": 100,
            "fw_resource_id": "005fd1d30dea11f08a2c56773bef875b",
            "id": "b156740b6335468d8354eb9ef8eddf5a",
            "loggable": false,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "FW_IGW_secuVPC",
            "pre_product_id": "76479b7ffee1431198d9beb4502cda08",
            "product_type": "IGW",
            "state": "CREATING",
            "status": "ENABLE",
            "total_rule_count": 8,
            "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
            "vpc_name": "secuVPC"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.5 - Set Firewall

1.5.1 - 1.1

put /v1/firewalls/{firewall_id}

Description

firewall 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathfirewall_id
required		Firewall ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone
bodybody
required
FirewallSetRequest

Responses

HTTP CodeDescriptionSchema
200OKFirewallShowResponseV1Dot1
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/firewalls/{firewall_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = firewall 1.1"

Request body

{
    "flavor_name": "EXSMALL",
    "loggable": false
}

Example HTTP response

Response 200

{
    "firewall": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "flavor_name": "SMALL",
        "flavor_rule_quota": 100,
        "id": "b156740b6335468d8354eb9ef8eddf5a",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "FW_IGW_secuVPC",
        "pre_product_id": "76479b7ffee1431198d9beb4502cda08",
        "product_type": "IGW",
        "state": "CREATING",
        "status": "ENABLE",
        "total_rule_count": 8,
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "secuVPC",
        "zone_resources": [
            {
                "allocate_state": "SUCCESS",
                "fw_resource_id": "005fd1d30dea11f08a2c56773bef875b",
                "zone": "kr-west1-a"
            }
        ]
    }
}

1.5.2 - 1.0

put /v1/firewalls/{firewall_id}

Description

firewall 수정한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020270131

Parameters

TypeNameDescriptionSchemaDefault
pathfirewall_id
required		Firewall ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone
bodybody
required
FirewallSetRequest

Responses

HTTP CodeDescriptionSchema
200OKFirewallShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/firewalls/{firewall_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = firewall 1.0"

Request body

{
    "flavor_name": "EXSMALL",
    "loggable": false
}

Example HTTP response

Response 200

{
    "firewall": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "flavor_name": "SMALL",
        "flavor_rule_quota": 100,
        "fw_resource_id": "005fd1d30dea11f08a2c56773bef875b",
        "id": "b156740b6335468d8354eb9ef8eddf5a",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "FW_IGW_secuVPC",
        "pre_product_id": "76479b7ffee1431198d9beb4502cda08",
        "product_type": "IGW",
        "state": "CREATING",
        "status": "ENABLE",
        "total_rule_count": 8,
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "secuVPC"
    }
}

1.6 - Set Firewall Rule

1.6.1 - 1.1

put /v1/firewalls/rules/{firewall_rule_id}

Description

firewall rule 수정한다,

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathfirewall_rule_id
required		Firewall rule ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone
bodybody
required
FirewallRuleUpdateSingleRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/firewalls/rules/{firewall_rule_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = firewall 1.1"

Request body

{
    "firewall_rule": {
        "action": "ALLOW",
        "description": "Firewall rule description example",
        "destination_address": [
            "10.0.0.1",
            "10.0.0.2"
        ],
        "direction": "INBOUND",
        "order_direction": "BEFORE",
        "order_rule_id": "043aa63459da466faad71fe4fe587031",
        "service": [
            {
                "service_type": "TCP",
                "service_value": "443"
            }
        ],
        "source_address": [
            "192.168.1.1",
            "192.168.1.2"
        ],
        "status": "ENABLE"
    }
}

Example HTTP response

Response 202

1.6.2 - 1.0

put /v1/firewalls/rules/{firewall_rule_id}

Description

firewall rule 수정한다,

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020270131

Parameters

TypeNameDescriptionSchemaDefault
pathfirewall_rule_id
required		Firewall rule ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone
bodybody
required
FirewallRuleSetRequest

Responses

HTTP CodeDescriptionSchema
200OKFirewallRuleShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/firewalls/rules/{firewall_rule_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = firewall 1.0"

Request body

{
    "action": "ALLOW",
    "description": "Firewall rule description example",
    "destination_address": [
        "10.0.0.1",
        "10.0.0.2"
    ],
    "direction": "INBOUND",
    "service": [
        {
            "service_type": "TCP",
            "service_value": "443"
        }
    ],
    "source_address": [
        "192.168.1.1",
        "192.168.1.2"
    ]
}

Example HTTP response

Response 200

{
    "firewall_rule": {
        "action": "ALLOW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Firewall rule description example",
        "destination_address": [
            "10.0.0.1",
            "10.0.0.2"
        ],
        "destination_interface": "IFW1-v1001dn",
        "direction": "INBOUND",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "b156740b6335468d8354eb9ef8eddf5a",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "b156740b6335468d8354eb9ef8eddf5a",
        "sequence": 100,
        "service": [
            {
                "service_type": "TCP",
                "service_value": "443"
            }
        ],
        "source_address": [
            "192.168.1.1",
            "192.168.1.2"
        ],
        "source_interface": "IFW1-v2501up",
        "state": "CREATING",
        "status": "ENABLE",
        "vendor_rule_id": "72"
    }
}

1.7 - Show Firewall

1.7.1 - 1.1

get /v1/firewalls/{firewall_id}

Description

firewall 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathfirewall_id
required		Firewall ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone

Responses

HTTP CodeDescriptionSchema
200OKFirewallShowResponseV1Dot1
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/firewalls/{firewall_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = firewall 1.1"

Example HTTP response

Response 200

{
    "firewall": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "flavor_name": "SMALL",
        "flavor_rule_quota": 100,
        "id": "b156740b6335468d8354eb9ef8eddf5a",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "FW_IGW_secuVPC",
        "pre_product_id": "76479b7ffee1431198d9beb4502cda08",
        "product_type": "IGW",
        "state": "CREATING",
        "status": "ENABLE",
        "total_rule_count": 8,
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "secuVPC",
        "zone_resources": [
            {
                "allocate_state": "SUCCESS",
                "fw_resource_id": "005fd1d30dea11f08a2c56773bef875b",
                "zone": "kr-west1-a"
            }
        ]
    }
}

1.7.2 - 1.0

get /v1/firewalls/{firewall_id}

Description

firewall 상세 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020270131

Parameters

TypeNameDescriptionSchemaDefault
pathfirewall_id
required		Firewall ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone

Responses

HTTP CodeDescriptionSchema
200OKFirewallShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/firewalls/{firewall_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = firewall 1.0"

Example HTTP response

Response 200

{
    "firewall": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "flavor_name": "SMALL",
        "flavor_rule_quota": 100,
        "fw_resource_id": "005fd1d30dea11f08a2c56773bef875b",
        "id": "b156740b6335468d8354eb9ef8eddf5a",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "FW_IGW_secuVPC",
        "pre_product_id": "76479b7ffee1431198d9beb4502cda08",
        "product_type": "IGW",
        "state": "CREATING",
        "status": "ENABLE",
        "total_rule_count": 8,
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "secuVPC"
    }
}

1.8 - Show Firewall Rule

1.8.1 - 1.1

get /v1/firewalls/rules/{firewall_rule_id}

Description

firewall rule 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathfirewall_rule_id
required		Firewall rule ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone

Responses

HTTP CodeDescriptionSchema
200OKFirewallRuleShowResponseV1Dot1
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/firewalls/rules/{firewall_rule_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = firewall 1.1"

Example HTTP response

Response 200

{
    "firewall_rule": {
        "action": "ALLOW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Firewall rule description example",
        "destination_address": [
            "10.0.0.1",
            "10.0.0.2"
        ],
        "direction": "INBOUND",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "b156740b6335468d8354eb9ef8eddf5a",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "sequence": 100,
        "service": [
            {
                "service_type": "TCP",
                "service_value": "443"
            }
        ],
        "source_address": [
            "192.168.1.1",
            "192.168.1.2"
        ],
        "state": "CREATING",
        "status": "ENABLE"
    }
}

1.8.2 - 1.0

get /v1/firewalls/rules/{firewall_rule_id}

Description

firewall rule 상세 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020270131

Parameters

TypeNameDescriptionSchemaDefault
pathfirewall_rule_id
required		Firewall rule ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone

Responses

HTTP CodeDescriptionSchema
200OKFirewallRuleShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/firewalls/rules/{firewall_rule_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = firewall 1.0"

Example HTTP response

Response 200

{
    "firewall_rule": {
        "action": "ALLOW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Firewall rule description example",
        "destination_address": [
            "10.0.0.1",
            "10.0.0.2"
        ],
        "destination_interface": "IFW1-v1001dn",
        "direction": "INBOUND",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "b156740b6335468d8354eb9ef8eddf5a",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "b156740b6335468d8354eb9ef8eddf5a",
        "sequence": 100,
        "service": [
            {
                "service_type": "TCP",
                "service_value": "443"
            }
        ],
        "source_address": [
            "192.168.1.1",
            "192.168.1.2"
        ],
        "source_interface": "IFW1-v2501up",
        "state": "CREATING",
        "status": "ENABLE",
        "vendor_rule_id": "72"
    }
}

2 - Models

2.1 - Firewall

NameDescriptionSchemaDefault
account_id
required		Account ID
Example : 0e3dffc50eb247a1adf4f2e5c82c4f99
string
created_at
required		생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required		생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
flavor_name
optional		Firewall 사이즈 이름
Example : SMALL
string
flavor_rule_quota
optional		Firewall 규칙 수 제한
Example : 100
integer
fw_resource_id
required		FW 리소스 ID
Example : 005fd1d30dea11f08a2c56773bef875b
string
id
required		Firewall ID
Example : b156740b6335468d8354eb9ef8eddf5a
string
loggable
required		로그 사용 여부
Example : False
boolean
modified_at
required		수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required		수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required		Firewall 이름
Example : FW_IGW_secuVPC
string
pre_product_id
optional		선행 상품 ID
Example : 76479b7ffee1431198d9beb4502cda08
string
product_type
required		Firewall 상품 유형
Example : IGW
enum (IGW, GGW, DGW, LB, SIGW, TGW_IGW, TGW_GGW, TGW_DGW, TGW_SIGW, TGW_BM)
state
required		Firewall 상태
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR, DEPLOYING)
status
required		Firewall 활성 여부
Example : ENABLE
enum (ENABLE, DISABLE)
total_rule_count
optional		전체 규칙 개수
Example : 8
integer
vpc_id
required		VPC ID
Example : ceb44ea5ecb34a49b16495f9a63b0718
any of [string, null]
vpc_name
required		VPC 명
Example : secuVPC
any of [string, null]

2.2 - FirewallListResponse

NameDescriptionSchemaDefault
count
required		count
Example : 20
integer
firewalls
required
array[Firewall]
page
required		page
Example : 0
integer
size
required		size
Example : 20
integer
sort
optional		sort
Example : ['created_at:asc']
any of [array[string], null]

2.3 - FirewallListResponseV1Dot1

NameDescriptionSchemaDefault
count
required		count
Example : 20
integer
firewalls
required
array[FirewallV1Dot1]
page
required		page
Example : 0
integer
size
required		size
Example : 20
integer
sort
optional		sort
Example : ['created_at:asc']
any of [array[string], null]

2.4 - FirewallPort

NameDescriptionSchemaDefault
service_type
required		서비스 프로토콜 유형
Example : TCP
enum (TCP, UDP, ICMP, IP, TCP_ALL, UDP_ALL, ICMP_ALL, ALL)
service_value
optional		서비스 포트 값
Example : 443
string

2.5 - FirewallRule

NameDescriptionSchemaDefault
action
required		Firewall rule 동작
Example : ALLOW
enum (ALLOW, DENY)
created_at
required		생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required		생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional		Firewall rule 설명
Example : Firewall rule description example
any of [string, null]
destination_address
required		목적지 주소
Example : ['10.0.0.1', '10.0.0.2']
array[string]
destination_interface
required		목적지 인터페이스 이름
Example : IFW1-v1001dn
string
direction
required		Firewall rule 방향
Example : INBOUND
enum (INBOUND, OUTBOUND)
firewall_id
required		Firewall ID
Example : b156740b6335468d8354eb9ef8eddf5a
string
id
required		Firewall rule ID
Example : b156740b6335468d8354eb9ef8eddf5a
string
modified_at
required		수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required		수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
optional		Firewall rule 이름
Example : b156740b6335468d8354eb9ef8eddf5a
any of [string, null]
sequence
required		Firewall rule 순서
Example : 100
integer
service
required		서비스 포트
array[FirewallPort]
source_address
required		출발지 주소
Example : ['192.168.1.1', '192.168.1.2']
array[string]
source_interface
required		출발지 인터페이스 이름
Example : IFW1-v2501up
string
state
required		Firewall rule 상태
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)
status
required		Firewall rule 사용 여부
Example : ENABLE
enum (ENABLE, DISABLE)
vendor_rule_id
required		벤더 규칙 ID
Example : 72
string

2.6 - FirewallRuleCreateRequest

NameDescriptionSchemaDefault
action
required		Firewall rule 동작
Example : ALLOW
enum (ALLOW, DENY)
description
optional		Firewall rule 설명
Example : Firewall rule description example
any of [string, null]
destination_address
required		목적지 주소
Example : ['10.0.0.1', '10.0.0.2']
array[string]
direction
required		Firewall rule 방향
Example : INBOUND
enum (INBOUND, OUTBOUND)
order_direction
optional		순서 방향
Example : BEFORE
enum (BEFORE, AFTER, BOTTOM)
order_rule_id
optional		순서 규칙 ID
Example : 043aa63459da466faad71fe4fe587031
string
service
required		서비스 포트
array[FirewallPort]
source_address
required		출발지 주소
Example : ['192.168.1.1', '192.168.1.2']
array[string]
status
required		Firewall rule 사용 여부
Example : ENABLE
enum (ENABLE, DISABLE)

2.7 - FirewallRuleCreateSingleRequest

NameDescriptionSchemaDefault
firewall_id
required		Firewall ID
Example : b156740b6335468d8354eb9ef8eddf5a
string
firewall_rule
required		Firewall 요청 Rule
FirewallRuleCreateRequest

2.8 - FirewallRuleListResponse

NameDescriptionSchemaDefault
count
required		count
Example : 20
integer
firewall_rules
required
array[FirewallRule]
page
required		page
Example : 0
integer
size
required		size
Example : 20
integer
sort
optional		sort
Example : ['created_at:asc']
any of [array[string], null]

2.9 - FirewallRuleListResponseV1Dot1

NameDescriptionSchemaDefault
count
required		count
Example : 20
integer
firewall_rules
required
array[FirewallRuleV1Dot1]
page
required		page
Example : 0
integer
size
required		size
Example : 20
integer
sort
optional		sort
Example : ['created_at:asc']
any of [array[string], null]

2.10 - FirewallRuleSetRequest

NameDescriptionSchemaDefault
action
required		Firewall rule 동작
Example : ALLOW
enum (ALLOW, DENY)
description
optional		Firewall rule 설명
Example : Firewall rule description example
any of [string, null]
destination_address
required		목적지 주소
Example : ['10.0.0.1', '10.0.0.2']
array[string]
direction
required		Firewall rule 방향
Example : INBOUND
enum (INBOUND, OUTBOUND)
service
required		서비스 포트
array[FirewallPort]
source_address
required		출발지 주소
Example : ['192.168.1.1', '192.168.1.2']
array[string]

2.11 - FirewallRuleShowResponse

NameDescriptionSchemaDefault
firewall_rule
required
FirewallRule

2.12 - FirewallRuleShowResponseV1Dot1

NameDescriptionSchemaDefault
firewall_rule
required
FirewallRuleV1Dot1

2.13 - FirewallRuleUpdateSingleRequest

NameDescriptionSchemaDefault
firewall_rule
required		Firewall 요청 Rule
FirewallRuleCreateRequest

2.14 - FirewallRuleV1Dot1

NameDescriptionSchemaDefault
action
required		Firewall rule 동작
Example : ALLOW
enum (ALLOW, DENY)
created_at
required		생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required		생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional		Firewall rule 설명
Example : Firewall rule description example
any of [string, null]
destination_address
required		목적지 주소
Example : ['10.0.0.1', '10.0.0.2']
array[string]
direction
required		Firewall rule 방향
Example : INBOUND
enum (INBOUND, OUTBOUND)
firewall_id
required		Firewall ID
Example : b156740b6335468d8354eb9ef8eddf5a
string
id
required		Firewall rule ID
Example : b156740b6335468d8354eb9ef8eddf5a
string
modified_at
required		수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required		수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
sequence
required		Firewall rule 순서
Example : 100
integer
service
required		서비스 포트
array[FirewallPort]
source_address
required		출발지 주소
Example : ['192.168.1.1', '192.168.1.2']
array[string]
state
required		Firewall rule 상태
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)
status
required		Firewall rule 사용 여부
Example : ENABLE
enum (ENABLE, DISABLE)

2.15 - FirewallSetRequest

NameDescriptionSchemaDefault
flavor_name
optional		Firewall 사이즈 이름
Example : EXSMALL
enum (EXSMALL, SMALL, MEDIUM, LARGE, EXLARGE)
loggable
optional		로그 사용 여부
Example : False
boolean

2.16 - FirewallShowResponse

NameDescriptionSchemaDefault
firewall
required
Firewall

2.17 - FirewallShowResponseV1Dot1

NameDescriptionSchemaDefault
firewall
required
FirewallV1Dot1

2.18 - FirewallV1Dot1

NameDescriptionSchemaDefault
account_id
required		Account ID
Example : 0e3dffc50eb247a1adf4f2e5c82c4f99
string
created_at
required		생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required		생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
flavor_name
optional		Firewall 사이즈 이름
Example : SMALL
string
flavor_rule_quota
optional		Firewall 규칙 수 제한
Example : 100
integer
id
required		Firewall ID
Example : b156740b6335468d8354eb9ef8eddf5a
string
loggable
required		로그 사용 여부
Example : False
boolean
modified_at
required		수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required		수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required		Firewall 이름
Example : FW_IGW_secuVPC
string
pre_product_id
optional		선행 상품 ID
Example : 76479b7ffee1431198d9beb4502cda08
string
product_type
required		Firewall 상품 유형
Example : IGW
enum (IGW, GGW, DGW, LB, SIGW, TGW_IGW, TGW_GGW, TGW_DGW, TGW_SIGW, TGW_BM)
state
required		Firewall 상태
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR, DEPLOYING)
status
required		Firewall 활성 여부
Example : ENABLE
enum (ENABLE, DISABLE)
total_rule_count
optional		전체 규칙 개수
Example : 8
integer
vpc_id
required		VPC ID
Example : ceb44ea5ecb34a49b16495f9a63b0718
any of [string, null]
vpc_name
required		VPC 명
Example : secuVPC
any of [string, null]
zone_resources
required		Firewall Zone Resources
array[ZoneResource]

2.19 - ZoneResource

NameDescriptionSchemaDefault
allocate_state
required		Firewall Allocate Type
Example : SUCCESS
enum (SUCCESS, FAIL, DELETED)
fw_resource_id
required		FW 리소스 ID
Example : 005fd1d30dea11f08a2c56773bef875b
string
zone
required		Firewall Zone
Example : kr-west1-a
string