Networking

1 - Cloud Secured SD-LAN

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 Cloud Secured SD-LAN 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

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

VersionStatusNot Before
1.0CURRENT-

OpenAPI URL

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

Environment and Region List

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

1.1 - APIs

1.1.1 - SetExternalCSSDLANNetworkChangeInfo

1.2 - Models

2 - Direct Connect

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 Direct Connect 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

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

VersionStatusNot Before
1.2CURRENT-
1.1SUPPORTED20270131
1.0SUPPORTED20261130

OpenAPI URL

https://direct-connect.{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.2

Multi AZ 기능이 추가됩니다.

변경사항

  • [변경] POST /v1/direct-connects - 요청 및 응답 시, 아래와 같은 필드가 추가됩니다.
    • uplink_active_zone
    • uplink_standby_zone
  • [변경] GET /v1/direct-connects/{direct_connect_id} - 응답 시, 아래와 같은 필드가 추가됩니다.
    • uplink_active_zone
    • uplink_standby_zone
  • [변경] PUT /v1/direct-connects/{direct_connect_id} - 호환성 대비를 위해 응답을 축소합니다.(요청한 값만 포함되도록 변경).

1.1

목록 API 페이징방식이 변경되었습니다.

변경사항

  • [변경] GET /v1/direct-connects - 요청 및 응답 시, 아래와 같은 필드가 변경 됩니다.
    • 삭제 : limit, marker
    • 추가 : size, page
  • [변경] GET /v1/direct-connects/{direct_connect_id}/routing-rules - 요청 및 응답 시, 아래와 같은 필드가 변경 됩니다.
    • 삭제 : limit, marker
    • 추가 : size, page

1.0

Direct Connect API가 출시되었습니다.

변경사항

  • [신규] GET /v1/direct-connects - api가 추가되었습니다.
  • [신규] POST /v1/direct-connects - api가 추가되었습니다.
  • [신규] GET /v1/direct-connects/{direct_connect_id} - api가 추가되었습니다.
  • [신규] PUT /v1/direct-connects/{direct_connect_id} - api가 추가되었습니다.
  • [신규] DELETE /v1/direct-connects/{direct_connect_id} - api가 추가되었습니다.
  • [신규] GET /v1/direct-connects/{direct_connect_id}/routing-rules - api가 추가되었습니다.
  • [신규] POST /v1/direct-connects/{direct_connect_id}/routing-rules - api가 추가되었습니다.
  • [신규] DELETE /v1/direct-connects/{direct_connect_id}/routing-rules/{routing_rule_id} - api가 추가되었습니다.

2.1 - APIs

2.1.1 - Create Direct Connect

2.1.1.1 - 1.2

post /v1/direct-connects

Description

Direct Connect를 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

DirectConnectCreateRequestV1Dot2

Responses

HTTP CodeDescriptionSchema
202AcceptedDirectConnectShowResponseV1Dot2
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/direct-connects

Request header

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

Request body

{
    "bandwidth": 1,
    "description": "Direct-connect Description",
    "firewall_enabled": true,
    "firewall_loggable": true,
    "name": "DirectConnectName",
    "tags": "[{'key': 'key', 'value': 'value'}]",
    "uplink_active_zone": "kr-west1-a",
    "uplink_standby_zone": "kr-west1-b",
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "direct_connect": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "fe860e0af0c04dcd8182b84f907f31f4",
        "firewall_id": "dffc455f1bd14e0594e4faa638aac3a1",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "DirectConnectName",
        "state": "ACTIVE",
        "uplink_active_zone": "kr-west1-a",
        "uplink_standby_zone": "kr-west1-b",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

2.1.1.2 - 1.1

post /v1/direct-connects

Description

Direct Connect를 생성한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120270131

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

DirectConnectCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedDirectConnectShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/direct-connects

Request header

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

Request body

{
    "bandwidth": 1,
    "description": "Direct-connect Description",
    "firewall_enabled": true,
    "firewall_loggable": true,
    "name": "DirectConnectName",
    "tags": "[{'key': 'key', 'value': 'value'}]",
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "direct_connect": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "fe860e0af0c04dcd8182b84f907f31f4",
        "firewall_id": "dffc455f1bd14e0594e4faa638aac3a1",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "DirectConnectName",
        "state": "ACTIVE",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

2.1.1.3 - 1.0

post /v1/direct-connects

Description

Direct Connect를 생성한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020261130

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

DirectConnectCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedDirectConnectShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/direct-connects

Request header

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

Request body

{
    "bandwidth": 1,
    "description": "Direct-connect Description",
    "firewall_enabled": true,
    "firewall_loggable": true,
    "name": "DirectConnectName",
    "tags": "[{'key': 'key', 'value': 'value'}]",
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "direct_connect": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "fe860e0af0c04dcd8182b84f907f31f4",
        "firewall_id": "dffc455f1bd14e0594e4faa638aac3a1",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "DirectConnectName",
        "state": "ACTIVE",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

2.1.2 - Create Routing Rule

2.1.2.1 - 1.2

post /v1/direct-connects/{direct_connect_id}/routing-rules

Description

Routing Rule을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

TypeNameDescriptionSchemaDefault
pathdirect_connect_id
required
Direct Connect ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
bodybody
required

RoutingRuleCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedRoutingRuleShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/direct-connects/{direct_connect_id}/routing-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 = direct-connect 1.2"

Request body

{
    "description": "TransitGateway Description",
    "destination_cidr": "11.11.11.0/24",
    "destination_resource_id": "be3c84238562488e81e4e0675f86be62",
    "destination_type": "ON_PREMISE"
}

Example HTTP response

Response 202

{
    "routing_rule": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "TransitGateway Description",
        "destination_cidr": "11.11.11.0/24",
        "destination_resource_id": "be3c84238562488e81e4e0675f86be62",
        "destination_resource_name": "ResourceName",
        "destination_type": "ON_PREMISE",
        "id": "c8980aa2bf1e43c9998682f7baaf1c46",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "owner_id": "cd1610830b9046418e4bc67831c533e6",
        "owner_type": "DIRECT_CONNECT",
        "state": "ACTIVE"
    }
}

2.1.2.2 - 1.1

post /v1/direct-connects/{direct_connect_id}/routing-rules

Description

Routing Rule을 생성한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120270131

Parameters

TypeNameDescriptionSchemaDefault
pathdirect_connect_id
required
Direct Connect ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
bodybody
required

RoutingRuleCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedRoutingRuleShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/direct-connects/{direct_connect_id}/routing-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 = direct-connect 1.1"

Request body

{
    "description": "TransitGateway Description",
    "destination_cidr": "11.11.11.0/24",
    "destination_resource_id": "be3c84238562488e81e4e0675f86be62",
    "destination_type": "ON_PREMISE"
}

Example HTTP response

Response 202

{
    "routing_rule": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "TransitGateway Description",
        "destination_cidr": "11.11.11.0/24",
        "destination_resource_id": "be3c84238562488e81e4e0675f86be62",
        "destination_resource_name": "ResourceName",
        "destination_type": "ON_PREMISE",
        "id": "c8980aa2bf1e43c9998682f7baaf1c46",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "owner_id": "cd1610830b9046418e4bc67831c533e6",
        "owner_type": "DIRECT_CONNECT",
        "state": "ACTIVE"
    }
}

2.1.2.3 - 1.0

post /v1/direct-connects/{direct_connect_id}/routing-rules

Description

Routing Rule을 생성한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020261130

Parameters

TypeNameDescriptionSchemaDefault
pathdirect_connect_id
required
Direct Connect ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
bodybody
required

RoutingRuleCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedRoutingRuleShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/direct-connects/{direct_connect_id}/routing-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 = direct-connect 1.0"

Request body

{
    "description": "TransitGateway Description",
    "destination_cidr": "11.11.11.0/24",
    "destination_resource_id": "be3c84238562488e81e4e0675f86be62",
    "destination_type": "ON_PREMISE"
}

Example HTTP response

Response 202

{
    "routing_rule": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "TransitGateway Description",
        "destination_cidr": "11.11.11.0/24",
        "destination_resource_id": "be3c84238562488e81e4e0675f86be62",
        "destination_resource_name": "ResourceName",
        "destination_type": "ON_PREMISE",
        "id": "c8980aa2bf1e43c9998682f7baaf1c46",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "owner_id": "cd1610830b9046418e4bc67831c533e6",
        "owner_type": "DIRECT_CONNECT",
        "state": "ACTIVE"
    }
}

2.1.3 - Delete Direct Connect

2.1.3.1 - 1.2

delete /v1/direct-connects/{direct_connect_id}

Description

Direct Connect를 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

TypeNameDescriptionSchemaDefault
pathdirect_connect_id
required
Direct Connect ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone

Responses

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

Example HTTP request

Request path

/v1/direct-connects/{direct_connect_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 = direct-connect 1.2"

Example HTTP response

Response 202

2.1.3.2 - 1.1

delete /v1/direct-connects/{direct_connect_id}

Description

Direct Connect를 삭제한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120270131

Parameters

TypeNameDescriptionSchemaDefault
pathdirect_connect_id
required
Direct Connect ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone

Responses

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

Example HTTP request

Request path

/v1/direct-connects/{direct_connect_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 = direct-connect 1.1"

Example HTTP response

Response 202

2.1.3.3 - 1.0

delete /v1/direct-connects/{direct_connect_id}

Description

Direct Connect를 삭제한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020261130

Parameters

TypeNameDescriptionSchemaDefault
pathdirect_connect_id
required
Direct Connect ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone

Responses

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

Example HTTP request

Request path

/v1/direct-connects/{direct_connect_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 = direct-connect 1.0"

Example HTTP response

Response 202

2.1.4 - Delete Routing Rule

2.1.4.1 - 1.2

delete /v1/direct-connects/{direct_connect_id}/routing-rules/{routing_rule_id}

Description

Routing Rule을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

TypeNameDescriptionSchemaDefault
pathdirect_connect_id
required
Direct Connect ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
pathrouting_rule_id
required
Routing Rule ID
Example : c8980aa2bf1e43c9998682f7baaf1c46
stringNone

Responses

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

Example HTTP request

Request path

/v1/direct-connects/{direct_connect_id}/routing-rules/{routing_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 = direct-connect 1.2"

Example HTTP response

Response 202

2.1.4.2 - 1.1

delete /v1/direct-connects/{direct_connect_id}/routing-rules/{routing_rule_id}

Description

Routing Rule을 삭제한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120270131

Parameters

TypeNameDescriptionSchemaDefault
pathdirect_connect_id
required
Direct Connect ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
pathrouting_rule_id
required
Routing Rule ID
Example : c8980aa2bf1e43c9998682f7baaf1c46
stringNone

Responses

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

Example HTTP request

Request path

/v1/direct-connects/{direct_connect_id}/routing-rules/{routing_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 = direct-connect 1.1"

Example HTTP response

Response 202

2.1.4.3 - 1.0

delete /v1/direct-connects/{direct_connect_id}/routing-rules/{routing_rule_id}

Description

Routing Rule을 삭제한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020261130

Parameters

TypeNameDescriptionSchemaDefault
pathdirect_connect_id
required
Direct Connect ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
pathrouting_rule_id
required
Routing Rule ID
Example : c8980aa2bf1e43c9998682f7baaf1c46
stringNone

Responses

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

Example HTTP request

Request path

/v1/direct-connects/{direct_connect_id}/routing-rules/{routing_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 = direct-connect 1.0"

Example HTTP response

Response 202

2.1.5 - List Direct Connects

2.1.5.1 - 1.2

get /v1/direct-connects

Description

Direct Connect 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

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
queryid
optional
Direct Connect ID
Example : fe860e0af0c04dcd8182b84f907f31f4
string
queryname
optional
Direct Connect명
Example : DirectConnectName
string
querystate
optional
상태
Example : ACTIVE
enum (CREATING, ACTIVE, EDITING, DELETING, DELETED, ERROR)
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
queryvpc_name
optional
VPC 명
Example : vpcName
string

Responses

HTTP CodeDescriptionSchema
200OKDirectConnectListResponseV1Dot1
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/direct-connects

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "direct_connects": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "bandwidth": 1,
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "fe860e0af0c04dcd8182b84f907f31f4",
            "firewall_id": "dffc455f1bd14e0594e4faa638aac3a1",
            "id": "fe860e0af0c04dcd8182b84f907f31f4",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "DirectConnectName",
            "state": "ACTIVE",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

2.1.5.2 - 1.1

get /v1/direct-connects

Description

Direct Connect 목록을 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120270131

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
queryid
optional
Direct Connect ID
Example : fe860e0af0c04dcd8182b84f907f31f4
string
queryname
optional
Direct Connect명
Example : DirectConnectName
string
querystate
optional
상태
Example : ACTIVE
enum (CREATING, ACTIVE, EDITING, DELETING, DELETED, ERROR)
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
queryvpc_name
optional
VPC 명
Example : vpcName
string

Responses

HTTP CodeDescriptionSchema
200OKDirectConnectListResponseV1Dot1
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/direct-connects

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "direct_connects": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "bandwidth": 1,
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "fe860e0af0c04dcd8182b84f907f31f4",
            "firewall_id": "dffc455f1bd14e0594e4faa638aac3a1",
            "id": "fe860e0af0c04dcd8182b84f907f31f4",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "DirectConnectName",
            "state": "ACTIVE",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

2.1.5.3 - 1.0

get /v1/direct-connects

Description

Direct Connect 목록을 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020261130

Parameters

TypeNameDescriptionSchemaDefault
querywith_count
optional
with count
Example : true
any of [string, null]None
querylimit
optional
한도
Example : 20
any of [integer, null]None
querymarker
optional
마커
Example : 607e0938521643b5b4b266f343fae693
any of [string, null]None
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
queryid
optional
Direct Connect ID
Example : fe860e0af0c04dcd8182b84f907f31f4
string
queryname
optional
Direct Connect명
Example : DirectConnectName
string
querystate
optional
상태
Example : ACTIVE
enum (CREATING, ACTIVE, EDITING, DELETING, DELETED, ERROR)
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
queryvpc_name
optional
VPC 명
Example : vpcName
string

Responses

HTTP CodeDescriptionSchema
200OKDirectConnectListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/direct-connects

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "direct_connects": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "bandwidth": 1,
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "fe860e0af0c04dcd8182b84f907f31f4",
            "firewall_id": "dffc455f1bd14e0594e4faa638aac3a1",
            "id": "fe860e0af0c04dcd8182b84f907f31f4",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "DirectConnectName",
            "state": "ACTIVE",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ],
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

2.1.6 - List Routing Rules

2.1.6.1 - 1.2

get /v1/direct-connects/{direct_connect_id}/routing-rules

Description

Routing Rule 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

TypeNameDescriptionSchemaDefault
pathdirect_connect_id
required
Direct Connect ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
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
queryid
optional
Routing Rule ID
Example : c8980aa2bf1e43c9998682f7baaf1c46
any of [string, null]None
querydestination_type
optional
목적지 타입
Example : ON_PREMISE
enum (VPC, ON_PREMISE)None
querydestination_cidr
optional
목적지 CIDR
Example : 11.11.11.0/24
any of [string, null]None
querystate
optional
상태
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)None

Responses

HTTP CodeDescriptionSchema
200OKRoutingRuleListResponseV1Dot1
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/direct-connects/{direct_connect_id}/routing-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 = direct-connect 1.2"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "routing_rules": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "TransitGateway Description",
            "destination_cidr": "11.11.11.0/24",
            "destination_resource_id": "be3c84238562488e81e4e0675f86be62",
            "destination_resource_name": "ResourceName",
            "destination_type": "ON_PREMISE",
            "id": "c8980aa2bf1e43c9998682f7baaf1c46",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "owner_id": "cd1610830b9046418e4bc67831c533e6",
            "owner_type": "DIRECT_CONNECT",
            "state": "ACTIVE"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

2.1.6.2 - 1.1

get /v1/direct-connects/{direct_connect_id}/routing-rules

Description

Routing Rule 목록을 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120270131

Parameters

TypeNameDescriptionSchemaDefault
pathdirect_connect_id
required
Direct Connect ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
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
queryid
optional
Routing Rule ID
Example : c8980aa2bf1e43c9998682f7baaf1c46
any of [string, null]None
querydestination_type
optional
목적지 타입
Example : ON_PREMISE
enum (VPC, ON_PREMISE)None
querydestination_cidr
optional
목적지 CIDR
Example : 11.11.11.0/24
any of [string, null]None
querystate
optional
상태
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)None

Responses

HTTP CodeDescriptionSchema
200OKRoutingRuleListResponseV1Dot1
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/direct-connects/{direct_connect_id}/routing-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 = direct-connect 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "routing_rules": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "TransitGateway Description",
            "destination_cidr": "11.11.11.0/24",
            "destination_resource_id": "be3c84238562488e81e4e0675f86be62",
            "destination_resource_name": "ResourceName",
            "destination_type": "ON_PREMISE",
            "id": "c8980aa2bf1e43c9998682f7baaf1c46",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "owner_id": "cd1610830b9046418e4bc67831c533e6",
            "owner_type": "DIRECT_CONNECT",
            "state": "ACTIVE"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

2.1.6.3 - 1.0

get /v1/direct-connects/{direct_connect_id}/routing-rules

Description

Routing Rule 목록을 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020261130

Parameters

TypeNameDescriptionSchemaDefault
pathdirect_connect_id
required
Direct Connect ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
querywith_count
optional
with count
Example : true
any of [string, null]None
querylimit
optional
한도
Example : 20
any of [integer, null]None
querymarker
optional
마커
Example : 607e0938521643b5b4b266f343fae693
any of [string, null]None
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
queryid
optional
Routing Rule ID
Example : c8980aa2bf1e43c9998682f7baaf1c46
any of [string, null]None
querydestination_type
optional
목적지 타입
Example : ON_PREMISE
enum (VPC, ON_PREMISE)None
querydestination_cidr
optional
목적지 CIDR
Example : 11.11.11.0/24
any of [string, null]None
querystate
optional
상태
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)None

Responses

HTTP CodeDescriptionSchema
200OKRoutingRuleListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/direct-connects/{direct_connect_id}/routing-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 = direct-connect 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "routing_rules": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "TransitGateway Description",
            "destination_cidr": "11.11.11.0/24",
            "destination_resource_id": "be3c84238562488e81e4e0675f86be62",
            "destination_resource_name": "ResourceName",
            "destination_type": "ON_PREMISE",
            "id": "c8980aa2bf1e43c9998682f7baaf1c46",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "owner_id": "cd1610830b9046418e4bc67831c533e6",
            "owner_type": "DIRECT_CONNECT",
            "state": "ACTIVE"
        }
    ]
}

2.1.7 - Set Direct Connect

2.1.7.1 - 1.2

put /v1/direct-connects/{direct_connect_id}

Description

Direct Connect를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

TypeNameDescriptionSchemaDefault
pathdirect_connect_id
required
Direct Connect ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
bodybody
required

DirectConnectSetRequest

Responses

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

Example HTTP request

Request path

/v1/direct-connects/{direct_connect_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 = direct-connect 1.2"

Request body

{
    "description": "Direct-connect Description"
}

Example HTTP response

Response 200

{
    "description": "Direct-connect Description"
}

2.1.7.2 - 1.1

put /v1/direct-connects/{direct_connect_id}

Description

Direct Connect를 수정한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120270131

Parameters

TypeNameDescriptionSchemaDefault
pathdirect_connect_id
required
Direct Connect ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
bodybody
required

DirectConnectSetRequest

Responses

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

Example HTTP request

Request path

/v1/direct-connects/{direct_connect_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 = direct-connect 1.1"

Request body

{
    "description": "Direct-connect Description"
}

Example HTTP response

Response 200

{
    "direct_connect": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "fe860e0af0c04dcd8182b84f907f31f4",
        "firewall_id": "dffc455f1bd14e0594e4faa638aac3a1",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "DirectConnectName",
        "state": "ACTIVE",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

2.1.7.3 - 1.0

put /v1/direct-connects/{direct_connect_id}

Description

Direct Connect를 수정한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020261130

Parameters

TypeNameDescriptionSchemaDefault
pathdirect_connect_id
required
Direct Connect ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
bodybody
required

DirectConnectSetRequest

Responses

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

Example HTTP request

Request path

/v1/direct-connects/{direct_connect_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 = direct-connect 1.0"

Request body

{
    "description": "Direct-connect Description"
}

Example HTTP response

Response 200

{
    "direct_connect": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "fe860e0af0c04dcd8182b84f907f31f4",
        "firewall_id": "dffc455f1bd14e0594e4faa638aac3a1",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "DirectConnectName",
        "state": "ACTIVE",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

2.1.8 - Show Direct Connect

2.1.8.1 - 1.2

get /v1/direct-connects/{direct_connect_id}

Description

Direct Connect를 상세조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.2-

Parameters

TypeNameDescriptionSchemaDefault
pathdirect_connect_id
required
Direct Connect ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone

Responses

HTTP CodeDescriptionSchema
200OKDirectConnectShowResponseV1Dot2
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/direct-connects/{direct_connect_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 = direct-connect 1.2"

Example HTTP response

Response 200

{
    "direct_connect": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "fe860e0af0c04dcd8182b84f907f31f4",
        "firewall_id": "dffc455f1bd14e0594e4faa638aac3a1",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "DirectConnectName",
        "state": "ACTIVE",
        "uplink_active_zone": "kr-west1-a",
        "uplink_standby_zone": "kr-west1-b",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

2.1.8.2 - 1.1

get /v1/direct-connects/{direct_connect_id}

Description

Direct Connect를 상세조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120270131

Parameters

TypeNameDescriptionSchemaDefault
pathdirect_connect_id
required
Direct Connect ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone

Responses

HTTP CodeDescriptionSchema
200OKDirectConnectShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/direct-connects/{direct_connect_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 = direct-connect 1.1"

Example HTTP response

Response 200

{
    "direct_connect": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "fe860e0af0c04dcd8182b84f907f31f4",
        "firewall_id": "dffc455f1bd14e0594e4faa638aac3a1",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "DirectConnectName",
        "state": "ACTIVE",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

2.1.8.3 - 1.0

get /v1/direct-connects/{direct_connect_id}

Description

Direct Connect를 상세조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020261130

Parameters

TypeNameDescriptionSchemaDefault
pathdirect_connect_id
required
Direct Connect ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone

Responses

HTTP CodeDescriptionSchema
200OKDirectConnectShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/direct-connects/{direct_connect_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 = direct-connect 1.0"

Example HTTP response

Response 200

{
    "direct_connect": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "fe860e0af0c04dcd8182b84f907f31f4",
        "firewall_id": "dffc455f1bd14e0594e4faa638aac3a1",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "DirectConnectName",
        "state": "ACTIVE",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

2.2 - Models

2.2.1 - DirectConnect

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
bandwidth
required
포트용량
Example : 1
integer
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
Direct Connect 설명
Example : fe860e0af0c04dcd8182b84f907f31f4
any of [string, null]
firewall_id
optional
Firewall ID
Example : dffc455f1bd14e0594e4faa638aac3a1
any of [string, null]
id
required
Direct Connect ID
Example : fe860e0af0c04dcd8182b84f907f31f4
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Direct Connect명
Example : DirectConnectName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
state
required
상태
Example : ACTIVE
enum (CREATING, ACTIVE, EDITING, DELETING, DELETED, ERROR)
vpc_id
required
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
vpc_name
required
VPC 명
Example : vpcName
string

2.2.2 - DirectConnectCreateRequest

NameDescriptionSchemaDefault
bandwidth
required
포트용량
Example : 1
integer
description
optional
Direct Connect 설명
Example : Direct-connect Description
Maximum length : 50
string
firewall_enabled
optional
Firewall 사용
Example : True
boolean
firewall_loggable
optional
방화벽 로깅 가능
Example : True
boolean
name
required
Direct Connect명
Example : DirectConnectName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
tags
optional
태그 목록
Example : [{'key': 'key', 'value': 'value'}]
array[Tag]
vpc_id
required
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string

2.2.3 - DirectConnectCreateRequestV1Dot2

NameDescriptionSchemaDefault
bandwidth
required
포트용량
Example : 1
integer
description
optional
Direct Connect 설명
Example : Direct-connect Description
Maximum length : 50
string
firewall_enabled
optional
Firewall 사용
Example : True
boolean
firewall_loggable
optional
방화벽 로깅 가능
Example : True
boolean
name
required
Direct Connect명
Example : DirectConnectName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
tags
optional
태그 목록
Example : [{'key': 'key', 'value': 'value'}]
array[Tag]
uplink_active_zone
optional
Uplink Active Zone
Example : kr-west1-a
any of [string, null]
uplink_standby_zone
optional
Uplink Standby Zone
Example : kr-west1-b
any of [string, null]
vpc_id
required
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string

2.2.4 - DirectConnectListResponse

NameDescriptionSchemaDefault
count
optional
전체 개수
Example : 20
any of [integer, null]
direct_connects
required

array[DirectConnect]
links
optional
links
Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]
any of [array[object], null]

2.2.5 - DirectConnectListResponseV1Dot1

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
direct_connects
required

array[DirectConnect]
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.2.6 - DirectConnectSetRequest

NameDescriptionSchemaDefault
description
required
Direct Connect 설명
Example : Direct-connect Description
Maximum length : 50
string

2.2.7 - DirectConnectSetResponse

NameDescriptionSchemaDefault
description
optional
Direct Connect 설명
Example : Direct-connect Description
any of [string, null]

2.2.8 - DirectConnectShowResponse

NameDescriptionSchemaDefault
direct_connect
required

DirectConnect

2.2.9 - DirectConnectShowResponseV1Dot2

NameDescriptionSchemaDefault
direct_connect
required

DirectConnectV1Dot2

2.2.10 - DirectConnectV1Dot2

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
bandwidth
required
포트용량
Example : 1
integer
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
Direct Connect 설명
Example : fe860e0af0c04dcd8182b84f907f31f4
any of [string, null]
firewall_id
optional
Firewall ID
Example : dffc455f1bd14e0594e4faa638aac3a1
any of [string, null]
id
required
Direct Connect ID
Example : fe860e0af0c04dcd8182b84f907f31f4
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Direct Connect명
Example : DirectConnectName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
state
required
상태
Example : ACTIVE
enum (CREATING, ACTIVE, EDITING, DELETING, DELETED, ERROR)
uplink_active_zone
optional
Uplink Active Zone
Example : kr-west1-a
any of [string, null]
uplink_standby_zone
optional
Uplink Standby Zone
Example : kr-west1-b
any of [string, null]
vpc_id
required
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
vpc_name
required
VPC 명
Example : vpcName
string

2.2.11 - RoutingRule

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
required
설명
Example : TransitGateway Description
string
destination_cidr
required
목적지 CIDR
Example : 11.11.11.0/24
string
destination_resource_id
required
목적지 자원 ID
Example : be3c84238562488e81e4e0675f86be62
any of [string, null]
destination_resource_name
optional
목적지 자원명
Example : ResourceName
any of [string, null]
destination_type
required
목적지 타입
Example : ON_PREMISE
enum (VPC, ON_PREMISE, INTERNET, TGW)
id
required
Routing Rule ID
Example : c8980aa2bf1e43c9998682f7baaf1c46
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
owner_id
required
Routing Rule 소유자 ID
Example : cd1610830b9046418e4bc67831c533e6
string
owner_type
required
Routing Rule 소유자 타입
Example : DIRECT_CONNECT
enum (INTERNET_GATEWAY, GROUP_GATEWAY, DIRECT_CONNECT, SUBNET, PRIVATE_NAT, TRANSIT_GATEWAY, VPC_PEERING, SECURE_INTERNET_GATEWAY)
state
required
상태
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)

2.2.12 - RoutingRuleCreateRequest

NameDescriptionSchemaDefault
description
optional
설명
Example : TransitGateway Description
Maximum length : 50
string
destination_cidr
required
목적지 CIDR
Example : 11.11.11.0/24
string
destination_resource_id
optional
목적지 자원 ID
Example : be3c84238562488e81e4e0675f86be62
any of [string, null]
destination_type
required
목적지 타입
Example : ON_PREMISE
enum (VPC, ON_PREMISE)

2.2.13 - RoutingRuleListResponse

NameDescriptionSchemaDefault
count
optional
전체 개수
Example : 20
any of [integer, null]
links
optional
links
Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]
any of [array[object], null]
routing_rules
required

array[RoutingRule]

2.2.14 - RoutingRuleListResponseV1Dot1

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
page
required
page
Example : 0
integer
routing_rules
required

array[RoutingRule]
size
required
size
Example : 20
integer
sort
optional
sort
Example : ['created_at:asc']
any of [array[string], null]

2.2.15 - RoutingRuleShowResponse

NameDescriptionSchemaDefault
routing_rule
required

RoutingRule

2.2.16 - Tag

NameDescriptionSchemaDefault
key
required
tag key
Example :
string
value
required
tag value
Example :
string

3 - DNS

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 DNS 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

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

VersionStatusNot Before
1.3CURRENT-

OpenAPI URL

https://dns.{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.3

  • DNS API가 1.3 버전으로 업데이트 되었습니다.
  • DNS API 1.0 ~ 1.2 버전은 DEPRECATED 되었습니다.

변경사항

  • [변경] POST /dns/1.1/hosted-zones - CreateHostedZone API 가 변경되었습니다.
    • 요청 시, email 필드가 삭제되었습니다.
  • [변경] GET /dns/1.1/hosted-zones/{hosted_zone_id} - ShowHostedZone API 가 변경되었습니다.
    • 응답 시, email 필드가 삭제되었습니다.
  • [변경] PUT /dns/1.1/hosted-zones/{hosted_zone_id} - SetHostedZone API 가 변경되었습니다.
    • 요청 시, email 필드가 삭제되었습니다.
  • [변경] GET /dns/1.1/hosted-zones/{hosted_zone_id}/records - ListHostedZoneRecords API 가 변경되었습니다.
    • Zone apex 레코드 이름이 원본 그대로 표시됩니다 (@. 표기법 미사용).
  • [변경] GET /dns/1.1/public-domain-names - ListPublicDomainNames API 가 변경되었습니다.
    • Operation ID가 listPublicDomainNames로 변경되었습니다.
  • [변경] POST /dns/1.1/public-domain-names - CreatePublicDomainName API 가 변경되었습니다.
    • Operation ID가 createPublicDomainName으로 변경되었습니다.
  • [변경] GET /dns/1.1/public-domain-names/{public_domain_id} - ShowPublicDomainName API 가 변경되었습니다.
    • Operation ID가 showPublicDomainName으로 변경되었습니다.
  • [변경] PUT /dns/1.1/public-domain-names/{public_domain_id} - SetPublicDomainName API 가 변경되었습니다.
    • Operation ID가 setPublicDomainName으로 변경되었습니다.
  • [신규] POST /dns/1.3/public-domain-names/{public_domain_id}/transfer - TransferPublicDomainName 1.3 API 가 추가되었습니다.

1.2

DNS API가 1.2 버전으로 업데이트 되었습니다.

변경사항

  • [변경] GET /dns/1.1/hosted-zones - ListHostedZones API 가 변경되었습니다.
    • 응답 시, 아래와 같은 필드가 추가됩니다.:
      • private_dns_name (Private DNS 이름 조회)
  • [변경] GET /dns/1.1/hosted-zones/{hosted_zone_id} - ShowHostedZone API 가 변경되었습니다.
    • 응답 시, 아래와 같은 필드가 추가됩니다.:
      • private_dns_name (Private DNS 이름 조회)

1.1

DNS API가 1.1 버전으로 업데이트 되었습니다.

변경사항

  • [변경] PATCH /dns/1.0/hosted-zones/{zone_id} - SetHostedZone 1.0 API 가 변경 되었습니다.
    • PUT /dns/1.0/hosted-zones/{hosted_zone_id} API 로 대체되었습니다.
  • [삭제] POST /dns/1.0/public-domain-names/{public_domain_id}/renew - RenewPublicDomainName 1.0 API 가 삭제되었습니다.
    • 해당 API 는 더 이상 제공되지 않습니다.
  • [변경] GET /dns/1.1/hosted-zones/{hosted_zone_id}/records - ListHostedZoneRecords API 가 변경되었습니다.
    • Zone apex 레코드 이름이 @. 표기법으로 표시됩니다.
  • [변경] POST /dns/1.0/private-dns - CreatePrivateDns API 가 변경되었습니다.
    • 요청 시, 아래와 같은 필드가 추가됩니다.:
      • registered_region
      • private_dns_cr_id

1.0

DNS API가 출시되었습니다.

변경사항

  • [신규] GET /dns/1.0/hosted-zones - ListHostedZones 1.0 API 가 추가되었습니다.
  • [신규] POST /dns/1.0/hosted-zones - CreateHostedZone 1.0 API 가 추가되었습니다.
  • [신규] GET /dns/1.0/hosted-zones/{zone_id} - ShowHostedZone 1.0 API 가 추가되었습니다.
  • [신규] PATCH /dns/1.0/hosted-zones/{zone_id} - SetHostedZone 1.0 API 가 추가되었습니다.
  • [신규] DELETE /dns/1.0/hosted-zones/{zone_id} - DeleteHostedZone 1.0 API 가 추가되었습니다.
  • [신규] GET /dns/1.0/hosted-zones/{zone_id}/records - ListHostedZoneRecords 1.0 API 가 추가되었습니다.
  • [신규] POST /dns/1.0/hosted-zones/{zone_id}/records - CreateHostedZoneRecord 1.0 API 가 추가되었습니다.
  • [신규] GET /dns/1.0/hosted-zones/{zone_id}/records/{recordset_id} - ShowHostedZoneRecord 1.0 API 가 추가되었습니다.
  • [신규] PUT /dns/1.0/hosted-zones/{zone_id}/records/{recordset_id} - SetHostedZoneRecord 1.0 API 가 추가되었습니다.
  • [신규] DELETE /dns/1.0/hosted-zones/{zone_id}/records/{recordset_id} - DeleteHostedZoneRecord 1.0 API 가 추가되었습니다.
  • [신규] GET /dns/1.0/private-dns - ListPrivateDns 1.0 API 가 추가되었습니다.
  • [신규] POST /dns/1.0/private-dns - CreatePrivateDns 1.0 API 가 추가되었습니다.
  • [신규] GET /dns/1.0/private-dns/{private_dns_id} - ShowPrivateDns 1.0 API 가 추가되었습니다.
  • [신규] PUT /dns/1.0/private-dns/{private_dns_id} - SetPrivateDns 1.0 API 가 추가되었습니다.
  • [신규] DELETE /dns/1.0/private-dns/{private_dns_id} - DeletePrivateDns 1.0 API 가 추가되었습니다.
  • [신규] POST /dns/1.0/private-dns/activate - ActivatePrivateDns 1.0 API 가 추가되었습니다.
  • [신규] GET /dns/1.0/public-domain-names - ListPublicDomainNames 1.0 API 가 추가되었습니다.
  • [신규] POST /dns/1.0/public-domain-names - CreatePublicDomainName 1.0 API 가 추가되었습니다.
  • [신규] GET /dns/1.0/public-domain-names/{public_domain_id} - ShowPublicDomainName 1.0 API 가 추가되었습니다.
  • [신규] PUT /dns/1.0/public-domain-names/{public_domain_id} - SetPublicDomainName 1.0 API 가 추가되었습니다.
  • [신규] PUT /dns/1.0/public-domain-names/{public_domain_id}/information - SetPublicDomainNameWhoisInfo 1.0 API 가 추가되었습니다.
  • [신규] POST /dns/1.0/public-domain-names/{public_domain_id}/renew - RenewPublicDomainName 1.0 API 가 추가되었습니다.

3.1 - APIs

3.1.1 - Activate Private DNS

3.1.1.1 - 1.3

post /v1/private-dns/activate

Description

Private DNS 활성화

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

PrivateDnsActivateRequest

Responses

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

Example HTTP request

Request path

/v1/private-dns/activate

Request header

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

Request body

{
    "name": "private-dns01"
}

Example HTTP response

Response 202

{
    "private_dns": {
        "auth_dns_name": "authdns-a1b2c3d4e5f6789012345678abcdef90",
        "connected_vpc_ids": [
            "1234567890abcdef1234567890abcdef",
            "fedcba0987654321fedcba0987654321"
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "This is description",
        "id": "fedcba9876543210fedcba9876543210",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "private-dns01",
        "pool_id": "12345678-90ab-cdef-1234-567890abcdef",
        "pool_name": "private01-a1b2c3d4e5f6789012345678abcdef90",
        "registered_region": "KR-WEST1",
        "resolver_ip": "198.19.0.101",
        "resolver_name": "resolver-a1b2c3d4e5f6789012345678abcdef90",
        "state": "ACTIVE"
    }
}

3.1.2 - Create Hosted Zone

3.1.2.1 - 1.3

post /v1/hosted-zones

Description

도메인 이름 해석을 관리하는 DNS 레코드를 포함하는 Hosted Zone을 생성합니다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

HostedZoneCreateRequestV1Dot3

Responses

HTTP CodeDescriptionSchema
202AcceptedHostedZoneShowResponseV1Dot3
400Bad RequestNone
403ForbiddenNone
409ConflictNone

Example HTTP request

Request path

/v1/hosted-zones

Request header

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

Request body

{
    "description": "This is description",
    "name": "my-zone.com",
    "private_dns_id": "fedcba9876543210fedcba9876543210",
    "tags": [],
    "type": "private"
}

Example HTTP response

Response 202

{
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "description": "This is description",
    "hosted_zone_type": "public",
    "id": "3432012nfdksdf03ktrld9234lgfg",
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "my-zone.com",
    "pool_id": "12345678-90ab-cdef-1234-567890abcdef",
    "private_dns_id": "fedcba9876543210fedcba9876543210",
    "private_dns_name": "private-dns01",
    "status": "CREATING",
    "ttl": 3600
}

3.1.3 - Create Hosted Zone Record

3.1.3.1 - 1.3

post /v1/hosted-zones/{hosted_zone_id}/records

Description

도메인 이름 해석을 관리하는 DNS 레코드 리소스를 생성합니다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathhosted_zone_id
required
Hosted Zone의 고유 식별자
Example : 3432012nfdksdf03ktrld9234lgfg
stringNone
bodybody
required

RecordCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedRecordCreateResponse
400Bad RequestNone
403ForbiddenNone
409ConflictNone

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records

Request header

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

Request body

{
    "description": "This is description",
    "name": "test.app",
    "records": [
        "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
    ],
    "ttl": 3600,
    "type": "A"
}

Example HTTP response

Response 202

{
    "action": "CREATE",
    "created_at": "2025-09-08T03:43:57Z",
    "description": "This is description",
    "id": "6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7",
    "links": "",
    "name": "test.app",
    "project_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
    "records": [
        "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
    ],
    "status": "ACTIVE",
    "ttl": 3600,
    "type": "A",
    "updated_at": "2026-02-09T08:00:40Z",
    "version": 1,
    "zone_id": "3432012nfdksdf03ktrld9234lgfg",
    "zone_name": "my-zone.com"
}

3.1.4 - Create Private DNS

3.1.4.1 - 1.3

post /v1/private-dns

Description

내부 DNS 해석을 관리하는 프라이빗 DNS 인스턴스를 생성합니다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

PrivateDnsCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedPrivateDnsShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/private-dns

Request header

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

Request body

{
    "connected_vpc_ids": [
        "1234567890abcdef1234567890abcdef",
        "fedcba0987654321fedcba0987654321"
    ],
    "description": "This is description",
    "name": "private-dns01",
    "tags": [
        {
            "key": "env",
            "value": "prod"
        }
    ]
}

Example HTTP response

Response 202

{
    "private_dns": {
        "auth_dns_name": "authdns-a1b2c3d4e5f6789012345678abcdef90",
        "connected_vpc_ids": [
            "1234567890abcdef1234567890abcdef",
            "fedcba0987654321fedcba0987654321"
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "This is description",
        "id": "fedcba9876543210fedcba9876543210",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "private-dns01",
        "pool_id": "12345678-90ab-cdef-1234-567890abcdef",
        "pool_name": "private01-a1b2c3d4e5f6789012345678abcdef90",
        "registered_region": "KR-WEST1",
        "resolver_ip": "198.19.0.101",
        "resolver_name": "resolver-a1b2c3d4e5f6789012345678abcdef90",
        "state": "ACTIVE"
    }
}

3.1.5 - Create Public Domain Name

3.1.5.1 - 1.3

post /v1/public-domain-names

Description

Public Domain Name 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

CreatePublicDomainRequest

Responses

HTTP CodeDescriptionSchema
201CreatedCreatePublicDomainResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/public-domain-names

Request header

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

Request body

{
    "address_type": "",
    "auto_extension": true,
    "description": "This is description",
    "domestic_first_address_en": "125 Olympic-ro 35-gil, Songpa-gu, Seoul",
    "domestic_first_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동)",
    "domestic_second_address_en": "West Campus 1F",
    "domestic_second_address_ko": "서관 1층",
    "name": "example.com",
    "overseas_first_address": "123 Main St",
    "overseas_second_address": "New York",
    "overseas_third_address": "NY 10001",
    "postal_code": "12345",
    "register_email": "admin@example.com",
    "register_name_en": "Hong Gildong",
    "register_name_ko": "홍길동",
    "register_telno": "",
    "tags": [
        {
            "key": "env",
            "value": "prod"
        }
    ]
}

Example HTTP response

Response 201

{
    "public_domain_name": {
        "address_type": "DOMESTIC",
        "auto_extension": true,
        "created_at": "2025-09-08T03:43:57Z",
        "created_by": "504f24f8111e42e0578f367acd2a149f",
        "description": "This is description",
        "domestic_address_en": "West Campus 1F, 125 Olympic-ro 35-gil, Songpa-gu, Seoul",
        "domestic_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동), 서관 1층",
        "domestic_first_address_en": "125 Olympic-ro 35-gil, Songpa-gu, Seoul",
        "domestic_first_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동)",
        "domestic_second_address_en": "West Campus 1F",
        "domestic_second_address_ko": "서관 1층",
        "expired_date": "2026-09-09T00:00:00Z",
        "id": "10fjkeweffpublicdomain3193rud543",
        "modified_at": "2026-02-09T08:00:40Z",
        "modified_by": "504f24f8111e42e0578f367acd2a149f",
        "name": "example.com",
        "overseas_address": "123 Main St, New York, NY 10001",
        "overseas_first_address": "123 Main St",
        "overseas_second_address": "New York",
        "overseas_third_address": "NY 10001",
        "postal_code": "12345",
        "register_email": "admin@example.com",
        "register_name_en": "Hong Gildong",
        "register_name_ko": "홍길동",
        "register_telno": "",
        "start_date": "2025-09-09T00:00:00Z",
        "status": "REGISTERED"
    }
}

3.1.6 - Delete Hosted Zone

3.1.6.1 - 1.3

delete /v1/hosted-zones/{hosted_zone_id}

Description

Hosted Zone 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathhosted_zone_id
required
Hosted Zone의 고유 식별자
Example : 3432012nfdksdf03ktrld9234lgfg
stringNone

Responses

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

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_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 = dns 1.3"

Example HTTP response

Response 202

3.1.7 - Delete Hosted Zone Record

3.1.7.1 - 1.3

delete /v1/hosted-zones/{hosted_zone_id}/records/{record_id}

Description

Hosted zone record 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathhosted_zone_id
required
이 Record를 포함하는 Hosted Zone의 식별자
Example : 3432012nfdksdf03ktrld9234lgfg
stringNone
pathrecord_id
required
DNS 레코드의 고유 식별자
Example : 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedRecordCreateResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records/{record_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 = dns 1.3"

Example HTTP response

Response 202

{
    "action": "CREATE",
    "created_at": "2025-09-08T03:43:57Z",
    "description": "This is description",
    "id": "6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7",
    "links": "",
    "name": "test.app",
    "project_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
    "records": [
        "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
    ],
    "status": "ACTIVE",
    "ttl": 3600,
    "type": "A",
    "updated_at": "2026-02-09T08:00:40Z",
    "version": 1,
    "zone_id": "3432012nfdksdf03ktrld9234lgfg",
    "zone_name": "my-zone.com"
}

3.1.8 - Delete Private DNS

3.1.8.1 - 1.3

delete /v1/private-dns/{private_dns_id}

Description

Private DNS 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_dns_id
required
프라이빗 DNS의 고유 식별자
Example : fedcba9876543210fedcba9876543210
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/private-dns/{private_dns_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 = dns 1.3"

Example HTTP response

Response 202

3.1.9 - List Hosted Zone Records

3.1.9.1 - 1.3

get /v1/hosted-zones/{hosted_zone_id}/records

Description

Record 목록을 제공합니다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathhosted_zone_id
required
Hosted Zone의 고유 식별자
Example : 3432012nfdksdf03ktrld9234lgfg
stringNone
querylimit
optional
반환할 최대 항목 수
Example :
any of [integer, null]None
querymarker
optional
이전 페이지의 마지막 레코드 ID
Example :
any of [string, null]None
querysort_dir
optional
목록의 정렬 방향(ASC 또는 DESC)
Example :
any of [string, null]None
querysort_key
optional
정렬 기준 필드
Example :
any of [string, null]None
queryname
optional
Record 이름
Example : test.app
any of [string, null]None
queryexact_name
optional
Record 이름
Example : test.app
any of [string, null]None
querytype
optional
DNS 레코드 유형(예: A, AAAA, CNAME, MX, TXT, SPF)
Example : A
any of [string, null]None
querydata
optional
DNS 레코드 필터링 데이터
Example : 12345.ns.private.kr-west1.dev2.samsungsdscloud.com
any of [string, null]None
querystatus
optional
DNS 레코드의 현재 상태
Example : ACTIVE
any of [string, null]None
querydescription
optional
설명
Example : This is description
any of [string, null]None
queryttl
optional
DNS 레코드의 TTL(초 단위) 값
Example : 3600
any of [integer, null]None

Responses

HTTP CodeDescriptionSchema
200OKRecordListResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "links": "",
    "metadata": "",
    "records": [
        {
            "action": "CREATE",
            "created_at": "2025-09-08T03:43:57Z",
            "description": "This is description",
            "id": "6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7",
            "links": "",
            "name": "test.app",
            "project_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
            "records": [
                "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
            ],
            "status": "ACTIVE",
            "ttl": 3600,
            "type": "A",
            "updated_at": "2026-02-09T08:00:40Z",
            "version": 1,
            "zone_id": "3432012nfdksdf03ktrld9234lgfg",
            "zone_name": "my-zone.com"
        }
    ]
}

3.1.10 - List Hosted Zones

3.1.10.1 - 1.3

get /v1/hosted-zones

Description

Hosted zone 목록

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

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
DNS 서비스가 관리하는 도메인 이름입니다. 해당 도메인 및 하위 도메인의 모든 DNS 레코드가 이 Hosted Zone에 저장되고 제공됩니다.
Example : my-zone.com
any of [string, null]None
querytype
optional
Hosted Zone 유형(예: 퍼블릭 또는 프라이빗)
Example :
any of [enum (public, private), null]None
querystatus
optional
Hosted Zone의 현재 상태(예: ACTIVE, CREATING, DELETING)
Example :
any of [enum (CREATING, EDITING, ACTIVE, DELETING, DELETED, ERROR, PENDING, UNKNOWN), null]None

Responses

HTTP CodeDescriptionSchema
200OKHostedZoneListResponseV1Dot3
403ForbiddenNone

Example HTTP request

Request path

/v1/hosted-zones

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "hosted_zones": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "This is description",
            "hosted_zone_type": "public",
            "id": "3432012nfdksdf03ktrld9234lgfg",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "my-zone.com",
            "pool_id": "12345678-90ab-cdef-1234-567890abcdef",
            "private_dns_id": "fedcba9876543210fedcba9876543210",
            "private_dns_name": "private-dns01",
            "status": "CREATING",
            "ttl": 3600
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

3.1.11 - List Private DNS

3.1.11.1 - 1.3

get /v1/private-dns

Description

프라이빗 DNS 목록

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

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
queryid
optional
프라이빗 DNS의 고유 식별자
Example : fedcba9876543210fedcba9876543210
any of [string, null]None
queryname
optional
Private DNS 이름
Example : private-dns01
any of [string, null]None
queryvpc_id
optional
이 프라이빗 DNS에 연결된 VPC ID 목록입니다. DNS에 연결된 VPC만 등록된 도메인 정보를 조회할 수 있습니다.
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
querystate
optional
상태
Example : ACTIVE
any of [enum (CREATING, EDITING, ACTIVE, ACTIVATING, INACTIVE, DELETING, DELETED, ERROR, PENDING), null]None

Responses

HTTP CodeDescriptionSchema
200OKPrivateDnsListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/private-dns

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "private_dns": [
        {
            "auth_dns_name": "authdns-a1b2c3d4e5f6789012345678abcdef90",
            "connected_vpc_ids": [
                "1234567890abcdef1234567890abcdef",
                "fedcba0987654321fedcba0987654321"
            ],
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "This is description",
            "id": "fedcba9876543210fedcba9876543210",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "private-dns01",
            "pool_id": "12345678-90ab-cdef-1234-567890abcdef",
            "pool_name": "private01-a1b2c3d4e5f6789012345678abcdef90",
            "registered_region": "KR-WEST1",
            "resolver_ip": "198.19.0.101",
            "resolver_name": "resolver-a1b2c3d4e5f6789012345678abcdef90",
            "state": "ACTIVE"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

3.1.12 - List Public Domain Names

3.1.12.1 - 1.3

get /v1/public-domain-names

Description

Public Domain Name 목록

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

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
Public Domain Name 이름
Example : example.com
any of [string, null]None
querycreated_by
optional
리소스를 생성한 사용자 ID
Example : 504f24f8111e42e0578f367acd2a149f
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKPublicDomainListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/public-domain-names

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "public_domain_names": [
        {
            "created_at": "2025-09-08T03:43:57Z",
            "created_by": "504f24f8111e42e0578f367acd2a149f",
            "expired_date": "2026-09-09T00:00:00Z",
            "id": "10fjkeweffpublicdomain3193rud543",
            "modified_at": "2026-02-09T08:00:40Z",
            "modified_by": "504f24f8111e42e0578f367acd2a149f",
            "name": "example.com",
            "register_email": "admin@example.com",
            "start_date": "2025-09-09T00:00:00Z",
            "status": "REGISTERED"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

3.1.13 - Set Hosted Zone

3.1.13.1 - 1.3

put /v1/hosted-zones/{hosted_zone_id}

Description

Hosted zone 업데이트

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathhosted_zone_id
required
Hosted Zone의 고유 식별자
Example : 3432012nfdksdf03ktrld9234lgfg
stringNone
bodybody
required

HostedZoneSetRequestV1Dot3

Responses

HTTP CodeDescriptionSchema
202AcceptedHostedZoneShowResponseV1Dot3
400Bad RequestNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_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 = dns 1.3"

Request body

{
    "description": "This is description"
}

Example HTTP response

Response 202

{
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "description": "This is description",
    "hosted_zone_type": "public",
    "id": "3432012nfdksdf03ktrld9234lgfg",
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "my-zone.com",
    "pool_id": "12345678-90ab-cdef-1234-567890abcdef",
    "private_dns_id": "fedcba9876543210fedcba9876543210",
    "private_dns_name": "private-dns01",
    "status": "CREATING",
    "ttl": 3600
}

3.1.14 - Set Hosted Zone Record

3.1.14.1 - 1.3

put /v1/hosted-zones/{hosted_zone_id}/records/{record_id}

Description

Hosted zone record 값 업데이트

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathhosted_zone_id
required
이 Record를 포함하는 Hosted Zone의 식별자
Example : 3432012nfdksdf03ktrld9234lgfg
stringNone
pathrecord_id
required
DNS 레코드의 고유 식별자
Example : 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
stringNone
bodybody
required

RecordSetRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedRecordSetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records/{record_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 = dns 1.3"

Request body

{
    "records": [
        "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
    ],
    "ttl": 3600
}

Example HTTP response

Response 202

{
    "action": "CREATE",
    "created_at": "2025-09-08T03:43:57Z",
    "description": "This is description",
    "id": "6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7",
    "links": "",
    "name": "test.app",
    "project_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
    "records": [
        "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
    ],
    "status": "ACTIVE",
    "ttl": 3600,
    "type": "A",
    "updated_at": "2026-02-09T08:00:40Z",
    "version": 1,
    "zone_id": "3432012nfdksdf03ktrld9234lgfg",
    "zone_name": "my-zone.com"
}

3.1.15 - Set Private DNS

3.1.15.1 - 1.3

put /v1/private-dns/{private_dns_id}

Description

Private DNS에 연결된 VPC 목록을 업데이트합니다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_dns_id
required
프라이빗 DNS의 고유 식별자
Example : fedcba9876543210fedcba9876543210
stringNone
bodybody
required

PrivateDnsSetRequest

Responses

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

Example HTTP request

Request path

/v1/private-dns/{private_dns_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 = dns 1.3"

Request body

{
    "connected_vpc_ids": [
        "1234567890abcdef1234567890abcdef",
        "fedcba0987654321fedcba0987654321"
    ],
    "description": "This is description"
}

Example HTTP response

Response 202

{
    "private_dns": {
        "auth_dns_name": "authdns-a1b2c3d4e5f6789012345678abcdef90",
        "connected_vpc_ids": [
            "1234567890abcdef1234567890abcdef",
            "fedcba0987654321fedcba0987654321"
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "This is description",
        "id": "fedcba9876543210fedcba9876543210",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "private-dns01",
        "pool_id": "12345678-90ab-cdef-1234-567890abcdef",
        "pool_name": "private01-a1b2c3d4e5f6789012345678abcdef90",
        "registered_region": "KR-WEST1",
        "resolver_ip": "198.19.0.101",
        "resolver_name": "resolver-a1b2c3d4e5f6789012345678abcdef90",
        "state": "ACTIVE"
    }
}

3.1.16 - Set Public Domain Name

3.1.16.1 - 1.3

put /v1/public-domain-names/{public_domain_id}

Description

Public Domain Name 업데이트

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathpublic_domain_id
required
Public Domain Name의 고유 식별자
Example : 10fjkeweffpublicdomain3193rud543
stringNone
bodybody
required

PublicDomainPartialUpdateRequest

Responses

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

Example HTTP request

Request path

/v1/public-domain-names/{public_domain_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 = dns 1.3"

Request body

{
    "auto_extension": true,
    "description": "This is description"
}

Example HTTP response

Response 200

{
    "auto_extension": true,
    "description": "This is description",
    "id": "10fjkeweffpublicdomain3193rud543"
}

3.1.17 - Set Public Domain Name Whois Info

3.1.17.1 - 1.3

put /v1/public-domain-names/{public_domain_id}/information

Description

Public Domain Name Whois 정보 업데이트

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathpublic_domain_id
required
Public Domain Name의 고유 식별자
Example : 10fjkeweffpublicdomain3193rud543
stringNone
bodybody
required

PubblicDomainWhoisInfoUpdateRequest

Responses

HTTP CodeDescriptionSchema
200OKPublicDomainWhoisInfoUpdateResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone
500Internal Server ErrorNone

Example HTTP request

Request path

/v1/public-domain-names/{public_domain_id}/information

Request header

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

Request body

{
    "address_type": "",
    "domestic_first_address_en": "125 Olympic-ro 35-gil, Songpa-gu, Seoul",
    "domestic_first_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동)",
    "domestic_second_address_en": "West Campus 1F",
    "domestic_second_address_ko": "서관 1층",
    "overseas_first_address": "123 Main St",
    "overseas_second_address": "New York",
    "overseas_third_address": "NY 10001",
    "postal_code": "12345",
    "register_email": "admin@example.com",
    "register_telno": ""
}

Example HTTP response

Response 200

{
    "address_type": "",
    "domestic_first_address_en": "125 Olympic-ro 35-gil, Songpa-gu, Seoul",
    "domestic_first_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동)",
    "domestic_second_address_en": "West Campus 1F",
    "domestic_second_address_ko": "서관 1층",
    "name": "example.com",
    "overseas_first_address": "123 Main St",
    "overseas_second_address": "New York",
    "overseas_third_address": "NY 10001",
    "postal_code": "12345",
    "register_email": "admin@example.com",
    "register_name_en": "Hong Gildong",
    "register_name_ko": "홍길동",
    "register_telno": ""
}

3.1.18 - Show Hosted Zone

3.1.18.1 - 1.3

get /v1/hosted-zones/{hosted_zone_id}

Description

Hosted zone 상세

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathhosted_zone_id
required
Hosted Zone의 고유 식별자
Example : 3432012nfdksdf03ktrld9234lgfg
stringNone

Responses

HTTP CodeDescriptionSchema
200OKHostedZoneShowResponseV1Dot3
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_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 = dns 1.3"

Example HTTP response

Response 200

{
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "description": "This is description",
    "hosted_zone_type": "public",
    "id": "3432012nfdksdf03ktrld9234lgfg",
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "my-zone.com",
    "pool_id": "12345678-90ab-cdef-1234-567890abcdef",
    "private_dns_id": "fedcba9876543210fedcba9876543210",
    "private_dns_name": "private-dns01",
    "status": "CREATING",
    "ttl": 3600
}

3.1.19 - Show Hosted Zone Record

3.1.19.1 - 1.3

get /v1/hosted-zones/{hosted_zone_id}/records/{record_id}

Description

Hosted zone record 상세

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathhosted_zone_id
required
이 Record를 포함하는 Hosted Zone의 식별자
Example : 3432012nfdksdf03ktrld9234lgfg
stringNone
pathrecord_id
required
DNS 레코드의 고유 식별자
Example : 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
stringNone

Responses

HTTP CodeDescriptionSchema
200OKRecordShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records/{record_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 = dns 1.3"

Example HTTP response

Response 200

{
    "action": "CREATE",
    "created_at": "2025-09-08T03:43:57Z",
    "description": "This is description",
    "id": "6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7",
    "links": "",
    "name": "test.app",
    "project_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
    "records": [
        "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
    ],
    "status": "ACTIVE",
    "ttl": 3600,
    "type": "A",
    "updated_at": "2026-02-09T08:00:40Z",
    "version": 1,
    "zone_id": "3432012nfdksdf03ktrld9234lgfg",
    "zone_name": "my-zone.com"
}

3.1.20 - Show Private DNS

3.1.20.1 - 1.3

get /v1/private-dns/{private_dns_id}

Description

프라이빗 DNS 상세

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_dns_id
required
프라이빗 DNS의 고유 식별자
Example : fedcba9876543210fedcba9876543210
stringNone

Responses

HTTP CodeDescriptionSchema
200OKPrivateDnsShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/private-dns/{private_dns_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 = dns 1.3"

Example HTTP response

Response 200

{
    "private_dns": {
        "auth_dns_name": "authdns-a1b2c3d4e5f6789012345678abcdef90",
        "connected_vpc_ids": [
            "1234567890abcdef1234567890abcdef",
            "fedcba0987654321fedcba0987654321"
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "This is description",
        "id": "fedcba9876543210fedcba9876543210",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "private-dns01",
        "pool_id": "12345678-90ab-cdef-1234-567890abcdef",
        "pool_name": "private01-a1b2c3d4e5f6789012345678abcdef90",
        "registered_region": "KR-WEST1",
        "resolver_ip": "198.19.0.101",
        "resolver_name": "resolver-a1b2c3d4e5f6789012345678abcdef90",
        "state": "ACTIVE"
    }
}

3.1.21 - Show Public Domain Name

3.1.21.1 - 1.3

get /v1/public-domain-names/{public_domain_id}

Description

Public Domain Name 상세

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathpublic_domain_id
required
Public Domain Name의 고유 식별자
Example : 10fjkeweffpublicdomain3193rud543
stringNone

Responses

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

Example HTTP request

Request path

/v1/public-domain-names/{public_domain_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 = dns 1.3"

Example HTTP response

Response 200

{
    "public_domain_name": {
        "address_type": "DOMESTIC",
        "auto_extension": true,
        "created_at": "2025-09-08T03:43:57Z",
        "created_by": "504f24f8111e42e0578f367acd2a149f",
        "description": "This is description",
        "domestic_address_en": "West Campus 1F, 125 Olympic-ro 35-gil, Songpa-gu, Seoul",
        "domestic_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동), 서관 1층",
        "domestic_first_address_en": "125 Olympic-ro 35-gil, Songpa-gu, Seoul",
        "domestic_first_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동)",
        "domestic_second_address_en": "West Campus 1F",
        "domestic_second_address_ko": "서관 1층",
        "expired_date": "2026-09-09T00:00:00Z",
        "id": "10fjkeweffpublicdomain3193rud543",
        "modified_at": "2026-02-09T08:00:40Z",
        "modified_by": "504f24f8111e42e0578f367acd2a149f",
        "name": "example.com",
        "overseas_address": "123 Main St, New York, NY 10001",
        "overseas_first_address": "123 Main St",
        "overseas_second_address": "New York",
        "overseas_third_address": "NY 10001",
        "postal_code": "12345",
        "register_email": "admin@example.com",
        "register_name_en": "Hong Gildong",
        "register_name_ko": "홍길동",
        "register_telno": "",
        "start_date": "2025-09-09T00:00:00Z",
        "status": "REGISTERED"
    }
}

3.1.22 - Transfer Public Domain Name

3.1.22.1 - 1.3

post /v1/public-domain-names/{public_domain_id}/transfer

Description

Public Domain Name을 다른 Account로 이관

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathpublic_domain_id
required
Public Domain Name의 고유 식별자
Example : 10fjkeweffpublicdomain3193rud543
stringNone
bodybody
required

PublicDomainTransferRequest

Responses

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

Example HTTP request

Request path

/v1/public-domain-names/{public_domain_id}/transfer

Request header

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

Request body

{
    "target_account_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
    "type": "REQUEST"
}

Example HTTP response

Response 200

{
    "auto_extension": true,
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "description": "This is description",
    "expired_date": "2026-09-09T00:00:00Z",
    "id": "10fjkeweffpublicdomain3193rud543",
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "example.com",
    "start_date": "2025-09-09T00:00:00Z",
    "state": "TRANSFER_REQUESTED"
}

3.2 - Models

3.2.1 - CreatePublicDomainRequest

NameDescriptionSchemaDefault
address_type
required
도메인 등록 주소 유형
Example :
string
auto_extension
optional
도메인 자동 연장 활성화 여부
Example : True
any of [boolean, null]True
description
optional
설명
Example : This is description
any of [string, null]
domestic_first_address_en
required
국내 주소 1 (EN)
Example : 125 Olympic-ro 35-gil, Songpa-gu, Seoul
string
domestic_first_address_ko
required
국내 주소 1 (KO)
Example : 서울특별시 송파구 올림픽로35길 125 (신천동)
string
domestic_second_address_en
required
국내 주소 2 (EN)
Example : West Campus 1F
any of [string, null]
domestic_second_address_ko
required
국내 주소 2 (KO)
Example : 서관 1층
Maximum length : 16
string
name
required
Public Domain Name 이름
Example : example.com
Minimum length : 2
Maximum length : 63
string
overseas_first_address
required
해외 주소 첫 번째 줄
Example : 123 Main St
any of [string, null]
overseas_second_address
required
해외 주소 두 번째 줄
Example : New York
any of [string, null]
overseas_third_address
required
해외 주소 세 번째 줄
Example : NY 10001
any of [string, null]
postal_code
required
도메인 등록 우편번호
Example : 12345
Maximum length : 6
string
register_email
required
도메인 등록자 이메일 주소
Example : admin@example.com
Pattern : ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$
Minimum length : 6
Maximum length : 64
string
register_name_en
required
도메인 등록자 이름(영문)
Example : Hong Gildong
Minimum length : 1
Maximum length : 30
string
register_name_ko
required
도메인 등록자 이름(국문)
Example : 홍길동
Minimum length : 1
Maximum length : 30
string
register_telno
required
도메인 등록자 전화번호
Example :
string
tags
optional
태그 목록
Example : [{'key': 'env', 'value': 'prod'}]
array[Tag]

3.2.2 - CreatePublicDomainResponse

NameDescriptionSchemaDefault
public_domain_name
required

PublicDomainDetail

3.2.3 - HostedZoneCreateRequestV1Dot3

NameDescriptionSchemaDefault
description
optional
설명
Example : This is description
any of [string, null]
name
required
DNS 서비스가 관리하는 도메인 이름입니다. 해당 도메인 및 하위 도메인의 모든 DNS 레코드가 이 Hosted Zone에 저장되고 제공됩니다.
Example : my-zone.com
Minimum length : 2
Maximum length : 69
string
private_dns_id
optional
Hosted Zone 등록을 위한 DNS 서버 ID입니다. 퍼블릭 유형의 Hosted Zone인 경우 빈 값으로 표시됩니다.
Example : fedcba9876543210fedcba9876543210
any of [string, null]
tags
optional
태그 목록
array[Tag]
type
required
Hosted Zone 유형(예: 퍼블릭 또는 프라이빗)
Example : private
enum (public, private)

3.2.4 - HostedZoneListResponseV1Dot3

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
hosted_zones
required
Hosted Zone 목록
array[HostedZoneV1Dot3]
page
required
page
Example : 0
integer
size
required
size
Example : 20
integer
sort
optional
sort
Example : ['created_at:asc']
any of [array[string], null]

3.2.5 - HostedZoneSetRequestV1Dot3

NameDescriptionSchemaDefault
description
optional
설명
Example : This is description
any of [string, null]

3.2.6 - HostedZoneShowResponseV1Dot3

NameDescriptionSchemaDefault
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
required
설명
Example : This is description
any of [string, null]
hosted_zone_type
optional
Hosted Zone 유형(예: 퍼블릭 또는 프라이빗)
Example : public
enum (public, private)
id
required
Hosted Zone의 고유 식별자
Example : 3432012nfdksdf03ktrld9234lgfg
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
DNS 서비스가 관리하는 도메인 이름입니다. 해당 도메인 및 하위 도메인의 모든 DNS 레코드가 이 Hosted Zone에 저장되고 제공됩니다.
Example : my-zone.com
string
pool_id
required
Hosted Zone에 연결된 리소스 풀 ID
Example : 12345678-90ab-cdef-1234-567890abcdef
string
private_dns_id
optional
Hosted Zone 등록을 위한 DNS 서버 ID입니다. 퍼블릭 유형의 Hosted Zone인 경우 빈 값으로 표시됩니다.
Example : fedcba9876543210fedcba9876543210
any of [string, null]
private_dns_name
optional
Hosted Zone 등록을 위한 DNS 서버 이름입니다. 퍼블릭 유형의 Hosted Zone인 경우 빈 값으로 표시됩니다.
Example : private-dns01
any of [string, null]
status
required
상태
Example : CREATING
enum (CREATING, EDITING, ACTIVE, DELETING, DELETED, ERROR, PENDING, UNKNOWN)
ttl
optional
이 존의 DNS 레코드에 대한 TTL(초 단위) 값
Example : 3600
any of [integer, null]

3.2.7 - HostedZoneV1Dot3

NameDescriptionSchemaDefault
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
required
설명
Example : This is description
any of [string, null]
hosted_zone_type
optional
Hosted Zone 유형(예: 퍼블릭 또는 프라이빗)
Example : public
enum (public, private)
id
required
Hosted Zone의 고유 식별자
Example : 3432012nfdksdf03ktrld9234lgfg
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
DNS 서비스가 관리하는 도메인 이름입니다. 해당 도메인 및 하위 도메인의 모든 DNS 레코드가 이 Hosted Zone에 저장되고 제공됩니다.
Example : my-zone.com
string
pool_id
required
Hosted Zone에 연결된 리소스 풀 ID
Example : 12345678-90ab-cdef-1234-567890abcdef
string
private_dns_id
optional
Hosted Zone 등록을 위한 DNS 서버 ID입니다. 퍼블릭 유형의 Hosted Zone인 경우 빈 값으로 표시됩니다.
Example : fedcba9876543210fedcba9876543210
any of [string, null]
private_dns_name
optional
Hosted Zone 등록을 위한 DNS 서버 이름입니다. 퍼블릭 유형의 Hosted Zone인 경우 빈 값으로 표시됩니다.
Example : private-dns01
any of [string, null]
status
required
상태
Example : CREATING
enum (CREATING, EDITING, ACTIVE, DELETING, DELETED, ERROR, PENDING, UNKNOWN)
ttl
optional
이 존의 DNS 레코드에 대한 TTL(초 단위) 값
Example : 3600
any of [integer, null]

3.2.8 - PrivateDns

NameDescriptionSchemaDefault
auth_dns_name
required
Private DNS의 권한 있는(authoritative) DNS 이름
Example : authdns-a1b2c3d4e5f6789012345678abcdef90
any of [string, null]
connected_vpc_ids
optional
이 프라이빗 DNS에 연결된 VPC ID 목록입니다. DNS에 연결된 VPC만 등록된 도메인 정보를 조회할 수 있습니다.
Example : ['1234567890abcdef1234567890abcdef', 'fedcba0987654321fedcba0987654321']
array[string]
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
required
설명
Example : This is description
any of [string, null]
id
required
프라이빗 DNS의 고유 식별자
Example : fedcba9876543210fedcba9876543210
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Private DNS 이름
Example : private-dns01
string
pool_id
required
Private DNS에 연결된 리소스 풀 식별자
Example : 12345678-90ab-cdef-1234-567890abcdef
any of [string, null]
pool_name
required
리소스 풀 이름
Example : private01-a1b2c3d4e5f6789012345678abcdef90
any of [string, null]
registered_region
required
프라이빗 DNS가 등록된 리전
Example : KR-WEST1
any of [string, null]
resolver_ip
required
DNS resolver IP 주소
Example : 198.19.0.101
any of [string, null]
resolver_name
required
DNS resolver 이름
Example : resolver-a1b2c3d4e5f6789012345678abcdef90
any of [string, null]
state
required
상태
Example : ACTIVE
enum (CREATING, EDITING, ACTIVE, ACTIVATING, INACTIVE, DELETING, DELETED, ERROR, PENDING)

3.2.9 - PrivateDnsActivateRequest

NameDescriptionSchemaDefault
name
required
Private DNS 이름
Example : private-dns01
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string

3.2.10 - PrivateDnsCreateRequest

NameDescriptionSchemaDefault
connected_vpc_ids
optional
이 프라이빗 DNS에 연결된 VPC ID 목록입니다. DNS에 연결된 VPC만 등록된 도메인 정보를 조회할 수 있습니다.
Example : ['1234567890abcdef1234567890abcdef', 'fedcba0987654321fedcba0987654321']
array[string]
description
optional
설명
Example : This is description
any of [string, null]
name
required
Private DNS 이름
Example : private-dns01
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
tags
optional
태그 목록
Example : [{'key': 'env', 'value': 'prod'}]
any of [array[Tag], null]

3.2.11 - PrivateDnsListResponse

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
page
required
page
Example : 0
integer
private_dns
required

array[PrivateDns]
size
required
size
Example : 20
integer
sort
optional
sort
Example : ['created_at:asc']
any of [array[string], null]

3.2.12 - PrivateDnsSetRequest

NameDescriptionSchemaDefault
connected_vpc_ids
optional
이 프라이빗 DNS에 연결된 VPC ID 목록입니다. DNS에 연결된 VPC만 등록된 도메인 정보를 조회할 수 있습니다.
Example : ['1234567890abcdef1234567890abcdef', 'fedcba0987654321fedcba0987654321']
any of [array[string], null]
description
optional
설명
Example : This is description
any of [string, null]

3.2.13 - PrivateDnsShowResponse

NameDescriptionSchemaDefault
private_dns
required

PrivateDns

3.2.14 - PubblicDomainWhoisInfoUpdateRequest

NameDescriptionSchemaDefault
address_type
required
도메인 등록 주소 유형
Example :
string
domestic_first_address_en
required
국내 주소 1 (EN)
Example : 125 Olympic-ro 35-gil, Songpa-gu, Seoul
string
domestic_first_address_ko
required
국내 주소 1 (KO)
Example : 서울특별시 송파구 올림픽로35길 125 (신천동)
string
domestic_second_address_en
required
국내 주소 2 (EN)
Example : West Campus 1F
any of [string, null]
domestic_second_address_ko
required
국내 주소 2 (KO)
Example : 서관 1층
Maximum length : 16
string
overseas_first_address
required
해외 주소 첫 번째 줄
Example : 123 Main St
any of [string, null]
overseas_second_address
required
해외 주소 두 번째 줄
Example : New York
any of [string, null]
overseas_third_address
required
해외 주소 세 번째 줄
Example : NY 10001
any of [string, null]
postal_code
required
도메인 등록 우편번호
Example : 12345
Maximum length : 6
string
register_email
required
도메인 등록자 이메일 주소
Example : admin@example.com
Pattern : ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$
Minimum length : 6
Maximum length : 64
string
register_telno
required
도메인 등록자 전화번호
Example :
string

3.2.15 - PublicDomainDetail

NameDescriptionSchemaDefault
address_type
required
도메인 등록 주소 유형
Example : DOMESTIC
string
auto_extension
required
도메인 자동 연장 활성화 여부
Example : True
boolean
created_at
required
리소스가 생성된 타임스탬프 (ISO 8601 형식)
Example : 2025-09-08T03:43:57Z
string
created_by
required
리소스를 생성한 사용자 ID
Example : 504f24f8111e42e0578f367acd2a149f
string
description
optional
설명
Example : This is description
any of [string, null]
domestic_address_en
required
도메인 등록 국내 주소(영문)
Example : West Campus 1F, 125 Olympic-ro 35-gil, Songpa-gu, Seoul
string
domestic_address_ko
required
도메인 등록 국내 주소(국문)
Example : 서울특별시 송파구 올림픽로35길 125 (신천동), 서관 1층
string
domestic_first_address_en
required
국내 주소 1 (EN)
Example : 125 Olympic-ro 35-gil, Songpa-gu, Seoul
string
domestic_first_address_ko
required
국내 주소 1 (KO)
Example : 서울특별시 송파구 올림픽로35길 125 (신천동)
string
domestic_second_address_en
required
국내 주소 2 (EN)
Example : West Campus 1F
string
domestic_second_address_ko
required
국내 주소 2 (KO)
Example : 서관 1층
string
expired_date
required
도메인 등록 만료일
Example : 2026-09-09T00:00:00Z
string
id
required
Public Domain Name의 고유 식별자
Example : 10fjkeweffpublicdomain3193rud543
string
modified_at
required
리소스가 마지막으로 수정된 타임스탬프 (ISO 8601 형식)
Example : 2026-02-09T08:00:40Z
string
modified_by
required
리소스를 마지막으로 수정한 사용자 ID
Example : 504f24f8111e42e0578f367acd2a149f
string
name
required
Public Domain Name 이름
Example : example.com
string
overseas_address
optional
도메인 등록 해외 주소
Example : 123 Main St, New York, NY 10001
string
overseas_first_address
required
해외 주소 첫 번째 줄
Example : 123 Main St
string
overseas_second_address
required
해외 주소 두 번째 줄
Example : New York
string
overseas_third_address
required
해외 주소 세 번째 줄
Example : NY 10001
string
postal_code
required
도메인 등록 우편번호
Example : 12345
string
register_email
required
도메인 등록자 이메일 주소
Example : admin@example.com
string
register_name_en
required
도메인 등록자 이름(영문)
Example : Hong Gildong
string
register_name_ko
required
도메인 등록자 이름(국문)
Example : 홍길동
string
register_telno
required
도메인 등록자 전화번호
Example :
string
start_date
required
도메인 등록 시작일
Example : 2025-09-09T00:00:00Z
string
status
required
Public Domain Name의 현재 상태
Example : REGISTERED
string

3.2.16 - PublicDomainDetailResponse

NameDescriptionSchemaDefault
public_domain_name
required

PublicDomainDetail

3.2.17 - PublicDomainListItem

NameDescriptionSchemaDefault
created_at
required
리소스가 생성된 타임스탬프 (ISO 8601 형식)
Example : 2025-09-08T03:43:57Z
string
created_by
required
리소스를 생성한 사용자 ID
Example : 504f24f8111e42e0578f367acd2a149f
string
expired_date
required
도메인 등록 만료일
Example : 2026-09-09T00:00:00Z
string
id
required
Public Domain Name의 고유 식별자
Example : 10fjkeweffpublicdomain3193rud543
string
modified_at
required
리소스가 마지막으로 수정된 타임스탬프 (ISO 8601 형식)
Example : 2026-02-09T08:00:40Z
string
modified_by
required
리소스를 마지막으로 수정한 사용자 ID
Example : 504f24f8111e42e0578f367acd2a149f
string
name
required
Public Domain Name 이름
Example : example.com
string
register_email
required
도메인 등록자 이메일 주소
Example : admin@example.com
string
start_date
required
도메인 등록 시작일
Example : 2025-09-09T00:00:00Z
string
status
required
Public Domain Name의 현재 상태
Example : REGISTERED
string

3.2.18 - PublicDomainListResponse

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
page
required
page
Example : 0
integer
public_domain_names
required

array[PublicDomainListItem]
size
required
size
Example : 20
integer
sort
optional
sort
Example : ['created_at:asc']
any of [array[string], null]

3.2.19 - PublicDomainPartialUpdateRequest

NameDescriptionSchemaDefault
auto_extension
optional
도메인 자동 연장 활성화 여부
Example : True
any of [boolean, null]
description
optional
설명
Example : This is description
any of [string, null]

3.2.20 - PublicDomainPartialUpdateResponse

NameDescriptionSchemaDefault
auto_extension
optional
도메인 자동 연장 활성화 여부
Example : True
any of [boolean, null]
description
optional
설명
Example : This is description
any of [string, null]
id
required
Public Domain Name의 고유 식별자
Example : 10fjkeweffpublicdomain3193rud543
string

3.2.21 - PublicDomainTransferRequest

NameDescriptionSchemaDefault
target_account_id
optional
대상 프로젝트 ID (type=REQUEST일 때 필수)
Example : 003dffc50eb123a1cbf4f2e5c71d4f15
any of [string, null]
type
required
이전 작업 유형
Example : REQUEST
enum (REQUEST, CANCEL, APPROVE, REJECT)

3.2.22 - PublicDomainTransferResponse

NameDescriptionSchemaDefault
auto_extension
required
도메인 자동 연장 활성화 여부
Example : True
boolean
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
required
설명
Example : This is description
any of [string, null]
expired_date
required
도메인 등록 만료일
Example : 2026-09-09T00:00:00Z
string (date-time)
id
required
Public Domain Name의 고유 식별자
Example : 10fjkeweffpublicdomain3193rud543
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Public Domain Name 이름
Example : example.com
string
start_date
required
도메인 등록 시작일
Example : 2025-09-09T00:00:00Z
string (date-time)
state
required
상태
Example : TRANSFER_REQUESTED
enum (CREATING, REGISTERED, EXPIRED, DELETED, TRANSFER_REQUESTING, TRANSFER_REQUESTED, DELETING)

3.2.23 - PublicDomainWhoisInfoUpdateResponse

NameDescriptionSchemaDefault
address_type
required
도메인 등록 주소 유형
Example :
string
domestic_first_address_en
required
국내 주소 1 (EN)
Example : 125 Olympic-ro 35-gil, Songpa-gu, Seoul
string
domestic_first_address_ko
required
국내 주소 1 (KO)
Example : 서울특별시 송파구 올림픽로35길 125 (신천동)
string
domestic_second_address_en
required
국내 주소 2 (EN)
Example : West Campus 1F
any of [string, null]
domestic_second_address_ko
required
국내 주소 2 (KO)
Example : 서관 1층
Maximum length : 16
string
name
required
Public Domain Name 이름
Example : example.com
string
overseas_first_address
required
해외 주소 첫 번째 줄
Example : 123 Main St
any of [string, null]
overseas_second_address
required
해외 주소 두 번째 줄
Example : New York
any of [string, null]
overseas_third_address
required
해외 주소 세 번째 줄
Example : NY 10001
any of [string, null]
postal_code
required
도메인 등록 우편번호
Example : 12345
Maximum length : 6
string
register_email
required
도메인 등록자 이메일 주소
Example : admin@example.com
Pattern : ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$
Minimum length : 6
Maximum length : 64
string
register_name_en
required
도메인 등록자 이름(영문)
Example : Hong Gildong
string
register_name_ko
required
도메인 등록자 이름(국문)
Example : 홍길동
string
register_telno
required
도메인 등록자 전화번호
Example :
string

3.2.24 - Record

NameDescriptionSchemaDefault
action
optional
DNS 레코드에 수행된 작업
Example : CREATE
any of [string, null]
created_at
optional
리소스가 생성된 타임스탬프 (ISO 8601 형식)
Example : 2025-09-08T03:43:57Z
any of [string, null]
description
optional
설명
Example : This is description
any of [string, null]
id
optional
DNS 레코드의 고유 식별자
Example : 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
any of [string, null]
links
optional
Record 관련 링크
Example :
any of [object, null]
name
optional
Record 이름
Example : test.app
any of [string, null]
project_id
optional
DNS 레코드에 연결된 프로젝트 ID
Example : 003dffc50eb123a1cbf4f2e5c71d4f15
any of [string, null]
records
optional
이 레코드의 데이터 목록
Example : ['12345.ns.private.kr-west1.dev2.samsungsdscloud.com']
any of [array[string], null]
status
optional
DNS 레코드의 현재 상태
Example : ACTIVE
any of [string, null]
ttl
optional
DNS 레코드의 TTL(초 단위) 값
Example : 3600
any of [integer, null]
type
optional
DNS 레코드 유형(예: A, AAAA, CNAME, MX, TXT, SPF)
Example : A
any of [string, null]
updated_at
optional
리소스가 마지막으로 업데이트된 타임스탬프 (ISO 8601 형식)
Example : 2026-02-09T08:00:40Z
any of [string, null]
version
optional
Record 버전
Example : 1
any of [integer, null]
zone_id
optional
이 레코드를 포함하는 존의 ID
Example : 3432012nfdksdf03ktrld9234lgfg
any of [string, null]
zone_name
optional
이 레코드를 포함하는 존의 이름
Example : my-zone.com
any of [string, null]

3.2.25 - RecordCreateRequest

NameDescriptionSchemaDefault
description
optional
설명
Example : This is description
any of [string, null]
name
required
Record 이름
Example : test.app
Minimum length : 1
Maximum length : 253
string
records
required
이 레코드의 데이터 목록
Example : ['12345.ns.private.kr-west1.dev2.samsungsdscloud.com']
array[object]
ttl
optional
DNS 레코드의 TTL(초 단위) 값
Example : 3600
any of [integer, null]
type
required
DNS 레코드 유형(예: A, AAAA, CNAME, MX, TXT, SPF)
Example : A
enum (A, AAAA, CNAME, TXT, SPF, MX)

3.2.26 - RecordCreateResponse

NameDescriptionSchemaDefault
action
optional
DNS 레코드에 수행된 작업
Example : CREATE
any of [string, null]
created_at
optional
리소스가 생성된 타임스탬프 (ISO 8601 형식)
Example : 2025-09-08T03:43:57Z
any of [string, null]
description
optional
설명
Example : This is description
any of [string, null]
id
optional
DNS 레코드의 고유 식별자
Example : 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
any of [string, null]
links
optional
Record 관련 링크
Example :
any of [object, null]
name
optional
Record 이름
Example : test.app
any of [string, null]
project_id
optional
DNS 레코드에 연결된 프로젝트 ID
Example : 003dffc50eb123a1cbf4f2e5c71d4f15
any of [string, null]
records
optional
이 레코드의 데이터 목록
Example : ['12345.ns.private.kr-west1.dev2.samsungsdscloud.com']
any of [array[string], null]
status
optional
DNS 레코드의 현재 상태
Example : ACTIVE
any of [string, null]
ttl
optional
DNS 레코드의 TTL(초 단위) 값
Example : 3600
any of [integer, null]
type
optional
DNS 레코드 유형(예: A, AAAA, CNAME, MX, TXT, SPF)
Example : A
any of [string, null]
updated_at
optional
리소스가 마지막으로 업데이트된 타임스탬프 (ISO 8601 형식)
Example : 2026-02-09T08:00:40Z
any of [string, null]
version
optional
Record 버전
Example : 1
any of [integer, null]
zone_id
optional
이 레코드를 포함하는 존의 ID
Example : 3432012nfdksdf03ktrld9234lgfg
any of [string, null]
zone_name
optional
이 레코드를 포함하는 존의 이름
Example : my-zone.com
any of [string, null]

3.2.27 - RecordListResponse

NameDescriptionSchemaDefault
count
optional
전체 개수
Example : 20
any of [integer, null]
links
optional
Record 관련 링크
Example :
any of [object, null]
metadata
optional
전체 개수
Example :
any of [object, null]
records
required
레코드 목록
array[Record]

3.2.28 - RecordSetRequest

NameDescriptionSchemaDefault
records
optional
이 레코드의 데이터 목록
Example : ['12345.ns.private.kr-west1.dev2.samsungsdscloud.com']
any of [array[object], null]
ttl
optional
DNS 레코드의 TTL(초 단위) 값
Example : 3600
any of [integer, null]

3.2.29 - RecordSetResponse

NameDescriptionSchemaDefault
action
optional
DNS 레코드에 수행된 작업
Example : CREATE
any of [string, null]
created_at
optional
리소스가 생성된 타임스탬프 (ISO 8601 형식)
Example : 2025-09-08T03:43:57Z
any of [string, null]
description
optional
설명
Example : This is description
any of [string, null]
id
optional
DNS 레코드의 고유 식별자
Example : 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
any of [string, null]
links
optional
Record 관련 링크
Example :
any of [object, null]
name
optional
Record 이름
Example : test.app
any of [string, null]
project_id
optional
DNS 레코드에 연결된 프로젝트 ID
Example : 003dffc50eb123a1cbf4f2e5c71d4f15
any of [string, null]
records
optional
이 레코드의 데이터 목록
Example : ['12345.ns.private.kr-west1.dev2.samsungsdscloud.com']
any of [array[string], null]
status
optional
DNS 레코드의 현재 상태
Example : ACTIVE
any of [string, null]
ttl
optional
DNS 레코드의 TTL(초 단위) 값
Example : 3600
any of [integer, null]
type
optional
DNS 레코드 유형(예: A, AAAA, CNAME, MX, TXT, SPF)
Example : A
any of [string, null]
updated_at
optional
리소스가 마지막으로 업데이트된 타임스탬프 (ISO 8601 형식)
Example : 2026-02-09T08:00:40Z
any of [string, null]
version
optional
Record 버전
Example : 1
any of [integer, null]
zone_id
optional
이 레코드를 포함하는 존의 ID
Example : 3432012nfdksdf03ktrld9234lgfg
any of [string, null]
zone_name
optional
이 레코드를 포함하는 존의 이름
Example : my-zone.com
any of [string, null]

3.2.30 - RecordShowResponse

NameDescriptionSchemaDefault
action
optional
DNS 레코드에 수행된 작업
Example : CREATE
any of [string, null]
created_at
optional
리소스가 생성된 타임스탬프 (ISO 8601 형식)
Example : 2025-09-08T03:43:57Z
any of [string, null]
description
optional
설명
Example : This is description
any of [string, null]
id
optional
DNS 레코드의 고유 식별자
Example : 6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7
any of [string, null]
links
optional
Record 관련 링크
Example :
any of [object, null]
name
optional
Record 이름
Example : test.app
any of [string, null]
project_id
optional
DNS 레코드에 연결된 프로젝트 ID
Example : 003dffc50eb123a1cbf4f2e5c71d4f15
any of [string, null]
records
optional
이 레코드의 데이터 목록
Example : ['12345.ns.private.kr-west1.dev2.samsungsdscloud.com']
any of [array[string], null]
status
optional
DNS 레코드의 현재 상태
Example : ACTIVE
any of [string, null]
ttl
optional
DNS 레코드의 TTL(초 단위) 값
Example : 3600
any of [integer, null]
type
optional
DNS 레코드 유형(예: A, AAAA, CNAME, MX, TXT, SPF)
Example : A
any of [string, null]
updated_at
optional
리소스가 마지막으로 업데이트된 타임스탬프 (ISO 8601 형식)
Example : 2026-02-09T08:00:40Z
any of [string, null]
version
optional
Record 버전
Example : 1
any of [integer, null]
zone_id
optional
이 레코드를 포함하는 존의 ID
Example : 3432012nfdksdf03ktrld9234lgfg
any of [string, null]
zone_name
optional
이 레코드를 포함하는 존의 이름
Example : my-zone.com
any of [string, null]

3.2.31 - Tag

NameDescriptionSchemaDefault
key
required
tag key
Example :
string
value
required
tag value
Example :
string

4 - 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가 추가되었습니다.

4.1 - APIs

4.1.1 - Create Firewall Rule

4.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

4.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"
    }
}

4.1.2 - Delete Firewall Rule

4.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

4.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

4.1.3 - List Firewall Rules

4.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"
    ]
}

4.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"
    ]
}

4.1.4 - List Firewalls

4.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"
    ]
}

4.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"
    ]
}

4.1.5 - Set Firewall

4.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"
            }
        ]
    }
}

4.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"
    }
}

4.1.6 - Set Firewall Rule

4.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

4.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"
    }
}

4.1.7 - Show Firewall

4.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"
            }
        ]
    }
}

4.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"
    }
}

4.1.8 - Show Firewall Rule

4.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"
    }
}

4.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"
    }
}

4.2 - Models

4.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]

4.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]

4.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]

4.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

4.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

4.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)

4.2.7 - FirewallRuleCreateSingleRequest

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

4.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]

4.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]

4.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]

4.2.11 - FirewallRuleShowResponse

NameDescriptionSchemaDefault
firewall_rule
required

FirewallRule

4.2.12 - FirewallRuleShowResponseV1Dot1

NameDescriptionSchemaDefault
firewall_rule
required

FirewallRuleV1Dot1

4.2.13 - FirewallRuleUpdateSingleRequest

NameDescriptionSchemaDefault
firewall_rule
required
Firewall 요청 Rule
FirewallRuleCreateRequest

4.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)

4.2.15 - FirewallSetRequest

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

4.2.16 - FirewallShowResponse

NameDescriptionSchemaDefault
firewall
required

Firewall

4.2.17 - FirewallShowResponseV1Dot1

NameDescriptionSchemaDefault
firewall
required

FirewallV1Dot1

4.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]

4.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

5 - Global CDN

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 Global CDN 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

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

VersionStatusNot Before
1.0CURRENT-

OpenAPI URL

https://cdn.{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.0

CDN API가 출시되었습니다.

변경사항

  • [신규] GET /cdn/1.0/cdns - ListCdnService API 가 추가되었습니다.
  • [신규] POST /cdn/1.0/cdns - CreateCdnService API 가 추가되었습니다.
  • [신규] GET /cdn/1.0/cdns/{id} - DetailCdnService API 가 추가되었습니다.
  • [신규] PUT /cdn/1.0/cdns/{id} - UpdateCdnService API 가 추가되었습니다.
  • [신규] DELETE /cdn/1.0/cdns/{id} - DeleteCdnService API 가 추가되었습니다.
  • [신규] PUT /cdn/1.0/cdns/{id}/description - UpdateDescriptionOfCdnService API 가 추가되었습니다.
  • [신규] POST /cdn/1.0/cdns/{id}/start - StartCdnService API 가 추가되었습니다.
  • [신규] POST /cdn/1.0/cdns/{id}/stop - StopCdnService API 가 추가되었습니다.
  • [신규] POST /cdn/1.0/cdns/{id}/purge - PurgeCdnService API 가 추가되었습니다.

5.1 - APIs

5.1.1 - Create Cdn Service

5.1.1.1 - 1.0

post /v1/cdns

Description

원본 서버의 콘텐츠를 엣지 로케이션을 통해 캐싱하고 배포하는 CDN 서비스 리소스를 생성합니다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

CdnServiceCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedCdnServiceResponseResult
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/cdns

Request header

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

Request body

{
    "cache_expiry_time": 86400,
    "cache_key_hostname": "REQUEST_HOST_HEADER",
    "caching_option": "CACHE",
    "cdn_origin_hostname": "test.example.com",
    "cdn_origin_port": 443,
    "cdn_origin_protocol": "HTTPS",
    "cdn_service_domain_prefix": "global1",
    "cdn_service_origin_path": "/test/global/",
    "content_policy": "ONLY_VALIDATED_CONTENTS",
    "custom_forward_host_header": "",
    "description": "추가 정보 입력 - 설명",
    "forward_host_header": "REQUEST_HOST_HEADER",
    "name": "test1",
    "origin_hostname_type": "DOMAIN",
    "query_string_ignored": true,
    "range_request_allowed": true,
    "request_custom_headers": "",
    "response_custom_headers": "",
    "tags": []
}

Example HTTP response

Response 202

{
    "cdn": {
        "account_id": "",
        "resource_id": "",
        "workflow_id": ""
    }
}

5.1.2 - Delete Cdn Service

5.1.2.1 - 1.0

delete /v1/cdns/{id}

Description

CDN 서비스 리소스 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathid
required
CDN 서비스의 고유 식별자
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/cdns/{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 = cdn 1.0"

Example HTTP response

Response 202

{
    "cdn": {
        "account_id": "",
        "resource_id": "",
        "workflow_id": ""
    }
}

5.1.3 - Detail Cdn Service

5.1.3.1 - 1.0

get /v1/cdns/{id}

Description

특정 CDN 서비스의 상세 정보를 조회합니다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathid
required
CDN 서비스의 고유 식별자
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/cdns/{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 = cdn 1.0"

Example HTTP response

Response 200

{
    "cdn": {
        "account_id": "",
        "cache_expiry_time": "",
        "cache_key_hostname": "",
        "caching_option": "",
        "cdn_origin_hostname": "",
        "cdn_origin_port": "",
        "cdn_origin_protocol": "",
        "cdn_service_activation_state": "",
        "cdn_service_config_version": "",
        "cdn_service_domain": "",
        "cdn_service_origin_path": "",
        "cdn_service_state": "",
        "content_policy": "",
        "created_at": "",
        "created_by": "",
        "custom_forward_host_header": "",
        "description": "",
        "forward_host_header": "",
        "id": "",
        "modified_at": "",
        "modified_by": "",
        "name": "",
        "origin_hostname_type": "",
        "query_string_ignored": "",
        "range_request_allowed": "",
        "region": "",
        "request_custom_headers": "",
        "response_custom_headers": ""
    }
}

5.1.4 - List Cdn Service

5.1.4.1 - 1.0

get /v1/cdns

Description

CDN 서비스 목록을 조회합니다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

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
querycreated_by
optional
리소스를 생성한 사용자 ID
Example :
any of [string, null]None
queryname
optional
CDN 서비스 이름
Example :
any of [string, null]None
querycdn_service_domain
optional
CDN 서비스가 콘텐츠를 제공하는 도메인 이름
Example :
any of [string, null]None
querycdn_origin_hostname
optional
CDN이 콘텐츠를 가져오는 원본 서버의 호스트네임
Example :
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKCdnServiceListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/cdns

Request header

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

Example HTTP response

Response 200

{
    "cdn": [
        {
            "account_id": "",
            "cdn_origin_hostname": "",
            "cdn_service_domain": "",
            "cdn_service_state": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "region": ""
        }
    ],
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

5.1.5 - Purge Cdn Service

5.1.5.1 - 1.0

post /v1/cdns/{id}/purge

Description

CDN 서비스의 캐시된 콘텐츠를 Purge합니다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathid
required
CDN 서비스의 고유 식별자
Example :
stringNone
bodybody
required

CdnServicePurgeRequest

Responses

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

Example HTTP request

Request path

/v1/cdns/{id}/purge

Request header

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

Request body

{
    "custom_url": "/test/",
    "target_content": "INVALIDATED_CONTENT",
    "target_url": "CUSTOM"
}

Example HTTP response

Response 202

{
    "cdn": {
        "account_id": "",
        "resource_id": "",
        "workflow_id": ""
    }
}

5.1.6 - Start Cdn Service

5.1.6.1 - 1.0

post /v1/cdns/{id}/start

Description

CDN 서비스를 시작합니다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathid
required
CDN 서비스의 고유 식별자
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/cdns/{id}/start

Request header

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

Example HTTP response

Response 202

{
    "cdn": {
        "account_id": "",
        "resource_id": "",
        "workflow_id": ""
    }
}

5.1.7 - Stop Cdn Service

5.1.7.1 - 1.0

post /v1/cdns/{id}/stop

Description

CDN 서비스를 정지합니다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathid
required
CDN 서비스의 고유 식별자
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/cdns/{id}/stop

Request header

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

Example HTTP response

Response 202

{
    "cdn": {
        "account_id": "",
        "resource_id": "",
        "workflow_id": ""
    }
}

5.1.8 - Update Cdn Service

5.1.8.1 - 1.0

put /v1/cdns/{id}

Description

CDN 서비스 리소스 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathid
required
CDN 서비스의 고유 식별자
Example :
stringNone
bodybody
required

CdnServiceUpdateRequest

Responses

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

Example HTTP request

Request path

/v1/cdns/{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 = cdn 1.0"

Request body

{
    "cache_expiry_time": 86400,
    "cache_key_hostname": "REQUEST_HOST_HEADER",
    "caching_option": "CACHE",
    "cdn_origin_hostname": "test.example.com",
    "cdn_origin_port": 443,
    "cdn_origin_protocol": "HTTPS",
    "cdn_service_origin_path": "/test/global/",
    "content_policy": "ONLY_VALIDATED_CONTENTS",
    "custom_forward_host_header": "",
    "forward_host_header": "REQUEST_HOST_HEADER",
    "origin_hostname_type": "DOMAIN",
    "query_string_ignored": true,
    "range_request_allowed": true,
    "request_custom_headers": "",
    "response_custom_headers": ""
}

Example HTTP response

Response 202

{
    "cdn": {
        "account_id": "",
        "resource_id": "",
        "workflow_id": ""
    }
}

5.1.9 - Update Description of Cdn Service

5.1.9.1 - 1.0

put /v1/cdns/{id}/description

Description

CDN 서비스 설명을 업데이트합니다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathid
required
CDN 서비스의 고유 식별자
Example :
stringNone
bodybody
required

CdnServiceModifyDescriptionRequest

Responses

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

Example HTTP request

Request path

/v1/cdns/{id}/description

Request header

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

Request body

{
    "description": "추가 정보 입력 - 설명"
}

Example HTTP response

Response 200

{
    "cdn": {
        "account_id": "",
        "cache_expiry_time": "",
        "cache_key_hostname": "",
        "caching_option": "",
        "cdn_origin_hostname": "",
        "cdn_origin_port": "",
        "cdn_origin_protocol": "",
        "cdn_service_activation_state": "",
        "cdn_service_config_version": "",
        "cdn_service_domain": "",
        "cdn_service_origin_path": "",
        "cdn_service_state": "",
        "content_policy": "",
        "created_at": "",
        "created_by": "",
        "custom_forward_host_header": "",
        "description": "",
        "forward_host_header": "",
        "id": "",
        "modified_at": "",
        "modified_by": "",
        "name": "",
        "origin_hostname_type": "",
        "query_string_ignored": "",
        "range_request_allowed": "",
        "region": "",
        "request_custom_headers": "",
        "response_custom_headers": ""
    }
}

5.2 - Models

5.2.1 - CdnServiceCreateRequest

NameDescriptionSchemaDefault
cache_expiry_time
required
엣지 로케이션에 저장된 콘텐츠의 캐시 만료 시간(초)
Example : 86400
Minimum : 3600
Maximum : 2592000
integer
cache_key_hostname
required
캐시 키의 일부로 사용되는 호스트네임(예: ORIGIN_HOSTNAME, INCOMING_HOST_HEADER)
Example : REQUEST_HOST_HEADER
enum (REQUEST_HOST_HEADER, ORIGIN_HOSTNAME)
caching_option
required
CDN 콘텐츠의 캐싱 옵션(예: CACHE, NO_CACHE, BYPASS_CACHE)
Example : CACHE
string
cdn_origin_hostname
required
CDN이 콘텐츠를 가져오는 원본 서버의 호스트네임
Example : test.example.com
Pattern : ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$
Maximum length : 253
string
cdn_origin_port
required
원본 서버 연결에 사용되는 포트
Example : 443
Minimum : 1
Maximum : 65535
integer
cdn_origin_protocol
required
원본 서버 연결에 사용되는 프로토콜(예: HTTP, HTTPS)
Example : HTTPS
string
cdn_service_domain_prefix
required
CDN 서비스 도메인 접두사
Example : global1
Pattern : ^[a-z0-9]*$
Minimum length : 4
Maximum length : 40
string
cdn_service_origin_path
optional
CDN이 콘텐츠를 가져오는 원본 서버의 경로
Example : /test/global/
Pattern : ^/$|^(/[a-zA-Z0-9-._]+)+/$
any of [string, null]
content_policy
required
CDN 서비스의 콘텐츠 배포 정책(예: ONLY_VALIDATED_CONTENTS, ALL_CONTENTS)
Example : ONLY_VALIDATED_CONTENTS
string
custom_forward_host_header
optional
포워드 호스트 헤더가 CUSTOM으로 설정된 경우 원본으로 전달되는 커스텀 호스트 헤더
Example :
any of [string, null]
description
optional
설명
Example : 추가 정보 입력 - 설명
any of [string, null]
forward_host_header
required
원본 서버로 전달되는 호스트 헤더(예: ORIGIN_HOSTNAME, INCOMING_HOST_HEADER, CUSTOM)
Example : REQUEST_HOST_HEADER
enum (REQUEST_HOST_HEADER, ORIGIN_HOSTNAME, CUSTOM)
name
required
CDN 서비스 이름
Example : test1
Pattern : ^[a-zA-Z0-9]*$
Minimum length : 3
Maximum length : 20
string
origin_hostname_type
required
원본 호스트네임 유형(예: DOMAIN, IP)
Example : DOMAIN
enum (DOMAIN, IP)
query_string_ignored
required
콘텐츠 캐싱 시 쿼리 문자열 무시 여부
Example : True
boolean
range_request_allowed
required
콘텐츠 배포 시 범위 요청 허용 여부
Example : True
boolean
request_custom_headers
optional
원본 서버로 전달되는 요청에 추가되는 커스텀 헤더
Example :
object
response_custom_headers
optional
클라이언트로 반환되는 응답에 추가되는 커스텀 헤더
Example :
object
tags
optional
태그 목록
array[Tag]

5.2.2 - CdnServiceDetail

NameDescriptionSchemaDefault
account_id
required
Account ID
Example :
string
cache_expiry_time
required
엣지 로케이션에 저장된 콘텐츠의 캐시 만료 시간(초)
Example :
integer
cache_key_hostname
required
캐시 키의 일부로 사용되는 호스트네임(예: ORIGIN_HOSTNAME, INCOMING_HOST_HEADER)
Example :
string
caching_option
required
CDN 콘텐츠의 캐싱 옵션(예: CACHE, NO_CACHE, BYPASS_CACHE)
Example :
string
cdn_origin_hostname
required
CDN이 콘텐츠를 가져오는 원본 서버의 호스트네임
Example :
string
cdn_origin_port
required
원본 서버 연결에 사용되는 포트
Example :
integer
cdn_origin_protocol
required
원본 서버 연결에 사용되는 프로토콜(예: HTTP, HTTPS)
Example :
string
cdn_service_activation_state
required
CDN 서비스 활성화 상태
Example :
string
cdn_service_config_version
required
CDN 서비스 설정 버전
Example :
integer
cdn_service_domain
required
CDN 서비스가 콘텐츠를 제공하는 도메인 이름
Example :
string
cdn_service_origin_path
required
CDN이 콘텐츠를 가져오는 원본 서버의 경로
Example :
string
cdn_service_state
required
CDN 서비스의 현재 상태(예: RUNNING, STOPPED, CREATING, DELETING)
Example :
string
content_policy
required
CDN 서비스의 콘텐츠 배포 정책(예: ONLY_VALIDATED_CONTENTS, ALL_CONTENTS)
Example :
string
created_at
required
리소스가 생성된 타임스탬프 (ISO 8601 형식)
Example :
string
created_by
required
리소스를 생성한 사용자 ID
Example :
string
custom_forward_host_header
required
포워드 호스트 헤더가 CUSTOM으로 설정된 경우 원본으로 전달되는 커스텀 호스트 헤더
Example :
string
description
required
설명
Example :
string
forward_host_header
required
원본 서버로 전달되는 호스트 헤더(예: ORIGIN_HOSTNAME, INCOMING_HOST_HEADER, CUSTOM)
Example :
string
id
required
CDN 서비스의 고유 식별자
Example :
string
modified_at
required
리소스가 마지막으로 수정된 타임스탬프 (ISO 8601 형식)
Example :
string
modified_by
required
리소스를 마지막으로 수정한 사용자 ID
Example :
string
name
required
CDN 서비스 이름
Example :
string
origin_hostname_type
required
원본 호스트네임 유형(예: DOMAIN, IP)
Example :
string
query_string_ignored
required
콘텐츠 캐싱 시 쿼리 문자열 무시 여부
Example :
boolean
range_request_allowed
required
콘텐츠 배포 시 범위 요청 허용 여부
Example :
boolean
region
required
CDN 서비스가 제공되는 리전
Example :
string
request_custom_headers
required
원본 서버로 전달되는 요청에 추가되는 커스텀 헤더
Example :
object
response_custom_headers
required
클라이언트로 반환되는 응답에 추가되는 커스텀 헤더
Example :
object

5.2.3 - CdnServiceDetailResponse

NameDescriptionSchemaDefault
cdn
required

CdnServiceDetail

5.2.4 - CdnServiceListResponse

NameDescriptionSchemaDefault
cdn
required

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

5.2.5 - CdnServiceModifyDescriptionRequest

NameDescriptionSchemaDefault
description
required
설명
Example : 추가 정보 입력 - 설명
Maximum length : 50
string

5.2.6 - CdnServicePurgeRequest

NameDescriptionSchemaDefault
custom_url
optional
대상 URL이 CUSTOM으로 설정된 경우 Purge할 커스텀 URL
Example : /test/
Pattern : ^/[a-zA-Z0-9-._/]*$
any of [string, null]
target_content
required
Purge할 대상 콘텐츠 유형(예: ALL_CONTENT, INVALIDATED_CONTENT)
Example : INVALIDATED_CONTENT
string
target_url
required
Purge 작업의 대상 URL 범위(예: ALL, CUSTOM)
Example : CUSTOM
string

5.2.7 - CdnServiceResponse

NameDescriptionSchemaDefault
account_id
required
Account ID
Example :
string
cdn_origin_hostname
required
CDN이 콘텐츠를 가져오는 원본 서버의 호스트네임
Example :
string
cdn_service_domain
required
CDN 서비스가 콘텐츠를 제공하는 도메인 이름
Example :
string
cdn_service_state
required
CDN 서비스의 현재 상태(예: RUNNING, STOPPED, CREATING, DELETING)
Example :
string
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
설명
Example :
any of [string, null]
id
required
CDN 서비스의 고유 식별자
Example :
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
CDN 서비스 이름
Example :
string
region
required
CDN 서비스가 제공되는 리전
Example :
string

5.2.8 - CdnServiceResponseResult

NameDescriptionSchemaDefault
cdn
required

CdnServiceResult

5.2.9 - CdnServiceResult

NameDescriptionSchemaDefault
account_id
required
Account ID
Example :
string
resource_id
required
리소스 ID
Example :
string
workflow_id
required
요청을 처리하는 워크플로우 ID
Example :
string

5.2.10 - CdnServiceUpdateRequest

NameDescriptionSchemaDefault
cache_expiry_time
required
엣지 로케이션에 저장된 콘텐츠의 캐시 만료 시간(초)
Example : 86400
Minimum : 3600
Maximum : 2592000
integer
cache_key_hostname
required
캐시 키의 일부로 사용되는 호스트네임(예: ORIGIN_HOSTNAME, INCOMING_HOST_HEADER)
Example : REQUEST_HOST_HEADER
enum (REQUEST_HOST_HEADER, ORIGIN_HOSTNAME)
caching_option
required
CDN 콘텐츠의 캐싱 옵션(예: CACHE, NO_CACHE, BYPASS_CACHE)
Example : CACHE
string
cdn_origin_hostname
required
CDN이 콘텐츠를 가져오는 원본 서버의 호스트네임
Example : test.example.com
Pattern : ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$
Maximum length : 253
string
cdn_origin_port
required
원본 서버 연결에 사용되는 포트
Example : 443
Minimum : 1
Maximum : 65535
integer
cdn_origin_protocol
required
원본 서버 연결에 사용되는 프로토콜(예: HTTP, HTTPS)
Example : HTTPS
string
cdn_service_origin_path
optional
CDN이 콘텐츠를 가져오는 원본 서버의 경로
Example : /test/global/
Pattern : ^/$|^(/[a-zA-Z0-9-._]+)+/$
any of [string, null]
content_policy
required
CDN 서비스의 콘텐츠 배포 정책(예: ONLY_VALIDATED_CONTENTS, ALL_CONTENTS)
Example : ONLY_VALIDATED_CONTENTS
string
custom_forward_host_header
optional
포워드 호스트 헤더가 CUSTOM으로 설정된 경우 원본으로 전달되는 커스텀 호스트 헤더
Example :
any of [string, null]
forward_host_header
required
원본 서버로 전달되는 호스트 헤더(예: ORIGIN_HOSTNAME, INCOMING_HOST_HEADER, CUSTOM)
Example : REQUEST_HOST_HEADER
enum (REQUEST_HOST_HEADER, ORIGIN_HOSTNAME, CUSTOM)
origin_hostname_type
required
원본 호스트네임 유형(예: DOMAIN, IP)
Example : DOMAIN
enum (DOMAIN, IP)
query_string_ignored
required
콘텐츠 캐싱 시 쿼리 문자열 무시 여부
Example : True
boolean
range_request_allowed
required
콘텐츠 배포 시 범위 요청 허용 여부
Example : True
boolean
request_custom_headers
optional
원본 서버로 전달되는 요청에 추가되는 커스텀 헤더
Example :
any of [object, null]
response_custom_headers
optional
클라이언트로 반환되는 응답에 추가되는 커스텀 헤더
Example :
any of [object, null]

5.2.11 - Tag

NameDescriptionSchemaDefault
key
required
tag key
Example :
string
value
required
tag value
Example :
string

6 - GSLB

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 GSLB 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

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

VersionStatusNot Before
1.1CURRENT-
1.0DEPRECATED20260531

OpenAPI URL

https://gslb.{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

GSLB API가 1.1 버전으로 업데이트 되었습니다.

변경사항

  • [변경] POST /gslb/1.1/gslbs - CreateGslb API 가 변경되었습니다.
    • 요청 시, routing_control_enabled 필드가 추가되었습니다.
  • [신규] GET /gslb/1.1/gslbs/routing-control - ListGslbsRegionalRoutingControl API 가 추가되었습니다.
  • [신규] PUT /gslb/1.1/gslbs/{gslb_id}/routing-control - SetGslbRegionalRoutingControl API 가 추가되었습니다.

1.0

GSLB API가 출시되었습니다.

변경사항

  • [신규] GET /gslb/1.0/gslbs - ListGslbs API 가 추가되었습니다.
  • [신규] POST /gslb/1.0/gslbs - CreateGslb API 가 추가되었습니다.
  • [신규] GET /gslb/1.0/gslbs/{gslb_id} - ShowGslb API 가 추가되었습니다.
  • [신규] PUT /gslb/1.0/gslbs/{gslb_id} - SetGslb API 가 추가되었습니다.
  • [신규] DELETE /gslb/1.0/gslbs/{gslb_id} - DeleteGslb API 가 추가되었습니다.
  • [신규] PUT /gslb/1.0/gslbs/{gslb_id}/health-check - SetGslbHealthCheck API 가 추가되었습니다.
  • [신규] GET /gslb/1.0/gslbs/{gslb_id}/resources - ListGslbResources API 가 추가되었습니다.
  • [신규] PUT /gslb/1.0/gslbs/{gslb_id}/resources - SetGslbResources API 가 추가되었습니다.

6.1 - APIs

6.1.1 - CreateGslb

6.1.1.1 - 1.1

post /v1/gslbs

Description

여러 리전에 트래픽을 분산하는 GSLB 리소스를 생성합니다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

GslbCreateRequestV1Dot1

Responses

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

Example HTTP request

Request path

/v1/gslbs

Request header

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

Request body

{
    "algorithm": "ROUND_ROBIN",
    "description": "Example Description for GSLB",
    "env_usage": "PUBLIC",
    "health_check": {
        "health_check_interval": 5,
        "health_check_probe_timeout": 5,
        "health_check_user_id": "user",
        "health_check_user_password": "Passw0rd!",
        "protocol": "https",
        "receive_string": "OK",
        "send_string": "GET /",
        "service_port": 1,
        "timeout": 6
    },
    "name": "example.gslb.e.samsungsdscloud.com",
    "resources": [
        {
            "description": "",
            "destination": "192.168.1.100",
            "region": "KR-WEST-1",
            "weight": 10
        }
    ],
    "tags": []
}

Example HTTP response

Response 202

{
    "gslb": {
        "algorithm": "ROUND_ROBIN",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for GSLB",
        "env_usage": "PUBLIC",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": 2,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "example.gslb.e.samsungsdscloud.com",
        "state": "ACTIVE"
    }
}

6.1.1.2 - 1.0

post /v1/gslbs

Description

여러 리전에 트래픽을 분산하는 GSLB 리소스를 생성합니다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020260531

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

GslbCreateRequest

Responses

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

Example HTTP request

Request path

/v1/gslbs

Request header

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

Request body

{
    "algorithm": "",
    "description": "",
    "env_usage": "",
    "health_check": {
        "health_check_interval": 5,
        "health_check_probe_timeout": 5,
        "health_check_user_id": "user",
        "health_check_user_password": "Passw0rd!",
        "protocol": "https",
        "receive_string": "OK",
        "send_string": "GET /",
        "service_port": 1,
        "timeout": 6
    },
    "name": "",
    "resources": [
        {
            "description": "",
            "destination": "192.168.1.100",
            "disabled": false,
            "region": "KR-WEST-1",
            "weight": 10
        }
    ],
    "tags": []
}

Example HTTP response

Response 202

{
    "gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": ""
    }
}

6.1.2 - DeleteGslb

6.1.2.1 - 1.1

delete /v1/gslbs/{gslb_id}

Description

GSLB 리소스를 삭제합니다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathgslb_id
required
GSLB의 고유 식별자
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/gslbs/{gslb_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 = gslb 1.1"

Example HTTP response

Response 202

{
    "gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": ""
    }
}

6.1.2.2 - 1.0

delete /v1/gslbs/{gslb_id}

Description

GSLB 리소스를 삭제합니다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020260531

Parameters

TypeNameDescriptionSchemaDefault
pathgslb_id
required
GSLB의 고유 식별자
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/gslbs/{gslb_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 = gslb 1.0"

Example HTTP response

Response 202

{
    "gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": ""
    }
}

6.1.3 - ListGslbResources

6.1.3.1 - 1.1

get /v1/gslbs/{gslb_id}/resources

Description

GSLB 리소스 목록

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathgslb_id
required
GSLB의 고유 식별자
Example :
stringNone
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

Responses

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

Example HTTP request

Request path

/v1/gslbs/{gslb_id}/resources

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "gslb_resources": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "destination": "192.168.1.100",
            "health_check_status": "CONNECTED",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "region": "KR-WEST-1",
            "status": "ENABLE",
            "weight": 10
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

6.1.3.2 - 1.0

get /v1/gslbs/{gslb_id}/resources

Description

GSLB 리소스 목록

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020260531

Parameters

TypeNameDescriptionSchemaDefault
pathgslb_id
required
GSLB의 고유 식별자
Example :
stringNone
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

Responses

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

Example HTTP request

Request path

/v1/gslbs/{gslb_id}/resources

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "gslb_resources": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "destination": "192.168.1.100",
            "disabled": false,
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "region": "KR-WEST-1",
            "weight": 10
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

6.1.4 - ListGslbs

6.1.4.1 - 1.1

get /v1/gslbs

Description

GSLB 목록을 조회합니다.

상태 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
querystate
optional
GSLB의 현재 상태(예: ACTIVE, CREATING, EDITING, ERROR, DELETING)
Example :
any of [string, null]None
queryname
optional
GSLB 이름
Example :
any of [string, null]None

Responses

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

Example HTTP request

Request path

/v1/gslbs

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "gslbs": [
        {
            "algorithm": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "env_usage": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "linked_resource_count": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "state": ""
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

6.1.4.2 - 1.0

get /v1/gslbs

Description

GSLB 목록을 조회합니다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020260531

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
querystate
optional
GSLB의 현재 상태(예: ACTIVE, CREATING, EDITING, ERROR, DELETING)
Example :
any of [string, null]None
queryname
optional
GSLB 이름
Example :
any of [string, null]None

Responses

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

Example HTTP request

Request path

/v1/gslbs

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "gslbs": [
        {
            "algorithm": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "env_usage": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "linked_resource_count": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "state": ""
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

6.1.5 - ListGslbsRegionalRoutingControl

6.1.5.1 - 1.1

get /v1/gslbs/routing-control

Description

GSLB 리전별 라우팅 제어 목록 조회

상태 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
queryregion
optional
GSLB 리소스가 위치한 리전
Example :
any of [string, null]None
querystatus
optional
GSLB 리소스 사용 여부(예: ENABLE, DISABLE)
Example :
any of [enum (ENABLE, DISABLE), null]None
queryname
optional
GSLB 이름
Example :
any of [string, null]None

Responses

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

Example HTTP request

Request path

/v1/gslbs/routing-control

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "regional_gslbs": [
        {
            "algorithm": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "env_usage": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "linked_regional_resource_count": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "region": "",
            "status": "ENABLE"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

6.1.6 - SetGslb

6.1.6.1 - 1.1

put /v1/gslbs/{gslb_id}

Description

GSLB 리소스를 수정합니다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathgslb_id
required
GSLB의 고유 식별자
Example :
stringNone
bodybody
required

GslbSetRequest

Responses

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

Example HTTP request

Request path

/v1/gslbs/{gslb_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 = gslb 1.1"

Request body

{
    "algorithm": "ROUND_ROBIN",
    "description": ""
}

Example HTTP response

Response 200

{
    "gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": ""
    }
}

6.1.6.2 - 1.0

put /v1/gslbs/{gslb_id}

Description

GSLB 리소스를 수정합니다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020260531

Parameters

TypeNameDescriptionSchemaDefault
pathgslb_id
required
GSLB의 고유 식별자
Example :
stringNone
bodybody
required

GslbSetRequest

Responses

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

Example HTTP request

Request path

/v1/gslbs/{gslb_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 = gslb 1.0"

Request body

{
    "algorithm": "ROUND_ROBIN",
    "description": ""
}

Example HTTP response

Response 200

{
    "gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": ""
    }
}

6.1.7 - SetGslbHealthCheck

6.1.7.1 - 1.1

put /v1/gslbs/{gslb_id}/health-check

Description

GSLB 헬스 체크 설정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathgslb_id
required
GSLB의 고유 식별자
Example :
stringNone
bodybody
required

GslbHealthCheck

Responses

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

Example HTTP request

Request path

/v1/gslbs/{gslb_id}/health-check

Request header

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

Request body

{
    "health_check_interval": 5,
    "health_check_probe_timeout": 5,
    "health_check_user_id": "user",
    "health_check_user_password": "Passw0rd!",
    "protocol": "https",
    "receive_string": "OK",
    "send_string": "GET /",
    "service_port": 1,
    "timeout": 6
}

Example HTTP response

Response 202

{
    "gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": ""
    }
}

6.1.7.2 - 1.0

put /v1/gslbs/{gslb_id}/health-check

Description

GSLB 헬스 체크 설정

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020260531

Parameters

TypeNameDescriptionSchemaDefault
pathgslb_id
required
GSLB의 고유 식별자
Example :
stringNone
bodybody
required

GslbHealthCheck

Responses

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

Example HTTP request

Request path

/v1/gslbs/{gslb_id}/health-check

Request header

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

Request body

{
    "health_check_interval": 5,
    "health_check_probe_timeout": 5,
    "health_check_user_id": "user",
    "health_check_user_password": "Passw0rd!",
    "protocol": "https",
    "receive_string": "OK",
    "send_string": "GET /",
    "service_port": 1,
    "timeout": 6
}

Example HTTP response

Response 202

{
    "gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": ""
    }
}

6.1.8 - SetGslbRegionalRoutingControl

6.1.8.1 - 1.1

put /v1/gslbs/{gslb_id}/routing-control

Description

GSLB 리전별 라우팅 제어 설정을 업데이트합니다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathgslb_id
required
GSLB의 고유 식별자
Example :
stringNone
bodybody
required

GslbRoutingControlRequest

Responses

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

Example HTTP request

Request path

/v1/gslbs/{gslb_id}/routing-control

Request header

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

Request body

{
    "region": "KR-WEST-1",
    "status": "ENABLE"
}

Example HTTP response

Response 202

{
    "regional_gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_regional_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "region": "",
        "status": "ENABLE"
    }
}

6.1.9 - SetGslbResources

6.1.9.1 - 1.1

put /v1/gslbs/{gslb_id}/resources

Description

GSLB 리소스 설정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathgslb_id
required
GSLB의 고유 식별자
Example :
stringNone
bodybody
required

GslbResourcesSetRequest

Responses

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

Example HTTP request

Request path

/v1/gslbs/{gslb_id}/resources

Request header

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

Request body

{
    "resources": [
        {
            "description": "",
            "destination": "192.168.1.100",
            "region": "KR-WEST-1",
            "weight": 10
        }
    ]
}

Example HTTP response

Response 202

{
    "gslb_resources": [
        {
            "description": "",
            "destination": "192.168.1.100",
            "region": "KR-WEST-1",
            "status": "ENABLE",
            "weight": 10
        }
    ]
}

6.1.9.2 - 1.0

put /v1/gslbs/{gslb_id}/resources

Description

GSLB 리소스 설정

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020260531

Parameters

TypeNameDescriptionSchemaDefault
pathgslb_id
required
GSLB의 고유 식별자
Example :
stringNone
bodybody
required

GslbResourceSetRequest

Responses

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

Example HTTP request

Request path

/v1/gslbs/{gslb_id}/resources

Request header

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

Request body

{
    "resources": [
        {
            "description": "",
            "destination": "192.168.1.100",
            "disabled": false,
            "region": "KR-WEST-1",
            "weight": 10
        }
    ]
}

Example HTTP response

Response 202

{
    "gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": ""
    }
}

6.1.10 - ShowGslb

6.1.10.1 - 1.1

get /v1/gslbs/{gslb_id}

Description

특정 GSLB의 상세 정보를 조회합니다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathgslb_id
required
GSLB의 고유 식별자
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/gslbs/{gslb_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 = gslb 1.1"

Example HTTP response

Response 200

{
    "gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": ""
    }
}

6.1.10.2 - 1.0

get /v1/gslbs/{gslb_id}

Description

특정 GSLB의 상세 정보를 조회합니다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020260531

Parameters

TypeNameDescriptionSchemaDefault
pathgslb_id
required
GSLB의 고유 식별자
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/gslbs/{gslb_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 = gslb 1.0"

Example HTTP response

Response 200

{
    "gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": ""
    }
}

6.2 - Models

6.2.1 - GslbCreateRequest

NameDescriptionSchemaDefault
algorithm
required
GSLB 트래픽 분산을 위한 부하 분산 알고리즘(예: ROUND_ROBIN, RATIO)
Example :
string
description
optional
설명
Example :
any of [string, null]
env_usage
required
GSLB의 환경 사용 유형(예: PUBLIC)
Example :
string
health_check
optional
GSLB 엔드포인트 가용성 모니터링을 위한 헬스 체크 설정
any of [GslbHealthCheck, null]
name
required
GSLB 이름
Example :
string
resources
required

array[GslbResource]
tags
optional
태그 목록
array[Tag]

6.2.2 - GslbCreateRequestV1Dot1

NameDescriptionSchemaDefault
algorithm
required
GSLB 트래픽 분산을 위한 부하 분산 알고리즘(예: ROUND_ROBIN, RATIO)
Example : ROUND_ROBIN
enum (RATIO, ROUND_ROBIN)
description
optional
설명
Example : Example Description for GSLB
any of [string, null]
env_usage
required
GSLB의 환경 사용 유형(예: PUBLIC)
Example : PUBLIC
enum (PUBLIC, PRIVATE)
health_check
optional
GSLB 엔드포인트 가용성 모니터링을 위한 헬스 체크 설정
any of [GslbHealthCheck, null]
name
required
GSLB 이름
Example : example.gslb.e.samsungsdscloud.com
string
resources
required
GSLB 리소스 목록
array[GslbResourceV1Dot1]
tags
optional
태그 목록
array[Tag]

6.2.3 - GslbDetail

NameDescriptionSchemaDefault
algorithm
required
GSLB 트래픽 분산을 위한 부하 분산 알고리즘(예: ROUND_ROBIN, RATIO)
Example :
string
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
설명
Example :
any of [string, null]
env_usage
required
GSLB의 환경 사용 유형(예: PUBLIC)
Example :
string
health_check
required

any of [GslbHeathCheckShowResponse, null]
id
required
ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
linked_resource_count
required
이 GSLB에 연결된 리소스 수
Example :
integer
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
GSLB 이름
Example :
string
state
required
GSLB의 현재 상태(예: ACTIVE, CREATING, EDITING, ERROR, DELETING)
Example :
string

6.2.4 - GslbHealthCheck

NameDescriptionSchemaDefault
health_check_interval
optional
GSLB 헬스 체크 주기
Example : 5
any of [integer, null]
health_check_probe_timeout
optional
GSLB 헬스 체크 Probe 타임아웃
Example : 5
any of [integer, null]
health_check_user_id
optional
GSLB 헬스 체크 사용자 이름
Example : user
any of [string, null]
health_check_user_password
optional
GSLB 헬스 체크 비밀번호
Example : Passw0rd!
any of [string, null]
protocol
required
헬스 체크에 사용되는 프로토콜(예: ICMP, TCP, HTTP, HTTPS)
Example : https
string
receive_string
optional
GSLB 헬스 체크 수신 문자열
Example : OK
Pattern : ^[a-zA-Z\d]+$
any of [string, null]
send_string
optional
GSLB 헬스 체크 Send String입니다. 입력하지 않으면 “GET /” 요청으로 동작합니다.
Example : GET /
Pattern : ^[^\u1100-\u11FF\uAC00-\uD7A3\uA960-\uA97C\uD7B0-\uD7FF\u3130-\u318F#<>]*$
any of [string, null]
service_port
optional
GSLB 헬스 체크 서비스 포트
Example : 1
any of [integer, null]
timeout
optional
GSLB 헬스 체크 타임아웃. Interval보다 커야 합니다.
Example : 6
any of [integer, null]

6.2.5 - GslbHeathCheckShowResponse

NameDescriptionSchemaDefault
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
health_check_interval
optional
GSLB 헬스 체크 주기
Example :
any of [integer, null]
health_check_probe_timeout
optional
GSLB 헬스 체크 Probe 타임아웃
Example :
any of [integer, null]
health_check_user_id
optional
GSLB 헬스 체크 사용자 이름
Example :
any of [string, null]
health_check_user_password
optional
GSLB 헬스 체크 비밀번호
Example :
any of [string, null]
id
required
ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
protocol
required
헬스 체크에 사용되는 프로토콜(예: ICMP, TCP, HTTP, HTTPS)
Example :
string
receive_string
optional
GSLB 헬스 체크 수신 문자열
Example :
any of [string, null]
send_string
optional
GSLB 헬스 체크 Send String입니다. 입력하지 않으면 “GET /” 요청으로 동작합니다.
Example :
any of [string, null]
service_port
optional
GSLB 헬스 체크 서비스 포트
Example :
any of [integer, null]
timeout
optional
GSLB 헬스 체크 타임아웃. Interval보다 커야 합니다.
Example :
any of [integer, null]

6.2.6 - GslbListResponse

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
gslbs
required

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

6.2.7 - GslbResource

NameDescriptionSchemaDefault
description
optional
설명
Example :
any of [string, null]
destination
required
GSLB 리소스의 대상 엔드포인트
Example : 192.168.1.100
string
disabled
optional
GSLB 리소스 비활성화
Example : False
any of [boolean, null]
region
required
GSLB 리소스가 위치한 리전
Example : KR-WEST-1
string
weight
optional
부하 분산 배분을 위한 가중치(0-100)
Example : 10
any of [integer, null]

6.2.8 - GslbResourceListResponse

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
gslb_resources
required

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

6.2.9 - GslbResourceListResponseV1Dot1

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
gslb_resources
required

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

6.2.10 - GslbResourceResponse

NameDescriptionSchemaDefault
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
설명
Example :
any of [string, null]
destination
required
GSLB 리소스의 대상 엔드포인트
Example : 192.168.1.100
string
disabled
optional
GSLB 리소스 비활성화
Example : False
any of [boolean, null]
id
required
ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
region
required
GSLB 리소스가 위치한 리전
Example : KR-WEST-1
string
weight
optional
부하 분산 배분을 위한 가중치(0-100)
Example : 10
any of [integer, null]

6.2.11 - GslbResourceResponseV1Dot1

NameDescriptionSchemaDefault
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
설명
Example :
any of [string, null]
destination
required
GSLB 리소스의 대상 엔드포인트
Example : 192.168.1.100
string
health_check_status
required
GSLB 리소스의 헬스 체크 상태(예: CONNECTED, DISCONNECTED)
Example : CONNECTED
enum (CONNECTED, DISCONNECTED)
id
required
ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
region
required
GSLB 리소스가 위치한 리전
Example : KR-WEST-1
string
status
required
GSLB 리소스 사용 여부(예: ENABLE, DISABLE)
Example : ENABLE
enum (ENABLE, DISABLE)
weight
optional
부하 분산 배분을 위한 가중치(0-100)
Example : 10
any of [integer, null]

6.2.12 - GslbResourceSetRequest

NameDescriptionSchemaDefault
resources
required

array[GslbResource]

6.2.13 - GslbResourceSetRequestV1Dot1

NameDescriptionSchemaDefault
description
optional
설명
Example :
any of [string, null]
destination
required
GSLB 리소스의 대상 엔드포인트
Example : 192.168.1.100
string
region
required
GSLB 리소스가 위치한 리전
Example : KR-WEST-1
string
weight
optional
부하 분산 배분을 위한 가중치(0-100)
Example : 10
any of [integer, null]

6.2.14 - GslbResourcesSetRequest

NameDescriptionSchemaDefault
resources
required
GSLB 리소스 목록
array[GslbResourceSetRequestV1Dot1]

6.2.15 - GslbResourcesSetResponse

NameDescriptionSchemaDefault
gslb_resources
required

array[GslbResourceWithStatus]

6.2.16 - GslbResourceV1Dot1

NameDescriptionSchemaDefault
description
optional
설명
Example :
any of [string, null]
destination
required
GSLB 리소스의 대상 엔드포인트
Example : 192.168.1.100
string
region
required
GSLB 리소스가 위치한 리전
Example : KR-WEST-1
string
weight
optional
부하 분산 배분을 위한 가중치(0-100)
Example : 10
any of [integer, null]

6.2.17 - GslbResourceWithStatus

NameDescriptionSchemaDefault
description
optional
설명
Example :
any of [string, null]
destination
required
GSLB 리소스의 대상 엔드포인트
Example : 192.168.1.100
string
region
required
GSLB 리소스가 위치한 리전
Example : KR-WEST-1
string
status
required
GSLB 리소스 사용 여부(예: ENABLE, DISABLE)
Example : ENABLE
enum (ENABLE, DISABLE)
weight
optional
부하 분산 배분을 위한 가중치(0-100)
Example : 10
any of [integer, null]

6.2.18 - GslbResponseCommon

NameDescriptionSchemaDefault
algorithm
required
GSLB 트래픽 분산을 위한 부하 분산 알고리즘(예: ROUND_ROBIN, RATIO)
Example :
string
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
설명
Example :
any of [string, null]
env_usage
required
GSLB의 환경 사용 유형(예: PUBLIC)
Example :
string
id
required
ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
linked_resource_count
required
이 GSLB에 연결된 리소스 수
Example :
integer
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
GSLB 이름
Example :
string
state
required
GSLB의 현재 상태(예: ACTIVE, CREATING, EDITING, ERROR, DELETING)
Example :
string

6.2.19 - GslbRoutingControlListResponse

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
page
required
page
Example : 0
integer
regional_gslbs
required

array[GslbRoutingControlResponseCommon]
size
required
size
Example : 20
integer
sort
optional
sort
Example : ['created_at:asc']
any of [array[string], null]

6.2.20 - GslbRoutingControlRequest

NameDescriptionSchemaDefault
region
required
GSLB 리소스가 위치한 리전
Example : KR-WEST-1
string
status
required
GSLB 리소스 사용 여부(예: ENABLE, DISABLE)
Example : ENABLE
enum (ENABLE, DISABLE)

6.2.21 - GslbRoutingControlResponse

NameDescriptionSchemaDefault
regional_gslb
required

GslbRoutingControlResponseCommon

6.2.22 - GslbRoutingControlResponseCommon

NameDescriptionSchemaDefault
algorithm
required
GSLB 트래픽 분산을 위한 부하 분산 알고리즘(예: ROUND_ROBIN, RATIO)
Example :
string
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
설명
Example :
any of [string, null]
env_usage
required
GSLB의 환경 사용 유형(예: PUBLIC)
Example :
string
id
required
ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
linked_regional_resource_count
required
리전 내 이 GSLB에 연결된 리소스 수
Example :
integer
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
GSLB 이름
Example :
string
region
required
GSLB 리소스가 위치한 리전
Example :
string
status
required
GSLB 리소스 사용 여부(예: ENABLE, DISABLE)
Example : ENABLE
enum (ENABLE, DISABLE)

6.2.23 - GslbSetRequest

NameDescriptionSchemaDefault
algorithm
optional
GSLB 트래픽 분산을 위한 부하 분산 알고리즘(예: ROUND_ROBIN, RATIO)
Example : ROUND_ROBIN
any of [string, null]
description
optional
설명
Example :
any of [string, null]

6.2.24 - GslbShowResponse

NameDescriptionSchemaDefault
gslb
required

GslbDetail

6.2.25 - GslbShowResponseV1Dot1

NameDescriptionSchemaDefault
gslb
required

GslbV1Dot1

6.2.26 - GslbV1Dot1

NameDescriptionSchemaDefault
algorithm
required
GSLB 트래픽 분산을 위한 부하 분산 알고리즘(예: ROUND_ROBIN, RATIO)
Example : ROUND_ROBIN
enum (RATIO, ROUND_ROBIN)
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
설명
Example : Example Description for GSLB
any of [string, null]
env_usage
required
GSLB의 환경 사용 유형(예: PUBLIC)
Example : PUBLIC
enum (PUBLIC, PRIVATE)
health_check
optional
GSLB 엔드포인트 가용성 모니터링을 위한 헬스 체크 설정
any of [GslbHeathCheckShowResponse, null]
id
required
ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
linked_resource_count
required
이 GSLB에 연결된 리소스 수
Example : 2
integer
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
GSLB 이름
Example : example.gslb.e.samsungsdscloud.com
string
state
required
GSLB의 현재 상태(예: ACTIVE, CREATING, EDITING, ERROR, DELETING)
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING)

6.2.27 - Tag

NameDescriptionSchemaDefault
key
required
tag key
Example :
string
value
required
tag value
Example :
string

7 - Load Balancer

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 LOADBALANCER 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

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

VersionStatusNot Before
1.4CURRENT-
1.3SUPPORTED20261031

OpenAPI URL

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

Environment and Region List

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

7.1 - APIs

7.1.1 - AddLbServerGroupMembers

7.1.1.1 - 1.4

post /v1/lb-server-groups/{lb_server_group_id}/members

Description

Member를 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

Parameters

TypeNameDescriptionSchemaDefault
pathlb_server_group_id
required
Lb Server Group ID
Example :
stringNone
bodybody
required

MemberListCreateRequestV1Dot1

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_id}/members

Request header

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

Request body

{
    "members": [
        {
            "member_ip": "192.168.0.1",
            "member_port": 80,
            "member_state": "ENABLE",
            "member_weight": 100,
            "name": "virtualserver-1",
            "object_id": "1",
            "object_type": "VM"
        }
    ]
}

Example HTTP response

Response 202

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "members": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "lb_server_group_id": "",
            "member_ip": "",
            "member_port": "",
            "member_state": "",
            "member_weight": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "object_id": "",
            "object_type": "VM",
            "state": "CREATING",
            "subnet_id": "",
            "uuid": ""
        }
    ]
}

7.1.1.2 - 1.3

post /v1/lb-server-groups/{lb_server_group_id}/members

Description

Member를 생성한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

Parameters

TypeNameDescriptionSchemaDefault
pathlb_server_group_id
required
Lb Server Group ID
Example :
stringNone
bodybody
required

MemberListCreateRequestV1Dot1

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_id}/members

Request header

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

Request body

{
    "members": [
        {
            "member_ip": "192.168.0.1",
            "member_port": 80,
            "member_state": "ENABLE",
            "member_weight": 100,
            "name": "virtualserver-1",
            "object_id": "1",
            "object_type": "VM"
        }
    ]
}

Example HTTP response

Response 202

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "members": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "lb_server_group_id": "",
            "member_ip": "",
            "member_port": "",
            "member_state": "",
            "member_weight": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "object_id": "",
            "object_type": "VM",
            "state": "CREATING",
            "subnet_id": "",
            "uuid": ""
        }
    ]
}

7.1.2 - CreateLBHealthCheck

7.1.2.1 - 1.4

post /v1/lb-health-checks

Description

LB 헬스 체크를 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

LbHealthCheckCreateRequest

Responses

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

Example HTTP request

Request path

/v1/lb-health-checks

Request header

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

Request body

{
    "lb_health_check": {
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_url": "/test",
        "http_method": "GET",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "tags": [],
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

Example HTTP response

Response 202

{
    "lb_health_check": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_type": "DEFAULT",
        "health_check_url": "/test",
        "http_method": "GET",
        "id": "46c681018e33453085ca7c8db54e0076",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "Test-LbMonitor-01",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

7.1.2.2 - 1.3

post /v1/lb-health-checks

Description

LB 헬스 체크를 생성한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

LbHealthCheckCreateRequest

Responses

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

Example HTTP request

Request path

/v1/lb-health-checks

Request header

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

Request body

{
    "lb_health_check": {
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_url": "/test",
        "http_method": "GET",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "tags": [],
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

Example HTTP response

Response 201

{
    "lb_health_check": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_type": "DEFAULT",
        "health_check_url": "/test",
        "http_method": "GET",
        "id": "46c681018e33453085ca7c8db54e0076",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "Test-LbMonitor-01",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

7.1.3 - CreateLbListener

7.1.3.1 - 1.4

post /v1/lb-listeners

Description

Listener를 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

LbListenerCreateRequestV1Dot4

Responses

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

Example HTTP request

Request path

/v1/lb-listeners

Request header

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

Request body

{
    "listener": {
        "condition_type": "URL_PATH",
        "description": "",
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "idle_timeout": "",
        "insert_client_ip": "",
        "loadbalancer_id": "",
        "name": "",
        "persistence": "",
        "protocol": "TCP",
        "response_timeout": "",
        "routing_action": "LB_SERVER_GROUP",
        "server_group_id": "",
        "service_port": "",
        "session_duration_time": "",
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "support_http2": false,
        "tags": [],
        "url_handler": [
            {
                "seq": "",
                "server_group_id": "",
                "url_pattern": ""
            }
        ],
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

Example HTTP response

Response 202

{
    "listener": {
        "condition_type": "URL_PATH",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "hsts_config": {
            "include_sub_domains": "",
            "max_age": ""
        },
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "idle_timeout": "",
        "insert_client_ip": "",
        "loadbalancer_id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "persistence": "",
        "protocol": "TCP",
        "response_timeout": "",
        "routing_action": "LB_SERVER_GROUP",
        "server_group_id": "",
        "server_group_name": "",
        "service_port": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "not_after_dt": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "state": "",
        "support_http2": "",
        "tags": [],
        "url_handler": [
            {
                "seq": "",
                "server_group_id": "",
                "server_group_name": "",
                "url_pattern": ""
            }
        ],
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

7.1.3.2 - 1.3

post /v1/lb-listeners

Description

Listener를 생성한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

LbListenerCreateRequestV1Dot3

Responses

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

Example HTTP request

Request path

/v1/lb-listeners

Request header

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

Request body

{
    "listener": {
        "condition_type": "URL_PATH",
        "description": "",
        "hsts_max_age": "",
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "idle_timeout": "",
        "insert_client_ip": "",
        "loadbalancer_id": "",
        "name": "",
        "persistence": "",
        "protocol": "TCP",
        "response_timeout": "",
        "routing_action": "LB_SERVER_GROUP",
        "server_group_id": "",
        "service_port": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "support_http2": false,
        "tags": [],
        "url_handler": "",
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

Example HTTP response

Response 201

{
    "listener": {
        "condition_type": "URL_PATH",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "hsts_max_age": "",
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "idle_timeout": "",
        "insert_client_ip": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "persistence": "",
        "protocol": "TCP",
        "response_timeout": "",
        "routing_action": "LB_SERVER_GROUP",
        "server_group_id": "",
        "server_group_name": "",
        "service_port": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "state": "",
        "support_http2": false,
        "url_handler": "",
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

7.1.4 - CreateLBServerGroup

7.1.4.1 - 1.4

post /v1/lb-server-groups

Description

LB 서버 그룹을 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

LbServerGroupCreateRequest

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups

Request header

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

Request body

{
    "lb_server_group": {
        "description": "this is an lb server group",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "tags": [],
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

Example HTTP response

Response 202

{
    "lb_server_group": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "id": "3d8d8754d0d54683a29f3dcc3dd95d5b",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN",
        "lb_name": "Test-LB-01",
        "loadbalancer_id": "82efa35c88834bc083020443e57faa10",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

7.1.4.2 - 1.3

post /v1/lb-server-groups

Description

LB 서버 그룹을 생성한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

LbServerGroupCreateRequest

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups

Request header

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

Request body

{
    "lb_server_group": {
        "description": "this is an lb server group",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "tags": [],
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

Example HTTP response

Response 202

{
    "lb_server_group": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "id": "3d8d8754d0d54683a29f3dcc3dd95d5b",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN",
        "lb_name": "Test-LB-01",
        "loadbalancer_id": "82efa35c88834bc083020443e57faa10",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

7.1.5 - CreateLoadbalancer

7.1.5.1 - 1.4

post /v1/loadbalancers

Description

LoadBalancer를 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

LoadbalancerCreateRequestV1Dot4

Responses

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

Example HTTP request

Request path

/v1/loadbalancers

Request header

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

Request body

{
    "loadbalancer": {
        "description": "",
        "firewall_enabled": true,
        "firewall_logging_enabled": true,
        "health_check_ips": [
            ""
        ],
        "layer_type": "",
        "name": "",
        "publicip_id": "",
        "service_ip": "",
        "source_nat_ip": "",
        "subnet_id": "",
        "tags": [],
        "vpc_id": "",
        "zones": []
    }
}

Example HTTP response

Response 202

{
    "loadbalancer": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "layer_type": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "",
        "subnet_id": "",
        "vpc_id": ""
    }
}

7.1.5.2 - 1.3

post /v1/loadbalancers

Description

LoadBalancer를 생성한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

LoadbalancerCreateRequest

Responses

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

Example HTTP request

Request path

/v1/loadbalancers

Request header

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

Request body

{
    "loadbalancer": {
        "description": "",
        "firewall_enabled": true,
        "firewall_logging_enabled": true,
        "health_check_ip_1": "",
        "health_check_ip_2": "",
        "layer_type": "",
        "name": "",
        "publicip_id": "",
        "service_ip": "",
        "source_nat_ip": "",
        "subnet_id": "",
        "tags": [],
        "vpc_id": ""
    }
}

Example HTTP response

Response 202

{
    "loadbalancer": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "layer_type": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "",
        "subnet_id": "",
        "vpc_id": ""
    }
}

7.1.6 - CreateLoadbalancerPrivateNatIp

7.1.6.1 - 1.4

post /v1/loadbalancers/{loadbalancer_id}/private-static-nats

Description

create Load Balancer Private NAT IP

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

Parameters

TypeNameDescriptionSchemaDefault
pathloadbalancer_id
required
자원 ID
Example :
stringNone
bodybody
required

PrivateStaticNatCreateRequest

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_id}/private-static-nats

Request header

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

Request body

{
    "static_nat": {
        "private_nat_id": "",
        "private_nat_ip_id": ""
    }
}

Example HTTP response

Response 202

{
    "static_nat": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "external_ip_address": "",
        "id": "",
        "internal_ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "private_nat_ip_id": "",
        "state": "",
        "subnet_id": ""
    }
}

7.1.6.2 - 1.3

post /v1/loadbalancers/{loadbalancer_id}/private-static-nats

Description

create Load Balancer Private NAT IP

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

Parameters

TypeNameDescriptionSchemaDefault
pathloadbalancer_id
required
자원 ID
Example :
stringNone
bodybody
required

PrivateStaticNatCreateRequest

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_id}/private-static-nats

Request header

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

Request body

{
    "static_nat": {
        "private_nat_id": "",
        "private_nat_ip_id": ""
    }
}

Example HTTP response

Response 202

{
    "static_nat": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "external_ip_address": "",
        "id": "",
        "internal_ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "private_nat_ip_id": "",
        "state": "",
        "subnet_id": ""
    }
}

7.1.7 - CreateLoadbalancerPublicNatIp

7.1.7.1 - 1.4

post /v1/loadbalancers/{loadbalancer_id}/static-nats

Description

LoadBalancer Public NAT를 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

Parameters

TypeNameDescriptionSchemaDefault
pathloadbalancer_id
required
자원 ID
Example :
stringNone
bodybody
required

StaticNatCreateRequest

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_id}/static-nats

Request header

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

Request body

{
    "static_nat": {
        "publicip_id": ""
    }
}

Example HTTP response

Response 201

{
    "static_nat": {
        "account_id": "",
        "action_type": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "external_ip_address": "",
        "id": "",
        "internal_ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "owner_id": "",
        "owner_name": "",
        "owner_type": "",
        "publicip_id": "",
        "service_ip_port_id": "",
        "state": "",
        "subnet_id": "",
        "type": "",
        "vpc_id": ""
    }
}

7.1.7.2 - 1.3

post /v1/loadbalancers/{loadbalancer_id}/static-nats

Description

LoadBalancer Public NAT를 생성한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

Parameters

TypeNameDescriptionSchemaDefault
pathloadbalancer_id
required
자원 ID
Example :
stringNone
bodybody
required

StaticNatCreateRequest

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_id}/static-nats

Request header

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

Request body

{
    "static_nat": {
        "publicip_id": ""
    }
}

Example HTTP response

Response 201

{
    "static_nat": {
        "account_id": "",
        "action_type": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "external_ip_address": "",
        "id": "",
        "internal_ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "owner_id": "",
        "owner_name": "",
        "owner_type": "",
        "publicip_id": "",
        "service_ip_port_id": "",
        "state": "",
        "subnet_id": "",
        "type": "",
        "vpc_id": ""
    }
}

7.1.8 - DeleteLBHealthCheck

7.1.8.1 - 1.4

delete /v1/lb-health-checks/{lb_health_check_id}

Description

LB 헬스 체크를 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

Parameters

TypeNameDescriptionSchemaDefault
pathlb_health_check_id
required
LB 헬스 체크 ID
Example : e3cd678b11784734bc366148aa37580e
stringNone

Responses

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

Example HTTP request

Request path

/v1/lb-health-checks/{lb_health_check_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 = loadbalancer 1.4"

Example HTTP response

Response 202

7.1.8.2 - 1.3

delete /v1/lb-health-checks/{lb_health_check_id}

Description

LB 헬스 체크를 삭제한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

Parameters

TypeNameDescriptionSchemaDefault
pathlb_health_check_id
required
LB 헬스 체크 ID
Example : e3cd678b11784734bc366148aa37580e
stringNone

Responses

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

Example HTTP request

Request path

/v1/lb-health-checks/{lb_health_check_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 = loadbalancer 1.3"

Example HTTP response

Response 204

7.1.9 - DeleteLbListener

7.1.9.1 - 1.4

delete /v1/lb-listeners/{listener_id}

Description

Listener를 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

Parameters

TypeNameDescriptionSchemaDefault
pathlistener_id
required
Listener 아이디
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/lb-listeners/{listener_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 = loadbalancer 1.4"

Example HTTP response

Response 202

7.1.9.2 - 1.3

delete /v1/lb-listeners/{listener_id}

Description

Listener를 삭제한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

Parameters

TypeNameDescriptionSchemaDefault
pathlistener_id
required
Listener 아이디
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/lb-listeners/{listener_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 = loadbalancer 1.3"

Example HTTP response

Response 204

7.1.10 - DeleteLBServerGroup

7.1.10.1 - 1.4

delete /v1/lb-server-groups/{lb_server_group_id}

Description

LB 서버 그룹을 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

Parameters

TypeNameDescriptionSchemaDefault
pathlb_server_group_id
required
LB 서버 그룹 ID
Example : 3d8d8754d0d54683a29f3dcc3dd95d5b
stringNone

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_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 = loadbalancer 1.4"

Example HTTP response

Response 202

7.1.10.2 - 1.3

delete /v1/lb-server-groups/{lb_server_group_id}

Description

LB 서버 그룹을 삭제한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

Parameters

TypeNameDescriptionSchemaDefault
pathlb_server_group_id
required
LB 서버 그룹 ID
Example : 3d8d8754d0d54683a29f3dcc3dd95d5b
stringNone

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_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 = loadbalancer 1.3"

Example HTTP response

Response 202

7.1.11 - DeleteLoadbalancer

7.1.11.1 - 1.4

delete /v1/loadbalancers/{loadbalancer_id}

Description

LoadBalancer를 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

Parameters

TypeNameDescriptionSchemaDefault
pathloadbalancer_id
required
자원 ID
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_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 = loadbalancer 1.4"

Example HTTP response

Response 202

7.1.11.2 - 1.3

delete /v1/loadbalancers/{loadbalancer_id}

Description

LoadBalancer를 삭제한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

Parameters

TypeNameDescriptionSchemaDefault
pathloadbalancer_id
required
자원 ID
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_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 = loadbalancer 1.3"

Example HTTP response

Response 202

7.1.12 - DeleteLoadbalancerPrivateNatIp

7.1.12.1 - 1.4

delete /v1/loadbalancers/{loadbalancer_id}/private-static-nats

Description

delete Load Balancer Private NAT IP

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

Parameters

TypeNameDescriptionSchemaDefault
pathloadbalancer_id
required
자원 ID
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_id}/private-static-nats

Request header

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

Example HTTP response

Response 202

7.1.12.2 - 1.3

delete /v1/loadbalancers/{loadbalancer_id}/private-static-nats

Description

delete Load Balancer Private NAT IP

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

Parameters

TypeNameDescriptionSchemaDefault
pathloadbalancer_id
required
자원 ID
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_id}/private-static-nats

Request header

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

Example HTTP response

Response 202

7.1.13 - DeleteLoadbalancerPublicNatIp

7.1.13.1 - 1.4

delete /v1/loadbalancers/{loadbalancer_id}/static-nats

Description

LoadBalancer Public NAT를 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

Parameters

TypeNameDescriptionSchemaDefault
pathloadbalancer_id
required
자원 ID
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_id}/static-nats

Request header

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

Example HTTP response

Response 204

7.1.13.2 - 1.3

delete /v1/loadbalancers/{loadbalancer_id}/static-nats

Description

LoadBalancer Public NAT를 삭제한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

Parameters

TypeNameDescriptionSchemaDefault
pathloadbalancer_id
required
자원 ID
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_id}/static-nats

Request header

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

Example HTTP response

Response 204

7.1.14 - ListLBHealthChecks

7.1.14.1 - 1.4

get /v1/lb-health-checks

Description

LB 헬스 체크 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

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
LB 헬스 체크명
Example : Test-LbMonitor-01
any of [string, null]None
queryprotocol
optional
프로토콜
Example : ['TCP', 'UDP']
any of [array[enum (TCP, HTTP, HTTPS)], enum (TCP, HTTP, HTTPS), null]None
querysubnet_id
optional
Service Subnet ID
Example : 60fba45cb6c811efba41ba92e4fe7200
any of [string, null]None

Responses

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

Example HTTP request

Request path

/v1/lb-health-checks

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "lb_health_checks": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_type": "DEFAULT",
            "id": "46c681018e33453085ca7c8db54e0076",
            "lb_server_group_count": 2,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "Test-LbMonitor-01",
            "protocol": "TCP",
            "state": "ACTIVE",
            "subnet_id": "60fba45cb6c811efba41ba92e4fe7200"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

7.1.14.2 - 1.3

get /v1/lb-health-checks

Description

LB 헬스 체크 목록을 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

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
LB 헬스 체크명
Example : Test-LbMonitor-01
any of [string, null]None
queryprotocol
optional
프로토콜
Example : ['TCP', 'UDP']
any of [array[enum (TCP, HTTP, HTTPS)], enum (TCP, HTTP, HTTPS), null]None
querysubnet_id
optional
Service Subnet ID
Example : 60fba45cb6c811efba41ba92e4fe7200
any of [string, null]None

Responses

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

Example HTTP request

Request path

/v1/lb-health-checks

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "lb_health_checks": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_type": "DEFAULT",
            "id": "46c681018e33453085ca7c8db54e0076",
            "lb_server_group_count": 2,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "Test-LbMonitor-01",
            "protocol": "TCP",
            "state": "ACTIVE",
            "subnet_id": "60fba45cb6c811efba41ba92e4fe7200"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

7.1.15 - ListLbListeners

7.1.15.1 - 1.4

get /v1/lb-listeners

Description

Listener 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

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
queryloadbalancer_id
optional
LB 아이디
Example :
any of [string, null]None
querystate
optional
Listener 상태
Example :
any of [string, null]None
queryname
optional
Listener 명
Example :
any of [string, null]None
queryservice_port
optional
서비스 포트
Example :
any of [integer, null]None
queryprotocol
optional
프로토콜
Example : ['TCP', 'UDP']
any of [array[enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY)], enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY), null]None
querynot_protocol
optional
The protocol of the listener to exclude.
Example : TCP
any of [enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY), null]None

Responses

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

Example HTTP request

Request path

/v1/lb-listeners

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "listeners": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "protocol": "TCP",
            "service_port": "",
            "state": ""
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

7.1.15.2 - 1.3

get /v1/lb-listeners

Description

Listener 목록을 조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

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
queryloadbalancer_id
optional
LB 아이디
Example :
any of [string, null]None
querystate
optional
Listener 상태
Example :
any of [string, null]None
queryname
optional
Listener 명
Example :
any of [string, null]None
queryservice_port
optional
서비스 포트
Example :
any of [integer, null]None
queryprotocol
optional
프로토콜
Example : ['TCP', 'UDP']
any of [array[enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY)], enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY), null]None
querynot_protocol
optional
The protocol of the listener to exclude.
Example : TCP
any of [enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY), null]None

Responses

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

Example HTTP request

Request path

/v1/lb-listeners

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "listeners": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "protocol": "TCP",
            "service_port": "",
            "state": ""
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

7.1.16 - ListLbServerGroupMembers

7.1.16.1 - 1.4

get /v1/lb-server-groups/{lb_server_group_id}/members

Description

Member 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

Parameters

TypeNameDescriptionSchemaDefault
pathlb_server_group_id
required
Lb Server Group ID
Example :
stringNone
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
Member 명
Example :
any of [string, null]None
querymember_ip
optional
Member ID
Example :
any of [string, null]None
querymember_port
optional
Member 포트
Example :
any of [integer, null]None

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_id}/members

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "members": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_state": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "lb_server_group_id": "",
            "member_ip": "",
            "member_port": "",
            "member_state": "",
            "member_weight": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "object_az": "",
            "object_id": "",
            "object_type": "VM",
            "state": "CREATING"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

7.1.16.2 - 1.3

get /v1/lb-server-groups/{lb_server_group_id}/members

Description

Member 목록을 조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

Parameters

TypeNameDescriptionSchemaDefault
pathlb_server_group_id
required
Lb Server Group ID
Example :
stringNone
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
Member 명
Example :
any of [string, null]None
querymember_ip
optional
Member ID
Example :
any of [string, null]None
querymember_port
optional
Member 포트
Example :
any of [integer, null]None

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_id}/members

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "members": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_state": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "lb_server_group_id": "",
            "member_ip": "",
            "member_port": "",
            "member_state": "",
            "member_weight": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "object_id": "",
            "object_type": "VM",
            "state": "CREATING"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

7.1.17 - ListLBServerGroups

7.1.17.1 - 1.4

get /v1/lb-server-groups

Description

LB 서버 그룹 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

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
LB 서버 그룹 명
Example : ServerGroup01
any of [string, null]None
querystate
optional
LB 서버 그룹 상태
Example : ACTIVE
any of [string, null]None
queryprotocol
optional
프로토콜
Example : ['TCP', 'UDP']
any of [array[enum (TCP, UDP)], enum (TCP, UDP), null]None
querysubnet_id
optional
Service Subnet ID
Example : 60fba45cb6c811efba41ba92e4fe7200
any of [string, null]None
queryvpc_id
optional
VPC ID
Example : 8acceeb6920c4fc494490d864f67f0b5
any of [string, null]None
querylb_health_check_id
optional
LB 헬스 체크 ID
Example : 46c681018e33453085ca7c8db54e0076
stringNone
querylb_method
optional
부하 분산
Example : ROUND_ROBIN
any of [array[enum (ROUND_ROBIN, LEAST_CONNECTION, SOURCE_IP_HASH, SOURCE_IP_PORT_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION)], enum (ROUND_ROBIN, LEAST_CONNECTION, SOURCE_IP_HASH, SOURCE_IP_PORT_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION), null]None

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "lb_server_groups": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "3d8d8754d0d54683a29f3dcc3dd95d5b",
            "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
            "lb_name": "Test-LB-01",
            "lb_server_group_member_count": 2,
            "loadbalancer_id": "82efa35c88834bc083020443e57faa10",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ServerGroup01",
            "protocol": "TCP",
            "state": "ACTIVE",
            "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

7.1.17.2 - 1.3

get /v1/lb-server-groups

Description

LB 서버 그룹 목록을 조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

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
LB 서버 그룹 명
Example : ServerGroup01
any of [string, null]None
querystate
optional
LB 서버 그룹 상태
Example : ACTIVE
any of [string, null]None
queryprotocol
optional
프로토콜
Example : ['TCP', 'UDP']
any of [array[enum (TCP, UDP)], enum (TCP, UDP), null]None
querysubnet_id
optional
Service Subnet ID
Example : 60fba45cb6c811efba41ba92e4fe7200
any of [string, null]None
queryvpc_id
optional
VPC ID
Example : 8acceeb6920c4fc494490d864f67f0b5
any of [string, null]None
querylb_health_check_id
optional
LB 헬스 체크 ID
Example : 46c681018e33453085ca7c8db54e0076
stringNone
querylb_method
optional
부하 분산
Example : ROUND_ROBIN
any of [array[enum (ROUND_ROBIN, LEAST_CONNECTION, SOURCE_IP_HASH, SOURCE_IP_PORT_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION)], enum (ROUND_ROBIN, LEAST_CONNECTION, SOURCE_IP_HASH, SOURCE_IP_PORT_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION), null]None

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "lb_server_groups": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "3d8d8754d0d54683a29f3dcc3dd95d5b",
            "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
            "lb_name": "Test-LB-01",
            "lb_server_group_member_count": 2,
            "loadbalancer_id": "82efa35c88834bc083020443e57faa10",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ServerGroup01",
            "protocol": "TCP",
            "state": "ACTIVE",
            "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

7.1.18 - ListLoadbalancerCertificates

7.1.18.1 - 1.4

get /v1/loadbalancers/certificates

Description

인증서 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/certificates

Request header

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

Example HTTP response

Response 200

{
    "certificates": [
        {
            "cert_kind": "",
            "cn": "",
            "created_at": "",
            "created_by": "",
            "id": "",
            "modified_at": "",
            "modified_by": "",
            "name": "",
            "not_after_dt": "2024-01-15T10:30:00.000Z",
            "not_before_dt": "2024-01-15T10:30:00.000Z",
            "state": ""
        }
    ],
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

7.1.18.2 - 1.3

get /v1/loadbalancers/certificates

Description

인증서 목록을 조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/certificates

Request header

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

Example HTTP response

Response 200

{
    "certificates": [
        {
            "cert_kind": "",
            "cn": "",
            "created_at": "",
            "created_by": "",
            "id": "",
            "modified_at": "",
            "modified_by": "",
            "name": "",
            "not_after_dt": "2024-01-15T10:30:00.000Z",
            "not_before_dt": "2024-01-15T10:30:00.000Z",
            "state": ""
        }
    ],
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

7.1.19 - ListLoadbalancers

7.1.19.1 - 1.4

get /v1/loadbalancers

Description

LoadBalancer 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

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
LoadBalancer 명
Example :
any of [string, null]None
querystate
optional
The state of the load balancer.
Example :
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), array[enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)]]
queryservice_ip
optional
LoadBalancer 서비스 IP
Example :
any of [string, null]None
querysubnet_id
optional
Subnet ID
Example :
any of [string, null]None
querylayer_type
optional
계층 타입
Example :
any of [enum (L4, L7), array[enum (L4, L7)]]
queryvpc_id
optional
VPC ID
Example :
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKLoadbalancerListResponseV1Dot4
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/loadbalancers

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "loadbalancers": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "firewall_id": "",
            "id": "",
            "layer_type": "",
            "listener_count": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "public_nat_enabled": "",
            "service_ip": "",
            "source_nat_ip": "",
            "state": "",
            "subnet_id": "",
            "vpc_id": "",
            "zones": []
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

7.1.19.2 - 1.3

get /v1/loadbalancers

Description

LoadBalancer 목록을 조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

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
LoadBalancer 명
Example :
any of [string, null]None
querystate
optional
The state of the load balancer.
Example :
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), array[enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)]]
queryservice_ip
optional
LoadBalancer 서비스 IP
Example :
any of [string, null]None
querysubnet_id
optional
Subnet ID
Example :
any of [string, null]None
querylayer_type
optional
계층 타입
Example :
any of [enum (L4, L7), array[enum (L4, L7)]]
queryvpc_id
optional
VPC ID
Example :
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKLoadbalancerListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/loadbalancers

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "loadbalancers": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "firewall_id": "",
            "id": "",
            "layer_type": "",
            "listener_count": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "public_nat_enabled": "",
            "service_ip": "",
            "source_nat_ip": "",
            "state": "",
            "subnet_id": "",
            "vpc_id": ""
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

7.1.20 - RemoveLbServerGroupMember

7.1.20.1 - 1.4

delete /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}

Description

Member를 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

Parameters

TypeNameDescriptionSchemaDefault
pathlb_server_group_id
required
Lb Server Group ID
Example :
stringNone
pathmember_id
required
ID of Member
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_id}/members/{member_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 = loadbalancer 1.4"

Example HTTP response

Response 202

7.1.20.2 - 1.3

delete /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}

Description

Member를 삭제한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

Parameters

TypeNameDescriptionSchemaDefault
pathlb_server_group_id
required
Lb Server Group ID
Example :
stringNone
pathmember_id
required
ID of Member
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_id}/members/{member_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 = loadbalancer 1.3"

Example HTTP response

Response 202

7.1.21 - RemoveLbServerGroupMembers

7.1.21.1 - 1.4

delete /v1/lb-server-groups/{lb_server_group_id}/members

Description

Remove Lb Server Group Members

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

Parameters

TypeNameDescriptionSchemaDefault
pathlb_server_group_id
required
Lb Server Group ID
Example :
stringNone
bodybody
required

MemberDeleteBulkRequestV1Dot2

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_id}/members

Request header

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

Request body

{
    "member_id_list": [
        ""
    ]
}

Example HTTP response

Response 202

7.1.21.2 - 1.3

delete /v1/lb-server-groups/{lb_server_group_id}/members

Description

Remove Lb Server Group Members

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

Parameters

TypeNameDescriptionSchemaDefault
pathlb_server_group_id
required
Lb Server Group ID
Example :
stringNone
bodybody
required

MemberDeleteBulkRequestV1Dot2

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_id}/members

Request header

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

Request body

{
    "member_id_list": [
        ""
    ]
}

Example HTTP response

Response 202

7.1.22 - SetLBHealthCheck

7.1.22.1 - 1.4

put /v1/lb-health-checks/{lb_health_check_id}

Description

LB 헬스 체크를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

Parameters

TypeNameDescriptionSchemaDefault
pathlb_health_check_id
required
LB 헬스 체크 ID
Example : e3cd678b11784734bc366148aa37580e
stringNone
bodybody
required

LbHealthCheckSetRequest

Responses

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

Example HTTP request

Request path

/v1/lb-health-checks/{lb_health_check_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 = loadbalancer 1.4"

Request body

{
    "lb_health_check": {
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_url": "/test",
        "http_method": "GET",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200"
    }
}

Example HTTP response

Response 202

{
    "lb_health_check": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_type": "DEFAULT",
        "health_check_url": "/test",
        "http_method": "GET",
        "id": "46c681018e33453085ca7c8db54e0076",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "Test-LbMonitor-01",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

7.1.22.2 - 1.3

put /v1/lb-health-checks/{lb_health_check_id}

Description

LB 헬스 체크를 수정한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

Parameters

TypeNameDescriptionSchemaDefault
pathlb_health_check_id
required
LB 헬스 체크 ID
Example : e3cd678b11784734bc366148aa37580e
stringNone
bodybody
required

LbHealthCheckSetRequest

Responses

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

Example HTTP request

Request path

/v1/lb-health-checks/{lb_health_check_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 = loadbalancer 1.3"

Request body

{
    "lb_health_check": {
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_url": "/test",
        "http_method": "GET",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200"
    }
}

Example HTTP response

Response 202

{
    "lb_health_check": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_type": "DEFAULT",
        "health_check_url": "/test",
        "http_method": "GET",
        "id": "46c681018e33453085ca7c8db54e0076",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "Test-LbMonitor-01",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

7.1.23 - SetLbListener

7.1.23.1 - 1.3

put /v1/lb-listeners/{listener_id}

Description

리스너 목록을 수정한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

Parameters

TypeNameDescriptionSchemaDefault
pathlistener_id
required
Listener 아이디
Example :
stringNone
bodybody
required

LbListenerSetRequestV1Dot3

Responses

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

Example HTTP request

Request path

/v1/lb-listeners/{listener_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 = loadbalancer 1.3"

Request body

{
    "listener": {
        "condition_type": "URL_PATH",
        "description": "",
        "hsts_max_age": "",
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "idle_timeout": "",
        "insert_client_ip": "",
        "persistence": "",
        "response_timeout": "",
        "server_group_id": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "support_http2": "",
        "url_handler": "",
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

Example HTTP response

Response 200

{
    "listener": {
        "condition_type": "URL_PATH",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "hsts_max_age": "",
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "idle_timeout": "",
        "insert_client_ip": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "persistence": "",
        "protocol": "TCP",
        "response_timeout": "",
        "routing_action": "LB_SERVER_GROUP",
        "server_group_id": "",
        "server_group_name": "",
        "service_port": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "state": "",
        "support_http2": false,
        "url_handler": "",
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

7.1.24 - SetLbListenerCertificate

7.1.24.1 - 1.4

put /v1/lb-listeners/{listener_id}/certificate

Description

set loadbalancer listener certificate

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

Parameters

TypeNameDescriptionSchemaDefault
pathlistener_id
required
Listener 아이디
Example :
stringNone
bodybody
required

LbListenerCertificateSetRequest

Responses

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

Example HTTP request

Request path

/v1/lb-listeners/{listener_id}/certificate

Request header

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

Request body

{
    "listener": {
        "sni_certificate": [
            {
                "domain_name": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        }
    }
}

Example HTTP response

Response 202

{
    "listener": {
        "condition_type": "URL_PATH",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "hsts_config": {
            "include_sub_domains": "",
            "max_age": ""
        },
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "idle_timeout": "",
        "insert_client_ip": "",
        "loadbalancer_id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "persistence": "",
        "protocol": "TCP",
        "response_timeout": "",
        "routing_action": "LB_SERVER_GROUP",
        "server_group_id": "",
        "server_group_name": "",
        "service_port": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "not_after_dt": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "state": "",
        "support_http2": "",
        "tags": [],
        "url_handler": [
            {
                "seq": "",
                "server_group_id": "",
                "server_group_name": "",
                "url_pattern": ""
            }
        ],
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

7.1.25 - SetLbListenerResource

7.1.25.1 - 1.4

put /v1/lb-listeners/{listener_id}/resource

Description

set loadbalancer listener resource

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

Parameters

TypeNameDescriptionSchemaDefault
pathlistener_id
required
Listener 아이디
Example :
stringNone
bodybody
required

LbListenerResourceSetRequest

Responses

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

Example HTTP request

Request path

/v1/lb-listeners/{listener_id}/resource

Request header

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

Request body

{
    "listener": {
        "description": "",
        "hsts_config": {
            "include_sub_domains": "",
            "max_age": ""
        },
        "idle_timeout": "",
        "insert_client_ip": "",
        "persistence": "",
        "response_timeout": "",
        "session_duration_time": "",
        "support_http2": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

Example HTTP response

Response 202

{
    "listener": {
        "condition_type": "URL_PATH",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "hsts_config": {
            "include_sub_domains": "",
            "max_age": ""
        },
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "idle_timeout": "",
        "insert_client_ip": "",
        "loadbalancer_id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "persistence": "",
        "protocol": "TCP",
        "response_timeout": "",
        "routing_action": "LB_SERVER_GROUP",
        "server_group_id": "",
        "server_group_name": "",
        "service_port": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "not_after_dt": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "state": "",
        "support_http2": "",
        "tags": [],
        "url_handler": [
            {
                "seq": "",
                "server_group_id": "",
                "server_group_name": "",
                "url_pattern": ""
            }
        ],
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

7.1.26 - SetLbListenerRule

7.1.26.1 - 1.4

put /v1/lb-listeners/{listener_id}/rule

Description

set loadbalancer listener rule

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

Parameters

TypeNameDescriptionSchemaDefault
pathlistener_id
required
Listener 아이디
Example :
stringNone
bodybody
required

LbListenerRuleSetRequest

Responses

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

Example HTTP request

Request path

/v1/lb-listeners/{listener_id}/rule

Request header

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

Request body

{
    "listener": {
        "condition_type": "URL_PATH",
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "server_group_id": "",
        "url_handler": [
            {
                "seq": "",
                "server_group_id": "",
                "url_pattern": ""
            }
        ],
        "url_redirection": ""
    }
}

Example HTTP response

Response 202

{
    "listener": {
        "condition_type": "URL_PATH",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "hsts_config": {
            "include_sub_domains": "",
            "max_age": ""
        },
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "idle_timeout": "",
        "insert_client_ip": "",
        "loadbalancer_id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "persistence": "",
        "protocol": "TCP",
        "response_timeout": "",
        "routing_action": "LB_SERVER_GROUP",
        "server_group_id": "",
        "server_group_name": "",
        "service_port": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "not_after_dt": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "state": "",
        "support_http2": "",
        "tags": [],
        "url_handler": [
            {
                "seq": "",
                "server_group_id": "",
                "server_group_name": "",
                "url_pattern": ""
            }
        ],
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

7.1.27 - SetLBServerGroup

7.1.27.1 - 1.4

put /v1/lb-server-groups/{lb_server_group_id}

Description

LB 서버 그룹을 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

Parameters

TypeNameDescriptionSchemaDefault
pathlb_server_group_id
required
LB 서버 그룹 ID
Example : 3d8d8754d0d54683a29f3dcc3dd95d5b
stringNone
bodybody
required

LbServerGroupSetRequest

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_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 = loadbalancer 1.4"

Request body

{
    "lb_server_group": {
        "description": "this is an lb server group",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN"
    }
}

Example HTTP response

Response 202

{
    "lb_server_group": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "id": "3d8d8754d0d54683a29f3dcc3dd95d5b",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN",
        "lb_name": "Test-LB-01",
        "loadbalancer_id": "82efa35c88834bc083020443e57faa10",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

7.1.27.2 - 1.3

put /v1/lb-server-groups/{lb_server_group_id}

Description

LB 서버 그룹을 수정한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

Parameters

TypeNameDescriptionSchemaDefault
pathlb_server_group_id
required
LB 서버 그룹 ID
Example : 3d8d8754d0d54683a29f3dcc3dd95d5b
stringNone
bodybody
required

LbServerGroupSetRequest

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_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 = loadbalancer 1.3"

Request body

{
    "lb_server_group": {
        "description": "this is an lb server group",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN"
    }
}

Example HTTP response

Response 202

{
    "lb_server_group": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "id": "3d8d8754d0d54683a29f3dcc3dd95d5b",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN",
        "lb_name": "Test-LB-01",
        "loadbalancer_id": "82efa35c88834bc083020443e57faa10",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

7.1.28 - SetLbServerGroupMember

7.1.28.1 - 1.4

put /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}

Description

Member를 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

Parameters

TypeNameDescriptionSchemaDefault
pathlb_server_group_id
required
Lb Server Group ID
Example :
stringNone
pathmember_id
required
ID of Member
Example :
stringNone
bodybody
required

MemberSetRequest

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_id}/members/{member_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 = loadbalancer 1.4"

Request body

{
    "member": {
        "member_port": 80,
        "member_state": "ENABLE",
        "member_weight": 100
    }
}

Example HTTP response

Response 202

{
    "member": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "lb_server_group_id": "",
        "member_ip": "",
        "member_port": "",
        "member_state": "",
        "member_weight": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "object_id": "",
        "object_type": "VM",
        "state": "CREATING",
        "subnet_id": "",
        "uuid": ""
    }
}

7.1.28.2 - 1.3

put /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}

Description

Member를 수정한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

Parameters

TypeNameDescriptionSchemaDefault
pathlb_server_group_id
required
Lb Server Group ID
Example :
stringNone
pathmember_id
required
ID of Member
Example :
stringNone
bodybody
required

MemberSetRequest

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_id}/members/{member_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 = loadbalancer 1.3"

Request body

{
    "member": {
        "member_port": 80,
        "member_state": "ENABLE",
        "member_weight": 100
    }
}

Example HTTP response

Response 202

{
    "member": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "lb_server_group_id": "",
        "member_ip": "",
        "member_port": "",
        "member_state": "",
        "member_weight": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "object_id": "",
        "object_type": "VM",
        "state": "CREATING",
        "subnet_id": "",
        "uuid": ""
    }
}

7.1.29 - SetLoadbalancer

7.1.29.1 - 1.4

put /v1/loadbalancers/{loadbalancer_id}

Description

LoadBalancer를 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

Parameters

TypeNameDescriptionSchemaDefault
pathloadbalancer_id
required
자원 ID
Example :
stringNone
bodybody
required

LoadbalancerUpdateRequest

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_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 = loadbalancer 1.4"

Request body

{
    "loadbalancer": {
        "description": ""
    }
}

Example HTTP response

Response 202

{
    "loadbalancer": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_id": "",
        "health_check_ip": [
            ""
        ],
        "id": "",
        "layer_type": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "public_nat_enabled": "",
        "service_ip": "",
        "source_nat_ip": "",
        "state": "",
        "subnet_id": "",
        "vpc_id": ""
    }
}

7.1.29.2 - 1.3

put /v1/loadbalancers/{loadbalancer_id}

Description

LoadBalancer를 수정한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

Parameters

TypeNameDescriptionSchemaDefault
pathloadbalancer_id
required
자원 ID
Example :
stringNone
bodybody
required

LoadbalancerUpdateRequest

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_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 = loadbalancer 1.3"

Request body

{
    "loadbalancer": {
        "description": ""
    }
}

Example HTTP response

Response 202

{
    "loadbalancer": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_id": "",
        "health_check_ip": [
            ""
        ],
        "id": "",
        "layer_type": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "public_nat_enabled": "",
        "service_ip": "",
        "source_nat_ip": "",
        "state": "",
        "subnet_id": "",
        "vpc_id": ""
    }
}

7.1.30 - ShowLBHealthCheck

7.1.30.1 - 1.4

get /v1/lb-health-checks/{lb_health_check_id}

Description

LB 헬스 체크를 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

Parameters

TypeNameDescriptionSchemaDefault
pathlb_health_check_id
required
LB 헬스 체크 ID
Example : e3cd678b11784734bc366148aa37580e
stringNone

Responses

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

Example HTTP request

Request path

/v1/lb-health-checks/{lb_health_check_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 = loadbalancer 1.4"

Example HTTP response

Response 200

{
    "lb_health_check": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_type": "DEFAULT",
        "health_check_url": "/test",
        "http_method": "GET",
        "id": "46c681018e33453085ca7c8db54e0076",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "Test-LbMonitor-01",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

7.1.30.2 - 1.3

get /v1/lb-health-checks/{lb_health_check_id}

Description

LB 헬스 체크를 상세 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

Parameters

TypeNameDescriptionSchemaDefault
pathlb_health_check_id
required
LB 헬스 체크 ID
Example : e3cd678b11784734bc366148aa37580e
stringNone

Responses

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

Example HTTP request

Request path

/v1/lb-health-checks/{lb_health_check_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 = loadbalancer 1.3"

Example HTTP response

Response 200

{
    "lb_health_check": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_type": "DEFAULT",
        "health_check_url": "/test",
        "http_method": "GET",
        "id": "46c681018e33453085ca7c8db54e0076",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "Test-LbMonitor-01",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

7.1.31 - ShowLbListener

7.1.31.1 - 1.4

get /v1/lb-listeners/{listener_id}

Description

Listener를 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

Parameters

TypeNameDescriptionSchemaDefault
pathlistener_id
required
Listener 아이디
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/lb-listeners/{listener_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 = loadbalancer 1.4"

Example HTTP response

Response 200

{
    "listener": {
        "condition_type": "URL_PATH",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "hsts_config": {
            "include_sub_domains": "",
            "max_age": ""
        },
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "idle_timeout": "",
        "insert_client_ip": "",
        "loadbalancer_id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "persistence": "",
        "protocol": "TCP",
        "response_timeout": "",
        "routing_action": "LB_SERVER_GROUP",
        "server_group_id": "",
        "server_group_name": "",
        "service_port": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "not_after_dt": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "state": "",
        "support_http2": "",
        "tags": [],
        "url_handler": [
            {
                "seq": "",
                "server_group_id": "",
                "server_group_name": "",
                "url_pattern": ""
            }
        ],
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

7.1.31.2 - 1.3

get /v1/lb-listeners/{listener_id}

Description

Listener를 조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

Parameters

TypeNameDescriptionSchemaDefault
pathlistener_id
required
Listener 아이디
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/lb-listeners/{listener_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 = loadbalancer 1.3"

Example HTTP response

Response 200

{
    "listener": {
        "condition_type": "URL_PATH",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "hsts_max_age": "",
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "idle_timeout": "",
        "insert_client_ip": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "persistence": "",
        "protocol": "TCP",
        "response_timeout": "",
        "routing_action": "LB_SERVER_GROUP",
        "server_group_id": "",
        "server_group_name": "",
        "service_port": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "state": "",
        "support_http2": false,
        "url_handler": "",
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

7.1.32 - ShowLBServerGroup

7.1.32.1 - 1.4

get /v1/lb-server-groups/{lb_server_group_id}

Description

LB 서버 그룹을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

Parameters

TypeNameDescriptionSchemaDefault
pathlb_server_group_id
required
LB 서버 그룹 ID
Example : 3d8d8754d0d54683a29f3dcc3dd95d5b
stringNone

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_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 = loadbalancer 1.4"

Example HTTP response

Response 200

{
    "lb_server_group": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "id": "3d8d8754d0d54683a29f3dcc3dd95d5b",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN",
        "lb_name": "Test-LB-01",
        "loadbalancer_id": "82efa35c88834bc083020443e57faa10",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

7.1.32.2 - 1.3

get /v1/lb-server-groups/{lb_server_group_id}

Description

LB 서버 그룹을 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

Parameters

TypeNameDescriptionSchemaDefault
pathlb_server_group_id
required
LB 서버 그룹 ID
Example : 3d8d8754d0d54683a29f3dcc3dd95d5b
stringNone

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_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 = loadbalancer 1.3"

Example HTTP response

Response 200

{
    "lb_server_group": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "id": "3d8d8754d0d54683a29f3dcc3dd95d5b",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN",
        "lb_name": "Test-LB-01",
        "loadbalancer_id": "82efa35c88834bc083020443e57faa10",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

7.1.33 - ShowLbServerGroupMember

7.1.33.1 - 1.4

get /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}

Description

Member를 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

Parameters

TypeNameDescriptionSchemaDefault
pathlb_server_group_id
required
Lb Server Group ID
Example :
stringNone
pathmember_id
required
ID of Member
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_id}/members/{member_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 = loadbalancer 1.4"

Example HTTP response

Response 200

{
    "member": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "lb_server_group_id": "",
        "member_ip": "",
        "member_port": "",
        "member_state": "",
        "member_weight": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "object_id": "",
        "object_type": "VM",
        "state": "CREATING",
        "subnet_id": "",
        "uuid": ""
    }
}

7.1.33.2 - 1.3

get /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}

Description

Member를 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

Parameters

TypeNameDescriptionSchemaDefault
pathlb_server_group_id
required
Lb Server Group ID
Example :
stringNone
pathmember_id
required
ID of Member
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_id}/members/{member_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 = loadbalancer 1.3"

Example HTTP response

Response 200

{
    "member": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "lb_server_group_id": "",
        "member_ip": "",
        "member_port": "",
        "member_state": "",
        "member_weight": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "object_id": "",
        "object_type": "VM",
        "state": "CREATING",
        "subnet_id": "",
        "uuid": ""
    }
}

7.1.34 - ShowLoadbalancer

7.1.34.1 - 1.4

get /v1/loadbalancers/{loadbalancer_id}

Description

LoadBalancer를 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

Parameters

TypeNameDescriptionSchemaDefault
pathloadbalancer_id
required
자원 ID
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_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 = loadbalancer 1.4"

Example HTTP response

Response 200

{
    "loadbalancer": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_id": "",
        "health_check_ips": [
            ""
        ],
        "id": "",
        "layer_type": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "public_nat_enabled": "",
        "service_ip": "",
        "source_nat_ip": "",
        "state": "",
        "subnet_id": "",
        "vpc_id": "",
        "zones": []
    }
}

7.1.34.2 - 1.3

get /v1/loadbalancers/{loadbalancer_id}

Description

LoadBalancer를 조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

Parameters

TypeNameDescriptionSchemaDefault
pathloadbalancer_id
required
자원 ID
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_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 = loadbalancer 1.3"

Example HTTP response

Response 200

{
    "loadbalancer": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_id": "",
        "health_check_ip": [
            ""
        ],
        "id": "",
        "layer_type": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "public_nat_enabled": "",
        "service_ip": "",
        "source_nat_ip": "",
        "state": "",
        "subnet_id": "",
        "vpc_id": ""
    }
}

7.1.35 - ShowLoadbalancerCertificate

7.1.35.1 - 1.4

get /v1/loadbalancers/certificates/{lb_certificate_id}

Description

인증서를 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

Parameters

TypeNameDescriptionSchemaDefault
pathlb_certificate_id
required
인증서 아이디
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/certificates/{lb_certificate_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 = loadbalancer 1.4"

Example HTTP response

Response 200

{
    "certificate": {
        "account_id": "",
        "cert_body": "",
        "cert_chain": "",
        "cert_kind": "",
        "cn": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "not_after_dt": "2024-01-15T10:30:00.000Z",
        "not_before_dt": "2024-01-15T10:30:00.000Z",
        "organization": "",
        "private_key": "",
        "state": ""
    }
}

7.1.35.2 - 1.3

get /v1/loadbalancers/certificates/{lb_certificate_id}

Description

인증서를 조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

Parameters

TypeNameDescriptionSchemaDefault
pathlb_certificate_id
required
인증서 아이디
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/certificates/{lb_certificate_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 = loadbalancer 1.3"

Example HTTP response

Response 200

{
    "certificate": {
        "account_id": "",
        "cert_body": "",
        "cert_chain": "",
        "cert_kind": "",
        "cn": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "not_after_dt": "2024-01-15T10:30:00.000Z",
        "not_before_dt": "2024-01-15T10:30:00.000Z",
        "organization": "",
        "private_key": "",
        "state": ""
    }
}

7.1.36 - ShowLoadbalancerPrivateNatIp

7.1.36.1 - 1.4

get /v1/loadbalancers/{loadbalancer_id}/private-static-nats

Description

Show Load Balancer Private NAT IP

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

Parameters

TypeNameDescriptionSchemaDefault
pathloadbalancer_id
required
자원 ID
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_id}/private-static-nats

Request header

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

Example HTTP response

Response 200

{
    "static_nat": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "external_ip_address": "",
        "id": "",
        "internal_ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "private_nat_ip_id": "",
        "state": ""
    }
}

7.1.36.2 - 1.3

get /v1/loadbalancers/{loadbalancer_id}/private-static-nats

Description

Show Load Balancer Private NAT IP

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

Parameters

TypeNameDescriptionSchemaDefault
pathloadbalancer_id
required
자원 ID
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_id}/private-static-nats

Request header

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

Example HTTP response

Response 200

{
    "static_nat": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "external_ip_address": "",
        "id": "",
        "internal_ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "private_nat_ip_id": "",
        "state": ""
    }
}

7.1.37 - ShowLoadbalancerPublicNatIp

7.1.37.1 - 1.4

get /v1/loadbalancers/{loadbalancer_id}/static-nats

Description

Show Load Balancer Public NAT IP

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.4-

Parameters

TypeNameDescriptionSchemaDefault
pathloadbalancer_id
required
자원 ID
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_id}/static-nats

Request header

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

Example HTTP response

Response 200

{
    "static_nat": {
        "external_ip_address": "",
        "publicip_id": "",
        "state": ""
    }
}

7.1.37.2 - 1.3

get /v1/loadbalancers/{loadbalancer_id}/static-nats

Description

Show Load Balancer Public NAT IP

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.320261031

Parameters

TypeNameDescriptionSchemaDefault
pathloadbalancer_id
required
자원 ID
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_id}/static-nats

Request header

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

Example HTTP response

Response 200

{
    "static_nat": {
        "external_ip_address": "",
        "publicip_id": "",
        "state": ""
    }
}

7.2 - Models

7.2.1 - HstsConfig

NameDescriptionSchemaDefault
include_sub_domains
optional
The hsts include_sub_domains of the listener.
Example :
any of [boolean, null]
max_age
optional
The hsts max_age of the listener.
Example :
any of [integer, null]

7.2.2 - HttpsRedirection

NameDescriptionSchemaDefault
port
optional
port
Example :
any of [string, null]
protocol
optional
프로토콜
Example :
any of [string, null]
response_code
optional
response_code
Example :
any of [string, null]

7.2.3 - LbCertificateForShow

NameDescriptionSchemaDefault
account_id
required
The project ID of the certificate
Example :
string
cert_body
required
The body of the certificate
Example :
string
cert_chain
optional
The chain of the certificate
Example :
any of [string, null]
cert_kind
optional

Example :
string
cn
optional

Example :
string
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
id
required
자원 ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
optional

Example :
string
not_after_dt
optional

Example : 2024-01-15T10:30:00.000Z
string (date-time)
not_before_dt
optional

Example : 2024-01-15T10:30:00.000Z
string (date-time)
organization
required
The organization of the certificate
Example :
string
private_key
required
인증서 개인키
Example :
string
state
optional

Example :
string

7.2.4 - LbCertificateListResponse

NameDescriptionSchemaDefault
certificates
required

array[LbCertificateListResponseDetail]
count
optional
전체 개수
Example : 20
any of [integer, null]
links
optional
links
Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]
any of [array[object], null]

7.2.5 - LbCertificateListResponseDetail

NameDescriptionSchemaDefault
cert_kind
required
Kind of certificate
Example :
string
cn
required
Common Name of certificate
Example :
string
created_at
optional
생성 시간
Example :
any of [string (date-time), null]
created_by
optional
생성자
Example :
any of [string, null]
id
required
ID of the certificate
Example :
string
modified_at
optional
수정 시간
Example :
any of [string (date-time), null]
modified_by
optional
수정자
Example :
any of [string, null]
name
required
Name of the certificate
Example :
string
not_after_dt
required
Expiration date and time of the certificate
Example : 2024-01-15T10:30:00.000Z
string (date-time)
not_before_dt
required
Start date and time when the certificate becomes valid
Example : 2024-01-15T10:30:00.000Z
string (date-time)
state
required
State of the certificate
Example :
string

7.2.6 - LbCertificateShowResponse

NameDescriptionSchemaDefault
certificate
required

LbCertificateForShow

7.2.7 - LbHealthCheckCreate

NameDescriptionSchemaDefault
description
optional
설명
Example : this is an lb server group
any of [string, null]
health_check_count
optional
탐지 횟수
Example : 3
Minimum : 1
Maximum : 10
integer3
health_check_interval
optional
헬스 체크 주기가 유효하지 않습니다. 입력 조건을 확인하세요.
Example : 5
Minimum : 1
Maximum : 180
integer5
health_check_port
optional
헬스 체크 포트
Example : 80
any of [integer, null]
health_check_timeout
optional
대기 시간
Example : 5
Minimum : 1
Maximum : 180
integer5
health_check_url
optional
URL 모니터
Example : /test
Pattern : ^\/[A-Za-z0-9/._?&=-]*$
any of [string, null]
http_method
optional
LB 헬스 체크 HTTP 방식
Example : GET
any of [enum (GET, POST), null]
name
required
LB 헬스 체크명
Example : ServerGroup01
Pattern : ^[a-zA-Z0-9][-a-zA-Z0-9_]*[a-zA-Z0-9]$
Minimum length : 3
Maximum length : 63
string
protocol
required
프로토콜
Example : TCP
enum (TCP, HTTP, HTTPS)
request_data
optional
요청 문자열
Example : username=admin&password=1234
Pattern : ^[a-zA-Z0-9_\W]*$
any of [string, null]
response_code
optional
응답 코드
Example : 200
any of [string, null]
subnet_id
required
Service Subnet ID
Example : 60fba45cb6c811efba41ba92e4fe7200
string
tags
optional
Tag List
array[Tag]
vpc_id
required
VPC ID
Example : 8acceeb6920c4fc494490d864f67f0b5
string

7.2.8 - LbHealthCheckCreateRequest

NameDescriptionSchemaDefault
lb_health_check
required

LbHealthCheckCreate

7.2.9 - LbHealthCheckList

NameDescriptionSchemaDefault
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
health_check_type
required
LB 헬스 체크 유형
Example : DEFAULT
enum (DEFAULT, CUSTOM)
id
required
LB 헬스 체크 ID
Example : 46c681018e33453085ca7c8db54e0076
string
lb_server_group_count
required
LB 서버 그룹 수
Example : 2
integer
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
LB 헬스 체크명
Example : Test-LbMonitor-01
string
protocol
required
프로토콜
Example : TCP
enum (TCP, HTTP, HTTPS)
state
required
LB Health Check state
Example : ACTIVE
string
subnet_id
required
Service Subnet ID
Example : 60fba45cb6c811efba41ba92e4fe7200
string

7.2.10 - LbHealthCheckListResponse

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
lb_health_checks
required

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

7.2.11 - LbHealthCheckSet

NameDescriptionSchemaDefault
description
optional
설명
Example : this is an lb server group
any of [string, null]
health_check_count
optional
탐지 횟수
Example : 3
any of [integer, null]
health_check_interval
optional
헬스 체크 주기가 유효하지 않습니다. 입력 조건을 확인하세요.
Example : 5
any of [integer, null]
health_check_port
optional
헬스 체크 포트
Example : 80
any of [integer, null]
health_check_timeout
optional
대기 시간
Example : 5
any of [integer, null]
health_check_url
optional
URL 모니터
Example : /test
Pattern : ^\/[A-Za-z0-9/._?&=-]*$
any of [string, null]
http_method
optional
LB 헬스 체크 HTTP 방식
Example : GET
any of [enum (GET, POST), null]
protocol
optional
프로토콜
Example : TCP
any of [enum (TCP, HTTP, HTTPS), null]
request_data
optional
요청 문자열
Example : username=admin&password=1234
Pattern : ^[a-zA-Z0-9_\W]*$
any of [string, null]
response_code
optional
응답 코드
Example : 200
any of [string, null]

7.2.12 - LbHealthCheckSetRequest

NameDescriptionSchemaDefault
lb_health_check
required

LbHealthCheckSet

7.2.13 - LbHealthCheckShow

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : e3cd678b11784734bc366148aa37580e
any of [string, null]
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
설명
Example : this is an lb server group
any of [string, null]
health_check_count
optional
탐지 횟수
Example : 3
integer3
health_check_interval
optional
헬스 체크 주기가 유효하지 않습니다. 입력 조건을 확인하세요.
Example : 5
integer5
health_check_port
required
헬스 체크 포트
Example : 80
any of [integer, null]
health_check_timeout
optional
대기 시간
Example : 5
integer5
health_check_type
required
LB 헬스 체크 유형
Example : DEFAULT
enum (DEFAULT, CUSTOM)
health_check_url
required
URL 모니터
Example : /test
any of [string, null]
http_method
required
LB 헬스 체크 HTTP 방식
Example : GET
any of [string, null]
id
required
LB 헬스 체크 ID
Example : 46c681018e33453085ca7c8db54e0076
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
LB 헬스 체크명
Example : Test-LbMonitor-01
string
protocol
optional
프로토콜
Example : TCP
enum (TCP, HTTP, HTTPS)TCP
request_data
required
요청 문자열
Example : username=admin&password=1234
any of [string, null]
response_code
required
응답 코드
Example : 200
any of [string, null]
state
required
LB Health Check state
Example : ACTIVE
string
subnet_id
required
Service Subnet ID
Example : 60fba45cb6c811efba41ba92e4fe7200
any of [string, null]
vpc_id
required
VPC ID
Example : 8acceeb6920c4fc494490d864f67f0b5
any of [string, null]

7.2.14 - LbHealthCheckShowResponse

NameDescriptionSchemaDefault
lb_health_check
required

LbHealthCheckShow

7.2.15 - LbListenerCertificateBase

NameDescriptionSchemaDefault
sni_certificate
optional
The sni certificate of the listener.
any of [array[SniCertificate], null]
ssl_certificate
optional
SSL 인증서
any of [SslCertificate, null]

7.2.16 - LbListenerCertificateSetRequest

NameDescriptionSchemaDefault
listener
required

LbListenerCertificateBase

7.2.17 - LbListenerCreateRequestV1Dot3

NameDescriptionSchemaDefault
listener
required

ListenerForCreateV1Dot3

7.2.18 - LbListenerCreateRequestV1Dot4

NameDescriptionSchemaDefault
listener
required

ListenerForCreateV1Dot4

7.2.19 - LbListenerDistinctBase

NameDescriptionSchemaDefault
description
optional
설명
Example :
any of [string, null]
hsts_config
optional
The hsts response header of the listener.
any of [HstsConfig, null]
idle_timeout
optional
The idle timeout(L7) of the listener.
Example :
any of [integer, null]
insert_client_ip
optional
Whether the client IP should be inserted.
Example :
any of [boolean, null]
persistence
optional
지속성 유형
Example :
any of [string, null]
response_timeout
optional
응답 시간 초과
Example :
any of [integer, null]
session_duration_time
optional
The session duration time.
Example :
any of [integer, null]
support_http2
optional
Whether the HTTP 2.0 is supported
Example :
any of [boolean, null]
x_forwarded_for
optional
Whether the X-Forwarded-For should be inserted.
Example :
any of [boolean, null]
x_forwarded_port
optional
Whether the X-Forwarded-Port should be inserted.
Example :
any of [boolean, null]
x_forwarded_proto
optional
Whether the X-Forwarded-Protocol should be inserted.
Example :
any of [boolean, null]

7.2.20 - LbListenerListResponse

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
listeners
required
The list of the listener.
array[ListenerForList]
page
required
page
Example : 0
integer
size
required
size
Example : 20
integer
sort
optional
sort
Example : ['created_at:asc']
any of [array[string], null]

7.2.21 - LbListenerResourceSetRequest

NameDescriptionSchemaDefault
listener
required

LbListenerDistinctBase

7.2.22 - LbListenerRuleBase

NameDescriptionSchemaDefault
condition_type
optional
The condition type of the listener.
Example : URL_PATH
any of [enum (URL_PATH, HOST_HEADER, PROTOCOL_PORT), null]
https_redirection
optional
The https redirection of the listener.
any of [HttpsRedirection, null]
server_group_id
optional
LB 서버 그룹 아이디
Example :
any of [string, null]
url_handler
optional
URL 처리
any of [array[UrlHandler], null]
url_redirection
optional
The URL redirect of the listener.
Example :
any of [string, null]

7.2.23 - LbListenerRuleSetRequest

NameDescriptionSchemaDefault
listener
required

LbListenerRuleBase

7.2.24 - LbListenerSetRequestV1Dot3

NameDescriptionSchemaDefault
listener
required

ListenerForSetV1Dot3

7.2.25 - LbListenerShowResponseV1Dot3

NameDescriptionSchemaDefault
listener
required

ListenerForShowV1Dot3

7.2.26 - LbListenerShowResponseV1Dot4

NameDescriptionSchemaDefault
listener
required

ListenerForShow

7.2.27 - LbListenerSslCertificate

NameDescriptionSchemaDefault
client_cert_id
optional
Certificate id for client ssl
Example :
any of [string, null]
client_cert_level
optional
Certificate level for client ssl
Example :
any of [string, null]
server_cert_level
optional
Certificate level for server ssl
Example :
any of [string, null]

7.2.28 - LbServerGroup

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : e3cd678b11784734bc366148aa37580e
string
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
설명
Example : this is an lb server group
any of [string, null]
id
required
LB 서버 그룹 ID
Example : 3d8d8754d0d54683a29f3dcc3dd95d5b
string
lb_health_check_id
required
LB 헬스 체크 ID
Example : 46c681018e33453085ca7c8db54e0076
any of [string, null]
lb_method
required
부하 분산
Example : ROUND_ROBIN
enum (ROUND_ROBIN, LEAST_CONNECTION, SOURCE_IP_HASH, SOURCE_IP_PORT_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION)
lb_name
optional
Load Balancer 명
Example : Test-LB-01
any of [string, null]
loadbalancer_id
optional
Load Balancer ID
Example : 82efa35c88834bc083020443e57faa10
any of [string, null]
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
LB 서버 그룹 명
Example : ServerGroup01
string
protocol
required
프로토콜
Example : TCP
enum (TCP, UDP)
state
required
LB 서버 그룹 상태
Example : ACTIVE
string
subnet_id
required
Service Subnet ID
Example : 60fba45cb6c811efba41ba92e4fe7200
string
vpc_id
required
VPC ID
Example : 8acceeb6920c4fc494490d864f67f0b5
string

7.2.29 - LbServerGroupCreate

NameDescriptionSchemaDefault
description
optional
설명
Example : this is an lb server group
any of [string, null]
lb_health_check_id
optional
LB 헬스 체크 ID
Example : 46c681018e33453085ca7c8db54e0076
any of [string, null]
lb_method
required
부하 분산
Example : ROUND_ROBIN
enum (ROUND_ROBIN, LEAST_CONNECTION, SOURCE_IP_HASH, SOURCE_IP_PORT_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION)
name
required
LB 헬스 체크명
Example : ServerGroup01
Pattern : ^[a-zA-Z0-9][-a-zA-Z0-9_]*[a-zA-Z0-9]$
Minimum length : 3
Maximum length : 63
string
protocol
required
프로토콜
Example : TCP
enum (TCP, UDP)
subnet_id
required
Service Subnet ID
Example : 60fba45cb6c811efba41ba92e4fe7200
string
tags
optional
Tag List
array[Tag]
vpc_id
required
VPC ID
Example : 8acceeb6920c4fc494490d864f67f0b5
string

7.2.30 - LbServerGroupCreateRequest

NameDescriptionSchemaDefault
lb_server_group
required

LbServerGroupCreate

7.2.31 - LbServerGroupList

NameDescriptionSchemaDefault
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
id
required
LB 서버 그룹 ID
Example : 3d8d8754d0d54683a29f3dcc3dd95d5b
string
lb_health_check_id
required
LB 헬스 체크 ID
Example : 46c681018e33453085ca7c8db54e0076
any of [string, null]
lb_name
optional
Load Balancer 명
Example : Test-LB-01
any of [string, null]
lb_server_group_member_count
required
서버 멤버 수
Example : 2
integer
loadbalancer_id
optional
Load Balancer ID
Example : 82efa35c88834bc083020443e57faa10
any of [string, null]
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
LB 서버 그룹 명
Example : ServerGroup01
string
protocol
required
프로토콜
Example : TCP
enum (TCP, UDP)
state
required
LB 서버 그룹 상태
Example : ACTIVE
string
vpc_id
required
VPC ID
Example : 8acceeb6920c4fc494490d864f67f0b5
string

7.2.32 - LbServerGroupListResponse

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
lb_server_groups
required

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

7.2.33 - LbServerGroupSet

NameDescriptionSchemaDefault
description
optional
설명
Example : this is an lb server group
any of [string, null]
lb_health_check_id
optional
LB 헬스 체크 ID
Example : 46c681018e33453085ca7c8db54e0076
any of [string, null]
lb_method
optional
부하 분산
Example : ROUND_ROBIN
any of [enum (ROUND_ROBIN, LEAST_CONNECTION, SOURCE_IP_HASH, SOURCE_IP_PORT_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION), null]

7.2.34 - LbServerGroupSetRequest

NameDescriptionSchemaDefault
lb_server_group
required

LbServerGroupSet

7.2.35 - LbServerGroupShowResponse

NameDescriptionSchemaDefault
lb_server_group
required

LbServerGroup

7.2.36 - ListenerForCreateV1Dot3

NameDescriptionSchemaDefault
condition_type
optional
The condition type of the listener.
Example : URL_PATH
any of [enum (URL_PATH, HOST_HEADER, PROTOCOL_PORT), null]
description
optional
설명
Example :
any of [string, null]
hsts_max_age
optional
The hsts max_age of the listener.
Example :
any of [integer, null]
https_redirection
optional
The https redirection of the listener.
any of [HttpsRedirection, null]
idle_timeout
optional
The idle timeout(L7) of the listener.
Example :
any of [integer, null]
insert_client_ip
optional
Whether the client IP should be inserted.
Example :
any of [boolean, null]
loadbalancer_id
required
LB 아이디
Example :
string
name
required
Listener 명
Example :
Pattern : ^[a-zA-Z0-9-_]*$
Minimum length : 3
Maximum length : 63
string
persistence
optional
지속성 유형
Example :
any of [string, null]
protocol
required
프로토콜
Example : TCP
enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY)
response_timeout
optional
응답 시간 초과
Example :
any of [integer, null]
routing_action
required
The routing action of the listener.
Example : LB_SERVER_GROUP
enum (LB_SERVER_GROUP, URL_REDIRECT)
server_group_id
optional
LB 서버 그룹 아이디
Example :
any of [string, null]
service_port
required
서비스 포트
Example :
Minimum : 1
Maximum : 65534
integer
session_duration_time
optional
The session duration time.
Example :
any of [integer, null]
sni_certificate
optional
The sni certificate of the listener.
any of [array[SniCertificate], null]
ssl_certificate
optional
SSL 인증서
any of [SslCertificate, null]
support_http2
optional
Whether the HTTP 2.0 is supported
Example : False
any of [boolean, null]
tags
optional
Tag List
array[Tag]
url_handler
optional
URL 처리
Example :
any of [array[object], null]
url_redirection
optional
The URL redirect of the listener.
Example :
any of [string, null]
x_forwarded_for
optional
Whether the X-Forwarded-For should be inserted.
Example :
any of [boolean, null]
x_forwarded_port
optional
Whether the X-Forwarded-Port should be inserted.
Example :
any of [boolean, null]
x_forwarded_proto
optional
Whether the X-Forwarded-Protocol should be inserted.
Example :
any of [boolean, null]

7.2.37 - ListenerForCreateV1Dot4

NameDescriptionSchemaDefault
condition_type
optional
The condition type of the listener.
Example : URL_PATH
any of [enum (URL_PATH, HOST_HEADER, PROTOCOL_PORT), null]
description
optional
설명
Example :
any of [string, null]
https_redirection
optional
The https redirection of the listener.
any of [HttpsRedirection, null]
idle_timeout
optional
The idle timeout(L7) of the listener.
Example :
any of [integer, null]
insert_client_ip
optional
Whether the client IP should be inserted.
Example :
any of [boolean, null]
loadbalancer_id
required
LB 아이디
Example :
string
name
required
Listener 명
Example :
Pattern : ^[a-zA-Z0-9-_]*$
Minimum length : 3
Maximum length : 63
string
persistence
optional
지속성 유형
Example :
any of [string, null]
protocol
required
프로토콜
Example : TCP
enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY)
response_timeout
optional
응답 시간 초과
Example :
any of [integer, null]
routing_action
required
The routing action of the listener.
Example : LB_SERVER_GROUP
enum (LB_SERVER_GROUP, URL_REDIRECT)
server_group_id
optional
LB 서버 그룹 아이디
Example :
any of [string, null]
service_port
required
서비스 포트
Example :
Minimum : 1
Maximum : 65534
integer
session_duration_time
optional
The session duration time.
Example :
any of [integer, null]
ssl_certificate
optional
SSL 인증서
any of [SslCertificate, null]
support_http2
optional
Whether the HTTP 2.0 is supported
Example : False
any of [boolean, null]
tags
optional
Tag List
array[Tag]
url_handler
optional
URL 처리
any of [array[UrlHandler], null]
url_redirection
optional
The URL redirect of the listener.
Example :
any of [string, null]
x_forwarded_for
optional
Whether the X-Forwarded-For should be inserted.
Example :
any of [boolean, null]
x_forwarded_port
optional
Whether the X-Forwarded-Port should be inserted.
Example :
any of [boolean, null]
x_forwarded_proto
optional
Whether the X-Forwarded-Protocol should be inserted.
Example :
any of [boolean, null]

7.2.38 - ListenerForList

NameDescriptionSchemaDefault
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
id
required
자원 ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Listener 명
Example :
Pattern : ^[a-zA-Z0-9-_]*$
Minimum length : 3
Maximum length : 63
string
protocol
required
프로토콜
Example : TCP
enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY)
service_port
required
서비스 포트
Example :
Minimum : 1
Maximum : 65534
integer
state
optional
Listener 상태
Example :
any of [string, null]

7.2.39 - ListenerForSetV1Dot3

NameDescriptionSchemaDefault
condition_type
optional
The condition type of the listener.
Example : URL_PATH
any of [enum (URL_PATH, HOST_HEADER, PROTOCOL_PORT), null]
description
optional
설명
Example :
any of [string, null]
hsts_max_age
optional
The hsts max_age of the listener.
Example :
any of [integer, null]
https_redirection
optional
The https redirection of the listener.
any of [HttpsRedirection, null]
idle_timeout
optional
The idle timeout(L7) of the listener.
Example :
any of [integer, null]
insert_client_ip
optional
Whether the client IP should be inserted.
Example :
any of [boolean, null]
persistence
optional
지속성 유형
Example :
any of [string, null]
response_timeout
optional
응답 시간 초과
Example :
any of [integer, null]
server_group_id
optional
LB 서버 그룹 아이디
Example :
any of [string, null]
session_duration_time
optional
The session duration time.
Example :
any of [integer, null]
sni_certificate
optional
The sni certificate of the listener.
any of [array[SniCertificate], null]
ssl_certificate
optional
SSL 인증서
any of [LbListenerSslCertificate, null]
support_http2
optional
Whether the HTTP 2.0 is supported
Example :
boolean
url_handler
optional
URL 처리
Example :
any of [array[object], null]
url_redirection
optional
The URL redirect of the listener.
Example :
any of [string, null]
x_forwarded_for
optional
Whether the X-Forwarded-For should be inserted.
Example :
any of [boolean, null]
x_forwarded_port
optional
Whether the X-Forwarded-Port should be inserted.
Example :
any of [boolean, null]
x_forwarded_proto
optional
Whether the X-Forwarded-Protocol should be inserted.
Example :
any of [boolean, null]

7.2.40 - ListenerForShow

NameDescriptionSchemaDefault
condition_type
optional
The condition type of the listener.
Example : URL_PATH
any of [enum (URL_PATH, HOST_HEADER, PROTOCOL_PORT), null]
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
설명
Example :
any of [string, null]
hsts_config
optional
The hsts response header of the listener.
any of [HstsConfig, null]
https_redirection
optional
The https redirection of the listener.
any of [HttpsRedirection, null]
id
required
자원 ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
idle_timeout
optional
The idle timeout(L7) of the listener.
Example :
any of [integer, null]
insert_client_ip
optional
Whether the client IP should be inserted.
Example :
any of [boolean, null]
loadbalancer_id
required
LB 아이디
Example :
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Listener 명
Example :
Pattern : ^[a-zA-Z0-9-_]*$
Minimum length : 3
Maximum length : 63
string
persistence
optional
지속성 유형
Example :
any of [string, null]
protocol
required
프로토콜
Example : TCP
enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY)
response_timeout
optional
응답 시간 초과
Example :
any of [integer, null]
routing_action
required
The routing action of the listener.
Example : LB_SERVER_GROUP
enum (LB_SERVER_GROUP, URL_REDIRECT)
server_group_id
optional
LB 서버 그룹 아이디
Example :
any of [string, null]
server_group_name
optional
LB 서버 그룹 명
Example :
any of [string, null]
service_port
required
서비스 포트
Example :
Minimum : 1
Maximum : 65534
integer
session_duration_time
optional
The session duration time.
Example :
any of [integer, null]
sni_certificate
optional
The sni certificate of the listener.
any of [array[SniCertificateResponse], null]
ssl_certificate
optional
SSL 인증서
any of [SslCertificate, null]
state
required
Listener 상태
Example :
string
support_http2
optional
Whether the HTTP 2.0 is supported
Example :
any of [boolean, null]
tags
optional
Tag List
array[Tag]
url_handler
optional
URL handler list
any of [array[UrlHandlerResponse], null]
url_redirection
optional
The URL redirect of the listener.
Example :
any of [string, null]
x_forwarded_for
optional
Whether the X-Forwarded-For should be inserted.
Example :
any of [boolean, null]
x_forwarded_port
optional
Whether the X-Forwarded-Port should be inserted.
Example :
any of [boolean, null]
x_forwarded_proto
optional
Whether the X-Forwarded-Protocol should be inserted.
Example :
any of [boolean, null]

7.2.41 - ListenerForShowV1Dot3

NameDescriptionSchemaDefault
condition_type
optional
The condition type of the listener.
Example : URL_PATH
any of [enum (URL_PATH, HOST_HEADER, PROTOCOL_PORT), null]
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
설명
Example :
any of [string, null]
hsts_max_age
optional
The hsts max_age of the listener.
Example :
any of [integer, null]
https_redirection
optional
The https redirection of the listener.
any of [HttpsRedirection, null]
id
required
자원 ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
idle_timeout
optional
The idle timeout(L7) of the listener.
Example :
any of [integer, null]
insert_client_ip
optional
Whether the client IP should be inserted.
Example :
any of [boolean, null]
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Listener 명
Example :
Pattern : ^[a-zA-Z0-9-_]*$
Minimum length : 3
Maximum length : 63
string
persistence
optional
지속성 유형
Example :
any of [string, null]
protocol
required
프로토콜
Example : TCP
enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY)
response_timeout
optional
응답 시간 초과
Example :
any of [integer, null]
routing_action
required
The routing action of the listener.
Example : LB_SERVER_GROUP
enum (LB_SERVER_GROUP, URL_REDIRECT)
server_group_id
optional
LB 서버 그룹 아이디
Example :
any of [string, null]
server_group_name
optional
LB 서버 그룹 명
Example :
any of [string, null]
service_port
required
서비스 포트
Example :
Minimum : 1
Maximum : 65534
integer
session_duration_time
optional
The session duration time.
Example :
any of [integer, null]
sni_certificate
optional
The sni certificate of the listener.
any of [array[SniCertificate], null]
ssl_certificate
optional
SSL 인증서
any of [SslCertificate, null]
state
required
Listener 상태
Example :
string
support_http2
optional
Whether the HTTP 2.0 is supported
Example : False
any of [boolean, null]
url_handler
optional
URL 처리
Example :
any of [array[object], null]
url_redirection
optional
The URL redirect of the listener.
Example :
any of [string, null]
x_forwarded_for
optional
Whether the X-Forwarded-For should be inserted.
Example :
any of [boolean, null]
x_forwarded_port
optional
Whether the X-Forwarded-Port should be inserted.
Example :
any of [boolean, null]
x_forwarded_proto
optional
Whether the X-Forwarded-Protocol should be inserted.
Example :
any of [boolean, null]

7.2.42 - Loadbalancer

NameDescriptionSchemaDefault
account_id
required
LoadBalancer account ID
Example :
string
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
설명
Example :
any of [string, null]
firewall_id
optional
방화벽 ID
Example :
any of [string, null]
health_check_ip
required
Health check IP
array[string]
id
required
자원 ID
Example :
string
layer_type
required
계층 타입
Example :
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
이름
Example :
string
public_nat_enabled
optional
Public NAT Enabled Status
Example :
any of [boolean, null]
service_ip
optional
LoadBalancer 서비스 IP
Example :
any of [string, null]
source_nat_ip
optional
Source NAT IP
Example :
any of [string, null]
state
required
The state of the load balancer.
Example :
string
subnet_id
required
Subnet ID
Example :
string
vpc_id
required
VPC ID
Example :
string

7.2.43 - LoadbalancerCreateRequest

NameDescriptionSchemaDefault
loadbalancer
required

LoadbalancerCreateRequestDetail

7.2.44 - LoadbalancerCreateRequestDetail

NameDescriptionSchemaDefault
description
optional
설명
Example :
any of [string, null]
firewall_enabled
optional
방화벽 사용 여부
Example : True
any of [boolean, null]True
firewall_logging_enabled
optional
방화벽 로깅 여부
Example : True
any of [boolean, null]True
health_check_ip_1
optional
Health check IP
Example :
any of [string, null]
health_check_ip_2
optional
Health check IP
Example :
any of [string, null]
layer_type
required
계층 타입
Example :
string
name
required
이름
Example :
Pattern : ^[a-zA-Z0-9-_]*$
Minimum length : 3
Maximum length : 63
string
publicip_id
optional
Public IP ID
Example :
any of [string, null]
service_ip
optional
LoadBalancer 서비스 IP
Example :
any of [string, null]
source_nat_ip
optional
Source NAT IP
Example :
any of [string, null]
subnet_id
required
Subnet ID
Example :
string
tags
optional
Tag List
array[Tag]
vpc_id
required
VPC ID
Example :
string

7.2.45 - LoadbalancerCreateRequestDetailV1Dot4

NameDescriptionSchemaDefault
description
optional
설명
Example :
any of [string, null]
firewall_enabled
optional
방화벽 사용 여부
Example : True
any of [boolean, null]True
firewall_logging_enabled
optional
방화벽 로깅 여부
Example : True
any of [boolean, null]True
health_check_ips
optional
The list of Health check IPs
Example :
any of [array[string], null]
layer_type
required
계층 타입
Example :
string
name
required
이름
Example :
Pattern : ^[a-zA-Z0-9-_]*$
Minimum length : 3
Maximum length : 63
string
publicip_id
optional
Public IP ID
Example :
any of [string, null]
service_ip
optional
LoadBalancer 서비스 IP
Example :
any of [string, null]
source_nat_ip
optional
Source NAT IP
Example :
any of [string, null]
subnet_id
required
Subnet ID
Example :
string
tags
optional
Tag List
array[Tag]
vpc_id
required
VPC ID
Example :
string
zones
optional
Availability Zones
array[string]

7.2.46 - LoadbalancerCreateRequestV1Dot4

NameDescriptionSchemaDefault
loadbalancer
required

LoadbalancerCreateRequestDetailV1Dot4

7.2.47 - LoadbalancerCreateResponse

NameDescriptionSchemaDefault
loadbalancer
required

LoadbalancerCreateResponseDetail

7.2.48 - LoadbalancerCreateResponseDetail

NameDescriptionSchemaDefault
account_id
required
LoadBalancer account ID
Example :
string
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
설명
Example :
any of [string, null]
id
required
자원 ID
Example :
string
layer_type
required
계층 타입
Example :
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
이름
Example :
string
state
required
The state of the load balancer.
Example :
string
subnet_id
required
Subnet ID
Example :
string
vpc_id
required
VPC ID
Example :
string

7.2.49 - LoadbalancerListResponse

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
loadbalancers
required

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

7.2.50 - LoadbalancerListResponseDetail

NameDescriptionSchemaDefault
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
firewall_id
optional
방화벽 ID
Example :
any of [string, null]
id
required
자원 ID
Example :
string
layer_type
optional
계층 타입
Example :
any of [string, null]
listener_count
optional
Listener 개수
Example :
any of [integer, null]
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
optional
LoadBalancer 명
Example :
any of [string, null]
public_nat_enabled
optional
Public NAT Enabled Status
Example :
any of [boolean, null]
service_ip
optional
LoadBalancer 서비스 IP
Example :
any of [string, null]
source_nat_ip
optional
Source NAT IP
Example :
any of [string, null]
state
optional
The state of the load balancer.
Example :
any of [string, null]
subnet_id
optional
Subnet ID
Example :
any of [string, null]
vpc_id
optional
VPC ID
Example :
any of [string, null]

7.2.51 - LoadbalancerListResponseDetailV1Dot4

NameDescriptionSchemaDefault
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
firewall_id
optional
방화벽 ID
Example :
any of [string, null]
id
required
자원 ID
Example :
string
layer_type
optional
계층 타입
Example :
any of [string, null]
listener_count
optional
Listener 개수
Example :
any of [integer, null]
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
optional
LoadBalancer 명
Example :
any of [string, null]
public_nat_enabled
optional
Public NAT Enabled Status
Example :
any of [boolean, null]
service_ip
optional
LoadBalancer 서비스 IP
Example :
any of [string, null]
source_nat_ip
optional
Source NAT IP
Example :
any of [string, null]
state
optional
The state of the load balancer.
Example :
any of [string, null]
subnet_id
optional
Subnet ID
Example :
any of [string, null]
vpc_id
optional
VPC ID
Example :
any of [string, null]
zones
optional
Availability Zones
array[string]

7.2.52 - LoadbalancerListResponseV1Dot4

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
loadbalancers
required

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

7.2.53 - LoadbalancerShowResponse

NameDescriptionSchemaDefault
loadbalancer
required

Loadbalancer

7.2.54 - LoadbalancerShowResponseV1Dot4

NameDescriptionSchemaDefault
loadbalancer
required

LoadbalancerV1Dot4

7.2.55 - LoadbalancerStaticNatResponse

NameDescriptionSchemaDefault
static_nat
required

StaticNat

7.2.56 - LoadbalancerUpdateRequest

NameDescriptionSchemaDefault
loadbalancer
required

LoadbalancerUpdateRequestDetail

7.2.57 - LoadbalancerUpdateRequestDetail

NameDescriptionSchemaDefault
description
required
설명
Example :
Maximum length : 255
string

7.2.58 - LoadbalancerV1Dot4

NameDescriptionSchemaDefault
account_id
required
LoadBalancer account ID
Example :
string
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
설명
Example :
any of [string, null]
firewall_id
optional
방화벽 ID
Example :
any of [string, null]
health_check_ips
required
Health check IP
array[string]
id
required
자원 ID
Example :
string
layer_type
required
계층 타입
Example :
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
이름
Example :
string
public_nat_enabled
optional
Public NAT Enabled Status
Example :
any of [boolean, null]
service_ip
optional
LoadBalancer 서비스 IP
Example :
any of [string, null]
source_nat_ip
optional
Source NAT IP
Example :
any of [string, null]
state
required
The state of the load balancer.
Example :
string
subnet_id
required
Subnet ID
Example :
string
vpc_id
required
VPC ID
Example :
string
zones
optional
Availability Zones
array[string]

7.2.59 - Member

NameDescriptionSchemaDefault
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
id
required
자원 ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
lb_server_group_id
required
Lb Server Group ID
Example :
string
member_ip
required
Member ID
Example :
string
member_port
required
Member 포트
Example :
integer
member_state
required
Member State of Member
Example :
string
member_weight
required
Weight of Member
Example :
integer
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Member 명
Example :
string
object_id
optional
Member 대상 서버의 ID
Example :
any of [string, null]
object_type
required
Member의 대상 서버 타입
Example : VM
enum (VM, BM, MANUAL, MNGC)
state
required
State of Member
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)
subnet_id
required
Sunbet ID
Example :
string
uuid
required
UUID of Member
Example :
string

7.2.60 - MemberCreateRequestV1Dot1

NameDescriptionSchemaDefault
member_ip
required
Member ID
Example : 192.168.0.1
string
member_port
required
Member 포트
Example : 80
Minimum : 1
Maximum : 65534
integer
member_state
optional
Member State of Member
Example : ENABLE
any of [enum (ENABLE, DISABLE), null]
member_weight
optional
Weight of Member
Example : 100
Minimum : 1
Maximum : 1000
integer
name
required
Member 명
Example : virtualserver-1
Pattern : ^[a-zA-Z0-9\s\-_\.]*$
Minimum length : 1
Maximum length : 63
string
object_id
optional
Member 대상 서버의 ID
Example : 1
string
object_type
required
Member의 대상 서버 타입
Example : VM
string

7.2.61 - MemberDeleteBulkRequestV1Dot2

NameDescriptionSchemaDefault
member_id_list
required
ID list of Member
array[string]

7.2.62 - MemberListCreateRequestV1Dot1

NameDescriptionSchemaDefault
members
required

array[MemberCreateRequestV1Dot1]

7.2.63 - MemberListResponse

NameDescriptionSchemaDefault
count
optional
전체 개수
Example : 20
any of [integer, null]
links
optional
links
Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]
any of [array[object], null]
members
required

array[Member]

7.2.64 - MemberSet

NameDescriptionSchemaDefault
member_port
optional
Member 포트
Example : 80
any of [integer, null]
member_state
optional
Member State of Member
Example : ENABLE
any of [enum (ENABLE, DISABLE), null]
member_weight
optional
Weight of Member
Example : 100
any of [integer, null]

7.2.65 - MemberSetRequest

NameDescriptionSchemaDefault
member
required

MemberSet

7.2.66 - MemberShowResponse

NameDescriptionSchemaDefault
member
required

any of [Member, null]

7.2.67 - MemberWithHealthState

NameDescriptionSchemaDefault
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
health_state
required
Member의 Health State
Example :
string
id
required
자원 ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
lb_server_group_id
required
Lb Server Group ID
Example :
string
member_ip
required
Member ID
Example :
string
member_port
required
Member 포트
Example :
integer
member_state
required
Member State of Member
Example :
string
member_weight
required
Weight of Member
Example :
integer
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Member 명
Example :
string
object_id
required
Member 대상 서버의 ID
Example :
any of [string, null]
object_type
required
Member의 대상 서버 타입
Example : VM
enum (VM, BM, MANUAL, MNGC)
state
required
State of Member
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)

7.2.68 - MemberWithHealthStateListResponse

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
members
required

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

7.2.69 - MemberWithHealthStateListResponseV1Dot4

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
members
required

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

7.2.70 - MemberWithHealthStateV1Dot4

NameDescriptionSchemaDefault
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
health_state
required
Member의 Health State
Example :
string
id
required
자원 ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
lb_server_group_id
required
Lb Server Group ID
Example :
string
member_ip
required
Member ID
Example :
string
member_port
required
Member 포트
Example :
integer
member_state
required
Member State of Member
Example :
string
member_weight
required
Weight of Member
Example :
integer
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Member 명
Example :
string
object_az
optional
Object AZ of Member
Example :
any of [string, null]
object_id
required
Member 대상 서버의 ID
Example :
any of [string, null]
object_type
required
Member의 대상 서버 타입
Example : VM
enum (VM, BM, MANUAL, MNGC)
state
required
State of Member
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)

7.2.71 - PrivateStaticNatCreateRequest

NameDescriptionSchemaDefault
static_nat
required

PrivateStaticNatCreateRequestDetail

7.2.72 - PrivateStaticNatCreateRequestDetail

NameDescriptionSchemaDefault
private_nat_id
required
private_nat_id
Example :
string
private_nat_ip_id
required
private_nat_ip_id
Example :
string

7.2.73 - PrivateStaticNatCreateResponse

NameDescriptionSchemaDefault
static_nat
required

PrivateStaticNatCreateResponseDetail

7.2.74 - PrivateStaticNatCreateResponseDetail

NameDescriptionSchemaDefault
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
external_ip_address
optional
external_ip_address
Example :
any of [string, null]
id
optional
자원 ID
Example :
any of [string, null]
internal_ip_address
optional
internal_ip_address
Example :
any of [string, null]
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
private_nat_ip_id
optional
private_nat_ip_id
Example :
any of [string, null]
state
optional
state
Example :
any of [string, null]
subnet_id
optional
subnet_id
Example :
any of [string, null]

7.2.75 - PrivateStaticNatShowResponse

NameDescriptionSchemaDefault
static_nat
required

any of [PrivateStaticNatShowResponseDetail, null]

7.2.76 - PrivateStaticNatShowResponseDetail

NameDescriptionSchemaDefault
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
external_ip_address
optional
external_ip_address
Example :
any of [string, null]
id
optional
자원 ID
Example :
any of [string, null]
internal_ip_address
optional
internal_ip_address
Example :
any of [string, null]
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
private_nat_ip_id
optional
private_nat_ip_id
Example :
any of [string, null]
state
optional
state
Example :
any of [string, null]

7.2.77 - SniCertificate

NameDescriptionSchemaDefault
domain_name
optional
Domain name for sni ssl
Example :
Pattern : ^[a-zA-Z0-9](?:[a-zA-Z0-9.-]{0,61}[a-zA-Z0-9])?$
any of [string, null]
sni_cert_id
optional
Certificate id for sni ssl
Example :
any of [string, null]

7.2.78 - SniCertificateResponse

NameDescriptionSchemaDefault
domain_name
optional
Domain name for sni ssl
Example :
Pattern : ^[a-zA-Z0-9](?:[a-zA-Z0-9.-]{0,61}[a-zA-Z0-9])?$
any of [string, null]
not_after_dt
optional
The expiration date and time of the certificate
Example :
any of [string (date-time), null]
sni_cert_id
optional
Certificate id for sni ssl
Example :
any of [string, null]

7.2.79 - SslCertificate

NameDescriptionSchemaDefault
client_cert_id
optional
Certificate id for client ssl
Example :
any of [string, null]
client_cert_level
optional
Certificate level for client ssl
Example :
any of [string, null]
server_cert_level
optional
Certificate level for server ssl
Example :
any of [string, null]

7.2.80 - StaticNat

NameDescriptionSchemaDefault
external_ip_address
required
Static Nat External Ip Address
Example :
string
publicip_id
optional
Publicip ID
Example :
any of [string, null]
state
required
Static Nat State
Example :
string

7.2.81 - StaticNatCreateRequest

NameDescriptionSchemaDefault
static_nat
required

StaticNatCreateRequestDetail

7.2.82 - StaticNatCreateRequestDetail

NameDescriptionSchemaDefault
publicip_id
required
publicip_id
Example :
string

7.2.83 - StaticNatCreateResponse

NameDescriptionSchemaDefault
static_nat
required

StaticNatCreateResponseDetail

7.2.84 - StaticNatCreateResponseDetail

NameDescriptionSchemaDefault
account_id
optional
account_id
Example :
any of [string, null]
action_type
optional
action_type
Example :
any of [string, null]
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
설명
Example :
any of [string, null]
external_ip_address
optional
external_ip_address
Example :
any of [string, null]
id
optional
자원 ID
Example :
any of [string, null]
internal_ip_address
optional
internal_ip_address
Example :
any of [string, null]
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
optional
이름
Example :
any of [string, null]
owner_id
optional
owner_id
Example :
any of [string, null]
owner_name
optional
owner_name
Example :
any of [string, null]
owner_type
optional
owner_type
Example :
any of [string, null]
publicip_id
optional
publicip_id
Example :
any of [string, null]
service_ip_port_id
optional
service_ip_port_id
Example :
any of [string, null]
state
optional
state
Example :
any of [string, null]
subnet_id
optional
subnet_id
Example :
any of [string, null]
type
optional
type
Example :
any of [string, null]
vpc_id
optional
vpc_id
Example :
any of [string, null]

7.2.85 - Tag

NameDescriptionSchemaDefault
key
required
tag key
Example :
string
value
required
tag value
Example :
string

7.2.86 - UrlHandler

NameDescriptionSchemaDefault
seq
required
Sequence number for ordering
Example :
integer
server_group_id
optional
LB 서버 그룹 아이디
Example :
any of [string, null]
url_pattern
required
URL pattern for routing action
Example :
Minimum length : 1
Maximum length : 63
string

7.2.87 - UrlHandlerResponse

NameDescriptionSchemaDefault
seq
optional
Sequence number for ordering
Example :
any of [integer, null]
server_group_id
optional
LB 서버 그룹 아이디
Example :
any of [string, null]
server_group_name
optional
LB 서버 그룹 명
Example :
any of [string, null]
url_pattern
required
URL pattern for routing
Example :
string

8 - Security Group

Overview

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

Version

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

VersionStatusNot Before
1.1CURRENT-
1.0SUPPORTED20270131

OpenAPI URL

https://security-group.{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

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

변경사항

  • [변경] GET /v1/security-group-rules - API 가 변경되었습니다.
    • 응답 모델이 SecurityGroupRuleListResponseV1Dot1 로 변경되었습니다.
      • 응답 시, 아래와 같은 필드가 추가됩니다.
      • remote_address_group_id, remote_address_group_name
  • [변경] POST /v1/security-group-rules - API 가 변경되었습니다.
    • 요청 모델이 SecurityGroupRuleCreateRequestV1Dot1 로 변경되었습니다.
      • 요청 시, 아래와 같은 필드가 추가됩니다.
      • remote_address_group_id
    • 응답 모델이 SecurityGroupRuleShowResponseV1Dot1 로 변경되었습니다.
      • 응답 시, 아래와 같은 필드가 추가됩니다.
      • remote_address_group_id, remote_address_group_name
  • [변경] GET /v1/security-group-rules/{security_group_rule_id} - API가 변경되었습니다.
    • 응답 모델이 SecurityGroupRuleShowResponseV1Dot1 로 변경되었습니다.
      • 응답 시, 아래와 같은 필드가 추가됩니다.
      • remote_address_group_id, remote_address_group_name
  • [신규] GET /v1/address-groups - API가 추가되었습니다.
  • [신규] POST /v1/address-groups - API가 추가되었습니다.
  • [신규] GET /v1/address-groups/{address_group_id} - API가 추가되었습니다.
  • [신규] PUT /v1/address-groups/{address_group_id} - API가 추가되었습니다.
  • [신규] DELETE /v1/address-groups/{address_group_id} - API가 추가되었습니다.
  • [신규] GET /v1/address-groups/{address_group_id}/addresses - API가 추가되었습니다.
  • [신규] PUT /v1/address-groups/{address_group_id}/add_addresses - API가 추가되었습니다.
  • [신규] PUT /v1/address-groups/{address_group_id}/remove_addresses - API가 추가되었습니다.

1.0

Security Group API가 출시되었습니다.

변경사항

  • [신규] GET /v1/security-groups - API가 추가되었습니다.
  • [신규] POST /v1/security-groups - API가 추가되었습니다.
  • [신규] SHOW /v1/security-groups/{security_group_id} - API가 추가되었습니다.
  • [신규] PUT /v1/security-groups/{security_group_id} - API가 추가되었습니다.
  • [신규] DELETE /v1/security-groups/{security_group_id} - API가 추가되었습니다.
  • [신규] GET /v1/security-group-rules - API가 추가되었습니다.
  • [신규] POST /v1/security-group-rules - API가 추가되었습니다.
  • [신규] GET /v1/security-group-rules/{security_group_rule_id} - API가 추가되었습니다.
  • [신규] DELETE /v1/security-group-rules/{security_group_rule_id} - API가 추가되었습니다.

8.1 - APIs

8.1.1 - Add Address Group IPs

8.1.1.1 - 1.1

put /v1/address-groups/{address_group_id}/add_addresses

Description

Address Group에 대상 주소를 추가한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathaddress_group_id
required
Address Group ID
Example : 4b18494930bf4c5dbb97a9eb2ef68fe1
stringNone
bodybody
required

AddressGroupCidrsAddRequest

Responses

HTTP CodeDescriptionSchema
200OKAddressGroupCidrsAddRequest
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/address-groups/{address_group_id}/add_addresses

Request header

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

Request body

{
    "addresses": [
        "10.1.1.1/32",
        "10.1.2.0/24",
        "10.1.3.0/24"
    ]
}

Example HTTP response

Response 200

{
    "addresses": [
        "10.1.1.1/32",
        "10.1.2.0/24",
        "10.1.3.0/24"
    ]
}

8.1.2 - Create Address Group

8.1.2.1 - 1.1

post /v1/address-groups

Description

Address Group을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

AddressGroupCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedAddressGroupShowResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
409ConflictNone

Example HTTP request

Request path

/v1/address-groups

Request header

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

Request body

{
    "addresses": [
        "10.1.1.1/32",
        "10.1.2.0/24",
        "10.1.3.0/24"
    ],
    "description": "Example Description for Address Group",
    "name": "ExampleAG1",
    "tags": []
}

Example HTTP response

Response 201

{
    "address_group": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "address_count": 10,
        "address_limit": 1000,
        "addresses": [
            "10.1.1.1/32",
            "10.1.2.0/24",
            "10.1.3.0/24"
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for Address Group",
        "id": "4b18494930bf4c5dbb97a9eb2ef68fe1",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleAG1",
        "state": "ACTIVE"
    }
}

8.1.3 - Create Security Group

8.1.3.1 - 1.1

post /v1/security-groups

Description

Security Group을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

SecurityGroupCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedSecurityGroupShowResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/security-groups

Request header

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

Request body

{
    "description": "Example Description for Security Group",
    "loggable": false,
    "name": "ExampleSG1",
    "tags": []
}

Example HTTP response

Response 201

{
    "security_group": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for Security Group",
        "id": "06e5d676-f330-485a-94e9-47ac91cce09a",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleSG1",
        "rule_count": 200,
        "state": "ACTIVE"
    }
}

8.1.3.2 - 1.0

post /v1/security-groups

Description

Security Group을 생성한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020270131

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

SecurityGroupCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedSecurityGroupShowResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/security-groups

Request header

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

Request body

{
    "description": "Example Description for Security Group",
    "loggable": false,
    "name": "ExampleSG1",
    "tags": []
}

Example HTTP response

Response 201

{
    "security_group": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for Security Group",
        "id": "06e5d676-f330-485a-94e9-47ac91cce09a",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleSG1",
        "rule_count": 200,
        "state": "ACTIVE"
    }
}

8.1.4 - Create Security Group Rule

8.1.4.1 - 1.1

post /v1/security-group-rules

Description

Security Group rule을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

SecurityGroupRuleCreateRequestV1Dot1

Responses

HTTP CodeDescriptionSchema
201CreatedSecurityGroupRuleShowResponseV1Dot1
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/security-group-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 = security-group 1.1"

Request body

{
    "description": "Example Description for Security Group Rule",
    "direction": "Ingress",
    "ethertype": "IPv4",
    "port_range_max": 22,
    "port_range_min": 22,
    "protocol": "TCP",
    "remote_address_group_id": "4b18494930bf4c5dbb97a9eb2ef68fe1",
    "remote_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a",
    "remote_ip_prefix": "1.1.1.1/32",
    "security_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a"
}

Example HTTP response

Response 201

{
    "security_group_rule": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for Security Group Rule",
        "direction": "Ingress",
        "ethertype": "IPv4",
        "id": "10d8250e-f4eb-453a-96af-b50b5b514a1a",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "port_range_max": 22,
        "port_range_min": 22,
        "protocol": "TCP",
        "remote_address_group_id": "4b18494930bf4c5dbb97a9eb2ef68fe1",
        "remote_address_group_name": "ExampleAG1",
        "remote_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a",
        "remote_group_name": "ExampleSG2",
        "remote_ip_prefix": "1.1.1.1/32",
        "security_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a"
    }
}

8.1.4.2 - 1.0

post /v1/security-group-rules

Description

Security Group rule을 생성한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020270131

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

SecurityGroupRuleCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedSecurityGroupRuleShowResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/security-group-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 = security-group 1.0"

Request body

{
    "description": "Example Description for Security Group Rule",
    "direction": "Ingress",
    "ethertype": "IPv4",
    "port_range_max": 22,
    "port_range_min": 22,
    "protocol": "TCP",
    "remote_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a",
    "remote_ip_prefix": "1.1.1.1/32",
    "security_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a"
}

Example HTTP response

Response 201

{
    "security_group_rule": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for Security Group Rule",
        "direction": "Ingress",
        "ethertype": "IPv4",
        "id": "10d8250e-f4eb-453a-96af-b50b5b514a1a",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "port_range_max": 22,
        "port_range_min": 22,
        "protocol": "TCP",
        "remote_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a",
        "remote_group_name": "ExampleSG2",
        "remote_ip_prefix": "1.1.1.1/32",
        "security_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a"
    }
}

8.1.5 - Delete Address Group

8.1.5.1 - 1.1

delete /v1/address-groups/{address_group_id}

Description

Address Group을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathaddress_group_id
required
Address Group ID
Example : 4b18494930bf4c5dbb97a9eb2ef68fe1
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/address-groups/{address_group_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 = security-group 1.1"

Example HTTP response

Response 204

8.1.6 - Delete Security Group

8.1.6.1 - 1.1

delete /v1/security-groups/{security_group_id}

Description

Security Group을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathsecurity_group_id
required
Security Group ID
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/security-groups/{security_group_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 = security-group 1.1"

Example HTTP response

Response 204

8.1.6.2 - 1.0

delete /v1/security-groups/{security_group_id}

Description

Security Group을 삭제한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020270131

Parameters

TypeNameDescriptionSchemaDefault
pathsecurity_group_id
required
Security Group ID
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/security-groups/{security_group_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 = security-group 1.0"

Example HTTP response

Response 204

8.1.7 - Delete Security Group Rule

8.1.7.1 - 1.1

delete /v1/security-group-rules/{security_group_rule_id}

Description

Security Group rule을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathsecurity_group_rule_id
required
Security Group Rule ID
Example : 10d8250e-f4eb-453a-96af-b50b5b514a1a
stringNone

Responses

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

Example HTTP request

Request path

/v1/security-group-rules/{security_group_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 = security-group 1.1"

Example HTTP response

Response 204

8.1.7.2 - 1.0

delete /v1/security-group-rules/{security_group_rule_id}

Description

Security Group rule을 삭제한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020270131

Parameters

TypeNameDescriptionSchemaDefault
pathsecurity_group_rule_id
required
Security Group Rule ID
Example : 10d8250e-f4eb-453a-96af-b50b5b514a1a
stringNone

Responses

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

Example HTTP request

Request path

/v1/security-group-rules/{security_group_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 = security-group 1.0"

Example HTTP response

Response 204

8.1.8 - List Address Group IPs

8.1.8.1 - 1.1

get /v1/address-groups/{address_group_id}/addresses

Description

Address Group 대상 주소 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathaddress_group_id
required
Address Group ID
Example : 4b18494930bf4c5dbb97a9eb2ef68fe1
stringNone
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
queryaddress
optional
Address Group 대상 주소
Example : 10.1.1.1/32
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKAddressGroupCidrListResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/address-groups/{address_group_id}/addresses

Request header

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

Example HTTP response

Response 200

{
    "addresses": [
        "10.1.1.1/32",
        "10.1.2.0/24",
        "10.1.3.0/24"
    ],
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

8.1.9 - List Address Groups

8.1.9.1 - 1.1

get /v1/address-groups

Description

Address Group 목록을 조회한다.

상태 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
queryid
optional
Address Group ID
Example : 4b18494930bf4c5dbb97a9eb2ef68fe1
stringNone
queryname
optional
Address Group 이름
Example : ExampleAG1
stringNone

Responses

HTTP CodeDescriptionSchema
200OKAddressGroupListResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone

Example HTTP request

Request path

/v1/address-groups

Request header

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

Example HTTP response

Response 200

{
    "address_groups": [
        {
            "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
            "address_count": 10,
            "address_limit": 1000,
            "addresses": [
                "10.1.1.1/32",
                "10.1.2.0/24",
                "10.1.3.0/24"
            ],
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Example Description for Address Group",
            "id": "4b18494930bf4c5dbb97a9eb2ef68fe1",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ExampleAG1",
            "state": "ACTIVE"
        }
    ],
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

8.1.10 - List Security Group Rules

8.1.10.1 - 1.1

get /v1/security-group-rules

Description

Security Group 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
queryid
optional
Security Group Rule ID
Example : 10d8250e-f4eb-453a-96af-b50b5b514a1a
stringNone
querysecurity_group_id
required
Security Group ID
Example : 06e5d676-f330-485a-94e9-47ac91cce09a
stringNone
queryremote_ip_prefix
optional
Security Group Rule IP 주소
Example : 1.1.1.1/32
stringNone
queryremote_group_id
optional
Security Group Rule 원격 그룹 ID
Example : 06e5d676-f330-485a-94e9-47ac91cce09a
stringNone
querydescription
optional
Security Group Rule 설명
Example : Example Description for Security Group Rule
stringNone
querydirection
optional
Security Group Rule 방향 (Ingress, Egress)
Example : Ingress
stringNone
queryservice
optional
Security Group Rule 서비스
Example : TCP 22
stringNone

Responses

HTTP CodeDescriptionSchema
200OKSecurityGroupRuleListResponseV1Dot1
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone

Example HTTP request

Request path

/v1/security-group-rules?security_group_id={security_group_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 = security-group 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "security_group_rules": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Example Description for Security Group Rule",
            "direction": "Ingress",
            "ethertype": "IPv4",
            "id": "10d8250e-f4eb-453a-96af-b50b5b514a1a",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "port_range_max": 22,
            "port_range_min": 22,
            "protocol": "TCP",
            "remote_address_group_id": "4b18494930bf4c5dbb97a9eb2ef68fe1",
            "remote_address_group_name": "ExampleAG1",
            "remote_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a",
            "remote_group_name": "ExampleSG2",
            "remote_ip_prefix": "1.1.1.1/32",
            "security_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a"
        }
    ]
}

8.1.10.2 - 1.0

get /v1/security-group-rules

Description

Security Group 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
queryid
optional
Security Group Rule ID
Example : 10d8250e-f4eb-453a-96af-b50b5b514a1a
stringNone
querysecurity_group_id
required
Security Group ID
Example : 06e5d676-f330-485a-94e9-47ac91cce09a
stringNone
queryremote_ip_prefix
optional
Security Group Rule IP 주소
Example : 1.1.1.1/32
stringNone
queryremote_group_id
optional
Security Group Rule 원격 그룹 ID
Example : 06e5d676-f330-485a-94e9-47ac91cce09a
stringNone
querydescription
optional
Security Group Rule 설명
Example : Example Description for Security Group Rule
stringNone
querydirection
optional
Security Group Rule 방향 (Ingress, Egress)
Example : Ingress
stringNone
queryservice
optional
Security Group Rule 서비스
Example : TCP 22
stringNone

Responses

HTTP CodeDescriptionSchema
200OKSecurityGroupRuleListResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone

Example HTTP request

Request path

/v1/security-group-rules?security_group_id={security_group_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 = security-group 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "security_group_rules": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Example Description for Security Group Rule",
            "direction": "Ingress",
            "ethertype": "IPv4",
            "id": "10d8250e-f4eb-453a-96af-b50b5b514a1a",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "port_range_max": 22,
            "port_range_min": 22,
            "protocol": "TCP",
            "remote_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a",
            "remote_group_name": "ExampleSG2",
            "remote_ip_prefix": "1.1.1.1/32",
            "security_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a"
        }
    ]
}

8.1.11 - List Security Groups

8.1.11.1 - 1.1

get /v1/security-groups

Description

Security Group 목록을 조회한다.

상태 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
queryid
optional
Security Group ID
Example :
stringNone
queryname
optional
Security Group 이름
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
200OKSecurityGroupListResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone

Example HTTP request

Request path

/v1/security-groups

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "security_groups": [
        {
            "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Example Description for Security Group",
            "id": "06e5d676-f330-485a-94e9-47ac91cce09a",
            "loggable": false,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ExampleSG1",
            "rule_count": 200,
            "state": "ACTIVE"
        }
    ]
}

8.1.11.2 - 1.0

get /v1/security-groups

Description

Security Group 목록을 조회한다.

상태 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
queryid
optional
Security Group ID
Example :
stringNone
queryname
optional
Security Group 이름
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
200OKSecurityGroupListResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone

Example HTTP request

Request path

/v1/security-groups

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "security_groups": [
        {
            "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Example Description for Security Group",
            "id": "06e5d676-f330-485a-94e9-47ac91cce09a",
            "loggable": false,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ExampleSG1",
            "rule_count": 200,
            "state": "ACTIVE"
        }
    ]
}

8.1.12 - Remove Address Group IPs

8.1.12.1 - 1.1

put /v1/address-groups/{address_group_id}/remove_addresses

Description

Address Group에서 대상 주소를 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathaddress_group_id
required
Address Group ID
Example : 4b18494930bf4c5dbb97a9eb2ef68fe1
stringNone
bodybody
required

AddressGroupCidrsAddRequest

Responses

HTTP CodeDescriptionSchema
200OKAddressGroupCidrsAddRequest
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/address-groups/{address_group_id}/remove_addresses

Request header

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

Request body

{
    "addresses": [
        "10.1.1.1/32",
        "10.1.2.0/24",
        "10.1.3.0/24"
    ]
}

Example HTTP response

Response 200

{
    "addresses": [
        "10.1.1.1/32",
        "10.1.2.0/24",
        "10.1.3.0/24"
    ]
}

8.1.13 - Set Address Group

8.1.13.1 - 1.1

put /v1/address-groups/{address_group_id}

Description

Address Group을 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathaddress_group_id
required
Address Group ID
Example : 4b18494930bf4c5dbb97a9eb2ef68fe1
stringNone
bodybody
required

AddressGroupSetRequest

Responses

HTTP CodeDescriptionSchema
200OKNone
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/address-groups/{address_group_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 = security-group 1.1"

Request body

{
    "description": "Example Description for Address Group"
}

Example HTTP response

Response 200

8.1.14 - Set Security Group

8.1.14.1 - 1.1

put /v1/security-groups/{security_group_id}

Description

Security Group을 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathsecurity_group_id
required
Security Group ID
Example :
stringNone
bodybody
required

SecurityGroupSetRequest

Responses

HTTP CodeDescriptionSchema
200OKNone
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/security-groups/{security_group_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 = security-group 1.1"

Request body

{
    "description": "Example Description for Security Group",
    "loggable": false
}

Example HTTP response

Response 200

8.1.14.2 - 1.0

put /v1/security-groups/{security_group_id}

Description

Security Group을 수정한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020270131

Parameters

TypeNameDescriptionSchemaDefault
pathsecurity_group_id
required
Security Group ID
Example :
stringNone
bodybody
required

SecurityGroupSetRequest

Responses

HTTP CodeDescriptionSchema
200OKNone
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/security-groups/{security_group_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 = security-group 1.0"

Request body

{
    "description": "Example Description for Security Group",
    "loggable": false
}

Example HTTP response

Response 200

8.1.15 - Show Address Group

8.1.15.1 - 1.1

get /v1/address-groups/{address_group_id}

Description

Address Group을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathaddress_group_id
required
Address Group ID
Example : 4b18494930bf4c5dbb97a9eb2ef68fe1
stringNone

Responses

HTTP CodeDescriptionSchema
200OKAddressGroupShowResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/address-groups/{address_group_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 = security-group 1.1"

Example HTTP response

Response 200

{
    "address_group": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "address_count": 10,
        "address_limit": 1000,
        "addresses": [
            "10.1.1.1/32",
            "10.1.2.0/24",
            "10.1.3.0/24"
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for Address Group",
        "id": "4b18494930bf4c5dbb97a9eb2ef68fe1",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleAG1",
        "state": "ACTIVE"
    }
}

8.1.16 - Show Security Group

8.1.16.1 - 1.1

get /v1/security-groups/{security_group_id}

Description

Security Group 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathsecurity_group_id
required
Security Group ID
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
200OKSecurityGroupShowResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/security-groups/{security_group_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 = security-group 1.1"

Example HTTP response

Response 200

{
    "security_group": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for Security Group",
        "id": "06e5d676-f330-485a-94e9-47ac91cce09a",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleSG1",
        "rule_count": 200,
        "state": "ACTIVE"
    }
}

8.1.16.2 - 1.0

get /v1/security-groups/{security_group_id}

Description

Security Group 상세 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020270131

Parameters

TypeNameDescriptionSchemaDefault
pathsecurity_group_id
required
Security Group ID
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
200OKSecurityGroupShowResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/security-groups/{security_group_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 = security-group 1.0"

Example HTTP response

Response 200

{
    "security_group": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for Security Group",
        "id": "06e5d676-f330-485a-94e9-47ac91cce09a",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleSG1",
        "rule_count": 200,
        "state": "ACTIVE"
    }
}

8.1.17 - Show Security Group Rule

8.1.17.1 - 1.1

get /v1/security-group-rules/{security_group_rule_id}

Description

Security Group rule을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathsecurity_group_rule_id
required
Security Group Rule ID
Example : 10d8250e-f4eb-453a-96af-b50b5b514a1a
stringNone
queryfields
optional
필드명
Example :
any of [array[object], string, null]None

Responses

HTTP CodeDescriptionSchema
200OKSecurityGroupRuleShowResponseV1Dot1
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/security-group-rules/{security_group_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 = security-group 1.1"

Example HTTP response

Response 200

{
    "security_group_rule": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for Security Group Rule",
        "direction": "Ingress",
        "ethertype": "IPv4",
        "id": "10d8250e-f4eb-453a-96af-b50b5b514a1a",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "port_range_max": 22,
        "port_range_min": 22,
        "protocol": "TCP",
        "remote_address_group_id": "4b18494930bf4c5dbb97a9eb2ef68fe1",
        "remote_address_group_name": "ExampleAG1",
        "remote_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a",
        "remote_group_name": "ExampleSG2",
        "remote_ip_prefix": "1.1.1.1/32",
        "security_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a"
    }
}

8.1.17.2 - 1.0

get /v1/security-group-rules/{security_group_rule_id}

Description

Security Group rule을 상세 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020270131

Parameters

TypeNameDescriptionSchemaDefault
pathsecurity_group_rule_id
required
Security Group Rule ID
Example : 10d8250e-f4eb-453a-96af-b50b5b514a1a
stringNone
queryfields
optional
필드명
Example :
any of [array[object], string, null]None

Responses

HTTP CodeDescriptionSchema
200OKSecurityGroupRuleShowResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/security-group-rules/{security_group_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 = security-group 1.0"

Example HTTP response

Response 200

{
    "security_group_rule": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for Security Group Rule",
        "direction": "Ingress",
        "ethertype": "IPv4",
        "id": "10d8250e-f4eb-453a-96af-b50b5b514a1a",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "port_range_max": 22,
        "port_range_min": 22,
        "protocol": "TCP",
        "remote_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a",
        "remote_group_name": "ExampleSG2",
        "remote_ip_prefix": "1.1.1.1/32",
        "security_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a"
    }
}

8.2 - Models

8.2.1 - AddressGroup

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : 0e3dffc50eb247a1adf4f2e5c82c4f99
string
address_count
optional
Address Group 대상 주소 개수
Example : 10
integer
address_limit
required
Address Group 대상 주소 최대 개수
Example : 1000
integer
addresses
required
Address Group 대상 주소
Example : ['10.1.1.1/32', '10.1.2.0/24', '10.1.3.0/24']
array[string]
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
required
설명
Example : Example Description for Address Group
any of [string, null]
id
required
Address Group ID
Example : 4b18494930bf4c5dbb97a9eb2ef68fe1
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Address Group 이름
Example : ExampleAG1
string
state
required
Address Group 상태
Example : ACTIVE
string

8.2.2 - AddressGroupCidrListResponse

NameDescriptionSchemaDefault
addresses
required
Address Group 대상 주소 목록
Example : ['10.1.1.1/32', '10.1.2.0/24', '10.1.3.0/24']
array[string]
count
optional
전체 개수
Example : 20
any of [integer, null]
links
optional
links
Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]
any of [array[object], null]

8.2.3 - AddressGroupCidrsAddRequest

NameDescriptionSchemaDefault
addresses
required
Address Group 대상 주소 목록
Example : ['10.1.1.1/32', '10.1.2.0/24', '10.1.3.0/24']
array[string]

8.2.4 - AddressGroupCreateRequest

NameDescriptionSchemaDefault
addresses
optional
Address Group 대상 주소
Example : ['10.1.1.1/32', '10.1.2.0/24', '10.1.3.0/24']
any of [array[string], null]
description
optional
Address Group 설명
Example : Example Description for Address Group
any of [string, null]
name
required
Address Group 이름
Example : ExampleAG1
string
tags
optional
태그 목록
array[Tag]

8.2.5 - AddressGroupListResponse

NameDescriptionSchemaDefault
address_groups
required

array[AddressGroup]
count
optional
전체 개수
Example : 20
any of [integer, null]
links
optional
links
Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]
any of [array[object], null]

8.2.6 - AddressGroupSetRequest

NameDescriptionSchemaDefault
description
optional
Address Group 설명
Example : Example Description for Address Group
any of [string, null]

8.2.7 - AddressGroupShowResponse

NameDescriptionSchemaDefault
address_group
required

AddressGroup

8.2.8 - SecurityGroup

NameDescriptionSchemaDefault
account_id
required
Security Group Account ID
Example : 0e3dffc50eb247a1adf4f2e5c82c4f99
string
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
required
Security Group 설명
Example : Example Description for Security Group
any of [string, null]
id
required
Security Group ID
Example : 06e5d676-f330-485a-94e9-47ac91cce09a
string
loggable
required
Security Group 로깅 여부
Example : False
boolean
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Security Group 이름
Example : ExampleSG1
string
rule_count
optional
Security Group Rule 수
Example : 200
integer
state
required
Security Group 상태
Example : ACTIVE
string

8.2.9 - SecurityGroupCreateRequest

NameDescriptionSchemaDefault
description
optional
Security Group 설명
Example : Example Description for Security Group
any of [string, null]
loggable
optional
Security Group 로깅 여부
Example : False
any of [boolean, null]
name
required
Security Group 이름
Example : ExampleSG1
Maximum length : 255
string
tags
optional
태그 목록
array[Tag]

8.2.10 - SecurityGroupListResponse

NameDescriptionSchemaDefault
count
optional
전체 개수
Example : 20
any of [integer, null]
links
optional
links
Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]
any of [array[object], null]
security_groups
required

array[SecurityGroup]

8.2.11 - SecurityGroupRule

NameDescriptionSchemaDefault
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
required
Security Group Rule 설명
Example : Example Description for Security Group Rule
any of [string, null]
direction
required
Security Group Rule 방향 (Ingress, Egress)
Example : Ingress
enum (ingress, egress)
ethertype
optional
Security Group Rule Ethertype (IPV4)
Example : IPv4
any of [string, null]IPv4
id
required
Security Group Rule ID
Example : 10d8250e-f4eb-453a-96af-b50b5b514a1a
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
port_range_max
required
Security Group Rule 포트 범위 최대값(None/1-65535). For ICMP and IP Protocol, None
Example : 22
any of [integer, null]
port_range_min
required
Security Group Rule 포트 범위 최소값(None, 1-65535). For ICMP, 0-255. For IP Protocol, None
Example : 22
any of [integer, null]
protocol
required
Security Group Rule 프로토콜 (None, TCP, UDP, ICMP, IP Protocol Number 1-254)
Example : TCP
any of [string, null]
remote_group_id
required
Security Group Rule 원격 그룹 ID
Example : 06e5d676-f330-485a-94e9-47ac91cce09a
any of [string, null]
remote_group_name
optional
Security Group Rule 원격 그룹 이름
Example : ExampleSG2
any of [string, null]
remote_ip_prefix
required
Security Group Rule IP 주소
Example : 1.1.1.1/32
any of [string, null]
security_group_id
required
Security Group ID
Example : 06e5d676-f330-485a-94e9-47ac91cce09a
string

8.2.12 - SecurityGroupRuleCreateRequest

NameDescriptionSchemaDefault
description
optional
Security Group Rule 설명
Example : Example Description for Security Group Rule
any of [string, null]
direction
required
Security Group Rule 방향 (Ingress, Egress)
Example : Ingress
string
ethertype
optional
Security Group Rule Ethertype (IPV4)
Example : IPv4
any of [string, null]IPv4
port_range_max
optional
Security Group Rule 포트 범위 최대값(None/1-65535). For ICMP and IP Protocol, None
Example : 22
any of [integer, null]
port_range_min
optional
Security Group Rule 포트 범위 최소값(None, 1-65535). For ICMP, 0-255. For IP Protocol, None
Example : 22
any of [integer, null]
protocol
optional
Security Group Rule 프로토콜 (None, TCP, UDP, ICMP, IP Protocol Number 1-254)
Example : TCP
any of [string, null]
remote_group_id
optional
Security Group Rule 원격 그룹 ID
Example : 06e5d676-f330-485a-94e9-47ac91cce09a
any of [string, null]
remote_ip_prefix
optional
Security Group Rule IP 주소
Example : 1.1.1.1/32
any of [string, null]
security_group_id
required
Security Group ID
Example : 06e5d676-f330-485a-94e9-47ac91cce09a
string

8.2.13 - SecurityGroupRuleCreateRequestV1Dot1

NameDescriptionSchemaDefault
description
optional
Security Group Rule 설명
Example : Example Description for Security Group Rule
any of [string, null]
direction
required
Security Group Rule 방향 (Ingress, Egress)
Example : Ingress
string
ethertype
optional
Security Group Rule Ethertype (IPV4)
Example : IPv4
any of [string, null]IPv4
port_range_max
optional
Security Group Rule 포트 범위 최대값(None/1-65535). For ICMP and IP Protocol, None
Example : 22
any of [integer, null]
port_range_min
optional
Security Group Rule 포트 범위 최소값(None, 1-65535). For ICMP, 0-255. For IP Protocol, None
Example : 22
any of [integer, null]
protocol
optional
Security Group Rule 프로토콜 (None, TCP, UDP, ICMP, IP Protocol Number 1-254)
Example : TCP
any of [string, null]
remote_address_group_id
optional
Security Group Rule 주소 그룹 ID
Example : 4b18494930bf4c5dbb97a9eb2ef68fe1
any of [string, null]
remote_group_id
optional
Security Group Rule 원격 그룹 ID
Example : 06e5d676-f330-485a-94e9-47ac91cce09a
any of [string, null]
remote_ip_prefix
optional
Security Group Rule IP 주소
Example : 1.1.1.1/32
any of [string, null]
security_group_id
required
Security Group ID
Example : 06e5d676-f330-485a-94e9-47ac91cce09a
string

8.2.14 - SecurityGroupRuleListResponse

NameDescriptionSchemaDefault
count
optional
전체 개수
Example : 20
any of [integer, null]
links
optional
links
Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]
any of [array[object], null]
security_group_rules
required

array[SecurityGroupRule]

8.2.15 - SecurityGroupRuleListResponseV1Dot1

NameDescriptionSchemaDefault
count
optional
전체 개수
Example : 20
any of [integer, null]
links
optional
links
Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]
any of [array[object], null]
security_group_rules
required

array[SecurityGroupRuleV1Dot1]

8.2.16 - SecurityGroupRuleShowResponse

NameDescriptionSchemaDefault
security_group_rule
required

SecurityGroupRule

8.2.17 - SecurityGroupRuleShowResponseV1Dot1

NameDescriptionSchemaDefault
security_group_rule
required

SecurityGroupRuleV1Dot1

8.2.18 - SecurityGroupRuleV1Dot1

NameDescriptionSchemaDefault
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
required
Security Group Rule 설명
Example : Example Description for Security Group Rule
any of [string, null]
direction
required
Security Group Rule 방향 (Ingress, Egress)
Example : Ingress
enum (ingress, egress)
ethertype
optional
Security Group Rule Ethertype (IPV4)
Example : IPv4
any of [string, null]IPv4
id
required
Security Group Rule ID
Example : 10d8250e-f4eb-453a-96af-b50b5b514a1a
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
port_range_max
required
Security Group Rule 포트 범위 최대값(None/1-65535). For ICMP and IP Protocol, None
Example : 22
any of [integer, null]
port_range_min
required
Security Group Rule 포트 범위 최소값(None, 1-65535). For ICMP, 0-255. For IP Protocol, None
Example : 22
any of [integer, null]
protocol
required
Security Group Rule 프로토콜 (None, TCP, UDP, ICMP, IP Protocol Number 1-254)
Example : TCP
any of [string, null]
remote_address_group_id
required
Address Group ID
Example : 4b18494930bf4c5dbb97a9eb2ef68fe1
any of [string, null]
remote_address_group_name
required
Address Group 이름
Example : ExampleAG1
any of [string, null]
remote_group_id
required
Security Group Rule 원격 그룹 ID
Example : 06e5d676-f330-485a-94e9-47ac91cce09a
any of [string, null]
remote_group_name
optional
Security Group Rule 원격 그룹 이름
Example : ExampleSG2
any of [string, null]
remote_ip_prefix
required
Security Group Rule IP 주소
Example : 1.1.1.1/32
any of [string, null]
security_group_id
required
Security Group ID
Example : 06e5d676-f330-485a-94e9-47ac91cce09a
string

8.2.19 - SecurityGroupSetRequest

NameDescriptionSchemaDefault
description
optional
Security Group 설명
Example : Example Description for Security Group
any of [string, null]
loggable
optional
Security Group 로깅 여부
Example : False
any of [boolean, null]

8.2.20 - SecurityGroupShowResponse

NameDescriptionSchemaDefault
security_group
required

SecurityGroup

8.2.21 - Tag

NameDescriptionSchemaDefault
key
required
tag key
Example :
string
value
required
tag value
Example :
string

9 - VPC

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 VPC 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

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

VersionStatusNot Before
1.3CURRENT-
1.2SUPPORTED20270131
1.1SUPPORTED20261130
1.0DEPRECATED20251231

OpenAPI URL

https://vpc.{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.3

Multi AZ 기능이 추가됩니다.

변경사항

  • [변경] POST /v1/vpcs - 응답 시, 아래와 같은 필드가 추가됩니다.
    • 추가 : zones, zone_type
  • [변경] GET /v1/vpcs - 요청 및 응답 시, 아래와 같은 필드가 추가됩니다.
    • 추가 : zone, zones, zone_type
  • [변경] GET /v1/vpcs/{vpc_id} - 응답 시, 아래와 같은 필드가 추가됩니다.
    • 추가 : zones, zone_type
  • [변경] PUT /v1/vpcs/{vpc_id} - 응답 시, description 필드 외 모두 제거됩니다.
  • [변경] POST /v1/vpcs/{vpc_id}/cidrs - 응답 시, cidr 필드 외 모두 제거됩니다.
  • [변경] POST /v1/subnets - 요청 및 응답 시, 아래와 같은 필드가 추가/변경됩니다.
    • 추가 : zones, role, primary_subnet_id, secondary_subnet_ids
    • 변경 : type의 boundary value 변경 및 추가(General -> Public 으로 변경, Private 신규)
  • [변경] GET /v1/subnets - 요청 및 응답 시, 아래와 같은 필드가 추가/변경됩니다.
    • 추가 : zones, role, primary_subnet_id
    • 변경 : type의 boundary value 변경 및 추가(General -> Public 으로 변경, Private 신규)
  • [변경] GET /v1/subnets/{subnet_id} - 응답 시, 아래와 같은 필드가 추가/변경됩니다.
    • 추가 : zones, role, primary_subnet_id, secondary_subnet_ids
    • 변경 : type의 boundary value 변경 및 추가(General -> Public 으로 변경, Private 신규)
  • [변경] PUT /v1/subnets/{subnet_id} - 응답 시, description, dhcp_ip_address 필드 외 모두 제거됩니다.
  • [변경] POST /v1/internet-gateways - 응답 시, 아래와 같은 필드가 추가됩니다.
    • 추가 : multi_zone_enabled
  • [변경] GET /v1/internet-gateways - 응답 시, 아래와 같은 필드가 추가됩니다.
    • 추가 : multi_zone_enabled
  • [변경] GET /v1/internet-gateways/{internet_gateway_id} - 응답 시, 아래와 같은 필드가 추가됩니다.
    • 추가 : multi_zone_enabled
  • [변경] PUT /v1/internet-gateways/{internet_gateway_id} - 응답 시, description, loggable 필드 외 모두 제거됩니다.
  • [변경] POST /v1/nat-gateways - 요청 및 응답 시, 아래와 같은 필드가 추가/변경됩니다.
    • 추가 : publicip_ids, multi_zone_enabled, nat_gateway_ip_addresses
    • 제거 : publicip_id, nat_gateway_ip_address
  • [변경] GET /v1/nat-gateways - 응답 시, 아래와 같은 필드가 추가/변경됩니다.
    • 추가 : multi_zone_enabled, nat_gateway_ip_addresses
    • 제거 : nat_gateway_ip_address
  • [변경] GET /v1/nat-gateways/{nat_gateway_id} - 응답 시, 아래와 같은 필드가 추가/변경됩니다.
    • 추가 : multi_zone_enabled, nat_gateway_ip_addresses
    • 제거 : nat_gateway_ip_address
  • [변경] PUT /v1/nat-gateways/{nat_gateway_id} - 응답 시, description 필드 외 모두 제거됩니다.
  • [변경] POST /v1/publicips - 요청 및 응답 시, 아래와 같은 필드가 추가됩니다.
    • 추가 : zone
  • [변경] GET /v1/publicips - 요청 및 응답 시, 아래와 같은 필드가 추가됩니다.
    • 추가 : zone
  • [변경] GET /v1/publicips/{publicip_id} - 응답 시, 아래와 같은 필드가 추가됩니다.
    • 추가 : zone
  • [변경] PUT /v1/publicips/{publicip_id} - 응답 시, description 필드 외 모두 제거됩니다.
  • [변경] GET /v1/transit-gateways - 요청 시, 아래와 같은 필드가 추가됩니다.
    • 추가 : uplink_zone_state
  • [변경] POST /v1/transit-gateways - 응답 시, 아래와 같은 필드가 추가됩니다.
    • 추가 : uplink_active_zone, uplink_standby_zone, uplink_zone_state
  • [변경] GET /v1/transit-gateways/{transit_gateway_id} - 응답 시, 아래와 같은 필드가 추가됩니다.
    • 추가 : uplink_active_zone, uplink_standby_zone, uplink_zone_state
  • [변경] PUT /v1/transit-gateways/{transit_gateway_id} - 응답 시, description 필드 외 모두 제거됩니다.
  • [변경] POST /v1/transit-gateways/{transit_gateway_id}/firewall-connections - 응답 시, firewall_connection_state 필드 외 모두 제거됩니다.
  • [변경] DELETE /v1/transit-gateways/{transit_gateway_id}/firewall-connections - 응답 시, firewall_connection_state 필드 외 모두 제거됩니다.
  • [변경] POST /v1/transit-gateways/{transit_gateway_id}/firewalls - 요청 및 응답 시, 아래와 같은 필드가 추가됩니다.
    • 추가 : uplink_active_zone, uplink_standby_zone, uplink_zone_state
  • [변경] DELETE /v1/transit-gateways/{transit_gateway_id}/firewalls/{firewall_id} - 응답 시, 아래와 같은 필드가 추가됩니다.
    • 추가 : uplink_active_zone, uplink_standby_zone, uplink_zone_state

1.2

Virtual IP 기능 및 Transit Gateway Firewall 연결 기능이 추가되었습니다.

변경사항

  • [신규] GET /v1/subnets/{subnet_id}/vips - api가 추가되었습니다.
  • [신규] POST /v1/subnets/{subnet_id}/vips - api가 추가되었습니다.
  • [신규] GET /v1/subnets/{subnet_id}/vips/{vip_id} - api가 추가되었습니다.
  • [신규] PUT /v1/subnets/{subnet_id}/vips/{vip_id} - api가 추가되었습니다.
  • [신규] DELETE /v1/subnets/{subnet_id}/vips/{vip_id} - api가 추가되었습니다.
  • [신규] POST /v1/subnets/{subnet_id}/vips/{vip_id}/connected-ports - api가 추가되었습니다.
  • [신규] DELETE /v1/subnets/{subnet_id}/vips/{vip_id}/connected-ports/{connected_port_id} - api가 추가되었습니다.
  • [신규] POST /v1/subnets/{subnet_id}/vips/{vip_id}/static-nat-ips - api가 추가되었습니다.
  • [신규] DELETE /v1/subnets/{subnet_id}/vips/{vip_id}/static-nat-ips/{static_nat_id} - api가 추가되었습니다.
  • [신규] POST /v1/transit-gateways/{transit_gateway_id}/firewall-connections - api가 추가되었습니다.
  • [신규] DELETE /v1/transit-gateways/{transit_gateway_id}/firewall-connections - api가 추가되었습니다.
  • [신규] POST /v1/transit-gateways/{transit_gateway_id}/firewalls - api가 추가되었습니다.
  • [신규] DELETE /v1/transit-gateways/{transit_gateway_id}/firewalls/{firewall_id} - api가 추가되었습니다.
  • [신규] POST /v1/vpcs/{vpc_id}/cidrs - api가 추가되었습니다.
  • [변경] GET /v1/vpcs - 요청 및 응답 시, 아래와 같은 필드가 추가/변경됩니다.
    • 추가 : size, page, cidr_count, cidrs
    • 제거 : limit, marker, cidr
  • [변경] GET /v1/vpcs/{vpc_id} - 응답 시, 아래와 같은 필드가 추가/변경됩니다.
    • 추가 : cidr_count, cidrs
    • 제거 : cidr
  • [변경] : POST /v1/vpcs - 응답 시, 아래와 같은 필드가 추가/변경됩니다.
    • 추가 : cidr_count, cidrs
    • 제거 : cidr
  • [변경] : PUT /v1/vpcs/{vpc_id} - 응답 시, 아래와 같은 필드가 추가/변경됩니다.
    • 추가 : cidr_count, cidrs
    • 제거 : cidr
  • [변경] : GET /v1/subnets - 요청 및 응답 시, 아래와 같은 필드가 추가/변경됩니다.
    • 추가 : size, page
    • 제거 : limit, marker
  • [변경] : GET /v1/subnets/{subnet_id} - 응답 시, 아래와 같은 필드가 추가됩니다.
    • 추가 : dhcp_ip_addres
  • [변경] : POST /v1/subnets - 요청 시, 아래와 같은 필드가 추가됩니다.
    • 추가 : gateway_ip_address
  • [변경] : PUT /v1/subnets/{subnet_id} - 요청 시, 아래와 같은 필드가 추가됩니다.
    • 추가 : dhcp_ip_address
  • [변경] : GET /v1/ports - 요청 시, 아래와 같은 필드가 추가됩니다.
    • 추가 : attached_resource_types
  • [변경] : GET /v1/ports/{port_id} - 응답 시, 아래와 같은 필드가 추가됩니다.
    • 추가 : virtual_ip_addresses
  • [변경] : POST /v1/ports - 응답 시, 아래와 같은 필드가 추가됩니다.
    • 추가 : virtual_ip_addresses
  • [변경] : PUT /v1/ports/{port_id} - 응답 시, 아래와 같은 필드가 추가됩니다.
    • 추가 : virtual_ip_addresses
  • [변경] : GET /v1/internet-gateways - 요청 및 응답 시, 아래와 같은 필드가 추가/변경됩니다.
    • 추가 : size, page
    • 제거 : limit, marker
  • [변경] : GET /v1/nat-gateways - 요청 및 응답 시, 아래와 같은 필드가 추가/변경됩니다.
    • 추가 : size, page
    • 제거 : limit, marker
  • [변경] : GET /v1/publicips - 요청 및 응답 시, 아래와 같은 필드가 추가/변경됩니다.
    • 추가 : size, page
    • 제거 : limit, marker
  • [변경] : GET /v1/publicips/{publicip_id} - attached_resource_type 필드의 Boundary Value가 확장 되었습니다.
  • [변경] : GET /v1/vpc-endpoints - 요청 및 응답 시, 아래와 같은 필드가 추가/변경됩니다.
    • 추가 : size, page
    • 제거 : limit, marker
  • [변경] : GET /v1/private-nats - 요청 및 응답 시, 아래와 같은 필드가 추가되며 vpc, dcon 관련 필드는 제거됩니다.
    • 추가 : service_type, service_resource_id, service_resource_name
  • [변경] : GET /v1/private-nats/{private_nat_id} - 요청 및 응답 시, 아래와 같은 필드가 추가되며 vpc, dcon 관련 필드는 제거됩니다.
    • 추가 : service_type, service_resource_id, service_resource_name
  • [변경] : POST /v1/private-nats - 요청 및 응답 시, 아래와 같은 필드가 추가되며 vpc, dcon 관련 필드는 제거됩니다.
    • 추가 : service_type, service_resource_id, service_resource_name
  • [변경] : PUT /v1/private-nats/{private_nat_id} - 요청 및 응답 시, 아래와 같은 필드가 추가되며 vpc, dcon 관련 필드는 제거됩니다.
    • 추가 : service_type, service_resource_id, service_resource_name
  • [변경] : GET /v1/vpc-peerings/{vpc_peering_id}/routing-rules - 요청 시, 아래와 같은 필드가 변경됩니다.
    • 제거 : name
  • [변경] : GET /v1/transit-gateways - 요청 및 응답 시, 아래와 같은 필드가 추가됩니다.
    • 추가 : firewall_connection_state
  • [변경] : GET /v1/transit-gateways/{transit_gateway_id} - 응답 시, 아래와 같은 필드가 추가됩니다.
    • 추가 : firewall_connection_state
  • [변경] : POST /v1/transit-gateways - 응답 시, 아래와 같은 필드가 추가됩니다.
    • 추가 : firewall_connection_state
  • [변경] : PUT /v1/transit-gateways/{transit_gateway_id} - 응답 시, 아래와 같은 필드가 추가됩니다.
    • 추가 : firewall_connection_state
  • [변경] : GET /v1/transit-gateways/{transit_gateway_id}/routing-rules - 요청 및 응답 시, 아래와 같은 필드가 추가됩니다.
    • 추가 : rule_type

1.1

VPC API가 출시되었습니다.

변경사항

  • [신규] GET /v1/privatelink-endpoints - api가 추가되었습니다.
  • [신규] POST /v1/privatelink-endpoints - api가 추가되었습니다.
  • [신규] GET /v1/privatelink-endpoints/{privatelink_endpoint_id} - api가 추가되었습니다.
  • [신규] PUT /v1/privatelink-endpoints/{privatelink_endpoint_id} - api가 추가되었습니다.
  • [신규] DELETE /v1/privatelink-endpoints/{privatelink_endpoint_id} - api가 추가되었습니다.
  • [신규] PUT /v1/privatelink-endpoints/{privatelink_endpoint_id}/approval - api가 추가되었습니다.
  • [신규] PUT /v1/privatelink-endpoints/{privatelink_endpoint_id}/connection - api가 추가되었습니다.
  • [신규] PUT /v1/privatelink-endpoints/{privatelink_endpoint_id}/request - api가 추가되었습니다.
  • [신규] GET /v1/privatelink-services - api가 추가되었습니다.
  • [신규] POST /v1/privatelink-services - api가 추가되었습니다.
  • [신규] GET /v1/privatelink-services/{privatelink_service_id} - api가 추가되었습니다.
  • [신규] PUT /v1/privatelink-services/{privatelink_service_id} - api가 추가되었습니다.
  • [신규] DELETE /v1/privatelink-services/{privatelink_service_id} - api가 추가되었습니다.
  • [신규] GET /v1/privatelink-services/{privatelink_service_id}/connected-endpoints - api가 추가되었습니다.
  • [신규] PUT /v1/vpc-peerings/{vpc_peering_id}/approval - api가 추가되었습니다.
  • [신규] GET /v1/subnets/{subnet_id}/sap-secondary-subnets - api가 추가되었습니다.

1.0

VPC API가 출시되었습니다.

변경사항

  • [신규] GET /v1/internet-gateways - api가 추가되었습니다.
  • [신규] POST /v1/internet-gateways - api가 추가되었습니다.
  • [신규] GET /v1/internet-gateways/{internet_gateway_id} - api가 추가되었습니다.
  • [신규] PUT /v1/internet-gateways/{internet_gateway_id} - api가 추가되었습니다.
  • [신규] DELETE /v1/internet-gateways/{internet_gateway_id} - api가 추가되었습니다.
  • [신규] GET /v1/nat-gateways - api가 추가되었습니다.
  • [신규] POST /v1/nat-gateways - api가 추가되었습니다.
  • [신규] GET /v1/nat-gateways/{nat_gateway_id} - api가 추가되었습니다.
  • [신규] PUT /v1/nat-gateways/{nat_gateway_id} - api가 추가되었습니다.
  • [신규] DELETE /v1/nat-gateways/{nat_gateway_id} - api가 추가되었습니다.
  • [신규] GET /v1/ports - api가 추가되었습니다.
  • [신규] POST /v1/ports - api가 추가되었습니다.
  • [신규] GET /v1/ports/{port_id} - api가 추가되었습니다.
  • [신규] PUT /v1/ports/{port_id} - api가 추가되었습니다.
  • [신규] DELETE /v1/ports/{port_id} - api가 추가되었습니다.
  • [신규] GET /v1/private-nats - api가 추가되었습니다.
  • [신규] POST /v1/private-nats - api가 추가되었습니다.
  • [신규] GET /v1/private-nats/{private_nat_id} - api가 추가되었습니다.
  • [신규] PUT /v1/private-nats/{private_nat_id} - api가 추가되었습니다.
  • [신규] DELETE /v1/private-nats/{private_nat_id} - api가 추가되었습니다.
  • [신규] GET /v1/private-nats/{private_nat_id}/private-nat-ips - api가 추가되었습니다.
  • [신규] POST /v1/private-nats/{private_nat_id}/private-nat-ips - api가 추가되었습니다.
  • [신규] DELETE /v1/private-nats/{private_nat_id}/private-nat-ips/{private_nat_ip_id} - api가 추가되었습니다.
  • [신규] GET /v1/publicips - api가 추가되었습니다.
  • [신규] POST /v1/publicips - api가 추가되었습니다.
  • [신규] GET /v1/publicips/{publicip_id} - api가 추가되었습니다.
  • [신규] PUT /v1/publicips/{publicip_id} - api가 추가되었습니다.
  • [신규] DELETE /v1/publicips/{publicip_id} - api가 추가되었습니다.
  • [신규] GET /v1/subnets - api가 추가되었습니다.
  • [신규] POST /v1/subnets - api가 추가되었습니다.
  • [신규] GET /v1/subnets/{subnet_id} - api가 추가되었습니다.
  • [신규] PUT /v1/subnets/{subnet_id} - api가 추가되었습니다.
  • [신규] DELETE /v1/subnets/{subnet_id} - api가 추가되었습니다.
  • [신규] GET /v1/transit-gateways - api가 추가되었습니다.
  • [신규] POST /v1/transit-gateways - api가 추가되었습니다.
  • [신규] GET /v1/transit-gateways/{transit_gateway_id} - api가 추가되었습니다.
  • [신규] PUT /v1/transit-gateways/{transit_gateway_id} - api가 추가되었습니다.
  • [신규] DELETE /v1/transit-gateways/{transit_gateway_id} - api가 추가되었습니다.
  • [신규] GET /v1/transit-gateways/{transit_gateway_id}/routing-rules - api가 추가되었습니다.
  • [신규] POST /v1/transit-gateways/{transit_gateway_id}/routing-rules - api가 추가되었습니다.
  • [신규] DELETE /v1/transit-gateways/{transit_gateway_id}/routing-rules/{routing_rule_id} - api가 추가되었습니다.
  • [신규] POST /v1/transit-gateways/{transit_gateway_id}/uplink-routing-rules - api가 추가되었습니다.
  • [신규] DELETE /v1/transit-gateways/{transit_gateway_id}/uplink-routing-rules/{routing_rule_id} - api가 추가되었습니다.
  • [신규] GET /v1/transit-gateways/{transit_gateway_id}/vpc-connections - api가 추가되었습니다.
  • [신규] POST /v1/transit-gateways/{transit_gateway_id}/vpc-connections - api가 추가되었습니다.
  • [신규] DELETE /v1/transit-gateways/{transit_gateway_id}/vpc-connections/{vpc_connection_id} - api가 추가되었습니다.
  • [신규] GET /v1/vpc-endpoints - api가 추가되었습니다.
  • [신규] POST /v1/vpc-endpoints - api가 추가되었습니다.
  • [신규] GET /v1/vpc-endpoints/connectable-resources - api가 추가되었습니다.
  • [신규] GET /v1/vpc-endpoints/{vpc_endpoint_id} - api가 추가되었습니다.
  • [신규] PUT /v1/vpc-endpoints/{vpc_endpoint_id} - api가 추가되었습니다.
  • [신규] DELETE /v1/vpc-endpoints/{vpc_endpoint_id} - api가 추가되었습니다.
  • [신규] GET /v1/vpc-peerings - api가 추가되었습니다.
  • [신규] POST /v1/vpc-peerings - api가 추가되었습니다.
  • [신규] GET /v1/vpc-peerings/{vpc_peering_id} - api가 추가되었습니다.
  • [신규] PUT /v1/vpc-peerings/{vpc_peering_id} - api가 추가되었습니다.
  • [신규] DELETE /v1/vpc-peerings/{vpc_peering_id} - api가 추가되었습니다.
  • [신규] GET /v1/vpc-peerings/{vpc_peering_id}/routing-rules - api가 추가되었습니다.
  • [신규] POST /v1/vpc-peerings/{vpc_peering_id}/routing-rules - api가 추가되었습니다.
  • [신규] DELETE /v1/vpc-peerings/{vpc_peering_id}/routing-rules/{routing_rule_id} - api가 추가되었습니다.
  • [신규] GET /v1/vpcs - api가 추가되었습니다.
  • [신규] POST /v1/vpcs - api가 추가되었습니다.
  • [신규] GET /v1/vpcs/{vpc_id} - api가 추가되었습니다.
  • [신규] PUT /v1/vpcs/{vpc_id} - api가 추가되었습니다.
  • [신규] DELETE /v1/vpcs/{vpc_id} - api가 추가되었습니다.

9.1 - APIs

9.1.1 - Add VPC CIDR

9.1.1.1 - 1.3

post /v1/vpcs/{vpc_id}/cidrs

Description

VPC Cidr 추가

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_id
required
VPC ID
Example :
stringNone
bodybody
required

VpcCidrCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedVpcCidrCreateResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpcs/{vpc_id}/cidrs

Request header

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

Request body

{
    "cidr": "192.167.0.0/18"
}

Example HTTP response

Response 201

{
    "cidr": "192.167.0.0/18"
}

9.1.1.2 - 1.2

post /v1/vpcs/{vpc_id}/cidrs

Description

VPC Cidr 추가

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_id
required
VPC ID
Example :
stringNone
bodybody
required

VpcCidrCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedVpcShowResponseV1Dot2
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpcs/{vpc_id}/cidrs

Request header

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

Request body

{
    "cidr": "192.167.0.0/18"
}

Example HTTP response

Response 201

{
    "vpc": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr_count": 20,
        "cidrs": [
            {
                "cidr": "192.167.0.0/18",
                "created_at": "2024-05-17T00:23:17Z",
                "created_by": "7df8abb4912e4709b1cb237daccca7a8",
                "id": "7df8abb4912e4709b1cb237daccca7a8"
            }
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "vpcDescription",
        "id": "7df8abb4912e4709b1cb237daccca7a8",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcName",
        "state": "CREATING"
    }
}

9.1.2 - Approval VPC Peering

9.1.2.1 - 1.3

put /v1/vpc-peerings/{vpc_peering_id}/approval

Description

VPC Peering 승인

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_peering_id
required
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
stringNone
bodybody
required

VpcPeeringApprovalRequest

Responses

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

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_id}/approval

Request header

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

Request body

{
    "type": "CREATE_APPROVE"
}

Example HTTP response

Response 200

{
    "vpc_peering": {
        "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"
    }
}

9.1.2.2 - 1.2

put /v1/vpc-peerings/{vpc_peering_id}/approval

Description

VPC Peering 승인

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_peering_id
required
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
stringNone
bodybody
required

VpcPeeringApprovalRequest

Responses

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

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_id}/approval

Request header

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

Request body

{
    "type": "CREATE_APPROVE"
}

Example HTTP response

Response 200

{
    "vpc_peering": {
        "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"
    }
}

9.1.2.3 - 1.1

put /v1/vpc-peerings/{vpc_peering_id}/approval

Description

VPC Peering 승인

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_peering_id
required
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
stringNone
bodybody
required

VpcPeeringApprovalRequest

Responses

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

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_id}/approval

Request header

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

Request body

{
    "type": "CREATE_APPROVE"
}

Example HTTP response

Response 200

{
    "vpc_peering": {
        "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"
    }
}

9.1.3 - Approve PrivateLink Endpoint

9.1.3.1 - 1.3

put /v1/privatelink-endpoints/{privatelink_endpoint_id}/approval

Description

Approve PrivateLink Endpoint

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_endpoint_id
required
PrivateLink Endpoint ID
Example : bba6d4de3ad64e41b3a1b6c88983ec02
stringNone
bodybody
required

PrivateLinkEndpointApprovalRequest

Responses

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

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_id}/approval

Request header

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

Request body

{
    "type": "APPROVE"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "created_at": "2024-06-16T02:55:13Z",
        "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
        "state": "ACTIVE"
    }
}

9.1.3.2 - 1.2

put /v1/privatelink-endpoints/{privatelink_endpoint_id}/approval

Description

Approve PrivateLink Endpoint

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_endpoint_id
required
PrivateLink Endpoint ID
Example : bba6d4de3ad64e41b3a1b6c88983ec02
stringNone
bodybody
required

PrivateLinkEndpointApprovalRequest

Responses

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

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_id}/approval

Request header

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

Request body

{
    "type": "APPROVE"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "created_at": "2024-06-16T02:55:13Z",
        "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
        "state": "ACTIVE"
    }
}

9.1.3.3 - 1.1

put /v1/privatelink-endpoints/{privatelink_endpoint_id}/approval

Description

Approve PrivateLink Endpoint

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_endpoint_id
required
PrivateLink Endpoint ID
Example : bba6d4de3ad64e41b3a1b6c88983ec02
stringNone
bodybody
required

PrivateLinkEndpointApprovalRequest

Responses

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

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_id}/approval

Request header

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

Request body

{
    "type": "APPROVE"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "created_at": "2024-06-16T02:55:13Z",
        "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
        "state": "ACTIVE"
    }
}

9.1.4 - Connect PrivateLink Endpoint

9.1.4.1 - 1.3

put /v1/privatelink-endpoints/{privatelink_endpoint_id}/connection

Description

Connect PrivateLink Endpoint

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_endpoint_id
required
PrivateLink Endpoint ID
Example : bba6d4de3ad64e41b3a1b6c88983ec02
stringNone
bodybody
required

PrivateLinkEndpointConnectionRequest

Responses

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

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_id}/connection

Request header

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

Request body

{
    "type": "DISCONNECT"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "created_at": "2024-06-16T02:55:13Z",
        "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
        "state": "ACTIVE"
    }
}

9.1.4.2 - 1.2

put /v1/privatelink-endpoints/{privatelink_endpoint_id}/connection

Description

Connect PrivateLink Endpoint

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_endpoint_id
required
PrivateLink Endpoint ID
Example : bba6d4de3ad64e41b3a1b6c88983ec02
stringNone
bodybody
required

PrivateLinkEndpointConnectionRequest

Responses

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

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_id}/connection

Request header

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

Request body

{
    "type": "DISCONNECT"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "created_at": "2024-06-16T02:55:13Z",
        "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
        "state": "ACTIVE"
    }
}

9.1.4.3 - 1.1

put /v1/privatelink-endpoints/{privatelink_endpoint_id}/connection

Description

Connect PrivateLink Endpoint

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_endpoint_id
required
PrivateLink Endpoint ID
Example : bba6d4de3ad64e41b3a1b6c88983ec02
stringNone
bodybody
required

PrivateLinkEndpointConnectionRequest

Responses

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

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_id}/connection

Request header

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

Request body

{
    "type": "DISCONNECT"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "created_at": "2024-06-16T02:55:13Z",
        "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
        "state": "ACTIVE"
    }
}

9.1.5 - Connect Subnet VIP Port

9.1.5.1 - 1.3

post /v1/subnets/{subnet_id}/vips/{vip_id}/connected-ports

Description

Subnet Vip Port 연결

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone
pathvip_id
required
Subnet Vip Id
Example : 0466a9448d9a4411a86055939e451c8f
stringNone
bodybody
required

VipPortRequest

Responses

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

Example HTTP request

Request path

/v1/subnets/{subnet_id}/vips/{vip_id}/connected-ports

Request header

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

Request body

{
    "port_id": "35268a9f2eda4cde83b1d85c1f61f67d"
}

Example HTTP response

Response 201

{
    "id": "35268a9f2eda4cde83b1d85c1f61f67d",
    "subnet_vip_id": "0466a9448d9a4411a86055939e451c8f"
}

9.1.5.2 - 1.2

post /v1/subnets/{subnet_id}/vips/{vip_id}/connected-ports

Description

Subnet Vip Port 연결

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone
pathvip_id
required
Subnet Vip Id
Example : 0466a9448d9a4411a86055939e451c8f
stringNone
bodybody
required

VipPortRequest

Responses

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

Example HTTP request

Request path

/v1/subnets/{subnet_id}/vips/{vip_id}/connected-ports

Request header

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

Request body

{
    "port_id": "35268a9f2eda4cde83b1d85c1f61f67d"
}

Example HTTP response

Response 201

{
    "id": "35268a9f2eda4cde83b1d85c1f61f67d",
    "subnet_vip_id": "0466a9448d9a4411a86055939e451c8f"
}

9.1.6 - Create Internet Gateway

9.1.6.1 - 1.3

post /v1/internet-gateways

Description

Internet Gateway를 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

InternetGatewayCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedInternetGatewayShowResponseV1Dot3
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/internet-gateways

Request header

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

Request body

{
    "description": "Internet Gateway Description",
    "firewall_enabled": false,
    "firewall_loggable": false,
    "tags": [],
    "type": "IGW",
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "internet_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Internet Gateway Description",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "023c57b14f11483689338d085e061492",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "multi_zone_enabled": true,
        "name": "IGW_VPCname",
        "state": "CREATING",
        "type": "IGW",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.6.2 - 1.2

post /v1/internet-gateways

Description

Internet Gateway를 생성한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

InternetGatewayCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedInternetGatewayShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/internet-gateways

Request header

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

Request body

{
    "description": "Internet Gateway Description",
    "firewall_enabled": false,
    "firewall_loggable": false,
    "tags": [],
    "type": "IGW",
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "internet_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Internet Gateway Description",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "023c57b14f11483689338d085e061492",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "IGW_VPCname",
        "state": "CREATING",
        "type": "IGW",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.6.3 - 1.1

post /v1/internet-gateways

Description

Internet Gateway를 생성한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

InternetGatewayCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedInternetGatewayShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/internet-gateways

Request header

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

Request body

{
    "description": "Internet Gateway Description",
    "firewall_enabled": false,
    "firewall_loggable": false,
    "tags": [],
    "type": "IGW",
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "internet_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Internet Gateway Description",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "023c57b14f11483689338d085e061492",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "IGW_VPCname",
        "state": "CREATING",
        "type": "IGW",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.6.4 - 1.0

post /v1/internet-gateways

Description

Internet Gateway를 생성한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

InternetGatewayCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedInternetGatewayShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/internet-gateways

Request header

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

Request body

{
    "description": "Internet Gateway Description",
    "firewall_enabled": false,
    "firewall_loggable": false,
    "tags": [],
    "type": "IGW",
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "internet_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Internet Gateway Description",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "023c57b14f11483689338d085e061492",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "IGW_VPCname",
        "state": "CREATING",
        "type": "IGW",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.7 - Create NAT Gateway

9.1.7.1 - 1.3

post /v1/nat-gateways

Description

NAT Gateway를 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

NatGatewayCreateRequestV1Dot3

Responses

HTTP CodeDescriptionSchema
202AcceptedNatGatewayShowResponseV1Dot3
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/nat-gateways

Request header

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

Request body

{
    "description": "VpcEndpoint Description",
    "multi_zone_enabled": "true",
    "publicip_ids": [
        "12f56e27070248a6a240a497e43fbe18",
        "24f56e27070248a6a240a497e43fbe18"
    ],
    "subnet_id": "023c57b14f11483689338d085e061492",
    "tags": "[{'key': 'key', 'value': 'value'}]"
}

Example HTTP response

Response 202

{
    "nat_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "VpcEndpoint Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "multi_zone_enabled": "true",
        "name": "NatGatewayName",
        "nat_gateway_ips": [
            {
                "ip_address": "192.167.0.5",
                "publicip_id": "12f56e27070248a6a240a497e43fbe18"
            }
        ],
        "state": "ACTIVE",
        "subnet_cidr": "192.167.1.0/24",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.7.2 - 1.2

post /v1/nat-gateways

Description

NAT Gateway를 생성한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

NatGatewayCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedNatGatewayShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/nat-gateways

Request header

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

Request body

{
    "description": "VpcEndpoint Description",
    "publicip_id": "12f56e27070248a6a240a497e43fbe18",
    "subnet_id": "023c57b14f11483689338d085e061492",
    "tags": "[{'key': 'key', 'value': 'value'}]"
}

Example HTTP response

Response 202

{
    "nat_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "VpcEndpoint Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "NatGatewayName",
        "nat_gateway_ip_address": "192.167.0.5",
        "publicip_id": "12f56e27070248a6a240a497e43fbe18",
        "state": "ACTIVE",
        "subnet_cidr": "192.167.1.0/24",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.7.3 - 1.1

post /v1/nat-gateways

Description

NAT Gateway를 생성한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

NatGatewayCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedNatGatewayShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/nat-gateways

Request header

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

Request body

{
    "description": "VpcEndpoint Description",
    "publicip_id": "12f56e27070248a6a240a497e43fbe18",
    "subnet_id": "023c57b14f11483689338d085e061492",
    "tags": "[{'key': 'key', 'value': 'value'}]"
}

Example HTTP response

Response 202

{
    "nat_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "VpcEndpoint Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "NatGatewayName",
        "nat_gateway_ip_address": "192.167.0.5",
        "publicip_id": "12f56e27070248a6a240a497e43fbe18",
        "state": "ACTIVE",
        "subnet_cidr": "192.167.1.0/24",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.7.4 - 1.0

post /v1/nat-gateways

Description

NAT Gateway를 생성한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

NatGatewayCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedNatGatewayShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/nat-gateways

Request header

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

Request body

{
    "description": "VpcEndpoint Description",
    "publicip_id": "12f56e27070248a6a240a497e43fbe18",
    "subnet_id": "023c57b14f11483689338d085e061492",
    "tags": "[{'key': 'key', 'value': 'value'}]"
}

Example HTTP response

Response 202

{
    "nat_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "VpcEndpoint Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "NatGatewayName",
        "nat_gateway_ip_address": "192.167.0.5",
        "publicip_id": "12f56e27070248a6a240a497e43fbe18",
        "state": "ACTIVE",
        "subnet_cidr": "192.167.1.0/24",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.8 - Create Port

9.1.8.1 - 1.3

post /v1/ports

Description

Port를 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

PortCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedPortShowResponseV1Dot2
400Bad RequestNone
403ForbiddenNone

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 = ko-KR",
"Scp-Api-Version = vpc 1.3"

Request body

{
    "description": "Port Description",
    "fixed_ip_address": "",
    "name": "portName",
    "security_groups": [],
    "subnet_id": "",
    "tags": []
}

Example HTTP response

Response 201

{
    "port": {
        "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",
        "security_groups": [
            {
                "id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
                "name": "sgName"
            }
        ],
        "state": "",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "virtual_ip_addresses": [
            ""
        ],
        "vpc_id": "071bc63b767444c9afaab1c972d302d5",
        "vpc_name": "vpcName"
    }
}

9.1.8.2 - 1.2

post /v1/ports

Description

Port를 생성한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

PortCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedPortShowResponseV1Dot2
400Bad RequestNone
403ForbiddenNone

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 = ko-KR",
"Scp-Api-Version = vpc 1.2"

Request body

{
    "description": "Port Description",
    "fixed_ip_address": "",
    "name": "portName",
    "security_groups": [],
    "subnet_id": "",
    "tags": []
}

Example HTTP response

Response 201

{
    "port": {
        "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",
        "security_groups": [
            {
                "id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
                "name": "sgName"
            }
        ],
        "state": "",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "virtual_ip_addresses": [
            ""
        ],
        "vpc_id": "071bc63b767444c9afaab1c972d302d5",
        "vpc_name": "vpcName"
    }
}

9.1.8.3 - 1.1

post /v1/ports

Description

Port를 생성한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

PortCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedPortShowResponse
400Bad RequestNone
403ForbiddenNone

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 = ko-KR",
"Scp-Api-Version = vpc 1.1"

Request body

{
    "description": "Port Description",
    "fixed_ip_address": "",
    "name": "portName",
    "security_groups": [],
    "subnet_id": "",
    "tags": []
}

Example HTTP response

Response 201

{
    "port": {
        "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",
        "security_groups": [
            {
                "id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
                "name": "sgName"
            }
        ],
        "state": "",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "071bc63b767444c9afaab1c972d302d5",
        "vpc_name": "vpcName"
    }
}

9.1.8.4 - 1.0

post /v1/ports

Description

Port를 생성한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

PortCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedPortShowResponse
400Bad RequestNone
403ForbiddenNone

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 = ko-KR",
"Scp-Api-Version = vpc 1.0"

Request body

{
    "description": "Port Description",
    "fixed_ip_address": "",
    "name": "portName",
    "security_groups": [],
    "subnet_id": "",
    "tags": []
}

Example HTTP response

Response 201

{
    "port": {
        "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",
        "security_groups": [
            {
                "id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
                "name": "sgName"
            }
        ],
        "state": "",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "071bc63b767444c9afaab1c972d302d5",
        "vpc_name": "vpcName"
    }
}

9.1.9 - Create Private NAT

9.1.9.1 - 1.3

post /v1/private-nats

Description

Private NAT 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

PrivateNatCreateRequestV1Dot2

Responses

HTTP CodeDescriptionSchema
202AcceptedPrivateNatShowResponseV1Dot2
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/private-nats

Request header

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

Request body

{
    "cidr": "192.167.0.0/24",
    "description": "PrivateNat Description",
    "name": "PrivateNatName",
    "service_resource_id": "3f342bf9a557405b997c2cf48c89cbc2",
    "service_type": "DIRECT_CONNECT",
    "tags": "[{'key': 'key', 'value': 'value'}]"
}

Example HTTP response

Response 202

{
    "private_nat": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateNat Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "PrivateNatName",
        "service_resource_id": "3f342bf9a557405b997c2cf48c89cbc2",
        "service_resource_name": "PrivateNatName",
        "service_type": "DIRECT_CONNECT",
        "state": "ACTIVE"
    }
}

9.1.9.2 - 1.2

post /v1/private-nats

Description

Private NAT 생성

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

PrivateNatCreateRequestV1Dot2

Responses

HTTP CodeDescriptionSchema
202AcceptedPrivateNatShowResponseV1Dot2
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/private-nats

Request header

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

Request body

{
    "cidr": "192.167.0.0/24",
    "description": "PrivateNat Description",
    "name": "PrivateNatName",
    "service_resource_id": "3f342bf9a557405b997c2cf48c89cbc2",
    "service_type": "DIRECT_CONNECT",
    "tags": "[{'key': 'key', 'value': 'value'}]"
}

Example HTTP response

Response 202

{
    "private_nat": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateNat Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "PrivateNatName",
        "service_resource_id": "3f342bf9a557405b997c2cf48c89cbc2",
        "service_resource_name": "PrivateNatName",
        "service_type": "DIRECT_CONNECT",
        "state": "ACTIVE"
    }
}

9.1.9.3 - 1.1

post /v1/private-nats

Description

Private NAT 생성

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

PrivateNatCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedPrivateNatShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/private-nats

Request header

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

Request body

{
    "cidr": "192.167.0.0/24",
    "description": "PrivateNat Description",
    "direct_connect_id": "fe860e0af0c04dcd8182b84f907f31f4",
    "name": "PrivateNatName",
    "tags": "[{'key': 'key', 'value': 'value'}]"
}

Example HTTP response

Response 202

{
    "private_nat": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateNat Description",
        "direct_connect_id": "fe860e0af0c04dcd8182b84f907f31f4",
        "direct_connect_name": "DirectConnectName",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "PrivateNatName",
        "state": "ACTIVE",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.9.4 - 1.0

post /v1/private-nats

Description

Private NAT 생성

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

PrivateNatCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedPrivateNatShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/private-nats

Request header

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

Request body

{
    "cidr": "192.167.0.0/24",
    "description": "PrivateNat Description",
    "direct_connect_id": "fe860e0af0c04dcd8182b84f907f31f4",
    "name": "PrivateNatName",
    "tags": "[{'key': 'key', 'value': 'value'}]"
}

Example HTTP response

Response 202

{
    "private_nat": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateNat Description",
        "direct_connect_id": "fe860e0af0c04dcd8182b84f907f31f4",
        "direct_connect_name": "DirectConnectName",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "PrivateNatName",
        "state": "ACTIVE",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.10 - Create Private NAT IP

9.1.10.1 - 1.3

post /v1/private-nats/{private_nat_id}/private-nat-ips

Description

Private NAT IP 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_nat_id
required
Private NAT ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone
bodybody
required

PrivateNatIpCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedPrivateNatIpShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/private-nats/{private_nat_id}/private-nat-ips

Request header

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

Request body

{
    "ip_address": ""
}

Example HTTP response

Response 201

{
    "private_nat_ip": {
        "attached_resource_id": "",
        "attached_resource_name": "",
        "attached_resource_type": "VM",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "",
        "ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "private_nat_id": "",
        "state": "RESERVED"
    }
}

9.1.10.2 - 1.2

post /v1/private-nats/{private_nat_id}/private-nat-ips

Description

Private NAT IP 생성

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_nat_id
required
Private NAT ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone
bodybody
required

PrivateNatIpCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedPrivateNatIpShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/private-nats/{private_nat_id}/private-nat-ips

Request header

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

Request body

{
    "ip_address": ""
}

Example HTTP response

Response 201

{
    "private_nat_ip": {
        "attached_resource_id": "",
        "attached_resource_name": "",
        "attached_resource_type": "VM",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "",
        "ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "private_nat_id": "",
        "state": "RESERVED"
    }
}

9.1.10.3 - 1.1

post /v1/private-nats/{private_nat_id}/private-nat-ips

Description

Private NAT IP 생성

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_nat_id
required
Private NAT ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone
bodybody
required

PrivateNatIpCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedPrivateNatIpShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/private-nats/{private_nat_id}/private-nat-ips

Request header

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

Request body

{
    "ip_address": ""
}

Example HTTP response

Response 201

{
    "private_nat_ip": {
        "attached_resource_id": "",
        "attached_resource_name": "",
        "attached_resource_type": "VM",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "",
        "ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "private_nat_id": "",
        "state": "RESERVED"
    }
}

9.1.10.4 - 1.0

post /v1/private-nats/{private_nat_id}/private-nat-ips

Description

Private NAT IP 생성

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_nat_id
required
Private NAT ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone
bodybody
required

PrivateNatIpCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedPrivateNatIpShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/private-nats/{private_nat_id}/private-nat-ips

Request header

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

Request body

{
    "ip_address": ""
}

Example HTTP response

Response 201

{
    "private_nat_ip": {
        "attached_resource_id": "",
        "attached_resource_name": "",
        "attached_resource_type": "VM",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "",
        "ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "private_nat_id": "",
        "state": "RESERVED"
    }
}

9.1.11 - Create PrivateLink Endpoint

9.1.11.1 - 1.3

post /v1/privatelink-endpoints

Description

PrivateLink Endpoint 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

PrivateLinkEndpointCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedPrivateLinkEndpointShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/privatelink-endpoints

Request header

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

Request body

{
    "description": "PrivateLink Endpoint Description",
    "endpoint_ip_address": "192.167.1.5",
    "name": "EndpointName",
    "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
    "security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
    "subnet_id": "023c57b14f11483689338d085e061492",
    "tags": "[{'key': 'key', 'value': 'value'}]"
}

Example HTTP response

Response 202

{
    "privatelink_endpoint": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Endpoint Description",
        "endpoint_ip_address": "192.167.1.5",
        "endpoint_ip_port_id": "b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e",
        "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "EndpointName",
        "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
        "state": "ACTIVE",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

9.1.11.2 - 1.2

post /v1/privatelink-endpoints

Description

PrivateLink Endpoint 생성

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

PrivateLinkEndpointCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedPrivateLinkEndpointShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/privatelink-endpoints

Request header

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

Request body

{
    "description": "PrivateLink Endpoint Description",
    "endpoint_ip_address": "192.167.1.5",
    "name": "EndpointName",
    "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
    "security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
    "subnet_id": "023c57b14f11483689338d085e061492",
    "tags": "[{'key': 'key', 'value': 'value'}]"
}

Example HTTP response

Response 202

{
    "privatelink_endpoint": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Endpoint Description",
        "endpoint_ip_address": "192.167.1.5",
        "endpoint_ip_port_id": "b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e",
        "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "EndpointName",
        "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
        "state": "ACTIVE",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

9.1.11.3 - 1.1

post /v1/privatelink-endpoints

Description

PrivateLink Endpoint 생성

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

PrivateLinkEndpointCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedPrivateLinkEndpointShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/privatelink-endpoints

Request header

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

Request body

{
    "description": "PrivateLink Endpoint Description",
    "endpoint_ip_address": "192.167.1.5",
    "name": "EndpointName",
    "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
    "security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
    "subnet_id": "023c57b14f11483689338d085e061492",
    "tags": "[{'key': 'key', 'value': 'value'}]"
}

Example HTTP response

Response 202

{
    "privatelink_endpoint": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Endpoint Description",
        "endpoint_ip_address": "192.167.1.5",
        "endpoint_ip_port_id": "b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e",
        "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "EndpointName",
        "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
        "state": "ACTIVE",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

9.1.12 - Create PrivateLink Service

9.1.12.1 - 1.3

post /v1/privatelink-services

Description

PrivateLink Service 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

PrivateLinkServiceCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedPrivateLinkServiceShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/privatelink-services

Request header

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

Request body

{
    "approval_type": "AUTO",
    "connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
    "connected_resource_ip_address": "192.167.0.10",
    "connected_resource_type": "LB",
    "description": "PrivateLink Service Description",
    "high_speed_transfer": false,
    "name": "ServiceName",
    "security_group_ids": "['00b6af37-73b5-4de2-b080-c295a1a0382e']",
    "service_ip_address": "192.167.0.5",
    "subnet_id": "023c57b14f11483689338d085e061492",
    "tags": "[{'key': 'key', 'value': 'value'}]"
}

Example HTTP response

Response 202

{
    "privatelink_service": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
        "connected_resource_ip_address": "192.167.0.10",
        "connected_resource_name": "lbResourceName",
        "connected_resource_type": "LB",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Service Description",
        "high_speed_transfer": false,
        "id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServiceName",
        "security_group_ids": "['00b6af37-73b5-4de2-b080-c295a1a0382e']",
        "service_ip_address": "192.167.0.5",
        "service_ip_port_id": "d21a4b81-f52a-43a8-b985-341e763458bb",
        "state": "CREATING",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

9.1.12.2 - 1.2

post /v1/privatelink-services

Description

PrivateLink Service 생성

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

PrivateLinkServiceCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedPrivateLinkServiceShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/privatelink-services

Request header

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

Request body

{
    "approval_type": "AUTO",
    "connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
    "connected_resource_ip_address": "192.167.0.10",
    "connected_resource_type": "LB",
    "description": "PrivateLink Service Description",
    "high_speed_transfer": false,
    "name": "ServiceName",
    "security_group_ids": "['00b6af37-73b5-4de2-b080-c295a1a0382e']",
    "service_ip_address": "192.167.0.5",
    "subnet_id": "023c57b14f11483689338d085e061492",
    "tags": "[{'key': 'key', 'value': 'value'}]"
}

Example HTTP response

Response 202

{
    "privatelink_service": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
        "connected_resource_ip_address": "192.167.0.10",
        "connected_resource_name": "lbResourceName",
        "connected_resource_type": "LB",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Service Description",
        "high_speed_transfer": false,
        "id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServiceName",
        "security_group_ids": "['00b6af37-73b5-4de2-b080-c295a1a0382e']",
        "service_ip_address": "192.167.0.5",
        "service_ip_port_id": "d21a4b81-f52a-43a8-b985-341e763458bb",
        "state": "CREATING",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

9.1.12.3 - 1.1

post /v1/privatelink-services

Description

PrivateLink Service 생성

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

PrivateLinkServiceCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedPrivateLinkServiceShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/privatelink-services

Request header

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

Request body

{
    "approval_type": "AUTO",
    "connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
    "connected_resource_ip_address": "192.167.0.10",
    "connected_resource_type": "LB",
    "description": "PrivateLink Service Description",
    "high_speed_transfer": false,
    "name": "ServiceName",
    "security_group_ids": "['00b6af37-73b5-4de2-b080-c295a1a0382e']",
    "service_ip_address": "192.167.0.5",
    "subnet_id": "023c57b14f11483689338d085e061492",
    "tags": "[{'key': 'key', 'value': 'value'}]"
}

Example HTTP response

Response 202

{
    "privatelink_service": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
        "connected_resource_ip_address": "192.167.0.10",
        "connected_resource_name": "lbResourceName",
        "connected_resource_type": "LB",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Service Description",
        "high_speed_transfer": false,
        "id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServiceName",
        "security_group_ids": "['00b6af37-73b5-4de2-b080-c295a1a0382e']",
        "service_ip_address": "192.167.0.5",
        "service_ip_port_id": "d21a4b81-f52a-43a8-b985-341e763458bb",
        "state": "CREATING",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

9.1.13 - Create PublicIP

9.1.13.1 - 1.3

post /v1/publicips

Description

PublicIP를 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

PublicipCreateRequestV1Dot3

Responses

HTTP CodeDescriptionSchema
201CreatedPublicipShowResponseV1Dot3
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/publicips

Request header

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

Request body

{
    "description": "Public IP Description",
    "tags": "[{'key': 'key', 'value': 'value'}]",
    "type": "IGW",
    "zone": "kr-west1-a"
}

Example HTTP response

Response 201

{
    "publicip": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
        "attached_resource_name": "Attached NAT Gateway Name",
        "attached_resource_type": "NAT_GW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Public IP Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "ip_address": "192.167.0.5",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ATTACHED",
        "type": "IGW",
        "zone": "kr-west1-a"
    }
}

9.1.13.2 - 1.2

post /v1/publicips

Description

PublicIP를 생성한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

PublicipCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedPublicipShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/publicips

Request header

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

Request body

{
    "description": "Public IP Description",
    "tags": "[{'key': 'key', 'value': 'value'}]",
    "type": "IGW"
}

Example HTTP response

Response 201

{
    "publicip": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
        "attached_resource_name": "Attached NAT Gateway Name",
        "attached_resource_type": "NAT_GW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Public IP Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "ip_address": "192.167.0.5",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ATTACHED",
        "type": "IGW"
    }
}

9.1.13.3 - 1.1

post /v1/publicips

Description

PublicIP를 생성한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

PublicipCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedPublicipShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/publicips

Request header

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

Request body

{
    "description": "Public IP Description",
    "tags": "[{'key': 'key', 'value': 'value'}]",
    "type": "IGW"
}

Example HTTP response

Response 201

{
    "publicip": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
        "attached_resource_name": "Attached NAT Gateway Name",
        "attached_resource_type": "NAT_GW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Public IP Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "ip_address": "192.167.0.5",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ATTACHED",
        "type": "IGW"
    }
}

9.1.13.4 - 1.0

post /v1/publicips

Description

PublicIP를 생성한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

PublicipCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedPublicipShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/publicips

Request header

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

Request body

{
    "description": "Public IP Description",
    "tags": "[{'key': 'key', 'value': 'value'}]",
    "type": "IGW"
}

Example HTTP response

Response 201

{
    "publicip": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
        "attached_resource_name": "Attached NAT Gateway Name",
        "attached_resource_type": "NAT_GW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Public IP Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "ip_address": "192.167.0.5",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ATTACHED",
        "type": "IGW"
    }
}

9.1.14 - Create Subnet

9.1.14.1 - 1.3

post /v1/subnets

Description

Subnet을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

SubnetCreateRequestV1Dot3

Responses

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

Example HTTP request

Request path

/v1/subnets

Request header

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

Request body

{
    "allocation_pools": "[{\"start\":\"192.167.1.2\", \"end\":\"192.167.1.100\"}]",
    "category": "PRIMARY",
    "cidr": "192.167.1.0/24",
    "description": "Subnet Description",
    "dns_nameservers": "[\"1.1.1.1\", \"2.2.2.2\"]",
    "gateway_ip_address": "192.167.1.1",
    "host_routes": "[{\"destination\":\"192.168.10.0/24\", \"nexthop\":\"192.168.10.0\"}]",
    "name": "subnetName",
    "primary_subnet_id": "023c57b14f11483689338d085e061492",
    "tags": [],
    "type": "PUBLIC",
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "subnet": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "allocation_pools": [],
        "category": "PRIMARY",
        "cidr": "192.167.1.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Subnet Description",
        "dhcp_ip_address": "",
        "dns_nameservers": [],
        "gateway_ip_address": "192.167.1.1",
        "host_routes": [],
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "subnetName",
        "primary_subnet_id": "023c57b14f11483689338d085e061492",
        "secondary_subnet_ids": "[\"522e102f680448a8804d18d4838baa78\", \"aec40baf53c243c1bb8401a703a2c888\"]",
        "state": "CREATING",
        "type": "PUBLIC",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName",
        "zones": "[\"kr-west1-a\", \"kr-west1-b\", \"kr-west1-c\"]"
    }
}

9.1.14.2 - 1.2

post /v1/subnets

Description

Subnet을 생성한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

SubnetCreateRequestV1Dot2

Responses

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

Example HTTP request

Request path

/v1/subnets

Request header

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

Request body

{
    "allocation_pools": "[{\"start\":\"192.167.1.2\", \"end\":\"192.167.1.100\"}]",
    "cidr": "192.167.1.0/24",
    "description": "Subnet Description",
    "dns_nameservers": "[\"1.1.1.1\", \"2.2.2.2\"]",
    "gateway_ip_address": "192.167.1.1",
    "host_routes": "[{\"destination\":\"192.168.10.0/24\", \"nexthop\":\"192.168.10.0\"}]",
    "name": "subnetName",
    "tags": [],
    "type": "GENERAL",
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "subnet": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "allocation_pools": [],
        "cidr": "192.167.1.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Subnet Description",
        "dhcp_ip_address": "",
        "dns_nameservers": [],
        "gateway_ip_address": "192.167.1.1",
        "host_routes": [],
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "subnetName",
        "state": "CREATING",
        "type": "GENERAL",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.14.3 - 1.1

post /v1/subnets

Description

Subnet을 생성한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

SubnetCreateRequest

Responses

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

Example HTTP request

Request path

/v1/subnets

Request header

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

Request body

{
    "allocation_pools": "[{\"start\":\"192.167.1.2\", \"end\":\"192.167.1.100\"}]",
    "cidr": "192.167.1.0/24",
    "description": "Subnet Description",
    "dns_nameservers": "[\"1.1.1.1\", \"2.2.2.2\"]",
    "host_routes": "[{\"destination\":\"192.168.10.0/24\", \"nexthop\":\"192.168.10.0\"}]",
    "name": "subnetName",
    "tags": [],
    "type": "GENERAL",
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "subnet": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "allocation_pools": [],
        "cidr": "192.167.1.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Subnet Description",
        "dns_nameservers": [],
        "gateway_ip_address": "192.167.1.1",
        "host_routes": [],
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "subnetName",
        "state": "CREATING",
        "type": "GENERAL",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.14.4 - 1.0

post /v1/subnets

Description

Subnet을 생성한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

SubnetCreateRequest

Responses

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

Example HTTP request

Request path

/v1/subnets

Request header

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

Request body

{
    "allocation_pools": "[{\"start\":\"192.167.1.2\", \"end\":\"192.167.1.100\"}]",
    "cidr": "192.167.1.0/24",
    "description": "Subnet Description",
    "dns_nameservers": "[\"1.1.1.1\", \"2.2.2.2\"]",
    "host_routes": "[{\"destination\":\"192.168.10.0/24\", \"nexthop\":\"192.168.10.0\"}]",
    "name": "subnetName",
    "tags": [],
    "type": "GENERAL",
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "subnet": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "allocation_pools": [],
        "cidr": "192.167.1.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Subnet Description",
        "dns_nameservers": [],
        "gateway_ip_address": "192.167.1.1",
        "host_routes": [],
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "subnetName",
        "state": "CREATING",
        "type": "GENERAL",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.15 - Create Subnet VIP

9.1.15.1 - 1.3

post /v1/subnets/{subnet_id}/vips

Description

Subnet Vip 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone
bodybody
required

VipCreateRequest

Responses

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

Example HTTP request

Request path

/v1/subnets/{subnet_id}/vips

Request header

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

Request body

{
    "description": "Subnet VIP Description",
    "virtual_ip_address": "192.168.20.6"
}

Example HTTP response

Response 201

{
    "subnet_vip": {
        "connected_ports": [
            {
                "attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
                "attached_resource_type": "Virtual Server",
                "id": "13e2a5a1acbe4713a9a2c70ce226e822",
                "port_id": "8b4705d3-43b7-4fad-8648-a5a1a90c31d0",
                "port_ip_address": "192.168.20.5",
                "port_name": "Port name"
            }
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Subnet VIP Description",
        "id": "0466a9448d9a4411a86055939e451c8f",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ACTIVE",
        "static_nat": {
            "external_ip_address": "100.112.9.84",
            "id": "0009e49548154745948e9722adefbf40",
            "publicip_id": "12f56e27070248a6a240a497e43fbe18",
            "state": "ACTIVE"
        },
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vip_port_id": "35268a9f2eda4cde83b1d85c1f61f67d",
        "virtual_ip_address": "192.168.20.6"
    }
}

9.1.15.2 - 1.2

post /v1/subnets/{subnet_id}/vips

Description

Subnet Vip 생성

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone
bodybody
required

VipCreateRequest

Responses

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

Example HTTP request

Request path

/v1/subnets/{subnet_id}/vips

Request header

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

Request body

{
    "description": "Subnet VIP Description",
    "virtual_ip_address": "192.168.20.6"
}

Example HTTP response

Response 201

{
    "subnet_vip": {
        "connected_ports": [
            {
                "attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
                "attached_resource_type": "Virtual Server",
                "id": "13e2a5a1acbe4713a9a2c70ce226e822",
                "port_id": "8b4705d3-43b7-4fad-8648-a5a1a90c31d0",
                "port_ip_address": "192.168.20.5",
                "port_name": "Port name"
            }
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Subnet VIP Description",
        "id": "0466a9448d9a4411a86055939e451c8f",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ACTIVE",
        "static_nat": {
            "external_ip_address": "100.112.9.84",
            "id": "0009e49548154745948e9722adefbf40",
            "publicip_id": "12f56e27070248a6a240a497e43fbe18",
            "state": "ACTIVE"
        },
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vip_port_id": "35268a9f2eda4cde83b1d85c1f61f67d",
        "virtual_ip_address": "192.168.20.6"
    }
}

9.1.16 - Create Subnet VIP NAT IP

9.1.16.1 - 1.3

post /v1/subnets/{subnet_id}/vips/{vip_id}/static-nat-ips

Description

Subnet Vip Nat Ip 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone
pathvip_id
required
Subnet Vip Id
Example : 0466a9448d9a4411a86055939e451c8f
stringNone
bodybody
required

VipNatCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedVipNatCreateResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/subnets/{subnet_id}/vips/{vip_id}/static-nat-ips

Request header

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

Request body

{
    "nat_type": "PUBLIC",
    "publicip_id": "12f56e27070248a6a240a497e43fbe18"
}

Example HTTP response

Response 202

{
    "id": "0009e49548154745948e9722adefbf40",
    "publicip_id": "12f56e27070248a6a240a497e43fbe18",
    "state": "ACTIVE"
}

9.1.16.2 - 1.2

post /v1/subnets/{subnet_id}/vips/{vip_id}/static-nat-ips

Description

Subnet Vip Nat Ip 생성

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone
pathvip_id
required
Subnet Vip Id
Example : 0466a9448d9a4411a86055939e451c8f
stringNone
bodybody
required

VipNatCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedVipNatCreateResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/subnets/{subnet_id}/vips/{vip_id}/static-nat-ips

Request header

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

Request body

{
    "nat_type": "PUBLIC",
    "publicip_id": "12f56e27070248a6a240a497e43fbe18"
}

Example HTTP response

Response 202

{
    "id": "0009e49548154745948e9722adefbf40",
    "publicip_id": "12f56e27070248a6a240a497e43fbe18",
    "state": "ACTIVE"
}

9.1.17 - Create Transit Gateway

9.1.17.1 - 1.3

post /v1/transit-gateways

Description

Transit Gateway 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

TransitGatewayCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedTransitGatewayShowResponseV1Dot3
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/transit-gateways

Request header

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

Request body

{
    "description": "TransitGateway Description",
    "name": "TransitGatewayName",
    "tags": "[{'key': 'key', 'value': 'value'}]"
}

Example HTTP response

Response 202

{
    "transit_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "TransitGateway Description",
        "firewall_connection_state": "INACTIVE",
        "firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "TransitGatewayName",
        "state": "ACTIVE",
        "uplink_active_zone": "kr-west1-a",
        "uplink_enabled": "False",
        "uplink_standby_zone": "kr-west1-b",
        "uplink_zone_state": "ACTIVE"
    }
}

9.1.17.2 - 1.2

post /v1/transit-gateways

Description

Transit Gateway 생성

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

TransitGatewayCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedTransitGatewayShowResponseV1Dot2
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/transit-gateways

Request header

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

Request body

{
    "description": "TransitGateway Description",
    "name": "TransitGatewayName",
    "tags": "[{'key': 'key', 'value': 'value'}]"
}

Example HTTP response

Response 202

{
    "transit_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "TransitGateway Description",
        "firewall_connection_state": "INACTIVE",
        "firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "TransitGatewayName",
        "state": "ACTIVE",
        "uplink_enabled": "False"
    }
}

9.1.17.3 - 1.1

post /v1/transit-gateways

Description

Transit Gateway 생성

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

TransitGatewayCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedTransitGatewayShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/transit-gateways

Request header

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

Request body

{
    "description": "TransitGateway Description",
    "name": "TransitGatewayName",
    "tags": "[{'key': 'key', 'value': 'value'}]"
}

Example HTTP response

Response 202

{
    "transit_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "TransitGateway Description",
        "firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "TransitGatewayName",
        "state": "ACTIVE",
        "uplink_enabled": "False"
    }
}

9.1.17.4 - 1.0

post /v1/transit-gateways

Description

Transit Gateway 생성

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

TransitGatewayCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedTransitGatewayShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/transit-gateways

Request header

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

Request body

{
    "description": "TransitGateway Description",
    "name": "TransitGatewayName",
    "tags": "[{'key': 'key', 'value': 'value'}]"
}

Example HTTP response

Response 202

{
    "transit_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "TransitGateway Description",
        "firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "TransitGatewayName",
        "state": "ACTIVE",
        "uplink_enabled": "False"
    }
}

9.1.18 - Create Transit Gateway Firewall

9.1.18.1 - 1.3

post /v1/transit-gateways/{transit_gateway_id}/firewalls

Description

Transit Gateway 방화벽 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
bodybody
required

TransitGatewayFirewallCreateRequestV1Dot3

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/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 = vpc 1.3"

Request body

{
    "product_type": "TGW_DGW",
    "uplink_active_zone": "kr-west1-a",
    "uplink_standby_zone": "kr-west1-b"
}

Example HTTP response

Response 202

{
    "state": "ACTIVE",
    "uplink_active_zone": "kr-west1-a",
    "uplink_standby_zone": "kr-west1-b",
    "uplink_zone_state": "ACTIVE"
}

9.1.18.2 - 1.2

post /v1/transit-gateways/{transit_gateway_id}/firewalls

Description

Transit Gateway 방화벽 생성

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
bodybody
required

TransitGatewayFirewallCreateRequest

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/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 = vpc 1.2"

Request body

{
    "product_type": "TGW_DGW"
}

Example HTTP response

Response 201

{
    "transit_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "TransitGateway Description",
        "firewall_connection_state": "INACTIVE",
        "firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "TransitGatewayName",
        "state": "ACTIVE",
        "uplink_enabled": "False"
    }
}

9.1.19 - Create Transit Gateway Firewall Connection

9.1.19.1 - 1.3

post /v1/transit-gateways/{transit_gateway_id}/firewall-connections

Description

Transit Gateway 방화벽 연결 생성.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/firewall-connections

Request header

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

Example HTTP response

Response 202

{
    "firewall_connection_state": "INACTIVE"
}

9.1.19.2 - 1.2

post /v1/transit-gateways/{transit_gateway_id}/firewall-connections

Description

Transit Gateway 방화벽 연결 생성.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/firewall-connections

Request header

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

Example HTTP response

Response 202

{
    "transit_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "TransitGateway Description",
        "firewall_connection_state": "INACTIVE",
        "firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "TransitGatewayName",
        "state": "ACTIVE",
        "uplink_enabled": "False"
    }
}

9.1.20 - Create Transit Gateway Rule

9.1.20.1 - 1.3

post /v1/transit-gateways/{transit_gateway_id}/routing-rules

Description

Transit Gateway 규칙 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
bodybody
required

TransitGatewayRuleCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedTransitGatewayRuleShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/routing-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 = vpc 1.3"

Request body

{
    "description": "Routing Rule Description",
    "destination_cidr": "192.167.5.0/24",
    "destination_type": "VPC",
    "tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34"
}

Example HTTP response

Response 202

{
    "transit_gateway_rule": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "description": "Routing Rule Description",
        "destination_cidr": "192.167.5.0/24",
        "destination_resource_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "destination_resource_name": "VpcName",
        "destination_type": "VPC",
        "id": "43772aff4539403d9ba74bf1fdaa00c8",
        "source_resource_id": "8582cc5d89994a42ad53282fd4a8d8be",
        "source_resource_name": "TgwName",
        "source_type": "TGW",
        "state": "ACTIVE",
        "tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34",
        "tgw_connection_vpc_name": "ConnectedVpcName"
    }
}

9.1.20.2 - 1.2

post /v1/transit-gateways/{transit_gateway_id}/routing-rules

Description

Transit Gateway 규칙 생성

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
bodybody
required

TransitGatewayRuleCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedTransitGatewayRuleShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/routing-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 = vpc 1.2"

Request body

{
    "description": "Routing Rule Description",
    "destination_cidr": "192.167.5.0/24",
    "destination_type": "VPC",
    "tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34"
}

Example HTTP response

Response 202

{
    "transit_gateway_rule": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "description": "Routing Rule Description",
        "destination_cidr": "192.167.5.0/24",
        "destination_resource_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "destination_resource_name": "VpcName",
        "destination_type": "VPC",
        "id": "43772aff4539403d9ba74bf1fdaa00c8",
        "source_resource_id": "8582cc5d89994a42ad53282fd4a8d8be",
        "source_resource_name": "TgwName",
        "source_type": "TGW",
        "state": "ACTIVE",
        "tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34",
        "tgw_connection_vpc_name": "ConnectedVpcName"
    }
}

9.1.20.3 - 1.1

post /v1/transit-gateways/{transit_gateway_id}/routing-rules

Description

Transit Gateway 규칙 생성

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
bodybody
required

TransitGatewayRuleCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedTransitGatewayRuleShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/routing-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 = vpc 1.1"

Request body

{
    "description": "Routing Rule Description",
    "destination_cidr": "192.167.5.0/24",
    "destination_type": "VPC",
    "tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34"
}

Example HTTP response

Response 202

{
    "transit_gateway_rule": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "description": "Routing Rule Description",
        "destination_cidr": "192.167.5.0/24",
        "destination_resource_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "destination_resource_name": "VpcName",
        "destination_type": "VPC",
        "id": "43772aff4539403d9ba74bf1fdaa00c8",
        "source_resource_id": "8582cc5d89994a42ad53282fd4a8d8be",
        "source_resource_name": "TgwName",
        "source_type": "TGW",
        "state": "ACTIVE",
        "tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34",
        "tgw_connection_vpc_name": "ConnectedVpcName"
    }
}

9.1.20.4 - 1.0

post /v1/transit-gateways/{transit_gateway_id}/routing-rules

Description

Transit Gateway 규칙 생성

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
bodybody
required

TransitGatewayRuleCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedTransitGatewayRuleShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/routing-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 = vpc 1.0"

Request body

{
    "description": "Routing Rule Description",
    "destination_cidr": "192.167.5.0/24",
    "destination_type": "VPC",
    "tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34"
}

Example HTTP response

Response 202

{
    "transit_gateway_rule": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "description": "Routing Rule Description",
        "destination_cidr": "192.167.5.0/24",
        "destination_resource_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "destination_resource_name": "VpcName",
        "destination_type": "VPC",
        "id": "43772aff4539403d9ba74bf1fdaa00c8",
        "source_resource_id": "8582cc5d89994a42ad53282fd4a8d8be",
        "source_resource_name": "TgwName",
        "source_type": "TGW",
        "state": "ACTIVE",
        "tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34",
        "tgw_connection_vpc_name": "ConnectedVpcName"
    }
}

9.1.21 - Create Transit Gateway Uplink Rule

9.1.21.1 - 1.3

post /v1/transit-gateways/{transit_gateway_id}/uplink-routing-rules

Description

Transit Gateway Uplink 규칙 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
bodybody
required

TransitGatewayUplinkRuleCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedTransitGatewayUplinkRuleCreateResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/uplink-routing-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 = vpc 1.3"

Request body

{
    "description": "Routing Rule Description",
    "destination_cidr": "192.167.5.0/24",
    "destination_type": "ON_PREMISE"
}

Example HTTP response

Response 202

{
    "transit_gateway_rule": {
        "description": "Routing Rule Description",
        "destination_cidr": "192.167.5.0/24",
        "destination_type": "ON_PREMISE",
        "id": "43772aff4539403d9ba74bf1fdaa00c8",
        "state": "ACTIVE"
    }
}

9.1.21.2 - 1.2

post /v1/transit-gateways/{transit_gateway_id}/uplink-routing-rules

Description

Transit Gateway Uplink 규칙 생성

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
bodybody
required

TransitGatewayUplinkRuleCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedTransitGatewayUplinkRuleCreateResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/uplink-routing-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 = vpc 1.2"

Request body

{
    "description": "Routing Rule Description",
    "destination_cidr": "192.167.5.0/24",
    "destination_type": "ON_PREMISE"
}

Example HTTP response

Response 202

{
    "transit_gateway_rule": {
        "description": "Routing Rule Description",
        "destination_cidr": "192.167.5.0/24",
        "destination_type": "ON_PREMISE",
        "id": "43772aff4539403d9ba74bf1fdaa00c8",
        "state": "ACTIVE"
    }
}

9.1.21.3 - 1.1

post /v1/transit-gateways/{transit_gateway_id}/uplink-routing-rules

Description

Transit Gateway Uplink 규칙 생성

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
bodybody
required

TransitGatewayUplinkRuleCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedTransitGatewayUplinkRuleCreateResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/uplink-routing-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 = vpc 1.1"

Request body

{
    "description": "Routing Rule Description",
    "destination_cidr": "192.167.5.0/24",
    "destination_type": "ON_PREMISE"
}

Example HTTP response

Response 202

{
    "transit_gateway_rule": {
        "description": "Routing Rule Description",
        "destination_cidr": "192.167.5.0/24",
        "destination_type": "ON_PREMISE",
        "id": "43772aff4539403d9ba74bf1fdaa00c8",
        "state": "ACTIVE"
    }
}

9.1.21.4 - 1.0

post /v1/transit-gateways/{transit_gateway_id}/uplink-routing-rules

Description

Transit Gateway Uplink 규칙 생성

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
bodybody
required

TransitGatewayUplinkRuleCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedTransitGatewayUplinkRuleCreateResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/uplink-routing-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 = vpc 1.0"

Request body

{
    "description": "Routing Rule Description",
    "destination_cidr": "192.167.5.0/24",
    "destination_type": "ON_PREMISE"
}

Example HTTP response

Response 202

{
    "transit_gateway_rule": {
        "description": "Routing Rule Description",
        "destination_cidr": "192.167.5.0/24",
        "destination_type": "ON_PREMISE",
        "id": "43772aff4539403d9ba74bf1fdaa00c8",
        "state": "ACTIVE"
    }
}

9.1.22 - Create Transit Gateway VPC Connection

9.1.22.1 - 1.3

post /v1/transit-gateways/{transit_gateway_id}/vpc-connections

Description

Transit Gateway VPC 연결 생성.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
bodybody
required

TransitGatewayVpcConnectionCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedTransitGatewayVpcConnectionShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/vpc-connections

Request header

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

Request body

{
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "transit_gateway_vpc_connection": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "ffeced8e191c478eabd66b6e2cab8e34",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ACTIVE",
        "transit_gateway_id": "fe860e0af0c04dcd8182b84f907f31f4",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.22.2 - 1.2

post /v1/transit-gateways/{transit_gateway_id}/vpc-connections

Description

Transit Gateway VPC 연결 생성.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
bodybody
required

TransitGatewayVpcConnectionCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedTransitGatewayVpcConnectionShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/vpc-connections

Request header

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

Request body

{
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "transit_gateway_vpc_connection": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "ffeced8e191c478eabd66b6e2cab8e34",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ACTIVE",
        "transit_gateway_id": "fe860e0af0c04dcd8182b84f907f31f4",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.22.3 - 1.1

post /v1/transit-gateways/{transit_gateway_id}/vpc-connections

Description

Transit Gateway VPC 연결 생성.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
bodybody
required

TransitGatewayVpcConnectionCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedTransitGatewayVpcConnectionShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/vpc-connections

Request header

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

Request body

{
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "transit_gateway_vpc_connection": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "ffeced8e191c478eabd66b6e2cab8e34",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ACTIVE",
        "transit_gateway_id": "fe860e0af0c04dcd8182b84f907f31f4",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.22.4 - 1.0

post /v1/transit-gateways/{transit_gateway_id}/vpc-connections

Description

Transit Gateway VPC 연결 생성.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
bodybody
required

TransitGatewayVpcConnectionCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedTransitGatewayVpcConnectionShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/vpc-connections

Request header

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

Request body

{
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "transit_gateway_vpc_connection": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "ffeced8e191c478eabd66b6e2cab8e34",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ACTIVE",
        "transit_gateway_id": "fe860e0af0c04dcd8182b84f907f31f4",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.23 - Create VPC

9.1.23.1 - 1.3

post /v1/vpcs

Description

VPC를 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

VpcCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedVpcShowResponseV1Dot3
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpcs

Request header

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

Request body

{
    "cidr": "192.167.0.0/18",
    "description": "VPC Description",
    "name": "vpcName",
    "tags": []
}

Example HTTP response

Response 201

{
    "vpc": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr_count": 20,
        "cidrs": [
            {
                "cidr": "192.167.0.0/18",
                "created_at": "2024-05-17T00:23:17Z",
                "created_by": "7df8abb4912e4709b1cb237daccca7a8",
                "id": "7df8abb4912e4709b1cb237daccca7a8"
            }
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "vpcDescription",
        "id": "7df8abb4912e4709b1cb237daccca7a8",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcName",
        "state": "CREATING",
        "zone_type": "PUBLIC",
        "zones": [
            "zone-a",
            "zone-b",
            "zone-c"
        ]
    }
}

9.1.23.2 - 1.2

post /v1/vpcs

Description

VPC를 생성한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

VpcCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedVpcShowResponseV1Dot2
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpcs

Request header

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

Request body

{
    "cidr": "192.167.0.0/18",
    "description": "VPC Description",
    "name": "vpcName",
    "tags": []
}

Example HTTP response

Response 201

{
    "vpc": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr_count": 20,
        "cidrs": [
            {
                "cidr": "192.167.0.0/18",
                "created_at": "2024-05-17T00:23:17Z",
                "created_by": "7df8abb4912e4709b1cb237daccca7a8",
                "id": "7df8abb4912e4709b1cb237daccca7a8"
            }
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "vpcDescription",
        "id": "7df8abb4912e4709b1cb237daccca7a8",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcName",
        "state": "CREATING"
    }
}

9.1.23.3 - 1.1

post /v1/vpcs

Description

VPC를 생성한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

VpcCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedVpcShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpcs

Request header

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

Request body

{
    "cidr": "192.167.0.0/18",
    "description": "VPC Description",
    "name": "vpcName",
    "tags": []
}

Example HTTP response

Response 201

{
    "vpc": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/18",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "vpcDescription",
        "id": "7df8abb4912e4709b1cb237daccca7a8",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcName",
        "state": "CREATING"
    }
}

9.1.23.4 - 1.0

post /v1/vpcs

Description

VPC를 생성한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

VpcCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedVpcShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpcs

Request header

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

Request body

{
    "cidr": "192.167.0.0/18",
    "description": "VPC Description",
    "name": "vpcName",
    "tags": []
}

Example HTTP response

Response 201

{
    "vpc": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/18",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "vpcDescription",
        "id": "7df8abb4912e4709b1cb237daccca7a8",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcName",
        "state": "CREATING"
    }
}

9.1.24 - Create VPC Endpoint

9.1.24.1 - 1.3

post /v1/vpc-endpoints

Description

VPC Endpoint 를 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

VpcEndpointCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedVpcEndpointShowResponse
400Bad RequestNone
403ForbiddenNone

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 = ko-KR",
"Scp-Api-Version = vpc 1.3"

Request body

{
    "description": "VpcEndpoint Description",
    "endpoint_ip_address": "192.167.0.5",
    "name": "VpcEndpointName",
    "resource_info": "x.samsungsdscloud.com(Registry)",
    "resource_key": "07c5364702384471b650147321b52173",
    "resource_type": "FS",
    "subnet_id": "023c57b14f11483689338d085e061492",
    "tags": "[{'key': 'key', 'value': 'value'}]",
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "vpc_endpoint": {
        "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"
    }
}

9.1.24.2 - 1.2

post /v1/vpc-endpoints

Description

VPC Endpoint 를 생성한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

VpcEndpointCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedVpcEndpointShowResponse
400Bad RequestNone
403ForbiddenNone

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 = ko-KR",
"Scp-Api-Version = vpc 1.2"

Request body

{
    "description": "VpcEndpoint Description",
    "endpoint_ip_address": "192.167.0.5",
    "name": "VpcEndpointName",
    "resource_info": "x.samsungsdscloud.com(Registry)",
    "resource_key": "07c5364702384471b650147321b52173",
    "resource_type": "FS",
    "subnet_id": "023c57b14f11483689338d085e061492",
    "tags": "[{'key': 'key', 'value': 'value'}]",
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "vpc_endpoint": {
        "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"
    }
}

9.1.24.3 - 1.1

post /v1/vpc-endpoints

Description

VPC Endpoint 를 생성한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

VpcEndpointCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedVpcEndpointShowResponse
400Bad RequestNone
403ForbiddenNone

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 = ko-KR",
"Scp-Api-Version = vpc 1.1"

Request body

{
    "description": "VpcEndpoint Description",
    "endpoint_ip_address": "192.167.0.5",
    "name": "VpcEndpointName",
    "resource_info": "x.samsungsdscloud.com(Registry)",
    "resource_key": "07c5364702384471b650147321b52173",
    "resource_type": "FS",
    "subnet_id": "023c57b14f11483689338d085e061492",
    "tags": "[{'key': 'key', 'value': 'value'}]",
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "vpc_endpoint": {
        "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"
    }
}

9.1.24.4 - 1.0

post /v1/vpc-endpoints

Description

VPC Endpoint 를 생성한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

VpcEndpointCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedVpcEndpointShowResponse
400Bad RequestNone
403ForbiddenNone

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 = ko-KR",
"Scp-Api-Version = vpc 1.0"

Request body

{
    "description": "VpcEndpoint Description",
    "endpoint_ip_address": "192.167.0.5",
    "name": "VpcEndpointName",
    "resource_info": "x.samsungsdscloud.com(Registry)",
    "resource_key": "07c5364702384471b650147321b52173",
    "resource_type": "FS",
    "subnet_id": "023c57b14f11483689338d085e061492",
    "tags": "[{'key': 'key', 'value': 'value'}]",
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "vpc_endpoint": {
        "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"
    }
}

9.1.25 - Create VPC Peering

9.1.25.1 - 1.3

post /v1/vpc-peerings

Description

VPC Peering 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

VpcPeeringCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedVpcPeeringShowResponse
400Bad RequestNone
403ForbiddenNone

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 = ko-KR",
"Scp-Api-Version = vpc 1.3"

Request body

{
    "approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
    "approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
    "description": "vpcPeering Description",
    "name": "vpcPeeringName",
    "requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
    "tags": []
}

Example HTTP response

Response 202

{
    "vpc_peering": {
        "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"
    }
}

9.1.25.2 - 1.2

post /v1/vpc-peerings

Description

VPC Peering 생성

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

VpcPeeringCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedVpcPeeringShowResponse
400Bad RequestNone
403ForbiddenNone

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 = ko-KR",
"Scp-Api-Version = vpc 1.2"

Request body

{
    "approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
    "approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
    "description": "vpcPeering Description",
    "name": "vpcPeeringName",
    "requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
    "tags": []
}

Example HTTP response

Response 202

{
    "vpc_peering": {
        "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"
    }
}

9.1.25.3 - 1.1

post /v1/vpc-peerings

Description

VPC Peering 생성

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

VpcPeeringCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedVpcPeeringShowResponse
400Bad RequestNone
403ForbiddenNone

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 = ko-KR",
"Scp-Api-Version = vpc 1.1"

Request body

{
    "approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
    "approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
    "description": "vpcPeering Description",
    "name": "vpcPeeringName",
    "requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
    "tags": []
}

Example HTTP response

Response 202

{
    "vpc_peering": {
        "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"
    }
}

9.1.25.4 - 1.0

post /v1/vpc-peerings

Description

VPC Peering 생성

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

VpcPeeringCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedVpcPeeringShowResponse
400Bad RequestNone
403ForbiddenNone

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 = ko-KR",
"Scp-Api-Version = vpc 1.0"

Request body

{
    "approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
    "approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
    "description": "vpcPeering Description",
    "name": "vpcPeeringName",
    "requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
    "tags": []
}

Example HTTP response

Response 202

{
    "vpc_peering": {
        "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"
    }
}

9.1.26 - Create Vpc Peering Rule

9.1.26.1 - 1.3

post /v1/vpc-peerings/{vpc_peering_id}/routing-rules

Description

VPC Peering 규칙 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_peering_id
required
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
stringNone
bodybody
required

VpcPeeringRuleCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedVpcPeeringRuleShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_id}/routing-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 = vpc 1.3"

Request body

{
    "destination_cidr": "",
    "destination_vpc_type": "REQUESTER_VPC",
    "tags": []
}

Example HTTP response

Response 202

{
    "vpc_peering_rule": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "destination_cidr": "",
        "destination_vpc_id": "",
        "destination_vpc_name": "",
        "destination_vpc_type": "REQUESTER_VPC",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "source_vpc_id": "",
        "source_vpc_name": "",
        "source_vpc_type": "REQUESTER_VPC",
        "state": "CREATING",
        "vpc_peering_id": ""
    }
}

9.1.26.2 - 1.2

post /v1/vpc-peerings/{vpc_peering_id}/routing-rules

Description

VPC Peering 규칙 생성

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_peering_id
required
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
stringNone
bodybody
required

VpcPeeringRuleCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedVpcPeeringRuleShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_id}/routing-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 = vpc 1.2"

Request body

{
    "destination_cidr": "",
    "destination_vpc_type": "REQUESTER_VPC",
    "tags": []
}

Example HTTP response

Response 202

{
    "vpc_peering_rule": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "destination_cidr": "",
        "destination_vpc_id": "",
        "destination_vpc_name": "",
        "destination_vpc_type": "REQUESTER_VPC",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "source_vpc_id": "",
        "source_vpc_name": "",
        "source_vpc_type": "REQUESTER_VPC",
        "state": "CREATING",
        "vpc_peering_id": ""
    }
}

9.1.26.3 - 1.1

post /v1/vpc-peerings/{vpc_peering_id}/routing-rules

Description

VPC Peering 규칙 생성

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_peering_id
required
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
stringNone
bodybody
required

VpcPeeringRuleCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedVpcPeeringRuleShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_id}/routing-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 = vpc 1.1"

Request body

{
    "destination_cidr": "",
    "destination_vpc_type": "REQUESTER_VPC",
    "tags": []
}

Example HTTP response

Response 202

{
    "vpc_peering_rule": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "destination_cidr": "",
        "destination_vpc_id": "",
        "destination_vpc_name": "",
        "destination_vpc_type": "REQUESTER_VPC",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "source_vpc_id": "",
        "source_vpc_name": "",
        "source_vpc_type": "REQUESTER_VPC",
        "state": "CREATING",
        "vpc_peering_id": ""
    }
}

9.1.26.4 - 1.0

post /v1/vpc-peerings/{vpc_peering_id}/routing-rules

Description

VPC Peering 규칙 생성

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_peering_id
required
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
stringNone
bodybody
required

VpcPeeringRuleCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedVpcPeeringRuleShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_id}/routing-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 = vpc 1.0"

Request body

{
    "destination_cidr": "",
    "destination_vpc_type": "REQUESTER_VPC",
    "tags": []
}

Example HTTP response

Response 202

{
    "vpc_peering_rule": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "destination_cidr": "",
        "destination_vpc_id": "",
        "destination_vpc_name": "",
        "destination_vpc_type": "REQUESTER_VPC",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "source_vpc_id": "",
        "source_vpc_name": "",
        "source_vpc_type": "REQUESTER_VPC",
        "state": "CREATING",
        "vpc_peering_id": ""
    }
}

9.1.27 - Delete Internet Gateway

9.1.27.1 - 1.3

delete /v1/internet-gateways/{internet_gateway_id}

Description

Internet Gateway를 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathinternet_gateway_id
required
Internet Gateway ID
Example : 023c57b14f11483689338d085e061492
stringNone

Responses

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

Example HTTP request

Request path

/v1/internet-gateways/{internet_gateway_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 = vpc 1.3"

Example HTTP response

Response 202

9.1.27.2 - 1.2

delete /v1/internet-gateways/{internet_gateway_id}

Description

Internet Gateway를 삭제한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathinternet_gateway_id
required
Internet Gateway ID
Example : 023c57b14f11483689338d085e061492
stringNone

Responses

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

Example HTTP request

Request path

/v1/internet-gateways/{internet_gateway_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 = vpc 1.2"

Example HTTP response

Response 202

9.1.27.3 - 1.1

delete /v1/internet-gateways/{internet_gateway_id}

Description

Internet Gateway를 삭제한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathinternet_gateway_id
required
Internet Gateway ID
Example : 023c57b14f11483689338d085e061492
stringNone

Responses

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

Example HTTP request

Request path

/v1/internet-gateways/{internet_gateway_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 = vpc 1.1"

Example HTTP response

Response 202

9.1.27.4 - 1.0

delete /v1/internet-gateways/{internet_gateway_id}

Description

Internet Gateway를 삭제한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathinternet_gateway_id
required
Internet Gateway ID
Example : 023c57b14f11483689338d085e061492
stringNone

Responses

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

Example HTTP request

Request path

/v1/internet-gateways/{internet_gateway_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 = vpc 1.0"

Example HTTP response

Response 202

9.1.28 - Delete NAT Gateway

9.1.28.1 - 1.3

delete /v1/nat-gateways/{nat_gateway_id}

Description

NAT Gateway를 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathnat_gateway_id
required
NAT Gateway 명
Example : 12f56e27070248a6a240a497e43fbe18
stringNone

Responses

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

Example HTTP request

Request path

/v1/nat-gateways/{nat_gateway_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 = vpc 1.3"

Example HTTP response

Response 202

9.1.28.2 - 1.2

delete /v1/nat-gateways/{nat_gateway_id}

Description

NAT Gateway를 삭제한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathnat_gateway_id
required
NAT Gateway 명
Example : 12f56e27070248a6a240a497e43fbe18
stringNone

Responses

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

Example HTTP request

Request path

/v1/nat-gateways/{nat_gateway_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 = vpc 1.2"

Example HTTP response

Response 202

9.1.28.3 - 1.1

delete /v1/nat-gateways/{nat_gateway_id}

Description

NAT Gateway를 삭제한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathnat_gateway_id
required
NAT Gateway 명
Example : 12f56e27070248a6a240a497e43fbe18
stringNone

Responses

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

Example HTTP request

Request path

/v1/nat-gateways/{nat_gateway_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 = vpc 1.1"

Example HTTP response

Response 202

9.1.28.4 - 1.0

delete /v1/nat-gateways/{nat_gateway_id}

Description

NAT Gateway를 삭제한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathnat_gateway_id
required
NAT Gateway 명
Example : 12f56e27070248a6a240a497e43fbe18
stringNone

Responses

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

Example HTTP request

Request path

/v1/nat-gateways/{nat_gateway_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 = vpc 1.0"

Example HTTP response

Response 202

9.1.29 - Delete Port

9.1.29.1 - 1.3

delete /v1/ports/{port_id}

Description

Port를 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathport_id
required
Port ID
Example : 023c57b1-4f11-4836-8933-8d085e061492
stringNone

Responses

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

Example HTTP request

Request path

/v1/ports/{port_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 = vpc 1.3"

Example HTTP response

Response 204

9.1.29.2 - 1.2

delete /v1/ports/{port_id}

Description

Port를 삭제한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathport_id
required
Port ID
Example : 023c57b1-4f11-4836-8933-8d085e061492
stringNone

Responses

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

Example HTTP request

Request path

/v1/ports/{port_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 = vpc 1.2"

Example HTTP response

Response 204

9.1.29.3 - 1.1

delete /v1/ports/{port_id}

Description

Port를 삭제한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathport_id
required
Port ID
Example : 023c57b1-4f11-4836-8933-8d085e061492
stringNone

Responses

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

Example HTTP request

Request path

/v1/ports/{port_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 = vpc 1.1"

Example HTTP response

Response 204

9.1.29.4 - 1.0

delete /v1/ports/{port_id}

Description

Port를 삭제한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathport_id
required
Port ID
Example : 023c57b1-4f11-4836-8933-8d085e061492
stringNone

Responses

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

Example HTTP request

Request path

/v1/ports/{port_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 = vpc 1.0"

Example HTTP response

Response 204

9.1.30 - Delete Private NAT

9.1.30.1 - 1.3

delete /v1/private-nats/{private_nat_id}

Description

Private NAT 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_nat_id
required
Private NAT ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone

Responses

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

Example HTTP request

Request path

/v1/private-nats/{private_nat_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 = vpc 1.3"

Example HTTP response

Response 202

9.1.30.2 - 1.2

delete /v1/private-nats/{private_nat_id}

Description

Private NAT 삭제

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_nat_id
required
Private NAT ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone

Responses

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

Example HTTP request

Request path

/v1/private-nats/{private_nat_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 = vpc 1.2"

Example HTTP response

Response 202

9.1.30.3 - 1.1

delete /v1/private-nats/{private_nat_id}

Description

Private NAT 삭제

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_nat_id
required
Private NAT ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone

Responses

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

Example HTTP request

Request path

/v1/private-nats/{private_nat_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 = vpc 1.1"

Example HTTP response

Response 202

9.1.30.4 - 1.0

delete /v1/private-nats/{private_nat_id}

Description

Private NAT 삭제

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_nat_id
required
Private NAT ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone

Responses

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

Example HTTP request

Request path

/v1/private-nats/{private_nat_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 = vpc 1.0"

Example HTTP response

Response 202

9.1.31 - Delete Private NAT IP

9.1.31.1 - 1.3

delete /v1/private-nats/{private_nat_id}/private-nat-ips/{private_nat_ip_id}

Description

Private NAT IP 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_nat_id
required
Private NAT ID
Example :
stringNone
pathprivate_nat_ip_id
required
Private NAT IP ID
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/private-nats/{private_nat_id}/private-nat-ips/{private_nat_ip_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 = vpc 1.3"

Example HTTP response

Response 204

9.1.31.2 - 1.2

delete /v1/private-nats/{private_nat_id}/private-nat-ips/{private_nat_ip_id}

Description

Private NAT IP 삭제

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_nat_id
required
Private NAT ID
Example :
stringNone
pathprivate_nat_ip_id
required
Private NAT IP ID
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/private-nats/{private_nat_id}/private-nat-ips/{private_nat_ip_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 = vpc 1.2"

Example HTTP response

Response 204

9.1.31.3 - 1.1

delete /v1/private-nats/{private_nat_id}/private-nat-ips/{private_nat_ip_id}

Description

Private NAT IP 삭제

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_nat_id
required
Private NAT ID
Example :
stringNone
pathprivate_nat_ip_id
required
Private NAT IP ID
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/private-nats/{private_nat_id}/private-nat-ips/{private_nat_ip_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 = vpc 1.1"

Example HTTP response

Response 204

9.1.31.4 - 1.0

delete /v1/private-nats/{private_nat_id}/private-nat-ips/{private_nat_ip_id}

Description

Private NAT IP 삭제

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_nat_id
required
Private NAT ID
Example :
stringNone
pathprivate_nat_ip_id
required
Private NAT IP ID
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/private-nats/{private_nat_id}/private-nat-ips/{private_nat_ip_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 = vpc 1.0"

Example HTTP response

Response 204

9.1.32 - Delete PrivateLink Endpoint

9.1.32.1 - 1.3

delete /v1/privatelink-endpoints/{privatelink_endpoint_id}

Description

PrivateLink Endpoint 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_endpoint_id
required
PrivateLink Endpoint ID
Example : bba6d4de3ad64e41b3a1b6c88983ec02
stringNone

Responses

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

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_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 = vpc 1.3"

Example HTTP response

Response 202

9.1.32.2 - 1.2

delete /v1/privatelink-endpoints/{privatelink_endpoint_id}

Description

PrivateLink Endpoint 삭제

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_endpoint_id
required
PrivateLink Endpoint ID
Example : bba6d4de3ad64e41b3a1b6c88983ec02
stringNone

Responses

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

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_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 = vpc 1.2"

Example HTTP response

Response 202

9.1.32.3 - 1.1

delete /v1/privatelink-endpoints/{privatelink_endpoint_id}

Description

PrivateLink Endpoint 삭제

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_endpoint_id
required
PrivateLink Endpoint ID
Example : bba6d4de3ad64e41b3a1b6c88983ec02
stringNone

Responses

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

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_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 = vpc 1.1"

Example HTTP response

Response 202

9.1.33 - Delete PrivateLink Service

9.1.33.1 - 1.3

delete /v1/privatelink-services/{privatelink_service_id}

Description

PrivateLink Service 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_service_id
required
PrivateLink Service ID
Example : e3df2e8e3b374fbb81d4e322b52ca50d
stringNone

Responses

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

Example HTTP request

Request path

/v1/privatelink-services/{privatelink_service_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 = vpc 1.3"

Example HTTP response

Response 202

9.1.33.2 - 1.2

delete /v1/privatelink-services/{privatelink_service_id}

Description

PrivateLink Service 삭제

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_service_id
required
PrivateLink Service ID
Example : e3df2e8e3b374fbb81d4e322b52ca50d
stringNone

Responses

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

Example HTTP request

Request path

/v1/privatelink-services/{privatelink_service_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 = vpc 1.2"

Example HTTP response

Response 202

9.1.33.3 - 1.1

delete /v1/privatelink-services/{privatelink_service_id}

Description

PrivateLink Service 삭제

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_service_id
required
PrivateLink Service ID
Example : e3df2e8e3b374fbb81d4e322b52ca50d
stringNone

Responses

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

Example HTTP request

Request path

/v1/privatelink-services/{privatelink_service_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 = vpc 1.1"

Example HTTP response

Response 202

9.1.34 - Delete PublicIP

9.1.34.1 - 1.3

delete /v1/publicips/{publicip_id}

Description

PublicIP를 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathpublicip_id
required
PublicIP ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/publicips/{publicip_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 = vpc 1.3"

Example HTTP response

Response 204

9.1.34.2 - 1.2

delete /v1/publicips/{publicip_id}

Description

PublicIP를 삭제한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathpublicip_id
required
PublicIP ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/publicips/{publicip_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 = vpc 1.2"

Example HTTP response

Response 204

9.1.34.3 - 1.1

delete /v1/publicips/{publicip_id}

Description

PublicIP를 삭제한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathpublicip_id
required
PublicIP ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/publicips/{publicip_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 = vpc 1.1"

Example HTTP response

Response 204

9.1.34.4 - 1.0

delete /v1/publicips/{publicip_id}

Description

PublicIP를 삭제한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathpublicip_id
required
PublicIP ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/publicips/{publicip_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 = vpc 1.0"

Example HTTP response

Response 204

9.1.35 - Delete Subnet

9.1.35.1 - 1.3

delete /v1/subnets/{subnet_id}

Description

Subnet을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/subnets/{subnet_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 = vpc 1.3"

Example HTTP response

Response 202

9.1.35.2 - 1.2

delete /v1/subnets/{subnet_id}

Description

Subnet을 삭제한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/subnets/{subnet_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 = vpc 1.2"

Example HTTP response

Response 202

9.1.35.3 - 1.1

delete /v1/subnets/{subnet_id}

Description

Subnet을 삭제한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/subnets/{subnet_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 = vpc 1.1"

Example HTTP response

Response 202

9.1.35.4 - 1.0

delete /v1/subnets/{subnet_id}

Description

Subnet을 삭제한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/subnets/{subnet_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 = vpc 1.0"

Example HTTP response

Response 202

9.1.36 - Delete Subnet Vip

9.1.36.1 - 1.3

delete /v1/subnets/{subnet_id}/vips/{vip_id}

Description

Subnet Vip 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone
pathvip_id
required
Subnet Vip Id
Example : 0466a9448d9a4411a86055939e451c8f
stringNone

Responses

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

Example HTTP request

Request path

/v1/subnets/{subnet_id}/vips/{vip_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 = vpc 1.3"

Example HTTP response

Response 204

9.1.36.2 - 1.2

delete /v1/subnets/{subnet_id}/vips/{vip_id}

Description

Subnet Vip 삭제

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone
pathvip_id
required
Subnet Vip Id
Example : 0466a9448d9a4411a86055939e451c8f
stringNone

Responses

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

Example HTTP request

Request path

/v1/subnets/{subnet_id}/vips/{vip_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 = vpc 1.2"

Example HTTP response

Response 204

9.1.37 - Delete Subnet Vip Connected Port

9.1.37.1 - 1.3

delete /v1/subnets/{subnet_id}/vips/{vip_id}/connected-ports/{connected_port_id}

Description

Subnet Vip 연결 Port 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone
pathvip_id
required
Subnet Vip Id
Example : 0466a9448d9a4411a86055939e451c8f
stringNone
pathconnected_port_id
required
Subnet Vip 연결 Port Id
Example : 13e2a5a1acbe4713a9a2c70ce226e822
stringNone

Responses

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

Example HTTP request

Request path

/v1/subnets/{subnet_id}/vips/{vip_id}/connected-ports/{connected_port_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 = vpc 1.3"

Example HTTP response

Response 204

9.1.37.2 - 1.2

delete /v1/subnets/{subnet_id}/vips/{vip_id}/connected-ports/{connected_port_id}

Description

Subnet Vip 연결 Port 삭제

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone
pathvip_id
required
Subnet Vip Id
Example : 0466a9448d9a4411a86055939e451c8f
stringNone
pathconnected_port_id
required
Subnet Vip 연결 Port Id
Example : 13e2a5a1acbe4713a9a2c70ce226e822
stringNone

Responses

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

Example HTTP request

Request path

/v1/subnets/{subnet_id}/vips/{vip_id}/connected-ports/{connected_port_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 = vpc 1.2"

Example HTTP response

Response 204

9.1.38 - Delete Subnet VIP NAT IP

9.1.38.1 - 1.3

delete /v1/subnets/{subnet_id}/vips/{vip_id}/static-nat-ips/{static_nat_id}

Description

Subnet Vip Nat Ip 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone
pathvip_id
required
Subnet Vip Id
Example : 0466a9448d9a4411a86055939e451c8f
stringNone
pathstatic_nat_id
required
Static NAT ID
Example : 0009e49548154745948e9722adefbf40
stringNone

Responses

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

Example HTTP request

Request path

/v1/subnets/{subnet_id}/vips/{vip_id}/static-nat-ips/{static_nat_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 = vpc 1.3"

Example HTTP response

Response 202

9.1.38.2 - 1.2

delete /v1/subnets/{subnet_id}/vips/{vip_id}/static-nat-ips/{static_nat_id}

Description

Subnet Vip Nat Ip 삭제

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone
pathvip_id
required
Subnet Vip Id
Example : 0466a9448d9a4411a86055939e451c8f
stringNone
pathstatic_nat_id
required
Static NAT ID
Example : 0009e49548154745948e9722adefbf40
stringNone

Responses

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

Example HTTP request

Request path

/v1/subnets/{subnet_id}/vips/{vip_id}/static-nat-ips/{static_nat_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 = vpc 1.2"

Example HTTP response

Response 202

9.1.39 - Delete Transit Gateway

9.1.39.1 - 1.3

delete /v1/transit-gateways/{transit_gateway_id}

Description

Transit Gateway 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_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 = vpc 1.3"

Example HTTP response

Response 202

9.1.39.2 - 1.2

delete /v1/transit-gateways/{transit_gateway_id}

Description

Transit Gateway 삭제

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_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 = vpc 1.2"

Example HTTP response

Response 202

9.1.39.3 - 1.1

delete /v1/transit-gateways/{transit_gateway_id}

Description

Transit Gateway 삭제

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_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 = vpc 1.1"

Example HTTP response

Response 202

9.1.39.4 - 1.0

delete /v1/transit-gateways/{transit_gateway_id}

Description

Transit Gateway 삭제

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_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 = vpc 1.0"

Example HTTP response

Response 202

9.1.40 - Delete Transit Gateway Firewall

9.1.40.1 - 1.3

delete /v1/transit-gateways/{transit_gateway_id}/firewalls/{firewall_id}

Description

Transit Gateway 방화벽 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
pathfirewall_id
required
Firewall ID
Example : bbb93aca123f4bb2b2c0f206f4a86b2b
stringNone

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/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 = vpc 1.3"

Example HTTP response

Response 202

{
    "state": "ACTIVE",
    "uplink_active_zone": "kr-west1-a",
    "uplink_standby_zone": "kr-west1-b",
    "uplink_zone_state": "ACTIVE"
}

9.1.40.2 - 1.2

delete /v1/transit-gateways/{transit_gateway_id}/firewalls/{firewall_id}

Description

Transit Gateway 방화벽 삭제

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
pathfirewall_id
required
Firewall ID
Example : bbb93aca123f4bb2b2c0f206f4a86b2b
stringNone

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/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 = vpc 1.2"

Example HTTP response

Response 204

9.1.41 - Delete Transit Gateway Firewall Connection

9.1.41.1 - 1.3

delete /v1/transit-gateways/{transit_gateway_id}/firewall-connections

Description

Transit Gateway 방화벽 연결 삭제.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/firewall-connections

Request header

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

Example HTTP response

Response 202

{
    "firewall_connection_state": "INACTIVE"
}

9.1.41.2 - 1.2

delete /v1/transit-gateways/{transit_gateway_id}/firewall-connections

Description

Transit Gateway 방화벽 연결 삭제.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/firewall-connections

Request header

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

Example HTTP response

Response 202

{
    "transit_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "TransitGateway Description",
        "firewall_connection_state": "INACTIVE",
        "firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "TransitGatewayName",
        "state": "ACTIVE",
        "uplink_enabled": "False"
    }
}

9.1.42 - Delete Transit Gateway Rule

9.1.42.1 - 1.3

delete /v1/transit-gateways/{transit_gateway_id}/routing-rules/{routing_rule_id}

Description

Transit Gateway 규칙 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
pathrouting_rule_id
required
Routing Rule ID
Example : 43772aff4539403d9ba74bf1fdaa00c8
stringNone

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/routing-rules/{routing_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 = vpc 1.3"

Example HTTP response

Response 202

9.1.42.2 - 1.2

delete /v1/transit-gateways/{transit_gateway_id}/routing-rules/{routing_rule_id}

Description

Transit Gateway 규칙 삭제

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
pathrouting_rule_id
required
Routing Rule ID
Example : 43772aff4539403d9ba74bf1fdaa00c8
stringNone

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/routing-rules/{routing_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 = vpc 1.2"

Example HTTP response

Response 202

9.1.42.3 - 1.1

delete /v1/transit-gateways/{transit_gateway_id}/routing-rules/{routing_rule_id}

Description

Transit Gateway 규칙 삭제

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
pathrouting_rule_id
required
Routing Rule ID
Example : 43772aff4539403d9ba74bf1fdaa00c8
stringNone

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/routing-rules/{routing_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 = vpc 1.1"

Example HTTP response

Response 202

9.1.42.4 - 1.0

delete /v1/transit-gateways/{transit_gateway_id}/routing-rules/{routing_rule_id}

Description

Transit Gateway 규칙 삭제

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
pathrouting_rule_id
required
Routing Rule ID
Example : 43772aff4539403d9ba74bf1fdaa00c8
stringNone

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/routing-rules/{routing_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 = vpc 1.0"

Example HTTP response

Response 202

9.1.43 - Delete Transit Gateway Uplink Rule

9.1.43.1 - 1.3

delete /v1/transit-gateways/{transit_gateway_id}/uplink-routing-rules/{routing_rule_id}

Description

Transit Gateway Uplink 규칙 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
pathrouting_rule_id
required
Routing Rule ID
Example : 43772aff4539403d9ba74bf1fdaa00c8
stringNone

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/uplink-routing-rules/{routing_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 = vpc 1.3"

Example HTTP response

Response 202

9.1.43.2 - 1.2

delete /v1/transit-gateways/{transit_gateway_id}/uplink-routing-rules/{routing_rule_id}

Description

Transit Gateway Uplink 규칙 삭제

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
pathrouting_rule_id
required
Routing Rule ID
Example : 43772aff4539403d9ba74bf1fdaa00c8
stringNone

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/uplink-routing-rules/{routing_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 = vpc 1.2"

Example HTTP response

Response 202

9.1.43.3 - 1.1

delete /v1/transit-gateways/{transit_gateway_id}/uplink-routing-rules/{routing_rule_id}

Description

Transit Gateway Uplink 규칙 삭제

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
pathrouting_rule_id
required
Routing Rule ID
Example : 43772aff4539403d9ba74bf1fdaa00c8
stringNone

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/uplink-routing-rules/{routing_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 = vpc 1.1"

Example HTTP response

Response 202

9.1.43.4 - 1.0

delete /v1/transit-gateways/{transit_gateway_id}/uplink-routing-rules/{routing_rule_id}

Description

Transit Gateway Uplink 규칙 삭제

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
pathrouting_rule_id
required
Routing Rule ID
Example : 43772aff4539403d9ba74bf1fdaa00c8
stringNone

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/uplink-routing-rules/{routing_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 = vpc 1.0"

Example HTTP response

Response 202

9.1.44 - Delete Transit Gateway VPC Connection

9.1.44.1 - 1.3

delete /v1/transit-gateways/{transit_gateway_id}/vpc-connections/{vpc_connection_id}

Description

Transit Gateway VPC 연결 삭제.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
pathvpc_connection_id
required
Transit Gateway VPC 연결 ID
Example : ffeced8e191c478eabd66b6e2cab8e34
stringNone

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/vpc-connections/{vpc_connection_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 = vpc 1.3"

Example HTTP response

Response 202

9.1.44.2 - 1.2

delete /v1/transit-gateways/{transit_gateway_id}/vpc-connections/{vpc_connection_id}

Description

Transit Gateway VPC 연결 삭제.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
pathvpc_connection_id
required
Transit Gateway VPC 연결 ID
Example : ffeced8e191c478eabd66b6e2cab8e34
stringNone

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/vpc-connections/{vpc_connection_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 = vpc 1.2"

Example HTTP response

Response 202

9.1.44.3 - 1.1

delete /v1/transit-gateways/{transit_gateway_id}/vpc-connections/{vpc_connection_id}

Description

Transit Gateway VPC 연결 삭제.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
pathvpc_connection_id
required
Transit Gateway VPC 연결 ID
Example : ffeced8e191c478eabd66b6e2cab8e34
stringNone

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/vpc-connections/{vpc_connection_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 = vpc 1.1"

Example HTTP response

Response 202

9.1.44.4 - 1.0

delete /v1/transit-gateways/{transit_gateway_id}/vpc-connections/{vpc_connection_id}

Description

Transit Gateway VPC 연결 삭제.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
pathvpc_connection_id
required
Transit Gateway VPC 연결 ID
Example : ffeced8e191c478eabd66b6e2cab8e34
stringNone

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/vpc-connections/{vpc_connection_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 = vpc 1.0"

Example HTTP response

Response 202

9.1.45 - Delete VPC

9.1.45.1 - 1.3

delete /v1/vpcs/{vpc_id}

Description

VPC를 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_id
required
VPC ID
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/vpcs/{vpc_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 = vpc 1.3"

Example HTTP response

Response 204

9.1.45.2 - 1.2

delete /v1/vpcs/{vpc_id}

Description

VPC를 삭제한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_id
required
VPC ID
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/vpcs/{vpc_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 = vpc 1.2"

Example HTTP response

Response 204

9.1.45.3 - 1.1

delete /v1/vpcs/{vpc_id}

Description

VPC를 삭제한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_id
required
VPC ID
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/vpcs/{vpc_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 = vpc 1.1"

Example HTTP response

Response 204

9.1.45.4 - 1.0

delete /v1/vpcs/{vpc_id}

Description

VPC를 삭제한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_id
required
VPC ID
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/vpcs/{vpc_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 = vpc 1.0"

Example HTTP response

Response 204

9.1.46 - Delete VPC Endpoint

9.1.46.1 - 1.3

delete /v1/vpc-endpoints/{vpc_endpoint_id}

Description

VPC Endpoint 를 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_endpoint_id
required
VPC Endpoint ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone

Responses

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

Example HTTP request

Request path

/v1/vpc-endpoints/{vpc_endpoint_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 = vpc 1.3"

Example HTTP response

Response 202

9.1.46.2 - 1.2

delete /v1/vpc-endpoints/{vpc_endpoint_id}

Description

VPC Endpoint 를 삭제한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_endpoint_id
required
VPC Endpoint ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone

Responses

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

Example HTTP request

Request path

/v1/vpc-endpoints/{vpc_endpoint_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 = vpc 1.2"

Example HTTP response

Response 202

9.1.46.3 - 1.1

delete /v1/vpc-endpoints/{vpc_endpoint_id}

Description

VPC Endpoint 를 삭제한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_endpoint_id
required
VPC Endpoint ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone

Responses

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

Example HTTP request

Request path

/v1/vpc-endpoints/{vpc_endpoint_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 = vpc 1.1"

Example HTTP response

Response 202

9.1.46.4 - 1.0

delete /v1/vpc-endpoints/{vpc_endpoint_id}

Description

VPC Endpoint 를 삭제한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_endpoint_id
required
VPC Endpoint ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone

Responses

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

Example HTTP request

Request path

/v1/vpc-endpoints/{vpc_endpoint_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 = vpc 1.0"

Example HTTP response

Response 202

9.1.47 - Delete VPC Peering

9.1.47.1 - 1.3

delete /v1/vpc-peerings/{vpc_peering_id}

Description

VPC Peering 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_peering_id
required
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
stringNone

Responses

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

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_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 = vpc 1.3"

Example HTTP response

Response 202

9.1.47.2 - 1.2

delete /v1/vpc-peerings/{vpc_peering_id}

Description

VPC Peering 삭제

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_peering_id
required
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
stringNone

Responses

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

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_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 = vpc 1.2"

Example HTTP response

Response 202

9.1.47.3 - 1.1

delete /v1/vpc-peerings/{vpc_peering_id}

Description

VPC Peering 삭제

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_peering_id
required
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
stringNone

Responses

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

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_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 = vpc 1.1"

Example HTTP response

Response 202

9.1.47.4 - 1.0

delete /v1/vpc-peerings/{vpc_peering_id}

Description

VPC Peering 삭제

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_peering_id
required
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
stringNone

Responses

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

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_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 = vpc 1.0"

Example HTTP response

Response 202

9.1.48 - Delete VPC Peering Rule

9.1.48.1 - 1.3

delete /v1/vpc-peerings/{vpc_peering_id}/routing-rules/{routing_rule_id}

Description

VPC Peering 규칙 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_peering_id
required
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
stringNone
pathrouting_rule_id
required
Routing Rule ID
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_id}/routing-rules/{routing_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 = vpc 1.3"

Example HTTP response

Response 202

9.1.48.2 - 1.2

delete /v1/vpc-peerings/{vpc_peering_id}/routing-rules/{routing_rule_id}

Description

VPC Peering 규칙 삭제

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_peering_id
required
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
stringNone
pathrouting_rule_id
required
Routing Rule ID
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_id}/routing-rules/{routing_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 = vpc 1.2"

Example HTTP response

Response 202

9.1.48.3 - 1.1

delete /v1/vpc-peerings/{vpc_peering_id}/routing-rules/{routing_rule_id}

Description

VPC Peering 규칙 삭제

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_peering_id
required
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
stringNone
pathrouting_rule_id
required
Routing Rule ID
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_id}/routing-rules/{routing_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 = vpc 1.1"

Example HTTP response

Response 202

9.1.48.4 - 1.0

delete /v1/vpc-peerings/{vpc_peering_id}/routing-rules/{routing_rule_id}

Description

VPC Peering 규칙 삭제

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_peering_id
required
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
stringNone
pathrouting_rule_id
required
Routing Rule ID
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_id}/routing-rules/{routing_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 = vpc 1.0"

Example HTTP response

Response 202

9.1.49 - List Connected PrivateLink Endpoints

9.1.49.1 - 1.3

get /v1/privatelink-services/{privatelink_service_id}/connected-endpoints

Description

연결된 PrivateLink Endpoint 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_service_id
required
PrivateLink Service ID
Example : e3df2e8e3b374fbb81d4e322b52ca50d
stringNone
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

Responses

HTTP CodeDescriptionSchema
200OKConnectedEndpointListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/privatelink-services/{privatelink_service_id}/connected-endpoints

Request header

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

Example HTTP response

Response 200

{
    "connected_privatelink_endpoints": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
            "state": "ACTIVE"
        }
    ],
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

9.1.49.2 - 1.2

get /v1/privatelink-services/{privatelink_service_id}/connected-endpoints

Description

연결된 PrivateLink Endpoint 목록 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_service_id
required
PrivateLink Service ID
Example : e3df2e8e3b374fbb81d4e322b52ca50d
stringNone
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

Responses

HTTP CodeDescriptionSchema
200OKConnectedEndpointListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/privatelink-services/{privatelink_service_id}/connected-endpoints

Request header

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

Example HTTP response

Response 200

{
    "connected_privatelink_endpoints": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
            "state": "ACTIVE"
        }
    ],
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

9.1.49.3 - 1.1

get /v1/privatelink-services/{privatelink_service_id}/connected-endpoints

Description

연결된 PrivateLink Endpoint 목록 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_service_id
required
PrivateLink Service ID
Example : e3df2e8e3b374fbb81d4e322b52ca50d
stringNone
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

Responses

HTTP CodeDescriptionSchema
200OKConnectedEndpointListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/privatelink-services/{privatelink_service_id}/connected-endpoints

Request header

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

Example HTTP response

Response 200

{
    "connected_privatelink_endpoints": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
            "state": "ACTIVE"
        }
    ],
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

9.1.50 - List Internet Gateways

9.1.50.1 - 1.3

get /v1/internet-gateways

Description

Internet Gateway 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

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
queryid
optional
Internet Gateway ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]None
queryname
optional
Internet Gateway 명
Example : IGW_VPCname
any of [string, null]None
querytype
optional
Internet Gateway 유형
Example :
enum (IGW, GGW, SIGW)
querystate
optional
상태
Example :
string
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]
queryvpc_name
optional
VPC 명
Example : vpcName
any of [string, null]

Responses

HTTP CodeDescriptionSchema
200OKInternetGatewayListResponseV1Dot3
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/internet-gateways

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "internet_gateways": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Internet Gateway Description",
            "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
            "id": "023c57b14f11483689338d085e061492",
            "loggable": false,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "multi_zone_enabled": true,
            "name": "IGW_VPCname",
            "state": "CREATING",
            "type": "IGW",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

9.1.50.2 - 1.2

get /v1/internet-gateways

Description

Internet Gateway 목록을 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

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
queryid
optional
Internet Gateway ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]None
queryname
optional
Internet Gateway 명
Example : IGW_VPCname
any of [string, null]None
querytype
optional
Internet Gateway 유형
Example :
enum (IGW, GGW, SIGW)
querystate
optional
상태
Example :
string
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]
queryvpc_name
optional
VPC 명
Example : vpcName
any of [string, null]

Responses

HTTP CodeDescriptionSchema
200OKInternetGatewayListResponseV1Dot2
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/internet-gateways

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "internet_gateways": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Internet Gateway Description",
            "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
            "id": "023c57b14f11483689338d085e061492",
            "loggable": false,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "IGW_VPCname",
            "state": "CREATING",
            "type": "IGW",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

9.1.50.3 - 1.1

get /v1/internet-gateways

Description

Internet Gateway 목록을 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
querywith_count
optional
with count
Example : true
any of [string, null]None
querylimit
optional
한도
Example : 20
any of [integer, null]None
querymarker
optional
마커
Example : 607e0938521643b5b4b266f343fae693
any of [string, null]None
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
queryid
optional
Internet Gateway ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]None
queryname
optional
Internet Gateway 명
Example : IGW_VPCname
any of [string, null]None
querytype
optional
Internet Gateway 유형
Example :
enum (IGW, GGW, SIGW)
querystate
optional
상태
Example :
string
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]
queryvpc_name
optional
VPC 명
Example : vpcName
any of [string, null]

Responses

HTTP CodeDescriptionSchema
200OKInternetGatewayListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/internet-gateways

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "internet_gateways": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Internet Gateway Description",
            "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
            "id": "023c57b14f11483689338d085e061492",
            "loggable": false,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "IGW_VPCname",
            "state": "CREATING",
            "type": "IGW",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ],
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

9.1.50.4 - 1.0

get /v1/internet-gateways

Description

Internet Gateway 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
querywith_count
optional
with count
Example : true
any of [string, null]None
querylimit
optional
한도
Example : 20
any of [integer, null]None
querymarker
optional
마커
Example : 607e0938521643b5b4b266f343fae693
any of [string, null]None
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
queryid
optional
Internet Gateway ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]None
queryname
optional
Internet Gateway 명
Example : IGW_VPCname
any of [string, null]None
querytype
optional
Internet Gateway 유형
Example :
enum (IGW, GGW, SIGW)
querystate
optional
상태
Example :
string
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]
queryvpc_name
optional
VPC 명
Example : vpcName
any of [string, null]

Responses

HTTP CodeDescriptionSchema
200OKInternetGatewayListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/internet-gateways

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "internet_gateways": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Internet Gateway Description",
            "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
            "id": "023c57b14f11483689338d085e061492",
            "loggable": false,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "IGW_VPCname",
            "state": "CREATING",
            "type": "IGW",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ],
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

9.1.51 - List NAT Gateways

9.1.51.1 - 1.3

get /v1/nat-gateways

Description

NAT Gateway 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

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
NAT Gateway 명
Example : NatGatewayName
any of [string, null]None
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
queryvpc_name
optional
VPC 명
Example : vpcName
any of [string, null]None
querysubnet_id
optional
Subnet ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]None
querysubnet_name
optional
Subnet 명
Example : subnetName
any of [string, null]None
querynat_gateway_ip_address
optional
NAT Gateway IP 주소
Example : 192.167.0.5
any of [string, null]None
querystate
optional
NAT Gateway 상태
Example : ACTIVE
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]None
querymulti_zone_enabled
optional
Multi Zone 사용
Example : true
any of [boolean, null]None

Responses

HTTP CodeDescriptionSchema
200OKNatGatewayListResponseV1Dot3
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/nat-gateways

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "nat_gateways": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "VpcEndpoint Description",
            "id": "12f56e27070248a6a240a497e43fbe18",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "multi_zone_enabled": "true",
            "name": "NatGatewayName",
            "nat_gateway_ips": [
                {
                    "ip_address": "192.167.0.5",
                    "publicip_id": "12f56e27070248a6a240a497e43fbe18"
                }
            ],
            "state": "ACTIVE",
            "subnet_cidr": "192.167.1.0/24",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "subnet_name": "subnetName",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

9.1.51.2 - 1.2

get /v1/nat-gateways

Description

NAT Gateway 목록을 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

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
NAT Gateway 명
Example : NatGatewayName
any of [string, null]None
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
queryvpc_name
optional
VPC 명
Example : vpcName
any of [string, null]None
querysubnet_id
optional
Subnet ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]None
querysubnet_name
optional
Subnet 명
Example : subnetName
any of [string, null]None
querynat_gateway_ip_address
optional
NAT Gateway IP 주소
Example : 192.167.0.5
any of [string, null]None
querystate
optional
NAT Gateway 상태
Example : ACTIVE
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]None

Responses

HTTP CodeDescriptionSchema
200OKNatGatewayListResponseV1Dot2
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/nat-gateways

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "nat_gateways": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "VpcEndpoint Description",
            "id": "12f56e27070248a6a240a497e43fbe18",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "NatGatewayName",
            "nat_gateway_ip_address": "192.167.0.5",
            "publicip_id": "12f56e27070248a6a240a497e43fbe18",
            "state": "ACTIVE",
            "subnet_cidr": "192.167.1.0/24",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "subnet_name": "subnetName",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

9.1.51.3 - 1.1

get /v1/nat-gateways

Description

NAT Gateway 목록을 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
querywith_count
optional
with count
Example : true
any of [string, null]None
querylimit
optional
한도
Example : 20
any of [integer, null]None
querymarker
optional
마커
Example : 607e0938521643b5b4b266f343fae693
any of [string, null]None
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
queryname
optional
NAT Gateway 명
Example : NatGatewayName
any of [string, null]None
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
queryvpc_name
optional
VPC 명
Example : vpcName
any of [string, null]None
querysubnet_id
optional
Subnet ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]None
querysubnet_name
optional
Subnet 명
Example : subnetName
any of [string, null]None
querynat_gateway_ip_address
optional
NAT Gateway IP 주소
Example : 192.167.0.5
any of [string, null]None
querystate
optional
NAT Gateway 상태
Example : ACTIVE
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]None

Responses

HTTP CodeDescriptionSchema
200OKNatGatewayListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/nat-gateways

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "nat_gateways": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "VpcEndpoint Description",
            "id": "12f56e27070248a6a240a497e43fbe18",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "NatGatewayName",
            "nat_gateway_ip_address": "192.167.0.5",
            "publicip_id": "12f56e27070248a6a240a497e43fbe18",
            "state": "ACTIVE",
            "subnet_cidr": "192.167.1.0/24",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "subnet_name": "subnetName",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ]
}

9.1.51.4 - 1.0

get /v1/nat-gateways

Description

NAT Gateway 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
querywith_count
optional
with count
Example : true
any of [string, null]None
querylimit
optional
한도
Example : 20
any of [integer, null]None
querymarker
optional
마커
Example : 607e0938521643b5b4b266f343fae693
any of [string, null]None
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
queryname
optional
NAT Gateway 명
Example : NatGatewayName
any of [string, null]None
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
queryvpc_name
optional
VPC 명
Example : vpcName
any of [string, null]None
querysubnet_id
optional
Subnet ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]None
querysubnet_name
optional
Subnet 명
Example : subnetName
any of [string, null]None
querynat_gateway_ip_address
optional
NAT Gateway IP 주소
Example : 192.167.0.5
any of [string, null]None
querystate
optional
NAT Gateway 상태
Example : ACTIVE
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]None

Responses

HTTP CodeDescriptionSchema
200OKNatGatewayListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/nat-gateways

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "nat_gateways": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "VpcEndpoint Description",
            "id": "12f56e27070248a6a240a497e43fbe18",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "NatGatewayName",
            "nat_gateway_ip_address": "192.167.0.5",
            "publicip_id": "12f56e27070248a6a240a497e43fbe18",
            "state": "ACTIVE",
            "subnet_cidr": "192.167.1.0/24",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "subnet_name": "subnetName",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ]
}

9.1.52 - List Ports

9.1.52.1 - 1.3

get /v1/ports

Description

Port 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
querywith_count
optional
with count
Example : true
any of [string, null]None
querylimit
optional
Port 제한
Example :
any of [integer, null]None
querymarker
optional
Port 마커
Example :
any of [string, null]None
querysort
optional
Port 정렬
Example :
any of [string, null]None
queryname
optional
Port 명
Example : portName
any of [string, null]None
querysubnet_id
optional
Subnet ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]None
querysubnet_name
optional
Subnet 명
Example : subnetName
any of [string, null]None
queryid
optional
Port ID
Example : 023c57b1-4f11-4836-8933-8d085e061492
any of [string, null]None
queryattached_resource_id
optional
연결된 자원 ID
Example : 9387e8f51de04a03994de8a9c3524935
any of [string, null]None
queryfixed_ip_address
optional
고정된 IP
Example : 192.168.1.100
any of [string, null]None
querymac_address
optional
MAC 주소
Example : fa:16:3e:00:00:01
any of [string, null]None
querystate
optional
상태
Example :
any of [string, null]None
querysecurity_groups
optional
Security Group 목록
Example :
any of [string, null]None
queryattached_resource_types
optional
연결된 자원 유형
Example :
any of [enum (VIRTUAL_SERVER, PRIVATELINKE, UNATTACHED), array[enum (VIRTUAL_SERVER, PRIVATELINKE, UNATTACHED)]]None

Responses

HTTP CodeDescriptionSchema
200OKPortListResponse
400Bad RequestNone
403ForbiddenNone

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 = ko-KR",
"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"
        }
    ]
}

9.1.52.2 - 1.2

get /v1/ports

Description

Port 목록을 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
querywith_count
optional
with count
Example : true
any of [string, null]None
querylimit
optional
Port 제한
Example :
any of [integer, null]None
querymarker
optional
Port 마커
Example :
any of [string, null]None
querysort
optional
Port 정렬
Example :
any of [string, null]None
queryname
optional
Port 명
Example : portName
any of [string, null]None
querysubnet_id
optional
Subnet ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]None
querysubnet_name
optional
Subnet 명
Example : subnetName
any of [string, null]None
queryid
optional
Port ID
Example : 023c57b1-4f11-4836-8933-8d085e061492
any of [string, null]None
queryattached_resource_id
optional
연결된 자원 ID
Example : 9387e8f51de04a03994de8a9c3524935
any of [string, null]None
queryfixed_ip_address
optional
고정된 IP
Example : 192.168.1.100
any of [string, null]None
querymac_address
optional
MAC 주소
Example : fa:16:3e:00:00:01
any of [string, null]None
querystate
optional
상태
Example :
any of [string, null]None
querysecurity_groups
optional
Security Group 목록
Example :
any of [string, null]None
queryattached_resource_types
optional
연결된 자원 유형
Example :
any of [enum (VIRTUAL_SERVER, PRIVATELINKE, UNATTACHED), array[enum (VIRTUAL_SERVER, PRIVATELINKE, UNATTACHED)]]None

Responses

HTTP CodeDescriptionSchema
200OKPortListResponse
400Bad RequestNone
403ForbiddenNone

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 = ko-KR",
"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"
        }
    ]
}

9.1.52.3 - 1.1

get /v1/ports

Description

Port 목록을 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
querywith_count
optional
with count
Example : true
any of [string, null]None
querylimit
optional
Port 제한
Example :
any of [integer, null]None
querymarker
optional
Port 마커
Example :
any of [string, null]None
querysort
optional
Port 정렬
Example :
any of [string, null]None
queryname
optional
Port 명
Example : portName
any of [string, null]None
querysubnet_id
optional
Subnet ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]None
querysubnet_name
optional
Subnet 명
Example : subnetName
any of [string, null]None
queryid
optional
Port ID
Example : 023c57b1-4f11-4836-8933-8d085e061492
any of [string, null]None
queryattached_resource_id
optional
연결된 자원 ID
Example : 9387e8f51de04a03994de8a9c3524935
any of [string, null]None
queryfixed_ip_address
optional
고정된 IP
Example : 192.168.1.100
any of [string, null]None
querymac_address
optional
MAC 주소
Example : fa:16:3e:00:00:01
any of [string, null]None
querystate
optional
상태
Example :
any of [string, null]None
querysecurity_groups
optional
Security Group 목록
Example :
any of [string, null]None
queryattached_resource_types
optional
연결된 자원 유형
Example :
any of [enum (VIRTUAL_SERVER, PRIVATELINKE, UNATTACHED), array[enum (VIRTUAL_SERVER, PRIVATELINKE, UNATTACHED)]]None

Responses

HTTP CodeDescriptionSchema
200OKPortListResponse
400Bad RequestNone
403ForbiddenNone

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 = ko-KR",
"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"
        }
    ]
}

9.1.52.4 - 1.0

get /v1/ports

Description

Port 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
querywith_count
optional
with count
Example : true
any of [string, null]None
querylimit
optional
Port 제한
Example :
any of [integer, null]None
querymarker
optional
Port 마커
Example :
any of [string, null]None
querysort
optional
Port 정렬
Example :
any of [string, null]None
queryname
optional
Port 명
Example : portName
any of [string, null]None
querysubnet_id
optional
Subnet ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]None
querysubnet_name
optional
Subnet 명
Example : subnetName
any of [string, null]None
queryid
optional
Port ID
Example : 023c57b1-4f11-4836-8933-8d085e061492
any of [string, null]None
queryattached_resource_id
optional
연결된 자원 ID
Example : 9387e8f51de04a03994de8a9c3524935
any of [string, null]None
queryfixed_ip_address
optional
고정된 IP
Example : 192.168.1.100
any of [string, null]None
querymac_address
optional
MAC 주소
Example : fa:16:3e:00:00:01
any of [string, null]None
querystate
optional
상태
Example :
any of [string, null]None
querysecurity_groups
optional
Security Group 목록
Example :
any of [string, null]None
queryattached_resource_types
optional
연결된 자원 유형
Example :
any of [enum (VIRTUAL_SERVER, PRIVATELINKE, UNATTACHED), array[enum (VIRTUAL_SERVER, PRIVATELINKE, UNATTACHED)]]None

Responses

HTTP CodeDescriptionSchema
200OKPortListResponse
400Bad RequestNone
403ForbiddenNone

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 = ko-KR",
"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"
        }
    ]
}

9.1.53 - List Private NAT

9.1.53.1 - 1.3

get /v1/private-nats

Description

Private NAT 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

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
Private NAT 명
Example : PrivateNatName
any of [string, null]None
querycidr
optional
Private NAT IP 대역
Example : 192.167.0.0/24
any of [string, null]None
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
queryservice_resource_id
optional
Private NAT에 연결된 Service Resource ID
Example : 3f342bf9a557405b997c2cf48c89cbc2
any of [string, null]None
queryservice_type
optional
Private NAT에 연결된 Service Type
Example : DIRECT_CONNECT
enum (DIRECT_CONNECT, TRANSIT_GATEWAY)None
queryservice_resource_name
optional
Private NAT에 연결된 Service Resource 이름
Example : Service Resource Name
any of [string, null]None
querystate
optional
Private NAT 상태
Example : ACTIVE
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]None

Responses

HTTP CodeDescriptionSchema
200OKPrivateNatListResponseV1Dot2
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/private-nats

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "private_nats": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "cidr": "192.167.0.0/24",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "PrivateNat Description",
            "id": "12f56e27070248a6a240a497e43fbe18",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "PrivateNatName",
            "service_resource_id": "3f342bf9a557405b997c2cf48c89cbc2",
            "service_resource_name": "PrivateNatName",
            "service_type": "DIRECT_CONNECT",
            "state": "ACTIVE"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

9.1.53.2 - 1.2

get /v1/private-nats

Description

Private NAT 목록 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

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
Private NAT 명
Example : PrivateNatName
any of [string, null]None
querycidr
optional
Private NAT IP 대역
Example : 192.167.0.0/24
any of [string, null]None
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
queryservice_resource_id
optional
Private NAT에 연결된 Service Resource ID
Example : 3f342bf9a557405b997c2cf48c89cbc2
any of [string, null]None
queryservice_type
optional
Private NAT에 연결된 Service Type
Example : DIRECT_CONNECT
enum (DIRECT_CONNECT, TRANSIT_GATEWAY)None
queryservice_resource_name
optional
Private NAT에 연결된 Service Resource 이름
Example : Service Resource Name
any of [string, null]None
querystate
optional
Private NAT 상태
Example : ACTIVE
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]None

Responses

HTTP CodeDescriptionSchema
200OKPrivateNatListResponseV1Dot2
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/private-nats

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "private_nats": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "cidr": "192.167.0.0/24",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "PrivateNat Description",
            "id": "12f56e27070248a6a240a497e43fbe18",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "PrivateNatName",
            "service_resource_id": "3f342bf9a557405b997c2cf48c89cbc2",
            "service_resource_name": "PrivateNatName",
            "service_type": "DIRECT_CONNECT",
            "state": "ACTIVE"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

9.1.53.3 - 1.1

get /v1/private-nats

Description

Private NAT 목록 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

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
Private NAT 명
Example : PrivateNatName
any of [string, null]None
querycidr
optional
Private NAT IP 대역
Example : 192.167.0.0/24
any of [string, null]None
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
queryvpc_name
optional
VPC 명
Example : vpcName
any of [string, null]None
querydirect_connect_id
optional
Direct Connect ID
Example : fe860e0af0c04dcd8182b84f907f31f4
any of [string, null]None
querydirect_connect_name
optional
Direct Connect명
Example : DirectConnectName
any of [string, null]None
querystate
optional
Private NAT 상태
Example : ACTIVE
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]None

Responses

HTTP CodeDescriptionSchema
200OKPrivateNatListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/private-nats

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "private_nats": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "cidr": "192.167.0.0/24",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "PrivateNat Description",
            "direct_connect_id": "fe860e0af0c04dcd8182b84f907f31f4",
            "direct_connect_name": "DirectConnectName",
            "id": "12f56e27070248a6a240a497e43fbe18",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "PrivateNatName",
            "state": "ACTIVE",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

9.1.53.4 - 1.0

get /v1/private-nats

Description

Private NAT 목록 조회

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

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
Private NAT 명
Example : PrivateNatName
any of [string, null]None
querycidr
optional
Private NAT IP 대역
Example : 192.167.0.0/24
any of [string, null]None
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
queryvpc_name
optional
VPC 명
Example : vpcName
any of [string, null]None
querydirect_connect_id
optional
Direct Connect ID
Example : fe860e0af0c04dcd8182b84f907f31f4
any of [string, null]None
querydirect_connect_name
optional
Direct Connect명
Example : DirectConnectName
any of [string, null]None
querystate
optional
Private NAT 상태
Example : ACTIVE
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]None

Responses

HTTP CodeDescriptionSchema
200OKPrivateNatListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/private-nats

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "private_nats": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "cidr": "192.167.0.0/24",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "PrivateNat Description",
            "direct_connect_id": "fe860e0af0c04dcd8182b84f907f31f4",
            "direct_connect_name": "DirectConnectName",
            "id": "12f56e27070248a6a240a497e43fbe18",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "PrivateNatName",
            "state": "ACTIVE",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

9.1.54 - List Private NAT IP

9.1.54.1 - 1.3

get /v1/private-nats/{private_nat_id}/private-nat-ips

Description

Private NAT IP 목록

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_nat_id
required
Private NAT ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone
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
queryip_address
optional
Private NAT IP 주소
Example :
any of [string, null]None
querystate
optional
Private NAT IP 상태
Example :
any of [enum (RESERVED, ATTACHED, DELETED), null]None
queryattached_resource_type
optional
Private NAT IP 연결된 자원 타입
Example :
any of [enum (VM, BM, ALB, GPU_SERVER), null]None
queryattached_resource_id
optional
Private NAT IP 연결된 자원 ID
Example :
any of [string, null]None
queryattached_resource_name
optional
Private NAT IP 연결된 자원명
Example :
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKPrivateNatIpListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/private-nats/{private_nat_id}/private-nat-ips

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "private_nat_ips": [
        {
            "attached_resource_id": "",
            "attached_resource_name": "",
            "attached_resource_type": "VM",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "",
            "ip_address": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "private_nat_id": "",
            "state": "RESERVED"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

9.1.54.2 - 1.2

get /v1/private-nats/{private_nat_id}/private-nat-ips

Description

Private NAT IP 목록

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_nat_id
required
Private NAT ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone
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
queryip_address
optional
Private NAT IP 주소
Example :
any of [string, null]None
querystate
optional
Private NAT IP 상태
Example :
any of [enum (RESERVED, ATTACHED, DELETED), null]None
queryattached_resource_type
optional
Private NAT IP 연결된 자원 타입
Example :
any of [enum (VM, BM, ALB, GPU_SERVER), null]None
queryattached_resource_id
optional
Private NAT IP 연결된 자원 ID
Example :
any of [string, null]None
queryattached_resource_name
optional
Private NAT IP 연결된 자원명
Example :
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKPrivateNatIpListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/private-nats/{private_nat_id}/private-nat-ips

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "private_nat_ips": [
        {
            "attached_resource_id": "",
            "attached_resource_name": "",
            "attached_resource_type": "VM",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "",
            "ip_address": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "private_nat_id": "",
            "state": "RESERVED"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

9.1.54.3 - 1.1

get /v1/private-nats/{private_nat_id}/private-nat-ips

Description

Private NAT IP 목록

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_nat_id
required
Private NAT ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone
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
queryip_address
optional
Private NAT IP 주소
Example :
any of [string, null]None
querystate
optional
Private NAT IP 상태
Example :
any of [enum (RESERVED, ATTACHED, DELETED), null]None
queryattached_resource_type
optional
Private NAT IP 연결된 자원 타입
Example :
any of [enum (VM, BM, ALB, GPU_SERVER), null]None
queryattached_resource_id
optional
Private NAT IP 연결된 자원 ID
Example :
any of [string, null]None
queryattached_resource_name
optional
Private NAT IP 연결된 자원명
Example :
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKPrivateNatIpListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/private-nats/{private_nat_id}/private-nat-ips

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "private_nat_ips": [
        {
            "attached_resource_id": "",
            "attached_resource_name": "",
            "attached_resource_type": "VM",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "",
            "ip_address": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "private_nat_id": "",
            "state": "RESERVED"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

9.1.54.4 - 1.0

get /v1/private-nats/{private_nat_id}/private-nat-ips

Description

Private NAT IP 목록

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_nat_id
required
Private NAT ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone
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
queryip_address
optional
Private NAT IP 주소
Example :
any of [string, null]None
querystate
optional
Private NAT IP 상태
Example :
any of [enum (RESERVED, ATTACHED, DELETED), null]None
queryattached_resource_type
optional
Private NAT IP 연결된 자원 타입
Example :
any of [enum (VM, BM, ALB, GPU_SERVER), null]None
queryattached_resource_id
optional
Private NAT IP 연결된 자원 ID
Example :
any of [string, null]None
queryattached_resource_name
optional
Private NAT IP 연결된 자원명
Example :
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKPrivateNatIpListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/private-nats/{private_nat_id}/private-nat-ips

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "private_nat_ips": [
        {
            "attached_resource_id": "",
            "attached_resource_name": "",
            "attached_resource_type": "VM",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "",
            "ip_address": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "private_nat_id": "",
            "state": "RESERVED"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

9.1.55 - List PrivateLink Endpoint

9.1.55.1 - 1.3

get /v1/privatelink-endpoints

Description

PrivateLink Endpoint 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

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
queryid
optional
PrivateLink Endpoint ID
Example : bba6d4de3ad64e41b3a1b6c88983ec02
any of [string, null]None
queryname
optional
PrivateLink Endpoint 명
Example : EndpointName
any of [string, null]None
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
querysubnet_id
optional
Subnet ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]None
queryprivatelink_service_id
optional
PrivateLink Service ID
Example : e3df2e8e3b374fbb81d4e322b52ca50d
any of [string, null]None
queryendpoint_ip_address
optional
Endpoint IP 주소
Example : 192.167.1.5
any of [string, null]None
querystate
optional
PrivateLink Endpoint 상태
Example : ACTIVE
any of [enum (REQUESTING, CREATING, REJECTED, CANCELED, ACTIVE, DISCONNECTED, DELETING, DELETED, ERROR), null]None

Responses

HTTP CodeDescriptionSchema
200OKPrivateLinkEndpointListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/privatelink-endpoints

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "privatelink_endpoints": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "approval_type": "AUTO",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "endpoint_ip_address": "192.167.1.5",
            "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "EndpointName",
            "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
            "state": "ACTIVE",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

9.1.55.2 - 1.2

get /v1/privatelink-endpoints

Description

PrivateLink Endpoint 목록 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

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
queryid
optional
PrivateLink Endpoint ID
Example : bba6d4de3ad64e41b3a1b6c88983ec02
any of [string, null]None
queryname
optional
PrivateLink Endpoint 명
Example : EndpointName
any of [string, null]None
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
querysubnet_id
optional
Subnet ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]None
queryprivatelink_service_id
optional
PrivateLink Service ID
Example : e3df2e8e3b374fbb81d4e322b52ca50d
any of [string, null]None
queryendpoint_ip_address
optional
Endpoint IP 주소
Example : 192.167.1.5
any of [string, null]None
querystate
optional
PrivateLink Endpoint 상태
Example : ACTIVE
any of [enum (REQUESTING, CREATING, REJECTED, CANCELED, ACTIVE, DISCONNECTED, DELETING, DELETED, ERROR), null]None

Responses

HTTP CodeDescriptionSchema
200OKPrivateLinkEndpointListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/privatelink-endpoints

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "privatelink_endpoints": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "approval_type": "AUTO",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "endpoint_ip_address": "192.167.1.5",
            "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "EndpointName",
            "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
            "state": "ACTIVE",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

9.1.55.3 - 1.1

get /v1/privatelink-endpoints

Description

PrivateLink Endpoint 목록 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

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
queryid
optional
PrivateLink Endpoint ID
Example : bba6d4de3ad64e41b3a1b6c88983ec02
any of [string, null]None
queryname
optional
PrivateLink Endpoint 명
Example : EndpointName
any of [string, null]None
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
querysubnet_id
optional
Subnet ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]None
queryprivatelink_service_id
optional
PrivateLink Service ID
Example : e3df2e8e3b374fbb81d4e322b52ca50d
any of [string, null]None
queryendpoint_ip_address
optional
Endpoint IP 주소
Example : 192.167.1.5
any of [string, null]None
querystate
optional
PrivateLink Endpoint 상태
Example : ACTIVE
any of [enum (REQUESTING, CREATING, REJECTED, CANCELED, ACTIVE, DISCONNECTED, DELETING, DELETED, ERROR), null]None

Responses

HTTP CodeDescriptionSchema
200OKPrivateLinkEndpointListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/privatelink-endpoints

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "privatelink_endpoints": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "approval_type": "AUTO",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "endpoint_ip_address": "192.167.1.5",
            "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "EndpointName",
            "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
            "state": "ACTIVE",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

9.1.56 - List PrivateLink Service

9.1.56.1 - 1.3

get /v1/privatelink-services

Description

PrivateLink Service 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

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
queryid
optional
PrivateLink Service ID
Example : e3df2e8e3b374fbb81d4e322b52ca50d
any of [string, null]None
queryname
optional
PrivateLink Service 명
Example : ServiceName
any of [string, null]None
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
querysubnet_id
optional
Subnet ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]None
queryservice_ip_address
optional
Service IP 주소
Example : 192.167.0.5
any of [string, null]None
queryconnected_resource_id
optional
연결된 자원 ID
Example : a3e3a662a4f34442a94166df5ff9f577
any of [string, null]None
queryconnected_resource_type
optional
연결된 자원 Type
Example : LB
any of [enum (LB, IP), null]None
queryconnected_resource_name
optional
연결된 자원명
Example : lbResourceName
any of [string, null]None
queryconnected_resource_ip_address
optional
연결된 자원 IP 주소
Example : 192.167.0.10
any of [string, null]None
querystate
optional
PrivateLink Service 상태
Example : ACTIVE
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]None

Responses

HTTP CodeDescriptionSchema
200OKPrivateLinkServiceListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/privatelink-services

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "privatelink_services": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "approval_type": "AUTO",
            "connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
            "connected_resource_ip_address": "192.167.0.10",
            "connected_resource_name": "lbResourceName",
            "connected_resource_type": "LB",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "e3df2e8e3b374fbb81d4e322b52ca50d",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ServiceName",
            "service_ip_address": "192.167.0.5",
            "state": "CREATING",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

9.1.56.2 - 1.2

get /v1/privatelink-services

Description

PrivateLink Service 목록 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

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
queryid
optional
PrivateLink Service ID
Example : e3df2e8e3b374fbb81d4e322b52ca50d
any of [string, null]None
queryname
optional
PrivateLink Service 명
Example : ServiceName
any of [string, null]None
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
querysubnet_id
optional
Subnet ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]None
queryservice_ip_address
optional
Service IP 주소
Example : 192.167.0.5
any of [string, null]None
queryconnected_resource_id
optional
연결된 자원 ID
Example : a3e3a662a4f34442a94166df5ff9f577
any of [string, null]None
queryconnected_resource_type
optional
연결된 자원 Type
Example : LB
any of [enum (LB, IP), null]None
queryconnected_resource_name
optional
연결된 자원명
Example : lbResourceName
any of [string, null]None
queryconnected_resource_ip_address
optional
연결된 자원 IP 주소
Example : 192.167.0.10
any of [string, null]None
querystate
optional
PrivateLink Service 상태
Example : ACTIVE
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]None

Responses

HTTP CodeDescriptionSchema
200OKPrivateLinkServiceListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/privatelink-services

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "privatelink_services": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "approval_type": "AUTO",
            "connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
            "connected_resource_ip_address": "192.167.0.10",
            "connected_resource_name": "lbResourceName",
            "connected_resource_type": "LB",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "e3df2e8e3b374fbb81d4e322b52ca50d",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ServiceName",
            "service_ip_address": "192.167.0.5",
            "state": "CREATING",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

9.1.56.3 - 1.1

get /v1/privatelink-services

Description

PrivateLink Service 목록 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

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
queryid
optional
PrivateLink Service ID
Example : e3df2e8e3b374fbb81d4e322b52ca50d
any of [string, null]None
queryname
optional
PrivateLink Service 명
Example : ServiceName
any of [string, null]None
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
querysubnet_id
optional
Subnet ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]None
queryservice_ip_address
optional
Service IP 주소
Example : 192.167.0.5
any of [string, null]None
queryconnected_resource_id
optional
연결된 자원 ID
Example : a3e3a662a4f34442a94166df5ff9f577
any of [string, null]None
queryconnected_resource_type
optional
연결된 자원 Type
Example : LB
any of [enum (LB, IP), null]None
queryconnected_resource_name
optional
연결된 자원명
Example : lbResourceName
any of [string, null]None
queryconnected_resource_ip_address
optional
연결된 자원 IP 주소
Example : 192.167.0.10
any of [string, null]None
querystate
optional
PrivateLink Service 상태
Example : ACTIVE
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]None

Responses

HTTP CodeDescriptionSchema
200OKPrivateLinkServiceListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/privatelink-services

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "privatelink_services": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "approval_type": "AUTO",
            "connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
            "connected_resource_ip_address": "192.167.0.10",
            "connected_resource_name": "lbResourceName",
            "connected_resource_type": "LB",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "e3df2e8e3b374fbb81d4e322b52ca50d",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ServiceName",
            "service_ip_address": "192.167.0.5",
            "state": "CREATING",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

9.1.57 - List PublicIPs

9.1.57.1 - 1.3

get /v1/publicips

Description

PublicIP 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

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
queryip_address
optional
IP 주소
Example : 192.167.0.5
any of [string, null]None
querystate
optional
PublicIP 상태
Example : ATTACHED
any of [string, null]None
queryattached_resource_type
optional
PublicIP 연결된 자원 타입
Example : NAT_GW
any of [string, null]None
queryattached_resource_id
optional
PublicIP 연결된 자원 ID
Example : 37e6db41f5124184a43251a63124cdc9
any of [string, null]None
queryattached_resource_name
optional
PublicIP 연결된 자원명
Example : Attached NAT Gateway Name
any of [string, null]None
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
querytype
optional
PublicIP 타입
Example : IGW
any of [enum (IGW, GGW, SIGW), null]None
queryzone
optional
Zone
Example : kr-west1-a
any of [array[string], string]None

Responses

HTTP CodeDescriptionSchema
200OKPublicipListResponseV1Dot3
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/publicips

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "publicips": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
            "attached_resource_name": "Attached NAT Gateway Name",
            "attached_resource_type": "NAT_GW",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Public IP Description",
            "id": "12f56e27070248a6a240a497e43fbe18",
            "ip_address": "192.167.0.5",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "state": "ATTACHED",
            "type": "IGW",
            "zone": "kr-west1-a"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

9.1.57.2 - 1.2

get /v1/publicips

Description

PublicIP 목록을 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

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
queryip_address
optional
IP 주소
Example : 192.167.0.5
any of [string, null]None
querystate
optional
PublicIP 상태
Example : ATTACHED
any of [string, null]None
queryattached_resource_type
optional
PublicIP 연결된 자원 타입
Example : NAT_GW
any of [string, null]None
queryattached_resource_id
optional
PublicIP 연결된 자원 ID
Example : 37e6db41f5124184a43251a63124cdc9
any of [string, null]None
queryattached_resource_name
optional
PublicIP 연결된 자원명
Example : Attached NAT Gateway Name
any of [string, null]None
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
querytype
optional
PublicIP 타입
Example : IGW
any of [enum (IGW, GGW, SIGW), null]None

Responses

HTTP CodeDescriptionSchema
200OKPublicipListResponseV1Dot2
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/publicips

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "publicips": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
            "attached_resource_name": "Attached NAT Gateway Name",
            "attached_resource_type": "NAT_GW",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Public IP Description",
            "id": "12f56e27070248a6a240a497e43fbe18",
            "ip_address": "192.167.0.5",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "state": "ATTACHED",
            "type": "IGW"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

9.1.57.3 - 1.1

get /v1/publicips

Description

PublicIP 목록을 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
querywith_count
optional
with count
Example : true
any of [string, null]None
querylimit
optional
한도
Example : 20
any of [integer, null]None
querymarker
optional
마커
Example : 607e0938521643b5b4b266f343fae693
any of [string, null]None
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
queryip_address
optional
IP 주소
Example : 192.167.0.5
any of [string, null]None
querystate
optional
PublicIP 상태
Example : ATTACHED
any of [string, null]None
queryattached_resource_type
optional
PublicIP 연결된 자원 타입
Example : NAT_GW
any of [string, null]None
queryattached_resource_id
optional
PublicIP 연결된 자원 ID
Example : 37e6db41f5124184a43251a63124cdc9
any of [string, null]None
queryattached_resource_name
optional
PublicIP 연결된 자원명
Example : Attached NAT Gateway Name
any of [string, null]None
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
querytype
optional
PublicIP 타입
Example : IGW
any of [enum (IGW, GGW, SIGW), null]None

Responses

HTTP CodeDescriptionSchema
200OKPublicipListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/publicips

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "publicips": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
            "attached_resource_name": "Attached NAT Gateway Name",
            "attached_resource_type": "NAT_GW",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Public IP Description",
            "id": "12f56e27070248a6a240a497e43fbe18",
            "ip_address": "192.167.0.5",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "state": "ATTACHED",
            "type": "IGW"
        }
    ]
}

9.1.57.4 - 1.0

get /v1/publicips

Description

PublicIP 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
querywith_count
optional
with count
Example : true
any of [string, null]None
querylimit
optional
한도
Example : 20
any of [integer, null]None
querymarker
optional
마커
Example : 607e0938521643b5b4b266f343fae693
any of [string, null]None
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
queryip_address
optional
IP 주소
Example : 192.167.0.5
any of [string, null]None
querystate
optional
PublicIP 상태
Example : ATTACHED
any of [string, null]None
queryattached_resource_type
optional
PublicIP 연결된 자원 타입
Example : NAT_GW
any of [string, null]None
queryattached_resource_id
optional
PublicIP 연결된 자원 ID
Example : 37e6db41f5124184a43251a63124cdc9
any of [string, null]None
queryattached_resource_name
optional
PublicIP 연결된 자원명
Example : Attached NAT Gateway Name
any of [string, null]None
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
querytype
optional
PublicIP 타입
Example : IGW
any of [enum (IGW, GGW, SIGW), null]None

Responses

HTTP CodeDescriptionSchema
200OKPublicipListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/publicips

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "publicips": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
            "attached_resource_name": "Attached NAT Gateway Name",
            "attached_resource_type": "NAT_GW",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Public IP Description",
            "id": "12f56e27070248a6a240a497e43fbe18",
            "ip_address": "192.167.0.5",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "state": "ATTACHED",
            "type": "IGW"
        }
    ]
}

9.1.58 - List SAP Secondary Subnets

9.1.58.1 - 1.3

get /v1/subnets/{subnet_id}/sap-secondary-subnets

Description

List SAP Secondary Subnets

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone
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

Responses

HTTP CodeDescriptionSchema
200OKSapSecondarySubnetListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/subnets/{subnet_id}/sap-secondary-subnets

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "secondary_subnets": [
        {
            "account_id": "",
            "cidr": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "state": "ACTIVE",
            "subnet_id": "",
            "vlan_no_id": "",
            "vpc_id": ""
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

9.1.58.2 - 1.2

get /v1/subnets/{subnet_id}/sap-secondary-subnets

Description

List SAP Secondary Subnets

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone
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

Responses

HTTP CodeDescriptionSchema
200OKSapSecondarySubnetListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/subnets/{subnet_id}/sap-secondary-subnets

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "secondary_subnets": [
        {
            "account_id": "",
            "cidr": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "state": "ACTIVE",
            "subnet_id": "",
            "vlan_no_id": "",
            "vpc_id": ""
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

9.1.58.3 - 1.1

get /v1/subnets/{subnet_id}/sap-secondary-subnets

Description

List SAP Secondary Subnets

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone
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

Responses

HTTP CodeDescriptionSchema
200OKSapSecondarySubnetListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/subnets/{subnet_id}/sap-secondary-subnets

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "secondary_subnets": [
        {
            "account_id": "",
            "cidr": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "state": "ACTIVE",
            "subnet_id": "",
            "vlan_no_id": "",
            "vpc_id": ""
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

9.1.59 - List Subnet Vips

9.1.59.1 - 1.3

get /v1/subnets/{subnet_id}/vips

Description

Subnet Vip 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone
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
queryvirtual_ip_address
optional
Virtual IP 주소
Example : 192.168.20.6
any of [string, null]None
querypublic_ip_address
optional
Public IP 주소
Example : 100.112.9.84
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKVipListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/subnets/{subnet_id}/vips

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "subnet_vips": [
        {
            "connected_port_count": 2,
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0466a9448d9a4411a86055939e451c8f",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "state": "ACTIVE",
            "static_nat": {
                "external_ip_address": "100.112.9.84",
                "id": "0009e49548154745948e9722adefbf40",
                "publicip_id": "12f56e27070248a6a240a497e43fbe18",
                "state": "ACTIVE"
            },
            "virtual_ip_address": "192.168.20.6"
        }
    ]
}

9.1.59.2 - 1.2

get /v1/subnets/{subnet_id}/vips

Description

Subnet Vip 목록 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone
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
queryvirtual_ip_address
optional
Virtual IP 주소
Example : 192.168.20.6
any of [string, null]None
querypublic_ip_address
optional
Public IP 주소
Example : 100.112.9.84
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKVipListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/subnets/{subnet_id}/vips

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "subnet_vips": [
        {
            "connected_port_count": 2,
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0466a9448d9a4411a86055939e451c8f",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "state": "ACTIVE",
            "static_nat": {
                "external_ip_address": "100.112.9.84",
                "id": "0009e49548154745948e9722adefbf40",
                "publicip_id": "12f56e27070248a6a240a497e43fbe18",
                "state": "ACTIVE"
            },
            "virtual_ip_address": "192.168.20.6"
        }
    ]
}

9.1.60 - List Subnets

9.1.60.1 - 1.3

get /v1/subnets

Description

Subnet 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

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
queryid
optional
Subnet ID
Example : 023c57b14f11483689338d085e061492
string
queryname
optional
Subnet 명
Example : subnetName
string
querytype
optional
Subnet 유형
Example :
any of [enum (PUBLIC, PRIVATE, LOCAL, VPC_ENDPOINT), array[enum (PUBLIC, PRIVATE, LOCAL, VPC_ENDPOINT)]]
querycidr
optional
Subnet Cidr
Example : 192.167.1.0/24
any of [string, null]None
querystate
optional
상태
Example :
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
queryvpc_name
optional
VPC 명
Example : vpcName
string
querycategory
optional
Subnet 구분
Example : PRIMARY
enum (PRIMARY, SECONDARY)
queryzone
optional
Subnet Zone
Example :
string
queryprimary_subnet_id
optional
Primary Subnet ID
Example : 023c57b14f11483689338d085e061492
string

Responses

HTTP CodeDescriptionSchema
200OKSubnetListResponseV1Dot3
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/subnets

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "subnets": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "category": "PRIMARY",
            "cidr": "192.167.1.0/24",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "gateway_ip_address": "192.167.1.1",
            "id": "023c57b14f11483689338d085e061492",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "subnetName",
            "primary_subnet_id": "023c57b14f11483689338d085e061492",
            "state": "CREATING",
            "type": "PUBLIC",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName",
            "zones": "[\"kr-west1-a\", \"kr-west1-b\", \"kr-west1-c\"]"
        }
    ]
}

9.1.60.2 - 1.2

get /v1/subnets

Description

Subnet 목록을 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

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
queryid
optional
Subnet ID
Example : 023c57b14f11483689338d085e061492
string
queryname
optional
Subnet 명
Example : subnetName
string
querytype
optional
Subnet 유형
Example :
any of [enum (GENERAL, LOCAL, VPC_ENDPOINT), array[enum (GENERAL, LOCAL, VPC_ENDPOINT)]]
querycidr
optional
Subnet Cidr
Example : 192.167.1.0/24
any of [string, null]None
querystate
optional
상태
Example :
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
queryvpc_name
optional
VPC 명
Example : vpcName
string

Responses

HTTP CodeDescriptionSchema
200OKSubnetListResponseV1Dot2
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/subnets

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "subnets": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "cidr": "192.167.1.0/24",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "gateway_ip_address": "192.167.1.1",
            "id": "023c57b14f11483689338d085e061492",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "subnetName",
            "state": "CREATING",
            "type": "GENERAL",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ]
}

9.1.60.3 - 1.1

get /v1/subnets

Description

Subnet 목록을 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
querywith_count
optional
with count
Example : true
any of [string, null]None
querylimit
optional
한도
Example : 20
any of [integer, null]None
querymarker
optional
마커
Example : 607e0938521643b5b4b266f343fae693
any of [string, null]None
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
queryid
optional
Subnet ID
Example : 023c57b14f11483689338d085e061492
string
queryname
optional
Subnet 명
Example : subnetName
string
querytype
optional
Subnet 유형
Example :
any of [enum (GENERAL, LOCAL, VPC_ENDPOINT), array[enum (GENERAL, LOCAL, VPC_ENDPOINT)]]
querystate
optional
상태
Example :
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
queryvpc_name
optional
VPC 명
Example : vpcName
string

Responses

HTTP CodeDescriptionSchema
200OKSubnetListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/subnets

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "subnets": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "cidr": "192.167.1.0/24",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "gateway_ip_address": "192.167.1.1",
            "id": "023c57b14f11483689338d085e061492",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "subnetName",
            "state": "CREATING",
            "type": "GENERAL",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ]
}

9.1.60.4 - 1.0

get /v1/subnets

Description

Subnet 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
querywith_count
optional
with count
Example : true
any of [string, null]None
querylimit
optional
한도
Example : 20
any of [integer, null]None
querymarker
optional
마커
Example : 607e0938521643b5b4b266f343fae693
any of [string, null]None
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
queryid
optional
Subnet ID
Example : 023c57b14f11483689338d085e061492
string
queryname
optional
Subnet 명
Example : subnetName
string
querytype
optional
Subnet 유형
Example :
any of [enum (GENERAL, LOCAL, VPC_ENDPOINT), array[enum (GENERAL, LOCAL, VPC_ENDPOINT)]]
querystate
optional
상태
Example :
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
queryvpc_name
optional
VPC 명
Example : vpcName
string

Responses

HTTP CodeDescriptionSchema
200OKSubnetListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/subnets

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "subnets": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "cidr": "192.167.1.0/24",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "gateway_ip_address": "192.167.1.1",
            "id": "023c57b14f11483689338d085e061492",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "subnetName",
            "state": "CREATING",
            "type": "GENERAL",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ]
}

9.1.61 - List Transit Gateway Rules

9.1.61.1 - 1.3

get /v1/transit-gateways/{transit_gateway_id}/routing-rules

Description

Transit Gateway 규칙 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
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
queryid
optional
Routing Rule ID
Example : 43772aff4539403d9ba74bf1fdaa00c8
any of [string, null]None
querytgw_connection_vpc_id
optional
Transit Gateway에 연결된 VPC ID.
Example : ffeced8e191c478eabd66b6e2cab8e34
any of [string, null]None
querytgw_connection_vpc_name
optional
Transit Gateway에 연결된 VPC명.
Example : ConnectedVpcName
any of [string, null]None
querysource_type
optional
출발지 타입
Example : TGW
enum (VPC, TGW, ON_PREMISE)None
querydestination_type
optional
목적지 타입
Example : VPC
enum (VPC, TGW, ON_PREMISE)None
querydestination_cidr
optional
목적지 CIDR
Example : 192.167.5.0/24
any of [string, null]None
querystate
optional
상태
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)None
queryrule_type
optional
규칙 타입
Example : TGW_VPC
enum (TGW_VPC, TGW_UPLINK)None

Responses

HTTP CodeDescriptionSchema
200OKTransitGatewayRuleListResponseV1Dot2
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/routing-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 = vpc 1.3"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "transit_gateway_rules": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Routing Rule Description",
            "destination_cidr": "192.167.5.0/24",
            "destination_resource_id": "ceb44ea5ecb34a49b16495f9a63b0718",
            "destination_resource_name": "VpcName",
            "destination_type": "VPC",
            "id": "43772aff4539403d9ba74bf1fdaa00c8",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "rule_type": "TGW_VPC",
            "source_resource_id": "8582cc5d89994a42ad53282fd4a8d8be",
            "source_resource_name": "TgwName",
            "source_type": "TGW",
            "state": "ACTIVE",
            "tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34",
            "tgw_connection_vpc_name": "ConnectedVpcName"
        }
    ]
}

9.1.61.2 - 1.2

get /v1/transit-gateways/{transit_gateway_id}/routing-rules

Description

Transit Gateway 규칙 목록 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
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
queryid
optional
Routing Rule ID
Example : 43772aff4539403d9ba74bf1fdaa00c8
any of [string, null]None
querytgw_connection_vpc_id
optional
Transit Gateway에 연결된 VPC ID.
Example : ffeced8e191c478eabd66b6e2cab8e34
any of [string, null]None
querytgw_connection_vpc_name
optional
Transit Gateway에 연결된 VPC명.
Example : ConnectedVpcName
any of [string, null]None
querysource_type
optional
출발지 타입
Example : TGW
enum (VPC, TGW, ON_PREMISE)None
querydestination_type
optional
목적지 타입
Example : VPC
enum (VPC, TGW, ON_PREMISE)None
querydestination_cidr
optional
목적지 CIDR
Example : 192.167.5.0/24
any of [string, null]None
querystate
optional
상태
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)None
queryrule_type
optional
규칙 타입
Example : TGW_VPC
enum (TGW_VPC, TGW_UPLINK)None

Responses

HTTP CodeDescriptionSchema
200OKTransitGatewayRuleListResponseV1Dot2
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/routing-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 = vpc 1.2"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "transit_gateway_rules": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Routing Rule Description",
            "destination_cidr": "192.167.5.0/24",
            "destination_resource_id": "ceb44ea5ecb34a49b16495f9a63b0718",
            "destination_resource_name": "VpcName",
            "destination_type": "VPC",
            "id": "43772aff4539403d9ba74bf1fdaa00c8",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "rule_type": "TGW_VPC",
            "source_resource_id": "8582cc5d89994a42ad53282fd4a8d8be",
            "source_resource_name": "TgwName",
            "source_type": "TGW",
            "state": "ACTIVE",
            "tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34",
            "tgw_connection_vpc_name": "ConnectedVpcName"
        }
    ]
}

9.1.61.3 - 1.1

get /v1/transit-gateways/{transit_gateway_id}/routing-rules

Description

Transit Gateway 규칙 목록 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
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
queryid
optional
Routing Rule ID
Example : 43772aff4539403d9ba74bf1fdaa00c8
any of [string, null]None
querytgw_connection_vpc_id
optional
Transit Gateway에 연결된 VPC ID.
Example : ffeced8e191c478eabd66b6e2cab8e34
any of [string, null]None
querytgw_connection_vpc_name
optional
Transit Gateway에 연결된 VPC명.
Example : ConnectedVpcName
any of [string, null]None
querysource_type
optional
출발지 타입
Example : TGW
enum (VPC, TGW, ON_PREMISE)None
querydestination_type
optional
목적지 타입
Example : VPC
enum (VPC, TGW, ON_PREMISE)None
querydestination_cidr
optional
목적지 CIDR
Example : 192.167.5.0/24
any of [string, null]None
querystate
optional
상태
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)None

Responses

HTTP CodeDescriptionSchema
200OKTransitGatewayRuleListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/routing-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 = vpc 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "transit_gateway_rules": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Routing Rule Description",
            "destination_cidr": "192.167.5.0/24",
            "destination_resource_id": "ceb44ea5ecb34a49b16495f9a63b0718",
            "destination_resource_name": "VpcName",
            "destination_type": "VPC",
            "id": "43772aff4539403d9ba74bf1fdaa00c8",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "source_resource_id": "8582cc5d89994a42ad53282fd4a8d8be",
            "source_resource_name": "TgwName",
            "source_type": "TGW",
            "state": "ACTIVE",
            "tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34",
            "tgw_connection_vpc_name": "ConnectedVpcName"
        }
    ]
}

9.1.61.4 - 1.0

get /v1/transit-gateways/{transit_gateway_id}/routing-rules

Description

Transit Gateway 규칙 목록 조회

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
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
queryid
optional
Routing Rule ID
Example : 43772aff4539403d9ba74bf1fdaa00c8
any of [string, null]None
querytgw_connection_vpc_id
optional
Transit Gateway에 연결된 VPC ID.
Example : ffeced8e191c478eabd66b6e2cab8e34
any of [string, null]None
querytgw_connection_vpc_name
optional
Transit Gateway에 연결된 VPC명.
Example : ConnectedVpcName
any of [string, null]None
querysource_type
optional
출발지 타입
Example : TGW
enum (VPC, TGW, ON_PREMISE)None
querydestination_type
optional
목적지 타입
Example : VPC
enum (VPC, TGW, ON_PREMISE)None
querydestination_cidr
optional
목적지 CIDR
Example : 192.167.5.0/24
any of [string, null]None
querystate
optional
상태
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)None

Responses

HTTP CodeDescriptionSchema
200OKTransitGatewayRuleListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/routing-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 = vpc 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "transit_gateway_rules": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Routing Rule Description",
            "destination_cidr": "192.167.5.0/24",
            "destination_resource_id": "ceb44ea5ecb34a49b16495f9a63b0718",
            "destination_resource_name": "VpcName",
            "destination_type": "VPC",
            "id": "43772aff4539403d9ba74bf1fdaa00c8",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "source_resource_id": "8582cc5d89994a42ad53282fd4a8d8be",
            "source_resource_name": "TgwName",
            "source_type": "TGW",
            "state": "ACTIVE",
            "tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34",
            "tgw_connection_vpc_name": "ConnectedVpcName"
        }
    ]
}

9.1.62 - List Transit Gateway VPC Connections

9.1.62.1 - 1.3

get /v1/transit-gateways/{transit_gateway_id}/vpc-connections

Description

Transit Gateway VPC 연결 목록 조회.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
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
queryid
optional
Transit Gateway VPC 연결 ID
Example : ffeced8e191c478eabd66b6e2cab8e34
any of [string, null]None
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
queryvpc_name
optional
VPC 명
Example : vpcName
any of [string, null]None
querystate
optional
상태
Example : ACTIVE
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]None

Responses

HTTP CodeDescriptionSchema
200OKTransitGatewayVpcConnectionListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/vpc-connections

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "transit_gateway_vpc_connections": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "ffeced8e191c478eabd66b6e2cab8e34",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "state": "ACTIVE",
            "transit_gateway_id": "fe860e0af0c04dcd8182b84f907f31f4",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ]
}

9.1.62.2 - 1.2

get /v1/transit-gateways/{transit_gateway_id}/vpc-connections

Description

Transit Gateway VPC 연결 목록 조회.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
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
queryid
optional
Transit Gateway VPC 연결 ID
Example : ffeced8e191c478eabd66b6e2cab8e34
any of [string, null]None
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
queryvpc_name
optional
VPC 명
Example : vpcName
any of [string, null]None
querystate
optional
상태
Example : ACTIVE
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]None

Responses

HTTP CodeDescriptionSchema
200OKTransitGatewayVpcConnectionListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/vpc-connections

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "transit_gateway_vpc_connections": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "ffeced8e191c478eabd66b6e2cab8e34",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "state": "ACTIVE",
            "transit_gateway_id": "fe860e0af0c04dcd8182b84f907f31f4",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ]
}

9.1.62.3 - 1.1

get /v1/transit-gateways/{transit_gateway_id}/vpc-connections

Description

Transit Gateway VPC 연결 목록 조회.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
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
queryid
optional
Transit Gateway VPC 연결 ID
Example : ffeced8e191c478eabd66b6e2cab8e34
any of [string, null]None
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
queryvpc_name
optional
VPC 명
Example : vpcName
any of [string, null]None
querystate
optional
상태
Example : ACTIVE
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]None

Responses

HTTP CodeDescriptionSchema
200OKTransitGatewayVpcConnectionListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/vpc-connections

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "transit_gateway_vpc_connections": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "ffeced8e191c478eabd66b6e2cab8e34",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "state": "ACTIVE",
            "transit_gateway_id": "fe860e0af0c04dcd8182b84f907f31f4",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ]
}

9.1.62.4 - 1.0

get /v1/transit-gateways/{transit_gateway_id}/vpc-connections

Description

Transit Gateway VPC 연결 목록 조회.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
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
queryid
optional
Transit Gateway VPC 연결 ID
Example : ffeced8e191c478eabd66b6e2cab8e34
any of [string, null]None
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
queryvpc_name
optional
VPC 명
Example : vpcName
any of [string, null]None
querystate
optional
상태
Example : ACTIVE
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]None

Responses

HTTP CodeDescriptionSchema
200OKTransitGatewayVpcConnectionListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/vpc-connections

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "transit_gateway_vpc_connections": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "ffeced8e191c478eabd66b6e2cab8e34",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "state": "ACTIVE",
            "transit_gateway_id": "fe860e0af0c04dcd8182b84f907f31f4",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ]
}

9.1.63 - List Transit Gateways

9.1.63.1 - 1.3

get /v1/transit-gateways

Description

Transit Gateway 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

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
queryid
optional
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
any of [string, null]None
queryname
optional
Transit Gateway 명
Example : TransitGatewayName
any of [string, null]None
querystate
optional
상태
Example : ACTIVE
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING), null]None
queryfirewall_connection_state
optional
Transit 연결 상태
Example : INACTIVE
any of [enum (ATTACHING, ACTIVE, DETACHING, DELETED, INACTIVE, ERROR), null]None
queryuplink_zone_state
optional
Uplink Zone 연결 상태
Example : ACTIVE
any of [enum (ATTACHING, ACTIVE, DETACHING, DELETED, INACTIVE, ERROR, EDITING), null]None

Responses

HTTP CodeDescriptionSchema
200OKTransitGatewayListResponseV1Dot2
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/transit-gateways

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "transit_gateways": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "bandwidth": 1,
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "TransitGateway Description",
            "firewall_connection_state": "INACTIVE",
            "firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
            "id": "fe860e0af0c04dcd8182b84f907f31f4",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "TransitGatewayName",
            "state": "ACTIVE",
            "uplink_enabled": "False"
        }
    ]
}

9.1.63.2 - 1.2

get /v1/transit-gateways

Description

Transit Gateway 목록 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

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
queryid
optional
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
any of [string, null]None
queryname
optional
Transit Gateway 명
Example : TransitGatewayName
any of [string, null]None
querystate
optional
상태
Example : ACTIVE
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING), null]None
queryfirewall_connection_state
optional
Transit 연결 상태
Example : INACTIVE
any of [enum (ATTACHING, ACTIVE, DETACHING, DELETED, INACTIVE, ERROR), null]None
queryuplink_zone_state
optional
Uplink Zone 연결 상태
Example : ACTIVE
any of [enum (ATTACHING, ACTIVE, DETACHING, DELETED, INACTIVE, ERROR, EDITING), null]None

Responses

HTTP CodeDescriptionSchema
200OKTransitGatewayListResponseV1Dot2
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/transit-gateways

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "transit_gateways": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "bandwidth": 1,
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "TransitGateway Description",
            "firewall_connection_state": "INACTIVE",
            "firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
            "id": "fe860e0af0c04dcd8182b84f907f31f4",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "TransitGatewayName",
            "state": "ACTIVE",
            "uplink_enabled": "False"
        }
    ]
}

9.1.63.3 - 1.1

get /v1/transit-gateways

Description

Transit Gateway 목록 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

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
queryid
optional
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
any of [string, null]None
queryname
optional
Transit Gateway 명
Example : TransitGatewayName
any of [string, null]None
querystate
optional
상태
Example : ACTIVE
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING), null]None

Responses

HTTP CodeDescriptionSchema
200OKTransitGatewayListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/transit-gateways

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "transit_gateways": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "bandwidth": 1,
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "TransitGateway Description",
            "firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
            "id": "fe860e0af0c04dcd8182b84f907f31f4",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "TransitGatewayName",
            "state": "ACTIVE",
            "uplink_enabled": "False"
        }
    ]
}

9.1.63.4 - 1.0

get /v1/transit-gateways

Description

Transit Gateway 목록 조회

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

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
queryid
optional
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
any of [string, null]None
queryname
optional
Transit Gateway 명
Example : TransitGatewayName
any of [string, null]None
querystate
optional
상태
Example : ACTIVE
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING), null]None

Responses

HTTP CodeDescriptionSchema
200OKTransitGatewayListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/transit-gateways

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "transit_gateways": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "bandwidth": 1,
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "TransitGateway Description",
            "firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
            "id": "fe860e0af0c04dcd8182b84f907f31f4",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "TransitGatewayName",
            "state": "ACTIVE",
            "uplink_enabled": "False"
        }
    ]
}

9.1.64 - List VPC Endpoint

9.1.64.1 - 1.3

get /v1/vpc-endpoints

Description

VPC Endpoint 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

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
queryid
optional
VPC Endpoint ID
Example : 12f56e27070248a6a240a497e43fbe18
any of [string, null]None
queryname
optional
VPC Endpoint 명
Example : VpcEndpointName
any of [string, null]None
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
queryvpc_name
optional
VPC 명
Example : vpcName
any of [string, null]None
querysubnet_id
optional
Subnet ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]None
queryresource_key
optional
VPC Endpoint Resource Key
Example : 07c5364702384471b650147321b52173
any of [string, null]None
queryresource_type
optional
VPC Endpoint 자원 타입
Example : FS
any of [enum (FS, OBS, SCR, DNS), null]None
queryendpoint_ip_address
optional
VPC Endpoint IP 주소
Example : 192.167.0.5
any of [string, null]None
querystate
optional
VPC Endpoint 상태
Example : ACTIVE
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]None

Responses

HTTP CodeDescriptionSchema
200OKVpcEndpointListResponseV1Dot2
400Bad RequestNone
403ForbiddenNone

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 = ko-KR",
"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"
        }
    ]
}

9.1.64.2 - 1.2

get /v1/vpc-endpoints

Description

VPC Endpoint 목록을 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

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
queryid
optional
VPC Endpoint ID
Example : 12f56e27070248a6a240a497e43fbe18
any of [string, null]None
queryname
optional
VPC Endpoint 명
Example : VpcEndpointName
any of [string, null]None
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
queryvpc_name
optional
VPC 명
Example : vpcName
any of [string, null]None
querysubnet_id
optional
Subnet ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]None
queryresource_key
optional
VPC Endpoint Resource Key
Example : 07c5364702384471b650147321b52173
any of [string, null]None
queryresource_type
optional
VPC Endpoint 자원 타입
Example : FS
any of [enum (FS, OBS, SCR, DNS), null]None
queryendpoint_ip_address
optional
VPC Endpoint IP 주소
Example : 192.167.0.5
any of [string, null]None
querystate
optional
VPC Endpoint 상태
Example : ACTIVE
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]None

Responses

HTTP CodeDescriptionSchema
200OKVpcEndpointListResponseV1Dot2
400Bad RequestNone
403ForbiddenNone

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 = ko-KR",
"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"
        }
    ]
}

9.1.64.3 - 1.1

get /v1/vpc-endpoints

Description

VPC Endpoint 목록을 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
querywith_count
optional
with count
Example : true
any of [string, null]None
querylimit
optional
한도
Example : 20
any of [integer, null]None
querymarker
optional
마커
Example : 607e0938521643b5b4b266f343fae693
any of [string, null]None
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
queryid
optional
VPC Endpoint ID
Example : 12f56e27070248a6a240a497e43fbe18
any of [string, null]None
queryname
optional
VPC Endpoint 명
Example : VpcEndpointName
any of [string, null]None
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
queryvpc_name
optional
VPC 명
Example : vpcName
any of [string, null]None
querysubnet_id
optional
Subnet ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]None
queryresource_key
optional
VPC Endpoint Resource Key
Example : 07c5364702384471b650147321b52173
any of [string, null]None
queryresource_type
optional
VPC Endpoint 자원 타입
Example : FS
any of [enum (FS, OBS, SCR, DNS), null]None
queryendpoint_ip_address
optional
VPC Endpoint IP 주소
Example : 192.167.0.5
any of [string, null]None
querystate
optional
VPC Endpoint 상태
Example : ACTIVE
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]None

Responses

HTTP CodeDescriptionSchema
200OKVpcEndpointListResponse
400Bad RequestNone
403ForbiddenNone

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 = ko-KR",
"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"
        }
    ]
}

9.1.64.4 - 1.0

get /v1/vpc-endpoints

Description

VPC Endpoint 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
querywith_count
optional
with count
Example : true
any of [string, null]None
querylimit
optional
한도
Example : 20
any of [integer, null]None
querymarker
optional
마커
Example : 607e0938521643b5b4b266f343fae693
any of [string, null]None
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
queryid
optional
VPC Endpoint ID
Example : 12f56e27070248a6a240a497e43fbe18
any of [string, null]None
queryname
optional
VPC Endpoint 명
Example : VpcEndpointName
any of [string, null]None
queryvpc_id
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
queryvpc_name
optional
VPC 명
Example : vpcName
any of [string, null]None
querysubnet_id
optional
Subnet ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]None
queryresource_key
optional
VPC Endpoint Resource Key
Example : 07c5364702384471b650147321b52173
any of [string, null]None
queryresource_type
optional
VPC Endpoint 자원 타입
Example : FS
any of [enum (FS, OBS, SCR, DNS), null]None
queryendpoint_ip_address
optional
VPC Endpoint IP 주소
Example : 192.167.0.5
any of [string, null]None
querystate
optional
VPC Endpoint 상태
Example : ACTIVE
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]None

Responses

HTTP CodeDescriptionSchema
200OKVpcEndpointListResponse
400Bad RequestNone
403ForbiddenNone

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 = ko-KR",
"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"
        }
    ]
}

9.1.65 - List VPC Endpoint Connectable Resources

9.1.65.1 - 1.3

get /v1/vpc-endpoints/connectable-resources

Description

List VpcEndpoint connectable resources

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
queryresource_type
required
VPC Endpoint 자원 타입
Example : FS
enum (FS, OBS, SCR, DNS)None
queryvpc_id
optional
VPC ID(resource_type이 DNS인 경우, 필수 입력값입니다)
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKVpcEndpointConnectableResourceListResponseV1Dot2
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpc-endpoints/connectable-resources?resource_type={resource_type}

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpc_endpoint_connectable_resources": [
        {
            "resource_info": "x.samsungsdscloud.com(Registry)",
            "resource_key": "07c5364702384471b650147321b52173",
            "resource_type": "FS"
        }
    ]
}

9.1.65.2 - 1.2

get /v1/vpc-endpoints/connectable-resources

Description

List VpcEndpoint connectable resources

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
queryresource_type
required
VPC Endpoint 자원 타입
Example : FS
enum (FS, OBS, SCR, DNS)None
queryvpc_id
optional
VPC ID(resource_type이 DNS인 경우, 필수 입력값입니다)
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKVpcEndpointConnectableResourceListResponseV1Dot2
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpc-endpoints/connectable-resources?resource_type={resource_type}

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpc_endpoint_connectable_resources": [
        {
            "resource_info": "x.samsungsdscloud.com(Registry)",
            "resource_key": "07c5364702384471b650147321b52173",
            "resource_type": "FS"
        }
    ]
}

9.1.65.3 - 1.1

get /v1/vpc-endpoints/connectable-resources

Description

List VpcEndpoint connectable resources

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
queryresource_type
required
VPC Endpoint 자원 타입
Example : FS
enum (FS, OBS, SCR, DNS)None
queryvpc_id
optional
VPC ID(resource_type이 DNS인 경우, 필수 입력값입니다)
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKVpcEndpointConnectableResourceListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpc-endpoints/connectable-resources?resource_type={resource_type}

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "vpc_endpoint_connectable_resources": [
        {
            "resource_info": "x.samsungsdscloud.com(Registry)",
            "resource_key": "07c5364702384471b650147321b52173",
            "resource_type": "FS"
        }
    ]
}

9.1.65.4 - 1.0

get /v1/vpc-endpoints/connectable-resources

Description

List VpcEndpoint connectable resources

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
queryresource_type
required
VPC Endpoint 자원 타입
Example : FS
enum (FS, OBS, SCR, DNS)None
queryvpc_id
optional
VPC ID(resource_type이 DNS인 경우, 필수 입력값입니다)
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKVpcEndpointConnectableResourceListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpc-endpoints/connectable-resources?resource_type={resource_type}

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "vpc_endpoint_connectable_resources": [
        {
            "resource_info": "x.samsungsdscloud.com(Registry)",
            "resource_key": "07c5364702384471b650147321b52173",
            "resource_type": "FS"
        }
    ]
}

9.1.66 - List VPC Peering

9.1.66.1 - 1.3

get /v1/vpc-peerings

Description

VPC Peering 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

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
queryid
optional
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]None
queryname
optional
VPC Peering 명
Example : vpcPeeringName
any of [string, null]None
queryrequester_vpc_id
optional
요청 VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
queryrequester_vpc_name
optional
요청 VPC 명
Example : vpcName
any of [string, null]None
queryapprover_vpc_id
optional
승인 VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
queryapprover_vpc_name
optional
승인 VPC 명
Example : vpcName
any of [string, null]None
queryaccount_type
optional
과제 유형
Example :
any of [enum (SAME, DIFFERENT), null]None
querystate
optional
상태
Example :
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING, CREATING_REQUESTING, REJECTED, CANCELED, DELETING_REQUESTING), null]None

Responses

HTTP CodeDescriptionSchema
200OKVpcPeeringListResponse
400Bad RequestNone
403ForbiddenNone

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 = ko-KR",
"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"
        }
    ]
}

9.1.66.2 - 1.2

get /v1/vpc-peerings

Description

VPC Peering 목록 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

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
queryid
optional
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]None
queryname
optional
VPC Peering 명
Example : vpcPeeringName
any of [string, null]None
queryrequester_vpc_id
optional
요청 VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
queryrequester_vpc_name
optional
요청 VPC 명
Example : vpcName
any of [string, null]None
queryapprover_vpc_id
optional
승인 VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
queryapprover_vpc_name
optional
승인 VPC 명
Example : vpcName
any of [string, null]None
queryaccount_type
optional
과제 유형
Example :
any of [enum (SAME, DIFFERENT), null]None
querystate
optional
상태
Example :
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING, CREATING_REQUESTING, REJECTED, CANCELED, DELETING_REQUESTING), null]None

Responses

HTTP CodeDescriptionSchema
200OKVpcPeeringListResponse
400Bad RequestNone
403ForbiddenNone

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 = ko-KR",
"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"
        }
    ]
}

9.1.66.3 - 1.1

get /v1/vpc-peerings

Description

VPC Peering 목록 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

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
queryid
optional
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]None
queryname
optional
VPC Peering 명
Example : vpcPeeringName
any of [string, null]None
queryrequester_vpc_id
optional
요청 VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
queryrequester_vpc_name
optional
요청 VPC 명
Example : vpcName
any of [string, null]None
queryapprover_vpc_id
optional
승인 VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
queryapprover_vpc_name
optional
승인 VPC 명
Example : vpcName
any of [string, null]None
queryaccount_type
optional
과제 유형
Example :
any of [enum (SAME, DIFFERENT), null]None
querystate
optional
상태
Example :
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING, CREATING_REQUESTING, REJECTED, CANCELED, DELETING_REQUESTING), null]None

Responses

HTTP CodeDescriptionSchema
200OKVpcPeeringListResponse
400Bad RequestNone
403ForbiddenNone

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 = ko-KR",
"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"
        }
    ]
}

9.1.66.4 - 1.0

get /v1/vpc-peerings

Description

VPC Peering 목록 조회

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

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
queryid
optional
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]None
queryname
optional
VPC Peering 명
Example : vpcPeeringName
any of [string, null]None
queryrequester_vpc_id
optional
요청 VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
queryrequester_vpc_name
optional
요청 VPC 명
Example : vpcName
any of [string, null]None
queryapprover_vpc_id
optional
승인 VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
queryapprover_vpc_name
optional
승인 VPC 명
Example : vpcName
any of [string, null]None
queryaccount_type
optional
과제 유형
Example :
any of [enum (SAME, DIFFERENT), null]None
querystate
optional
상태
Example :
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING, CREATING_REQUESTING, REJECTED, CANCELED, DELETING_REQUESTING), null]None

Responses

HTTP CodeDescriptionSchema
200OKVpcPeeringListResponse
400Bad RequestNone
403ForbiddenNone

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 = ko-KR",
"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"
        }
    ]
}

9.1.67 - List VPC Peering Rules

9.1.67.1 - 1.3

get /v1/vpc-peerings/{vpc_peering_id}/routing-rules

Description

VPC Peering 규칙 목록 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_peering_id
required
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
stringNone
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
queryid
optional
VPC Peering 규칙 ID
Example :
any of [string, null]None
querysource_vpc_id
optional
출발지 VPC ID
Example :
any of [string, null]None
querysource_vpc_type
optional
출발지 VPC 유형
Example :
enum (REQUESTER_VPC, APPROVER_VPC)None
querydestination_vpc_id
optional
목적지 VPC ID
Example :
any of [string, null]None
querydestination_vpc_type
optional
목적지 VPC 유형
Example :
enum (REQUESTER_VPC, APPROVER_VPC)None
querydestination_cidr
optional
목적지 CIDR
Example :
any of [string, null]None
querystate
optional
상태
Example :
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING, CREATING_REQUESTING, REJECTED, CANCELED, DELETING_REQUESTING), null]None

Responses

HTTP CodeDescriptionSchema
200OKVpcPeeringRuleListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_id}/routing-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 = vpc 1.3"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpc_peering_rules": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "destination_cidr": "",
            "destination_vpc_id": "",
            "destination_vpc_name": "",
            "destination_vpc_type": "REQUESTER_VPC",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "source_vpc_id": "",
            "source_vpc_name": "",
            "source_vpc_type": "REQUESTER_VPC",
            "state": "CREATING",
            "vpc_peering_id": ""
        }
    ]
}

9.1.67.2 - 1.2

get /v1/vpc-peerings/{vpc_peering_id}/routing-rules

Description

VPC Peering 규칙 목록 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_peering_id
required
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
stringNone
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
queryid
optional
VPC Peering 규칙 ID
Example :
any of [string, null]None
querysource_vpc_id
optional
출발지 VPC ID
Example :
any of [string, null]None
querysource_vpc_type
optional
출발지 VPC 유형
Example :
enum (REQUESTER_VPC, APPROVER_VPC)None
querydestination_vpc_id
optional
목적지 VPC ID
Example :
any of [string, null]None
querydestination_vpc_type
optional
목적지 VPC 유형
Example :
enum (REQUESTER_VPC, APPROVER_VPC)None
querydestination_cidr
optional
목적지 CIDR
Example :
any of [string, null]None
querystate
optional
상태
Example :
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING, CREATING_REQUESTING, REJECTED, CANCELED, DELETING_REQUESTING), null]None

Responses

HTTP CodeDescriptionSchema
200OKVpcPeeringRuleListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_id}/routing-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 = vpc 1.2"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpc_peering_rules": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "destination_cidr": "",
            "destination_vpc_id": "",
            "destination_vpc_name": "",
            "destination_vpc_type": "REQUESTER_VPC",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "source_vpc_id": "",
            "source_vpc_name": "",
            "source_vpc_type": "REQUESTER_VPC",
            "state": "CREATING",
            "vpc_peering_id": ""
        }
    ]
}

9.1.67.3 - 1.1

get /v1/vpc-peerings/{vpc_peering_id}/routing-rules

Description

VPC Peering 규칙 목록 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_peering_id
required
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
stringNone
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
queryid
optional
VPC Peering 규칙 ID
Example :
any of [string, null]None
querysource_vpc_id
optional
출발지 VPC ID
Example :
any of [string, null]None
querysource_vpc_type
optional
출발지 VPC 유형
Example :
enum (REQUESTER_VPC, APPROVER_VPC)None
querydestination_vpc_id
optional
목적지 VPC ID
Example :
any of [string, null]None
querydestination_vpc_type
optional
목적지 VPC 유형
Example :
enum (REQUESTER_VPC, APPROVER_VPC)None
querydestination_cidr
optional
목적지 CIDR
Example :
any of [string, null]None
querystate
optional
상태
Example :
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING, CREATING_REQUESTING, REJECTED, CANCELED, DELETING_REQUESTING), null]None
queryname
optional
VPC Peering 명
Example :
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKVpcPeeringRuleListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_id}/routing-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 = vpc 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpc_peering_rules": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "destination_cidr": "",
            "destination_vpc_id": "",
            "destination_vpc_name": "",
            "destination_vpc_type": "REQUESTER_VPC",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "source_vpc_id": "",
            "source_vpc_name": "",
            "source_vpc_type": "REQUESTER_VPC",
            "state": "CREATING",
            "vpc_peering_id": ""
        }
    ]
}

9.1.67.4 - 1.0

get /v1/vpc-peerings/{vpc_peering_id}/routing-rules

Description

VPC Peering 규칙 목록 조회

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_peering_id
required
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
stringNone
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
queryid
optional
VPC Peering 규칙 ID
Example :
any of [string, null]None
querysource_vpc_id
optional
출발지 VPC ID
Example :
any of [string, null]None
querysource_vpc_type
optional
출발지 VPC 유형
Example :
enum (REQUESTER_VPC, APPROVER_VPC)None
querydestination_vpc_id
optional
목적지 VPC ID
Example :
any of [string, null]None
querydestination_vpc_type
optional
목적지 VPC 유형
Example :
enum (REQUESTER_VPC, APPROVER_VPC)None
querydestination_cidr
optional
목적지 CIDR
Example :
any of [string, null]None
querystate
optional
상태
Example :
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING, CREATING_REQUESTING, REJECTED, CANCELED, DELETING_REQUESTING), null]None
queryname
optional
VPC Peering 명
Example :
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKVpcPeeringRuleListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_id}/routing-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 = vpc 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpc_peering_rules": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "destination_cidr": "",
            "destination_vpc_id": "",
            "destination_vpc_name": "",
            "destination_vpc_type": "REQUESTER_VPC",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "source_vpc_id": "",
            "source_vpc_name": "",
            "source_vpc_type": "REQUESTER_VPC",
            "state": "CREATING",
            "vpc_peering_id": ""
        }
    ]
}

9.1.68 - List VPCs

9.1.68.1 - 1.3

get /v1/vpcs

Description

VPC 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

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
queryid
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
queryname
optional
VPC 명
Example : vpcName
any of [string, null]None
querystate
optional
상태
Example :
enum (CREATING, ACTIVE, DELETED, ERROR)None
querycidr
optional
VPC Cidr
Example : 192.167.0.0/18
any of [string, null]None
queryzone
optional
Zone
Example : kr-west1-a
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKVpcListResponseV1Dot3
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpcs

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpcs": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "cidr_count": 20,
            "cidrs": [
                {
                    "cidr": "192.167.0.0/18",
                    "created_at": "2024-05-17T00:23:17Z",
                    "created_by": "7df8abb4912e4709b1cb237daccca7a8",
                    "id": "7df8abb4912e4709b1cb237daccca7a8"
                }
            ],
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "vpcDescription",
            "id": "7df8abb4912e4709b1cb237daccca7a8",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "vpcName",
            "state": "CREATING",
            "zone_type": "PUBLIC",
            "zones": [
                "zone-a",
                "zone-b",
                "zone-c"
            ]
        }
    ]
}

9.1.68.2 - 1.2

get /v1/vpcs

Description

VPC 목록을 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

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
queryid
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
queryname
optional
VPC 명
Example : vpcName
any of [string, null]None
querystate
optional
상태
Example :
enum (CREATING, ACTIVE, DELETED, ERROR)None
querycidr
optional
VPC Cidr
Example : 192.167.0.0/18
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKVpcListResponseV1Dot2
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpcs

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpcs": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "cidr_count": 20,
            "cidrs": [
                {
                    "cidr": "192.167.0.0/18",
                    "created_at": "2024-05-17T00:23:17Z",
                    "created_by": "7df8abb4912e4709b1cb237daccca7a8",
                    "id": "7df8abb4912e4709b1cb237daccca7a8"
                }
            ],
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "vpcDescription",
            "id": "7df8abb4912e4709b1cb237daccca7a8",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "vpcName",
            "state": "CREATING"
        }
    ]
}

9.1.68.3 - 1.1

get /v1/vpcs

Description

VPC 목록을 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
querywith_count
optional
with count
Example : true
any of [string, null]None
querylimit
optional
한도
Example : 20
any of [integer, null]None
querymarker
optional
마커
Example : 607e0938521643b5b4b266f343fae693
any of [string, null]None
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
queryid
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
queryname
optional
VPC 명
Example : vpcName
any of [string, null]None
querystate
optional
상태
Example :
enum (CREATING, ACTIVE, DELETED, ERROR)None
querycidr
optional
VPC Cidr
Example : 192.167.0.0/18
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKVpcListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpcs

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "vpcs": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "cidr": "192.167.0.0/18",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "vpcDescription",
            "id": "7df8abb4912e4709b1cb237daccca7a8",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "vpcName",
            "state": "CREATING"
        }
    ]
}

9.1.68.4 - 1.0

get /v1/vpcs

Description

VPC 목록을 조회한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
querywith_count
optional
with count
Example : true
any of [string, null]None
querylimit
optional
한도
Example : 20
any of [integer, null]None
querymarker
optional
마커
Example : 607e0938521643b5b4b266f343fae693
any of [string, null]None
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
queryid
optional
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
any of [string, null]None
queryname
optional
VPC 명
Example : vpcName
any of [string, null]None
querystate
optional
상태
Example :
enum (CREATING, ACTIVE, DELETED, ERROR)None
querycidr
optional
VPC Cidr
Example : 192.167.0.0/18
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKVpcListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpcs

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "vpcs": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "cidr": "192.167.0.0/18",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "vpcDescription",
            "id": "7df8abb4912e4709b1cb237daccca7a8",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "vpcName",
            "state": "CREATING"
        }
    ]
}

9.1.69 - Request PrivateLink Endpoint

9.1.69.1 - 1.3

put /v1/privatelink-endpoints/{privatelink_endpoint_id}/request

Description

Request PrivateLink Endpoint

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_endpoint_id
required
PrivateLink Endpoint ID
Example : bba6d4de3ad64e41b3a1b6c88983ec02
stringNone
bodybody
required

PrivateLinkEndpointRequest

Responses

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

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_id}/request

Request header

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

Request body

{
    "type": "CANCEL"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Endpoint Description",
        "endpoint_ip_address": "192.167.1.5",
        "endpoint_ip_port_id": "b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e",
        "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "EndpointName",
        "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
        "state": "ACTIVE",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

9.1.69.2 - 1.2

put /v1/privatelink-endpoints/{privatelink_endpoint_id}/request

Description

Request PrivateLink Endpoint

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_endpoint_id
required
PrivateLink Endpoint ID
Example : bba6d4de3ad64e41b3a1b6c88983ec02
stringNone
bodybody
required

PrivateLinkEndpointRequest

Responses

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

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_id}/request

Request header

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

Request body

{
    "type": "CANCEL"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Endpoint Description",
        "endpoint_ip_address": "192.167.1.5",
        "endpoint_ip_port_id": "b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e",
        "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "EndpointName",
        "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
        "state": "ACTIVE",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

9.1.69.3 - 1.1

put /v1/privatelink-endpoints/{privatelink_endpoint_id}/request

Description

Request PrivateLink Endpoint

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_endpoint_id
required
PrivateLink Endpoint ID
Example : bba6d4de3ad64e41b3a1b6c88983ec02
stringNone
bodybody
required

PrivateLinkEndpointRequest

Responses

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

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_id}/request

Request header

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

Request body

{
    "type": "CANCEL"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Endpoint Description",
        "endpoint_ip_address": "192.167.1.5",
        "endpoint_ip_port_id": "b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e",
        "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "EndpointName",
        "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
        "state": "ACTIVE",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

9.1.70 - Set Internet Gateway

9.1.70.1 - 1.3

put /v1/internet-gateways/{internet_gateway_id}

Description

Internet Gateway를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathinternet_gateway_id
required
Internet Gateway ID
Example : 023c57b14f11483689338d085e061492
stringNone
bodybody
required

InternetGatewaySetRequest

Responses

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

Example HTTP request

Request path

/v1/internet-gateways/{internet_gateway_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 = vpc 1.3"

Request body

{
    "description": "Internet Gateway Description",
    "loggable": ""
}

Example HTTP response

Response 200

{
    "description": "Internet Gateway Description",
    "loggable": ""
}

9.1.70.2 - 1.2

put /v1/internet-gateways/{internet_gateway_id}

Description

Internet Gateway를 수정한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathinternet_gateway_id
required
Internet Gateway ID
Example : 023c57b14f11483689338d085e061492
stringNone
bodybody
required

InternetGatewaySetRequest

Responses

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

Example HTTP request

Request path

/v1/internet-gateways/{internet_gateway_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 = vpc 1.2"

Request body

{
    "description": "Internet Gateway Description",
    "loggable": ""
}

Example HTTP response

Response 200

{
    "internet_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Internet Gateway Description",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "023c57b14f11483689338d085e061492",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "IGW_VPCname",
        "state": "CREATING",
        "type": "IGW",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.70.3 - 1.1

put /v1/internet-gateways/{internet_gateway_id}

Description

Internet Gateway를 수정한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathinternet_gateway_id
required
Internet Gateway ID
Example : 023c57b14f11483689338d085e061492
stringNone
bodybody
required

InternetGatewaySetRequest

Responses

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

Example HTTP request

Request path

/v1/internet-gateways/{internet_gateway_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 = vpc 1.1"

Request body

{
    "description": "Internet Gateway Description",
    "loggable": ""
}

Example HTTP response

Response 200

{
    "internet_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Internet Gateway Description",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "023c57b14f11483689338d085e061492",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "IGW_VPCname",
        "state": "CREATING",
        "type": "IGW",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.70.4 - 1.0

put /v1/internet-gateways/{internet_gateway_id}

Description

Internet Gateway를 수정한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathinternet_gateway_id
required
Internet Gateway ID
Example : 023c57b14f11483689338d085e061492
stringNone
bodybody
required

InternetGatewaySetRequest

Responses

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

Example HTTP request

Request path

/v1/internet-gateways/{internet_gateway_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 = vpc 1.0"

Request body

{
    "description": "Internet Gateway Description",
    "loggable": ""
}

Example HTTP response

Response 200

{
    "internet_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Internet Gateway Description",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "023c57b14f11483689338d085e061492",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "IGW_VPCname",
        "state": "CREATING",
        "type": "IGW",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.71 - Set NAT Gateway

9.1.71.1 - 1.3

put /v1/nat-gateways/{nat_gateway_id}

Description

NAT Gateway를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathnat_gateway_id
required
NAT Gateway 명
Example : 12f56e27070248a6a240a497e43fbe18
stringNone
bodybody
required

NatGatewaySetRequest

Responses

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

Example HTTP request

Request path

/v1/nat-gateways/{nat_gateway_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 = vpc 1.3"

Request body

{
    "description": "VpcEndpoint Description"
}

Example HTTP response

Response 200

{
    "description": "VpcEndpoint Description"
}

9.1.71.2 - 1.2

put /v1/nat-gateways/{nat_gateway_id}

Description

NAT Gateway를 수정한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathnat_gateway_id
required
NAT Gateway 명
Example : 12f56e27070248a6a240a497e43fbe18
stringNone
bodybody
required

NatGatewaySetRequest

Responses

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

Example HTTP request

Request path

/v1/nat-gateways/{nat_gateway_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 = vpc 1.2"

Request body

{
    "description": "VpcEndpoint Description"
}

Example HTTP response

Response 200

{
    "nat_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "VpcEndpoint Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "NatGatewayName",
        "nat_gateway_ip_address": "192.167.0.5",
        "publicip_id": "12f56e27070248a6a240a497e43fbe18",
        "state": "ACTIVE",
        "subnet_cidr": "192.167.1.0/24",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.71.3 - 1.1

put /v1/nat-gateways/{nat_gateway_id}

Description

NAT Gateway를 수정한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathnat_gateway_id
required
NAT Gateway 명
Example : 12f56e27070248a6a240a497e43fbe18
stringNone
bodybody
required

NatGatewaySetRequest

Responses

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

Example HTTP request

Request path

/v1/nat-gateways/{nat_gateway_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 = vpc 1.1"

Request body

{
    "description": "VpcEndpoint Description"
}

Example HTTP response

Response 200

{
    "nat_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "VpcEndpoint Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "NatGatewayName",
        "nat_gateway_ip_address": "192.167.0.5",
        "publicip_id": "12f56e27070248a6a240a497e43fbe18",
        "state": "ACTIVE",
        "subnet_cidr": "192.167.1.0/24",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.71.4 - 1.0

put /v1/nat-gateways/{nat_gateway_id}

Description

NAT Gateway를 수정한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathnat_gateway_id
required
NAT Gateway 명
Example : 12f56e27070248a6a240a497e43fbe18
stringNone
bodybody
required

NatGatewaySetRequest

Responses

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

Example HTTP request

Request path

/v1/nat-gateways/{nat_gateway_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 = vpc 1.0"

Request body

{
    "description": "VpcEndpoint Description"
}

Example HTTP response

Response 200

{
    "nat_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "VpcEndpoint Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "NatGatewayName",
        "nat_gateway_ip_address": "192.167.0.5",
        "publicip_id": "12f56e27070248a6a240a497e43fbe18",
        "state": "ACTIVE",
        "subnet_cidr": "192.167.1.0/24",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.72 - Set Port

9.1.72.1 - 1.3

put /v1/ports/{port_id}

Description

Port를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathport_id
required
Port ID
Example : 023c57b1-4f11-4836-8933-8d085e061492
stringNone
bodybody
required

PortSetRequest

Responses

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

Example HTTP request

Request path

/v1/ports/{port_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 = vpc 1.3"

Request body

{
    "description": "Port Description",
    "security_groups": [
        ""
    ]
}

Example HTTP response

Response 200

{
    "port": {
        "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",
        "security_groups": [
            {
                "id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
                "name": "sgName"
            }
        ],
        "state": "",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "virtual_ip_addresses": [
            ""
        ],
        "vpc_id": "071bc63b767444c9afaab1c972d302d5",
        "vpc_name": "vpcName"
    }
}

9.1.72.2 - 1.2

put /v1/ports/{port_id}

Description

Port를 수정한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathport_id
required
Port ID
Example : 023c57b1-4f11-4836-8933-8d085e061492
stringNone
bodybody
required

PortSetRequest

Responses

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

Example HTTP request

Request path

/v1/ports/{port_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 = vpc 1.2"

Request body

{
    "description": "Port Description",
    "security_groups": [
        ""
    ]
}

Example HTTP response

Response 200

{
    "port": {
        "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",
        "security_groups": [
            {
                "id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
                "name": "sgName"
            }
        ],
        "state": "",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "virtual_ip_addresses": [
            ""
        ],
        "vpc_id": "071bc63b767444c9afaab1c972d302d5",
        "vpc_name": "vpcName"
    }
}

9.1.72.3 - 1.1

put /v1/ports/{port_id}

Description

Port를 수정한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathport_id
required
Port ID
Example : 023c57b1-4f11-4836-8933-8d085e061492
stringNone
bodybody
required

PortSetRequest

Responses

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

Example HTTP request

Request path

/v1/ports/{port_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 = vpc 1.1"

Request body

{
    "description": "Port Description",
    "security_groups": [
        ""
    ]
}

Example HTTP response

Response 200

{
    "port": {
        "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",
        "security_groups": [
            {
                "id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
                "name": "sgName"
            }
        ],
        "state": "",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "071bc63b767444c9afaab1c972d302d5",
        "vpc_name": "vpcName"
    }
}

9.1.72.4 - 1.0

put /v1/ports/{port_id}

Description

Port를 수정한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathport_id
required
Port ID
Example : 023c57b1-4f11-4836-8933-8d085e061492
stringNone
bodybody
required

PortSetRequest

Responses

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

Example HTTP request

Request path

/v1/ports/{port_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 = vpc 1.0"

Request body

{
    "description": "Port Description",
    "security_groups": [
        ""
    ]
}

Example HTTP response

Response 200

{
    "port": {
        "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",
        "security_groups": [
            {
                "id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
                "name": "sgName"
            }
        ],
        "state": "",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "071bc63b767444c9afaab1c972d302d5",
        "vpc_name": "vpcName"
    }
}

9.1.73 - Set Private NAT

9.1.73.1 - 1.3

put /v1/private-nats/{private_nat_id}

Description

Private NAT 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_nat_id
required
Private NAT ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone
bodybody
required

PrivateNatSetRequest

Responses

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

Example HTTP request

Request path

/v1/private-nats/{private_nat_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 = vpc 1.3"

Request body

{
    "description": "PrivateNat Description"
}

Example HTTP response

Response 200

{
    "private_nat": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateNat Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "PrivateNatName",
        "service_resource_id": "3f342bf9a557405b997c2cf48c89cbc2",
        "service_resource_name": "PrivateNatName",
        "service_type": "DIRECT_CONNECT",
        "state": "ACTIVE"
    }
}

9.1.73.2 - 1.2

put /v1/private-nats/{private_nat_id}

Description

Private NAT 수정

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_nat_id
required
Private NAT ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone
bodybody
required

PrivateNatSetRequest

Responses

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

Example HTTP request

Request path

/v1/private-nats/{private_nat_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 = vpc 1.2"

Request body

{
    "description": "PrivateNat Description"
}

Example HTTP response

Response 200

{
    "private_nat": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateNat Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "PrivateNatName",
        "service_resource_id": "3f342bf9a557405b997c2cf48c89cbc2",
        "service_resource_name": "PrivateNatName",
        "service_type": "DIRECT_CONNECT",
        "state": "ACTIVE"
    }
}

9.1.73.3 - 1.1

put /v1/private-nats/{private_nat_id}

Description

Private NAT 수정

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_nat_id
required
Private NAT ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone
bodybody
required

PrivateNatSetRequest

Responses

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

Example HTTP request

Request path

/v1/private-nats/{private_nat_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 = vpc 1.1"

Request body

{
    "description": "PrivateNat Description"
}

Example HTTP response

Response 200

{
    "private_nat": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateNat Description",
        "direct_connect_id": "fe860e0af0c04dcd8182b84f907f31f4",
        "direct_connect_name": "DirectConnectName",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "PrivateNatName",
        "state": "ACTIVE",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.73.4 - 1.0

put /v1/private-nats/{private_nat_id}

Description

Private NAT 수정

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_nat_id
required
Private NAT ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone
bodybody
required

PrivateNatSetRequest

Responses

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

Example HTTP request

Request path

/v1/private-nats/{private_nat_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 = vpc 1.0"

Request body

{
    "description": "PrivateNat Description"
}

Example HTTP response

Response 200

{
    "private_nat": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateNat Description",
        "direct_connect_id": "fe860e0af0c04dcd8182b84f907f31f4",
        "direct_connect_name": "DirectConnectName",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "PrivateNatName",
        "state": "ACTIVE",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.74 - Set PrivateLink Endpoint

9.1.74.1 - 1.3

put /v1/privatelink-endpoints/{privatelink_endpoint_id}

Description

PrivateLink Endpoint 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_endpoint_id
required
PrivateLink Endpoint ID
Example : bba6d4de3ad64e41b3a1b6c88983ec02
stringNone
bodybody
required

PrivateLinkEndpointSetRequest

Responses

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

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_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 = vpc 1.3"

Request body

{
    "description": "PrivateLink Endpoint Description"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Endpoint Description",
        "endpoint_ip_address": "192.167.1.5",
        "endpoint_ip_port_id": "b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e",
        "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "EndpointName",
        "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
        "state": "ACTIVE",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

9.1.74.2 - 1.2

put /v1/privatelink-endpoints/{privatelink_endpoint_id}

Description

PrivateLink Endpoint 수정

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_endpoint_id
required
PrivateLink Endpoint ID
Example : bba6d4de3ad64e41b3a1b6c88983ec02
stringNone
bodybody
required

PrivateLinkEndpointSetRequest

Responses

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

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_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 = vpc 1.2"

Request body

{
    "description": "PrivateLink Endpoint Description"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Endpoint Description",
        "endpoint_ip_address": "192.167.1.5",
        "endpoint_ip_port_id": "b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e",
        "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "EndpointName",
        "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
        "state": "ACTIVE",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

9.1.74.3 - 1.1

put /v1/privatelink-endpoints/{privatelink_endpoint_id}

Description

PrivateLink Endpoint 수정

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_endpoint_id
required
PrivateLink Endpoint ID
Example : bba6d4de3ad64e41b3a1b6c88983ec02
stringNone
bodybody
required

PrivateLinkEndpointSetRequest

Responses

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

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_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 = vpc 1.1"

Request body

{
    "description": "PrivateLink Endpoint Description"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Endpoint Description",
        "endpoint_ip_address": "192.167.1.5",
        "endpoint_ip_port_id": "b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e",
        "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "EndpointName",
        "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
        "state": "ACTIVE",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

9.1.75 - Set PrivateLink Service

9.1.75.1 - 1.3

put /v1/privatelink-services/{privatelink_service_id}

Description

PrivateLink Service 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_service_id
required
PrivateLink Service ID
Example : e3df2e8e3b374fbb81d4e322b52ca50d
stringNone
bodybody
required

PrivateLinkServiceSetRequest

Responses

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

Example HTTP request

Request path

/v1/privatelink-services/{privatelink_service_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 = vpc 1.3"

Request body

{
    "description": "PrivateLink Service Description"
}

Example HTTP response

Response 200

{
    "privatelink_service": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
        "connected_resource_ip_address": "192.167.0.10",
        "connected_resource_name": "lbResourceName",
        "connected_resource_type": "LB",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Service Description",
        "high_speed_transfer": false,
        "id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServiceName",
        "security_group_ids": "['00b6af37-73b5-4de2-b080-c295a1a0382e']",
        "service_ip_address": "192.167.0.5",
        "service_ip_port_id": "d21a4b81-f52a-43a8-b985-341e763458bb",
        "state": "CREATING",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

9.1.75.2 - 1.2

put /v1/privatelink-services/{privatelink_service_id}

Description

PrivateLink Service 수정

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_service_id
required
PrivateLink Service ID
Example : e3df2e8e3b374fbb81d4e322b52ca50d
stringNone
bodybody
required

PrivateLinkServiceSetRequest

Responses

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

Example HTTP request

Request path

/v1/privatelink-services/{privatelink_service_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 = vpc 1.2"

Request body

{
    "description": "PrivateLink Service Description"
}

Example HTTP response

Response 200

{
    "privatelink_service": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
        "connected_resource_ip_address": "192.167.0.10",
        "connected_resource_name": "lbResourceName",
        "connected_resource_type": "LB",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Service Description",
        "high_speed_transfer": false,
        "id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServiceName",
        "security_group_ids": "['00b6af37-73b5-4de2-b080-c295a1a0382e']",
        "service_ip_address": "192.167.0.5",
        "service_ip_port_id": "d21a4b81-f52a-43a8-b985-341e763458bb",
        "state": "CREATING",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

9.1.75.3 - 1.1

put /v1/privatelink-services/{privatelink_service_id}

Description

PrivateLink Service 수정

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_service_id
required
PrivateLink Service ID
Example : e3df2e8e3b374fbb81d4e322b52ca50d
stringNone
bodybody
required

PrivateLinkServiceSetRequest

Responses

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

Example HTTP request

Request path

/v1/privatelink-services/{privatelink_service_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 = vpc 1.1"

Request body

{
    "description": "PrivateLink Service Description"
}

Example HTTP response

Response 200

{
    "privatelink_service": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
        "connected_resource_ip_address": "192.167.0.10",
        "connected_resource_name": "lbResourceName",
        "connected_resource_type": "LB",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Service Description",
        "high_speed_transfer": false,
        "id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServiceName",
        "security_group_ids": "['00b6af37-73b5-4de2-b080-c295a1a0382e']",
        "service_ip_address": "192.167.0.5",
        "service_ip_port_id": "d21a4b81-f52a-43a8-b985-341e763458bb",
        "state": "CREATING",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

9.1.76 - Set PublicIP

9.1.76.1 - 1.3

put /v1/publicips/{publicip_id}

Description

PublicIP를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathpublicip_id
required
PublicIP ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone
bodybody
required

PublicipSetRequest

Responses

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

Example HTTP request

Request path

/v1/publicips/{publicip_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 = vpc 1.3"

Request body

{
    "description": "Public IP Description"
}

Example HTTP response

Response 200

{
    "description": "Public IP Description"
}

9.1.76.2 - 1.2

put /v1/publicips/{publicip_id}

Description

PublicIP를 수정한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathpublicip_id
required
PublicIP ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone
bodybody
required

PublicipSetRequest

Responses

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

Example HTTP request

Request path

/v1/publicips/{publicip_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 = vpc 1.2"

Request body

{
    "description": "Public IP Description"
}

Example HTTP response

Response 200

{
    "publicip": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
        "attached_resource_name": "Attached NAT Gateway Name",
        "attached_resource_type": "NAT_GW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Public IP Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "ip_address": "192.167.0.5",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ATTACHED",
        "type": "IGW"
    }
}

9.1.76.3 - 1.1

put /v1/publicips/{publicip_id}

Description

PublicIP를 수정한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathpublicip_id
required
PublicIP ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone
bodybody
required

PublicipSetRequest

Responses

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

Example HTTP request

Request path

/v1/publicips/{publicip_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 = vpc 1.1"

Request body

{
    "description": "Public IP Description"
}

Example HTTP response

Response 200

{
    "publicip": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
        "attached_resource_name": "Attached NAT Gateway Name",
        "attached_resource_type": "NAT_GW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Public IP Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "ip_address": "192.167.0.5",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ATTACHED",
        "type": "IGW"
    }
}

9.1.76.4 - 1.0

put /v1/publicips/{publicip_id}

Description

PublicIP를 수정한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathpublicip_id
required
PublicIP ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone
bodybody
required

PublicipSetRequest

Responses

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

Example HTTP request

Request path

/v1/publicips/{publicip_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 = vpc 1.0"

Request body

{
    "description": "Public IP Description"
}

Example HTTP response

Response 200

{
    "publicip": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
        "attached_resource_name": "Attached NAT Gateway Name",
        "attached_resource_type": "NAT_GW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Public IP Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "ip_address": "192.167.0.5",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ATTACHED",
        "type": "IGW"
    }
}

9.1.77 - Set Subnet

9.1.77.1 - 1.3

put /v1/subnets/{subnet_id}

Description

Subnet을 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone
bodybody
required

SubnetSetRequestV1Dot2

Responses

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

Example HTTP request

Request path

/v1/subnets/{subnet_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 = vpc 1.3"

Request body

{
    "description": "Subnet Description",
    "dhcp_ip_address": "192.167.1.2"
}

Example HTTP response

Response 200

{
    "description": "Subnet Description",
    "dhcp_ip_address": "192.167.1.2"
}

9.1.77.2 - 1.2

put /v1/subnets/{subnet_id}

Description

Subnet을 수정한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone
bodybody
required

SubnetSetRequestV1Dot2

Responses

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

Example HTTP request

Request path

/v1/subnets/{subnet_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 = vpc 1.2"

Request body

{
    "description": "Subnet Description",
    "dhcp_ip_address": "192.167.1.2"
}

Example HTTP response

Response 200

{
    "subnet": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "allocation_pools": [],
        "cidr": "192.167.1.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Subnet Description",
        "dhcp_ip_address": "",
        "dns_nameservers": [],
        "gateway_ip_address": "192.167.1.1",
        "host_routes": [],
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "subnetName",
        "state": "CREATING",
        "type": "GENERAL",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.77.3 - 1.1

put /v1/subnets/{subnet_id}

Description

Subnet을 수정한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone
bodybody
required

SubnetSetRequest

Responses

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

Example HTTP request

Request path

/v1/subnets/{subnet_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 = vpc 1.1"

Request body

{
    "description": "Subnet Description"
}

Example HTTP response

Response 200

{
    "subnet": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "allocation_pools": [],
        "cidr": "192.167.1.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Subnet Description",
        "dns_nameservers": [],
        "gateway_ip_address": "192.167.1.1",
        "host_routes": [],
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "subnetName",
        "state": "CREATING",
        "type": "GENERAL",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.77.4 - 1.0

put /v1/subnets/{subnet_id}

Description

Subnet을 수정한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone
bodybody
required

SubnetSetRequest

Responses

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

Example HTTP request

Request path

/v1/subnets/{subnet_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 = vpc 1.0"

Request body

{
    "description": "Subnet Description"
}

Example HTTP response

Response 200

{
    "subnet": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "allocation_pools": [],
        "cidr": "192.167.1.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Subnet Description",
        "dns_nameservers": [],
        "gateway_ip_address": "192.167.1.1",
        "host_routes": [],
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "subnetName",
        "state": "CREATING",
        "type": "GENERAL",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.78 - Set Subnet Vip

9.1.78.1 - 1.3

put /v1/subnets/{subnet_id}/vips/{vip_id}

Description

Subnet Vip 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone
pathvip_id
required
Subnet Vip Id
Example : 0466a9448d9a4411a86055939e451c8f
stringNone
bodybody
required

VipSetRequest

Responses

HTTP CodeDescriptionSchema
200OKVipShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/subnets/{subnet_id}/vips/{vip_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 = vpc 1.3"

Request body

{
    "description": "Subnet VIP Description"
}

Example HTTP response

Response 200

{
    "subnet_vip": {
        "connected_ports": [
            {
                "attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
                "attached_resource_type": "Virtual Server",
                "id": "13e2a5a1acbe4713a9a2c70ce226e822",
                "port_id": "8b4705d3-43b7-4fad-8648-a5a1a90c31d0",
                "port_ip_address": "192.168.20.5",
                "port_name": "Port name"
            }
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Subnet VIP Description",
        "id": "0466a9448d9a4411a86055939e451c8f",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ACTIVE",
        "static_nat": {
            "external_ip_address": "100.112.9.84",
            "id": "0009e49548154745948e9722adefbf40",
            "publicip_id": "12f56e27070248a6a240a497e43fbe18",
            "state": "ACTIVE"
        },
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vip_port_id": "35268a9f2eda4cde83b1d85c1f61f67d",
        "virtual_ip_address": "192.168.20.6"
    }
}

9.1.78.2 - 1.2

put /v1/subnets/{subnet_id}/vips/{vip_id}

Description

Subnet Vip 수정

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone
pathvip_id
required
Subnet Vip Id
Example : 0466a9448d9a4411a86055939e451c8f
stringNone
bodybody
required

VipSetRequest

Responses

HTTP CodeDescriptionSchema
200OKVipShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/subnets/{subnet_id}/vips/{vip_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 = vpc 1.2"

Request body

{
    "description": "Subnet VIP Description"
}

Example HTTP response

Response 200

{
    "subnet_vip": {
        "connected_ports": [
            {
                "attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
                "attached_resource_type": "Virtual Server",
                "id": "13e2a5a1acbe4713a9a2c70ce226e822",
                "port_id": "8b4705d3-43b7-4fad-8648-a5a1a90c31d0",
                "port_ip_address": "192.168.20.5",
                "port_name": "Port name"
            }
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Subnet VIP Description",
        "id": "0466a9448d9a4411a86055939e451c8f",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ACTIVE",
        "static_nat": {
            "external_ip_address": "100.112.9.84",
            "id": "0009e49548154745948e9722adefbf40",
            "publicip_id": "12f56e27070248a6a240a497e43fbe18",
            "state": "ACTIVE"
        },
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vip_port_id": "35268a9f2eda4cde83b1d85c1f61f67d",
        "virtual_ip_address": "192.168.20.6"
    }
}

9.1.79 - Set Transit Gateway

9.1.79.1 - 1.3

put /v1/transit-gateways/{transit_gateway_id}

Description

Transit Gateway 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
bodybody
required

TransitGatewaySetRequest

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_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 = vpc 1.3"

Request body

{
    "description": "TransitGateway Description"
}

Example HTTP response

Response 200

{
    "description": "TransitGateway Description"
}

9.1.79.2 - 1.2

put /v1/transit-gateways/{transit_gateway_id}

Description

Transit Gateway 수정

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
bodybody
required

TransitGatewaySetRequest

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_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 = vpc 1.2"

Request body

{
    "description": "TransitGateway Description"
}

Example HTTP response

Response 200

{
    "transit_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "TransitGateway Description",
        "firewall_connection_state": "INACTIVE",
        "firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "TransitGatewayName",
        "state": "ACTIVE",
        "uplink_enabled": "False"
    }
}

9.1.79.3 - 1.1

put /v1/transit-gateways/{transit_gateway_id}

Description

Transit Gateway 수정

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
bodybody
required

TransitGatewaySetRequest

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_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 = vpc 1.1"

Request body

{
    "description": "TransitGateway Description"
}

Example HTTP response

Response 200

{
    "transit_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "TransitGateway Description",
        "firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "TransitGatewayName",
        "state": "ACTIVE",
        "uplink_enabled": "False"
    }
}

9.1.79.4 - 1.0

put /v1/transit-gateways/{transit_gateway_id}

Description

Transit Gateway 수정

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone
bodybody
required

TransitGatewaySetRequest

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_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 = vpc 1.0"

Request body

{
    "description": "TransitGateway Description"
}

Example HTTP response

Response 200

{
    "transit_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "TransitGateway Description",
        "firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "TransitGatewayName",
        "state": "ACTIVE",
        "uplink_enabled": "False"
    }
}

9.1.80 - Set VPC

9.1.80.1 - 1.3

put /v1/vpcs/{vpc_id}

Description

VPC를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_id
required
VPC ID
Example :
stringNone
bodybody
required

VpcSetRequest

Responses

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

Example HTTP request

Request path

/v1/vpcs/{vpc_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 = vpc 1.3"

Request body

{
    "description": "vpcDescription"
}

Example HTTP response

Response 200

{
    "description": "vpcDescription"
}

9.1.80.2 - 1.2

put /v1/vpcs/{vpc_id}

Description

VPC를 수정한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_id
required
VPC ID
Example :
stringNone
bodybody
required

VpcSetRequest

Responses

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

Example HTTP request

Request path

/v1/vpcs/{vpc_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 = vpc 1.2"

Request body

{
    "description": "vpcDescription"
}

Example HTTP response

Response 200

{
    "vpc": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr_count": 20,
        "cidrs": [
            {
                "cidr": "192.167.0.0/18",
                "created_at": "2024-05-17T00:23:17Z",
                "created_by": "7df8abb4912e4709b1cb237daccca7a8",
                "id": "7df8abb4912e4709b1cb237daccca7a8"
            }
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "vpcDescription",
        "id": "7df8abb4912e4709b1cb237daccca7a8",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcName",
        "state": "CREATING"
    }
}

9.1.80.3 - 1.1

put /v1/vpcs/{vpc_id}

Description

VPC를 수정한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_id
required
VPC ID
Example :
stringNone
bodybody
required

VpcSetRequest

Responses

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

Example HTTP request

Request path

/v1/vpcs/{vpc_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 = vpc 1.1"

Request body

{
    "description": "vpcDescription"
}

Example HTTP response

Response 200

{
    "vpc": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/18",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "vpcDescription",
        "id": "7df8abb4912e4709b1cb237daccca7a8",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcName",
        "state": "CREATING"
    }
}

9.1.80.4 - 1.0

put /v1/vpcs/{vpc_id}

Description

VPC를 수정한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_id
required
VPC ID
Example :
stringNone
bodybody
required

VpcSetRequest

Responses

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

Example HTTP request

Request path

/v1/vpcs/{vpc_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 = vpc 1.0"

Request body

{
    "description": "vpcDescription"
}

Example HTTP response

Response 200

{
    "vpc": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/18",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "vpcDescription",
        "id": "7df8abb4912e4709b1cb237daccca7a8",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcName",
        "state": "CREATING"
    }
}

9.1.81 - Set VPC Endpoint

9.1.81.1 - 1.3

put /v1/vpc-endpoints/{vpc_endpoint_id}

Description

VPC Endpoint 를 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_endpoint_id
required
VPC Endpoint ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone
bodybody
required

VpcEndpointSetRequest

Responses

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

Example HTTP request

Request path

/v1/vpc-endpoints/{vpc_endpoint_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 = vpc 1.3"

Request body

{
    "description": "VpcEndpoint Description"
}

Example HTTP response

Response 200

{
    "vpc_endpoint": {
        "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"
    }
}

9.1.81.2 - 1.2

put /v1/vpc-endpoints/{vpc_endpoint_id}

Description

VPC Endpoint 를 수정한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_endpoint_id
required
VPC Endpoint ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone
bodybody
required

VpcEndpointSetRequest

Responses

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

Example HTTP request

Request path

/v1/vpc-endpoints/{vpc_endpoint_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 = vpc 1.2"

Request body

{
    "description": "VpcEndpoint Description"
}

Example HTTP response

Response 200

{
    "vpc_endpoint": {
        "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"
    }
}

9.1.81.3 - 1.1

put /v1/vpc-endpoints/{vpc_endpoint_id}

Description

VPC Endpoint 를 수정한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_endpoint_id
required
VPC Endpoint ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone
bodybody
required

VpcEndpointSetRequest

Responses

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

Example HTTP request

Request path

/v1/vpc-endpoints/{vpc_endpoint_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 = vpc 1.1"

Request body

{
    "description": "VpcEndpoint Description"
}

Example HTTP response

Response 200

{
    "vpc_endpoint": {
        "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"
    }
}

9.1.81.4 - 1.0

put /v1/vpc-endpoints/{vpc_endpoint_id}

Description

VPC Endpoint 를 수정한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_endpoint_id
required
VPC Endpoint ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone
bodybody
required

VpcEndpointSetRequest

Responses

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

Example HTTP request

Request path

/v1/vpc-endpoints/{vpc_endpoint_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 = vpc 1.0"

Request body

{
    "description": "VpcEndpoint Description"
}

Example HTTP response

Response 200

{
    "vpc_endpoint": {
        "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"
    }
}

9.1.82 - Set VPC Peering

9.1.82.1 - 1.3

put /v1/vpc-peerings/{vpc_peering_id}

Description

VPC Peering 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_peering_id
required
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
stringNone
bodybody
required

VpcPeeringSetRequest

Responses

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

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_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 = vpc 1.3"

Request body

{
    "description": "vpcPeering Description"
}

Example HTTP response

Response 200

{
    "vpc_peering": {
        "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"
    }
}

9.1.82.2 - 1.2

put /v1/vpc-peerings/{vpc_peering_id}

Description

VPC Peering 수정

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_peering_id
required
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
stringNone
bodybody
required

VpcPeeringSetRequest

Responses

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

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_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 = vpc 1.2"

Request body

{
    "description": "vpcPeering Description"
}

Example HTTP response

Response 200

{
    "vpc_peering": {
        "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"
    }
}

9.1.82.3 - 1.1

put /v1/vpc-peerings/{vpc_peering_id}

Description

VPC Peering 수정

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_peering_id
required
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
stringNone
bodybody
required

VpcPeeringSetRequest

Responses

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

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_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 = vpc 1.1"

Request body

{
    "description": "vpcPeering Description"
}

Example HTTP response

Response 200

{
    "vpc_peering": {
        "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"
    }
}

9.1.82.4 - 1.0

put /v1/vpc-peerings/{vpc_peering_id}

Description

VPC Peering 수정

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_peering_id
required
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
stringNone
bodybody
required

VpcPeeringSetRequest

Responses

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

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_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 = vpc 1.0"

Request body

{
    "description": "vpcPeering Description"
}

Example HTTP response

Response 200

{
    "vpc_peering": {
        "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"
    }
}

9.1.83 - Show Internet Gateway

9.1.83.1 - 1.3

get /v1/internet-gateways/{internet_gateway_id}

Description

Internet Gateway를 상세조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathinternet_gateway_id
required
Internet Gateway ID
Example : 023c57b14f11483689338d085e061492
stringNone

Responses

HTTP CodeDescriptionSchema
200OKInternetGatewayShowResponseV1Dot3
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/internet-gateways/{internet_gateway_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 = vpc 1.3"

Example HTTP response

Response 200

{
    "internet_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Internet Gateway Description",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "023c57b14f11483689338d085e061492",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "multi_zone_enabled": true,
        "name": "IGW_VPCname",
        "state": "CREATING",
        "type": "IGW",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.83.2 - 1.2

get /v1/internet-gateways/{internet_gateway_id}

Description

Internet Gateway를 상세조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathinternet_gateway_id
required
Internet Gateway ID
Example : 023c57b14f11483689338d085e061492
stringNone

Responses

HTTP CodeDescriptionSchema
200OKInternetGatewayShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/internet-gateways/{internet_gateway_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 = vpc 1.2"

Example HTTP response

Response 200

{
    "internet_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Internet Gateway Description",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "023c57b14f11483689338d085e061492",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "IGW_VPCname",
        "state": "CREATING",
        "type": "IGW",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.83.3 - 1.1

get /v1/internet-gateways/{internet_gateway_id}

Description

Internet Gateway를 상세조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathinternet_gateway_id
required
Internet Gateway ID
Example : 023c57b14f11483689338d085e061492
stringNone

Responses

HTTP CodeDescriptionSchema
200OKInternetGatewayShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/internet-gateways/{internet_gateway_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 = vpc 1.1"

Example HTTP response

Response 200

{
    "internet_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Internet Gateway Description",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "023c57b14f11483689338d085e061492",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "IGW_VPCname",
        "state": "CREATING",
        "type": "IGW",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.83.4 - 1.0

get /v1/internet-gateways/{internet_gateway_id}

Description

Internet Gateway를 상세조회한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathinternet_gateway_id
required
Internet Gateway ID
Example : 023c57b14f11483689338d085e061492
stringNone

Responses

HTTP CodeDescriptionSchema
200OKInternetGatewayShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/internet-gateways/{internet_gateway_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 = vpc 1.0"

Example HTTP response

Response 200

{
    "internet_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Internet Gateway Description",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "023c57b14f11483689338d085e061492",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "IGW_VPCname",
        "state": "CREATING",
        "type": "IGW",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.84 - Show NAT Gateway

9.1.84.1 - 1.3

get /v1/nat-gateways/{nat_gateway_id}

Description

NAT Gateway를 상세조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathnat_gateway_id
required
NAT Gateway 명
Example : 12f56e27070248a6a240a497e43fbe18
stringNone

Responses

HTTP CodeDescriptionSchema
200OKNatGatewayShowResponseV1Dot3
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nat-gateways/{nat_gateway_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 = vpc 1.3"

Example HTTP response

Response 200

{
    "nat_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "VpcEndpoint Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "multi_zone_enabled": "true",
        "name": "NatGatewayName",
        "nat_gateway_ips": [
            {
                "ip_address": "192.167.0.5",
                "publicip_id": "12f56e27070248a6a240a497e43fbe18"
            }
        ],
        "state": "ACTIVE",
        "subnet_cidr": "192.167.1.0/24",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.84.2 - 1.2

get /v1/nat-gateways/{nat_gateway_id}

Description

NAT Gateway를 상세조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathnat_gateway_id
required
NAT Gateway 명
Example : 12f56e27070248a6a240a497e43fbe18
stringNone

Responses

HTTP CodeDescriptionSchema
200OKNatGatewayShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nat-gateways/{nat_gateway_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 = vpc 1.2"

Example HTTP response

Response 200

{
    "nat_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "VpcEndpoint Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "NatGatewayName",
        "nat_gateway_ip_address": "192.167.0.5",
        "publicip_id": "12f56e27070248a6a240a497e43fbe18",
        "state": "ACTIVE",
        "subnet_cidr": "192.167.1.0/24",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.84.3 - 1.1

get /v1/nat-gateways/{nat_gateway_id}

Description

NAT Gateway를 상세조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathnat_gateway_id
required
NAT Gateway 명
Example : 12f56e27070248a6a240a497e43fbe18
stringNone

Responses

HTTP CodeDescriptionSchema
200OKNatGatewayShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nat-gateways/{nat_gateway_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 = vpc 1.1"

Example HTTP response

Response 200

{
    "nat_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "VpcEndpoint Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "NatGatewayName",
        "nat_gateway_ip_address": "192.167.0.5",
        "publicip_id": "12f56e27070248a6a240a497e43fbe18",
        "state": "ACTIVE",
        "subnet_cidr": "192.167.1.0/24",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.84.4 - 1.0

get /v1/nat-gateways/{nat_gateway_id}

Description

NAT Gateway를 상세조회한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathnat_gateway_id
required
NAT Gateway 명
Example : 12f56e27070248a6a240a497e43fbe18
stringNone

Responses

HTTP CodeDescriptionSchema
200OKNatGatewayShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/nat-gateways/{nat_gateway_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 = vpc 1.0"

Example HTTP response

Response 200

{
    "nat_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "VpcEndpoint Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "NatGatewayName",
        "nat_gateway_ip_address": "192.167.0.5",
        "publicip_id": "12f56e27070248a6a240a497e43fbe18",
        "state": "ACTIVE",
        "subnet_cidr": "192.167.1.0/24",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.85 - Show Port

9.1.85.1 - 1.3

get /v1/ports/{port_id}

Description

Port를 상세조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathport_id
required
Port ID
Example : 023c57b1-4f11-4836-8933-8d085e061492
stringNone

Responses

HTTP CodeDescriptionSchema
200OKPortShowResponseV1Dot2
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/ports/{port_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 = vpc 1.3"

Example HTTP response

Response 200

{
    "port": {
        "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",
        "security_groups": [
            {
                "id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
                "name": "sgName"
            }
        ],
        "state": "",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "virtual_ip_addresses": [
            ""
        ],
        "vpc_id": "071bc63b767444c9afaab1c972d302d5",
        "vpc_name": "vpcName"
    }
}

9.1.85.2 - 1.2

get /v1/ports/{port_id}

Description

Port를 상세조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathport_id
required
Port ID
Example : 023c57b1-4f11-4836-8933-8d085e061492
stringNone

Responses

HTTP CodeDescriptionSchema
200OKPortShowResponseV1Dot2
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/ports/{port_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 = vpc 1.2"

Example HTTP response

Response 200

{
    "port": {
        "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",
        "security_groups": [
            {
                "id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
                "name": "sgName"
            }
        ],
        "state": "",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "virtual_ip_addresses": [
            ""
        ],
        "vpc_id": "071bc63b767444c9afaab1c972d302d5",
        "vpc_name": "vpcName"
    }
}

9.1.85.3 - 1.1

get /v1/ports/{port_id}

Description

Port를 상세조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathport_id
required
Port ID
Example : 023c57b1-4f11-4836-8933-8d085e061492
stringNone

Responses

HTTP CodeDescriptionSchema
200OKPortShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/ports/{port_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 = vpc 1.1"

Example HTTP response

Response 200

{
    "port": {
        "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",
        "security_groups": [
            {
                "id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
                "name": "sgName"
            }
        ],
        "state": "",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "071bc63b767444c9afaab1c972d302d5",
        "vpc_name": "vpcName"
    }
}

9.1.85.4 - 1.0

get /v1/ports/{port_id}

Description

Port를 상세조회한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathport_id
required
Port ID
Example : 023c57b1-4f11-4836-8933-8d085e061492
stringNone

Responses

HTTP CodeDescriptionSchema
200OKPortShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/ports/{port_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 = vpc 1.0"

Example HTTP response

Response 200

{
    "port": {
        "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",
        "security_groups": [
            {
                "id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
                "name": "sgName"
            }
        ],
        "state": "",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "071bc63b767444c9afaab1c972d302d5",
        "vpc_name": "vpcName"
    }
}

9.1.86 - Show Private NAT

9.1.86.1 - 1.3

get /v1/private-nats/{private_nat_id}

Description

Private NAT 상세 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_nat_id
required
Private NAT ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone

Responses

HTTP CodeDescriptionSchema
200OKPrivateNatShowResponseV1Dot2
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/private-nats/{private_nat_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 = vpc 1.3"

Example HTTP response

Response 200

{
    "private_nat": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateNat Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "PrivateNatName",
        "service_resource_id": "3f342bf9a557405b997c2cf48c89cbc2",
        "service_resource_name": "PrivateNatName",
        "service_type": "DIRECT_CONNECT",
        "state": "ACTIVE"
    }
}

9.1.86.2 - 1.2

get /v1/private-nats/{private_nat_id}

Description

Private NAT 상세 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_nat_id
required
Private NAT ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone

Responses

HTTP CodeDescriptionSchema
200OKPrivateNatShowResponseV1Dot2
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/private-nats/{private_nat_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 = vpc 1.2"

Example HTTP response

Response 200

{
    "private_nat": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateNat Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "PrivateNatName",
        "service_resource_id": "3f342bf9a557405b997c2cf48c89cbc2",
        "service_resource_name": "PrivateNatName",
        "service_type": "DIRECT_CONNECT",
        "state": "ACTIVE"
    }
}

9.1.86.3 - 1.1

get /v1/private-nats/{private_nat_id}

Description

Private NAT 상세 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_nat_id
required
Private NAT ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone

Responses

HTTP CodeDescriptionSchema
200OKPrivateNatShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/private-nats/{private_nat_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 = vpc 1.1"

Example HTTP response

Response 200

{
    "private_nat": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateNat Description",
        "direct_connect_id": "fe860e0af0c04dcd8182b84f907f31f4",
        "direct_connect_name": "DirectConnectName",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "PrivateNatName",
        "state": "ACTIVE",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.86.4 - 1.0

get /v1/private-nats/{private_nat_id}

Description

Private NAT 상세 조회

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_nat_id
required
Private NAT ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone

Responses

HTTP CodeDescriptionSchema
200OKPrivateNatShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/private-nats/{private_nat_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 = vpc 1.0"

Example HTTP response

Response 200

{
    "private_nat": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateNat Description",
        "direct_connect_id": "fe860e0af0c04dcd8182b84f907f31f4",
        "direct_connect_name": "DirectConnectName",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "PrivateNatName",
        "state": "ACTIVE",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.87 - Show PrivateLink Endpoint

9.1.87.1 - 1.3

get /v1/privatelink-endpoints/{privatelink_endpoint_id}

Description

PrivateLink Endpoint 상세 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_endpoint_id
required
PrivateLink Endpoint ID
Example : bba6d4de3ad64e41b3a1b6c88983ec02
stringNone

Responses

HTTP CodeDescriptionSchema
200OKPrivateLinkEndpointShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_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 = vpc 1.3"

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Endpoint Description",
        "endpoint_ip_address": "192.167.1.5",
        "endpoint_ip_port_id": "b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e",
        "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "EndpointName",
        "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
        "state": "ACTIVE",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

9.1.87.2 - 1.2

get /v1/privatelink-endpoints/{privatelink_endpoint_id}

Description

PrivateLink Endpoint 상세 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_endpoint_id
required
PrivateLink Endpoint ID
Example : bba6d4de3ad64e41b3a1b6c88983ec02
stringNone

Responses

HTTP CodeDescriptionSchema
200OKPrivateLinkEndpointShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_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 = vpc 1.2"

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Endpoint Description",
        "endpoint_ip_address": "192.167.1.5",
        "endpoint_ip_port_id": "b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e",
        "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "EndpointName",
        "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
        "state": "ACTIVE",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

9.1.87.3 - 1.1

get /v1/privatelink-endpoints/{privatelink_endpoint_id}

Description

PrivateLink Endpoint 상세 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_endpoint_id
required
PrivateLink Endpoint ID
Example : bba6d4de3ad64e41b3a1b6c88983ec02
stringNone

Responses

HTTP CodeDescriptionSchema
200OKPrivateLinkEndpointShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_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 = vpc 1.1"

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Endpoint Description",
        "endpoint_ip_address": "192.167.1.5",
        "endpoint_ip_port_id": "b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e",
        "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "EndpointName",
        "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
        "state": "ACTIVE",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

9.1.88 - Show PrivateLink Service

9.1.88.1 - 1.3

get /v1/privatelink-services/{privatelink_service_id}

Description

PrivateLink Service 상세 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_service_id
required
PrivateLink Service ID
Example : e3df2e8e3b374fbb81d4e322b52ca50d
stringNone

Responses

HTTP CodeDescriptionSchema
200OKPrivateLinkServiceShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/privatelink-services/{privatelink_service_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 = vpc 1.3"

Example HTTP response

Response 200

{
    "privatelink_service": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
        "connected_resource_ip_address": "192.167.0.10",
        "connected_resource_name": "lbResourceName",
        "connected_resource_type": "LB",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Service Description",
        "high_speed_transfer": false,
        "id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServiceName",
        "security_group_ids": "['00b6af37-73b5-4de2-b080-c295a1a0382e']",
        "service_ip_address": "192.167.0.5",
        "service_ip_port_id": "d21a4b81-f52a-43a8-b985-341e763458bb",
        "state": "CREATING",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

9.1.88.2 - 1.2

get /v1/privatelink-services/{privatelink_service_id}

Description

PrivateLink Service 상세 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_service_id
required
PrivateLink Service ID
Example : e3df2e8e3b374fbb81d4e322b52ca50d
stringNone

Responses

HTTP CodeDescriptionSchema
200OKPrivateLinkServiceShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/privatelink-services/{privatelink_service_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 = vpc 1.2"

Example HTTP response

Response 200

{
    "privatelink_service": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
        "connected_resource_ip_address": "192.167.0.10",
        "connected_resource_name": "lbResourceName",
        "connected_resource_type": "LB",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Service Description",
        "high_speed_transfer": false,
        "id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServiceName",
        "security_group_ids": "['00b6af37-73b5-4de2-b080-c295a1a0382e']",
        "service_ip_address": "192.167.0.5",
        "service_ip_port_id": "d21a4b81-f52a-43a8-b985-341e763458bb",
        "state": "CREATING",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

9.1.88.3 - 1.1

get /v1/privatelink-services/{privatelink_service_id}

Description

PrivateLink Service 상세 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathprivatelink_service_id
required
PrivateLink Service ID
Example : e3df2e8e3b374fbb81d4e322b52ca50d
stringNone

Responses

HTTP CodeDescriptionSchema
200OKPrivateLinkServiceShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/privatelink-services/{privatelink_service_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 = vpc 1.1"

Example HTTP response

Response 200

{
    "privatelink_service": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
        "connected_resource_ip_address": "192.167.0.10",
        "connected_resource_name": "lbResourceName",
        "connected_resource_type": "LB",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Service Description",
        "high_speed_transfer": false,
        "id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServiceName",
        "security_group_ids": "['00b6af37-73b5-4de2-b080-c295a1a0382e']",
        "service_ip_address": "192.167.0.5",
        "service_ip_port_id": "d21a4b81-f52a-43a8-b985-341e763458bb",
        "state": "CREATING",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

9.1.89 - Show PublicIP

9.1.89.1 - 1.3

get /v1/publicips/{publicip_id}

Description

PublicIP를 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathpublicip_id
required
PublicIP ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone

Responses

HTTP CodeDescriptionSchema
200OKPublicipShowResponseV1Dot3
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/publicips/{publicip_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 = vpc 1.3"

Example HTTP response

Response 200

{
    "publicip": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
        "attached_resource_name": "Attached NAT Gateway Name",
        "attached_resource_type": "NAT_GW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Public IP Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "ip_address": "192.167.0.5",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ATTACHED",
        "type": "IGW",
        "zone": "kr-west1-a"
    }
}

9.1.89.2 - 1.2

get /v1/publicips/{publicip_id}

Description

PublicIP를 상세 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathpublicip_id
required
PublicIP ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone

Responses

HTTP CodeDescriptionSchema
200OKPublicipShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/publicips/{publicip_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 = vpc 1.2"

Example HTTP response

Response 200

{
    "publicip": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
        "attached_resource_name": "Attached NAT Gateway Name",
        "attached_resource_type": "NAT_GW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Public IP Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "ip_address": "192.167.0.5",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ATTACHED",
        "type": "IGW"
    }
}

9.1.89.3 - 1.1

get /v1/publicips/{publicip_id}

Description

PublicIP를 상세 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathpublicip_id
required
PublicIP ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone

Responses

HTTP CodeDescriptionSchema
200OKPublicipShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/publicips/{publicip_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 = vpc 1.1"

Example HTTP response

Response 200

{
    "publicip": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
        "attached_resource_name": "Attached NAT Gateway Name",
        "attached_resource_type": "NAT_GW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Public IP Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "ip_address": "192.167.0.5",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ATTACHED",
        "type": "IGW"
    }
}

9.1.89.4 - 1.0

get /v1/publicips/{publicip_id}

Description

PublicIP를 상세 조회한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathpublicip_id
required
PublicIP ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone

Responses

HTTP CodeDescriptionSchema
200OKPublicipShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/publicips/{publicip_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 = vpc 1.0"

Example HTTP response

Response 200

{
    "publicip": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
        "attached_resource_name": "Attached NAT Gateway Name",
        "attached_resource_type": "NAT_GW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Public IP Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "ip_address": "192.167.0.5",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ATTACHED",
        "type": "IGW"
    }
}

9.1.90 - Show Subnet

9.1.90.1 - 1.3

get /v1/subnets/{subnet_id}

Description

Subnet을 상세조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone

Responses

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

Example HTTP request

Request path

/v1/subnets/{subnet_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 = vpc 1.3"

Example HTTP response

Response 200

{
    "subnet": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "allocation_pools": [],
        "category": "PRIMARY",
        "cidr": "192.167.1.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Subnet Description",
        "dhcp_ip_address": "",
        "dns_nameservers": [],
        "gateway_ip_address": "192.167.1.1",
        "host_routes": [],
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "subnetName",
        "primary_subnet_id": "023c57b14f11483689338d085e061492",
        "secondary_subnet_ids": "[\"522e102f680448a8804d18d4838baa78\", \"aec40baf53c243c1bb8401a703a2c888\"]",
        "state": "CREATING",
        "type": "PUBLIC",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName",
        "zones": "[\"kr-west1-a\", \"kr-west1-b\", \"kr-west1-c\"]"
    }
}

9.1.90.2 - 1.2

get /v1/subnets/{subnet_id}

Description

Subnet을 상세조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone

Responses

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

Example HTTP request

Request path

/v1/subnets/{subnet_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 = vpc 1.2"

Example HTTP response

Response 200

{
    "subnet": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "allocation_pools": [],
        "cidr": "192.167.1.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Subnet Description",
        "dhcp_ip_address": "",
        "dns_nameservers": [],
        "gateway_ip_address": "192.167.1.1",
        "host_routes": [],
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "subnetName",
        "state": "CREATING",
        "type": "GENERAL",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.90.3 - 1.1

get /v1/subnets/{subnet_id}

Description

Subnet을 상세조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone

Responses

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

Example HTTP request

Request path

/v1/subnets/{subnet_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 = vpc 1.1"

Example HTTP response

Response 200

{
    "subnet": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "allocation_pools": [],
        "cidr": "192.167.1.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Subnet Description",
        "dns_nameservers": [],
        "gateway_ip_address": "192.167.1.1",
        "host_routes": [],
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "subnetName",
        "state": "CREATING",
        "type": "GENERAL",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.90.4 - 1.0

get /v1/subnets/{subnet_id}

Description

Subnet을 상세조회한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone

Responses

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

Example HTTP request

Request path

/v1/subnets/{subnet_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 = vpc 1.0"

Example HTTP response

Response 200

{
    "subnet": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "allocation_pools": [],
        "cidr": "192.167.1.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Subnet Description",
        "dns_nameservers": [],
        "gateway_ip_address": "192.167.1.1",
        "host_routes": [],
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "subnetName",
        "state": "CREATING",
        "type": "GENERAL",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

9.1.91 - Show Subnet Vip

9.1.91.1 - 1.3

get /v1/subnets/{subnet_id}/vips/{vip_id}

Description

Subnet Vip 상세 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone
pathvip_id
required
Subnet Vip Id
Example : 0466a9448d9a4411a86055939e451c8f
stringNone

Responses

HTTP CodeDescriptionSchema
200OKVipShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/subnets/{subnet_id}/vips/{vip_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 = vpc 1.3"

Example HTTP response

Response 200

{
    "subnet_vip": {
        "connected_ports": [
            {
                "attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
                "attached_resource_type": "Virtual Server",
                "id": "13e2a5a1acbe4713a9a2c70ce226e822",
                "port_id": "8b4705d3-43b7-4fad-8648-a5a1a90c31d0",
                "port_ip_address": "192.168.20.5",
                "port_name": "Port name"
            }
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Subnet VIP Description",
        "id": "0466a9448d9a4411a86055939e451c8f",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ACTIVE",
        "static_nat": {
            "external_ip_address": "100.112.9.84",
            "id": "0009e49548154745948e9722adefbf40",
            "publicip_id": "12f56e27070248a6a240a497e43fbe18",
            "state": "ACTIVE"
        },
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vip_port_id": "35268a9f2eda4cde83b1d85c1f61f67d",
        "virtual_ip_address": "192.168.20.6"
    }
}

9.1.91.2 - 1.2

get /v1/subnets/{subnet_id}/vips/{vip_id}

Description

Subnet Vip 상세 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathsubnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
stringNone
pathvip_id
required
Subnet Vip Id
Example : 0466a9448d9a4411a86055939e451c8f
stringNone

Responses

HTTP CodeDescriptionSchema
200OKVipShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/subnets/{subnet_id}/vips/{vip_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 = vpc 1.2"

Example HTTP response

Response 200

{
    "subnet_vip": {
        "connected_ports": [
            {
                "attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
                "attached_resource_type": "Virtual Server",
                "id": "13e2a5a1acbe4713a9a2c70ce226e822",
                "port_id": "8b4705d3-43b7-4fad-8648-a5a1a90c31d0",
                "port_ip_address": "192.168.20.5",
                "port_name": "Port name"
            }
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Subnet VIP Description",
        "id": "0466a9448d9a4411a86055939e451c8f",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ACTIVE",
        "static_nat": {
            "external_ip_address": "100.112.9.84",
            "id": "0009e49548154745948e9722adefbf40",
            "publicip_id": "12f56e27070248a6a240a497e43fbe18",
            "state": "ACTIVE"
        },
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vip_port_id": "35268a9f2eda4cde83b1d85c1f61f67d",
        "virtual_ip_address": "192.168.20.6"
    }
}

9.1.92 - Show Transit Gateway

9.1.92.1 - 1.3

get /v1/transit-gateways/{transit_gateway_id}

Description

Transit Gateway 상세 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone

Responses

HTTP CodeDescriptionSchema
200OKTransitGatewayShowResponseV1Dot3
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_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 = vpc 1.3"

Example HTTP response

Response 200

{
    "transit_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "TransitGateway Description",
        "firewall_connection_state": "INACTIVE",
        "firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "TransitGatewayName",
        "state": "ACTIVE",
        "uplink_active_zone": "kr-west1-a",
        "uplink_enabled": "False",
        "uplink_standby_zone": "kr-west1-b",
        "uplink_zone_state": "ACTIVE"
    }
}

9.1.92.2 - 1.2

get /v1/transit-gateways/{transit_gateway_id}

Description

Transit Gateway 상세 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone

Responses

HTTP CodeDescriptionSchema
200OKTransitGatewayShowResponseV1Dot2
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_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 = vpc 1.2"

Example HTTP response

Response 200

{
    "transit_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "TransitGateway Description",
        "firewall_connection_state": "INACTIVE",
        "firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "TransitGatewayName",
        "state": "ACTIVE",
        "uplink_enabled": "False"
    }
}

9.1.92.3 - 1.1

get /v1/transit-gateways/{transit_gateway_id}

Description

Transit Gateway 상세 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone

Responses

HTTP CodeDescriptionSchema
200OKTransitGatewayShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_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 = vpc 1.1"

Example HTTP response

Response 200

{
    "transit_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "TransitGateway Description",
        "firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "TransitGatewayName",
        "state": "ACTIVE",
        "uplink_enabled": "False"
    }
}

9.1.92.4 - 1.0

get /v1/transit-gateways/{transit_gateway_id}

Description

Transit Gateway 상세 조회

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathtransit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
stringNone

Responses

HTTP CodeDescriptionSchema
200OKTransitGatewayShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_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 = vpc 1.0"

Example HTTP response

Response 200

{
    "transit_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "TransitGateway Description",
        "firewall_ids": "bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "TransitGatewayName",
        "state": "ACTIVE",
        "uplink_enabled": "False"
    }
}

9.1.93 - Show VPC

9.1.93.1 - 1.3

get /v1/vpcs/{vpc_id}

Description

VPC를 상세조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_id
required
VPC ID
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/vpcs/{vpc_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 = vpc 1.3"

Example HTTP response

Response 200

{
    "vpc": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr_count": 20,
        "cidrs": [
            {
                "cidr": "192.167.0.0/18",
                "created_at": "2024-05-17T00:23:17Z",
                "created_by": "7df8abb4912e4709b1cb237daccca7a8",
                "id": "7df8abb4912e4709b1cb237daccca7a8"
            }
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "vpcDescription",
        "id": "7df8abb4912e4709b1cb237daccca7a8",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcName",
        "state": "CREATING",
        "zone_type": "PUBLIC",
        "zones": [
            "zone-a",
            "zone-b",
            "zone-c"
        ]
    }
}

9.1.93.2 - 1.2

get /v1/vpcs/{vpc_id}

Description

VPC를 상세조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_id
required
VPC ID
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/vpcs/{vpc_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 = vpc 1.2"

Example HTTP response

Response 200

{
    "vpc": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr_count": 20,
        "cidrs": [
            {
                "cidr": "192.167.0.0/18",
                "created_at": "2024-05-17T00:23:17Z",
                "created_by": "7df8abb4912e4709b1cb237daccca7a8",
                "id": "7df8abb4912e4709b1cb237daccca7a8"
            }
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "vpcDescription",
        "id": "7df8abb4912e4709b1cb237daccca7a8",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcName",
        "state": "CREATING"
    }
}

9.1.93.3 - 1.1

get /v1/vpcs/{vpc_id}

Description

VPC를 상세조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_id
required
VPC ID
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/vpcs/{vpc_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 = vpc 1.1"

Example HTTP response

Response 200

{
    "vpc": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/18",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "vpcDescription",
        "id": "7df8abb4912e4709b1cb237daccca7a8",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcName",
        "state": "CREATING"
    }
}

9.1.93.4 - 1.0

get /v1/vpcs/{vpc_id}

Description

VPC를 상세조회한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_id
required
VPC ID
Example :
stringNone

Responses

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

Example HTTP request

Request path

/v1/vpcs/{vpc_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 = vpc 1.0"

Example HTTP response

Response 200

{
    "vpc": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/18",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "vpcDescription",
        "id": "7df8abb4912e4709b1cb237daccca7a8",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcName",
        "state": "CREATING"
    }
}

9.1.94 - Show VPC Endpoint

9.1.94.1 - 1.3

get /v1/vpc-endpoints/{vpc_endpoint_id}

Description

VPC Endpoint 를 상세조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_endpoint_id
required
VPC Endpoint ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone

Responses

HTTP CodeDescriptionSchema
200OKVpcEndpointShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/vpc-endpoints/{vpc_endpoint_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 = vpc 1.3"

Example HTTP response

Response 200

{
    "vpc_endpoint": {
        "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"
    }
}

9.1.94.2 - 1.2

get /v1/vpc-endpoints/{vpc_endpoint_id}

Description

VPC Endpoint 를 상세조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_endpoint_id
required
VPC Endpoint ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone

Responses

HTTP CodeDescriptionSchema
200OKVpcEndpointShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/vpc-endpoints/{vpc_endpoint_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 = vpc 1.2"

Example HTTP response

Response 200

{
    "vpc_endpoint": {
        "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"
    }
}

9.1.94.3 - 1.1

get /v1/vpc-endpoints/{vpc_endpoint_id}

Description

VPC Endpoint 를 상세조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_endpoint_id
required
VPC Endpoint ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone

Responses

HTTP CodeDescriptionSchema
200OKVpcEndpointShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/vpc-endpoints/{vpc_endpoint_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 = vpc 1.1"

Example HTTP response

Response 200

{
    "vpc_endpoint": {
        "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"
    }
}

9.1.94.4 - 1.0

get /v1/vpc-endpoints/{vpc_endpoint_id}

Description

VPC Endpoint 를 상세조회한다.

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_endpoint_id
required
VPC Endpoint ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone

Responses

HTTP CodeDescriptionSchema
200OKVpcEndpointShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/vpc-endpoints/{vpc_endpoint_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 = vpc 1.0"

Example HTTP response

Response 200

{
    "vpc_endpoint": {
        "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"
    }
}

9.1.95 - Show VPC Peering

9.1.95.1 - 1.3

get /v1/vpc-peerings/{vpc_peering_id}

Description

VPC Peering 상세 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_peering_id
required
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
stringNone

Responses

HTTP CodeDescriptionSchema
200OKVpcPeeringShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_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 = vpc 1.3"

Example HTTP response

Response 200

{
    "vpc_peering": {
        "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"
    }
}

9.1.95.2 - 1.2

get /v1/vpc-peerings/{vpc_peering_id}

Description

VPC Peering 상세 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_peering_id
required
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
stringNone

Responses

HTTP CodeDescriptionSchema
200OKVpcPeeringShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_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 = vpc 1.2"

Example HTTP response

Response 200

{
    "vpc_peering": {
        "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"
    }
}

9.1.95.3 - 1.1

get /v1/vpc-peerings/{vpc_peering_id}

Description

VPC Peering 상세 조회

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_peering_id
required
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
stringNone

Responses

HTTP CodeDescriptionSchema
200OKVpcPeeringShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_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 = vpc 1.1"

Example HTTP response

Response 200

{
    "vpc_peering": {
        "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"
    }
}

9.1.95.4 - 1.0

get /v1/vpc-peerings/{vpc_peering_id}

Description

VPC Peering 상세 조회

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathvpc_peering_id
required
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
stringNone

Responses

HTTP CodeDescriptionSchema
200OKVpcPeeringShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_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 = vpc 1.0"

Example HTTP response

Response 200

{
    "vpc_peering": {
        "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"
    }
}

9.2 - Models

9.2.1 - ConnectedEndpointListResponse

NameDescriptionSchemaDefault
connected_privatelink_endpoints
required

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

9.2.2 - ConnectedPortInfo

NameDescriptionSchemaDefault
attached_resource_id
required
연결된 자원 ID
Example : 9387e8f51de04a03994de8a9c3524935
string
attached_resource_type
required
연결된 자원 유형
Example : Virtual Server
string
id
required
연결 Port Id
Example : 13e2a5a1acbe4713a9a2c70ce226e822
string
port_id
required
Port ID
Example : 8b4705d3-43b7-4fad-8648-a5a1a90c31d0
string
port_ip_address
required
Port IP 주소
Example : 192.168.20.5
string
port_name
required
Port 명
Example : Port name
string

9.2.3 - ConnectedPrivateLinkEndpoint

NameDescriptionSchemaDefault
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
id
required
PrivateLink Endpoint ID
Example : bba6d4de3ad64e41b3a1b6c88983ec02
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
privatelink_service_id
required
PrivateLink Service ID
Example : e3df2e8e3b374fbb81d4e322b52ca50d
string
state
required
PrivateLink Endpoint 상태
Example : ACTIVE
enum (REQUESTING, CREATING, REJECTED, CANCELED, ACTIVE, DISCONNECTED, DELETING, DELETED, ERROR)

9.2.4 - InternetGateway

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
설명
Example : Internet Gateway Description
any of [string, null]
firewall_id
optional
Firewall ID
Example : b156740b6335468d8354eb9ef8eddf5a
any of [string, null]
id
required
Internet Gateway ID
Example : 023c57b14f11483689338d085e061492
string
loggable
optional
NAT 로그 저장 여부
Example : False
boolean
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Internet Gateway 명
Example : IGW_VPCname
string
state
required
상태
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
type
required
Internet Gateway 유형
Example : IGW
enum (IGW, GGW, SIGW)
vpc_id
required
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
vpc_name
required
VPC 명
Example : vpcName
string

9.2.5 - InternetGatewayCreateRequest

NameDescriptionSchemaDefault
description
optional
설명
Example : Internet Gateway Description
any of [string, null]
firewall_enabled
optional
방화벽 사용
Example : False
boolean
firewall_loggable
optional
방화벽 로깅 가능
Example : False
boolean
tags
optional
태그 목록
array[Tag]
type
required
Internet Gateway 유형
Example : IGW
enum (IGW, GGW, SIGW)
vpc_id
required
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string

9.2.6 - InternetGatewayListResponse

NameDescriptionSchemaDefault
count
optional
전체 개수
Example : 20
any of [integer, null]
internet_gateways
required

array[InternetGateway]
links
optional
links
Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]
any of [array[object], null]

9.2.7 - InternetGatewayListResponseV1Dot2

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
internet_gateways
required

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

9.2.8 - InternetGatewayListResponseV1Dot3

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
internet_gateways
required

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

9.2.9 - InternetGatewaySetRequest

NameDescriptionSchemaDefault
description
optional
설명
Example : Internet Gateway Description
any of [string, null]
loggable
optional
NAT 로그 저장 여부
Example :
boolean

9.2.10 - InternetGatewaySetResponse

NameDescriptionSchemaDefault
description
optional
설명
Example : Internet Gateway Description
any of [string, null]
loggable
optional
NAT 로그 저장 여부
Example :
boolean

9.2.11 - InternetGatewayShowResponse

NameDescriptionSchemaDefault
internet_gateway
required

InternetGateway

9.2.12 - InternetGatewayShowResponseV1Dot3

NameDescriptionSchemaDefault
internet_gateway
required

InternetGatewayV1Dot3

9.2.13 - InternetGatewayV1Dot3

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
설명
Example : Internet Gateway Description
any of [string, null]
firewall_id
optional
Firewall ID
Example : b156740b6335468d8354eb9ef8eddf5a
any of [string, null]
id
required
Internet Gateway ID
Example : 023c57b14f11483689338d085e061492
string
loggable
optional
NAT 로그 저장 여부
Example : False
boolean
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
multi_zone_enabled
optional
Multi zone 사용여부
Example : True
boolean
name
required
Internet Gateway 명
Example : IGW_VPCname
string
state
required
상태
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
type
required
Internet Gateway 유형
Example : IGW
enum (IGW, GGW, SIGW)
vpc_id
required
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
vpc_name
required
VPC 명
Example : vpcName
string

9.2.14 - NatGateway

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
NAT Gateway 상세설명
Example : VpcEndpoint Description
any of [string, null]
id
required
NAT Gateway 명
Example : 12f56e27070248a6a240a497e43fbe18
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
NAT Gateway 명
Example : NatGatewayName
string
nat_gateway_ip_address
required
NAT Gateway IP 주소
Example : 192.167.0.5
string
publicip_id
optional
PublicIP ID
Example : 12f56e27070248a6a240a497e43fbe18
any of [string, null]
state
required
NAT Gateway 상태
Example : ACTIVE
string
subnet_cidr
required
Subnet Cidr
Example : 192.167.1.0/24
string
subnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
string
subnet_name
required
Subnet 명
Example : subnetName
string
vpc_id
required
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
vpc_name
required
VPC 명
Example : vpcName
string

9.2.15 - NatGatewayCreateRequest

NameDescriptionSchemaDefault
description
optional
NAT Gateway 상세설명
Example : VpcEndpoint Description
Maximum length : 50
string
publicip_id
required
PublicIP ID
Example : 12f56e27070248a6a240a497e43fbe18
string
subnet_id
required
Subnet CIDR
Example : 023c57b14f11483689338d085e061492
string
tags
optional
태그 목록
Example : [{'key': 'key', 'value': 'value'}]
array[Tag]

9.2.16 - NatGatewayCreateRequestV1Dot3

NameDescriptionSchemaDefault
description
optional
NAT Gateway 상세설명
Example : VpcEndpoint Description
Maximum length : 50
string
multi_zone_enabled
optional
Multi Zone 사용
Example : true
any of [boolean, null]
publicip_ids
required
PublicIP ID들
Example : ['12f56e27070248a6a240a497e43fbe18', '24f56e27070248a6a240a497e43fbe18']
array[string]
subnet_id
required
Subnet CIDR
Example : 023c57b14f11483689338d085e061492
string
tags
optional
태그 목록
Example : [{'key': 'key', 'value': 'value'}]
array[Tag]

9.2.17 - NatGatewayIp

NameDescriptionSchemaDefault
ip_address
required
NAT Gateway IP 주소
Example : 192.167.0.5
string
publicip_id
required
PublicIP ID
Example : 12f56e27070248a6a240a497e43fbe18
string

9.2.18 - NatGatewayListResponse

NameDescriptionSchemaDefault
count
optional
전체 개수
Example : 20
any of [integer, null]
links
optional
links
Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]
any of [array[object], null]
nat_gateways
required

array[NatGateway]

9.2.19 - NatGatewayListResponseV1Dot2

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
nat_gateways
required

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

9.2.20 - NatGatewayListResponseV1Dot3

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
nat_gateways
required

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

9.2.21 - NatGatewaySetRequest

NameDescriptionSchemaDefault
description
optional
NAT Gateway 상세설명
Example : VpcEndpoint Description
Maximum length : 50
string

9.2.22 - NatGatewaySetResponse

NameDescriptionSchemaDefault
description
optional
NAT Gateway 상세설명
Example : VpcEndpoint Description
any of [string, null]

9.2.23 - NatGatewayShowResponse

NameDescriptionSchemaDefault
nat_gateway
required

NatGateway

9.2.24 - NatGatewayShowResponseV1Dot3

NameDescriptionSchemaDefault
nat_gateway
required

NatGatewayV1Dot3

9.2.25 - NatGatewayV1Dot3

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
NAT Gateway 상세설명
Example : VpcEndpoint Description
any of [string, null]
id
required
NAT Gateway 명
Example : 12f56e27070248a6a240a497e43fbe18
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
multi_zone_enabled
required
Multi Zone 사용
Example : true
boolean
name
required
NAT Gateway 명
Example : NatGatewayName
string
nat_gateway_ips
optional
NAT Gateway IP들
any of [array[NatGatewayIp], null]
state
required
NAT Gateway 상태
Example : ACTIVE
string
subnet_cidr
required
Subnet Cidr
Example : 192.167.1.0/24
string
subnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
string
subnet_name
required
Subnet 명
Example : subnetName
string
vpc_id
required
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
vpc_name
required
VPC 명
Example : vpcName
string

9.2.26 - Port

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
attached_resource_id
required
연결된 자원 ID
Example : 9387e8f51de04a03994de8a9c3524935
string
attached_resource_type
required
연결된 자원 유형
Example :
string
created_at
required
생성일시
Example : 2024-01-15T10:30:00.000Z
string (date-time)
description
required
설명
Example : Port Description
Maximum length : 50
string
fixed_ip_address
required
고정된 IP
Example : 192.168.1.100
string
id
required
Port ID
Example : 023c57b1-4f11-4836-8933-8d085e061492
string
mac_address
required
MAC 주소
Example : fa:16:3e:00:00:01
string
modified_at
required
수정일시
Example : 2024-01-15T10:30:00.000Z
string (date-time)
name
required
Port 명
Example : portName
string
security_groups
required
Security Group 목록
array[PortSecurityGroup]
state
required
상태
Example :
string
subnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
string
subnet_name
required
Subnet 명
Example : subnetName
string
vpc_id
required
VPC ID
Example : 071bc63b767444c9afaab1c972d302d5
string
vpc_name
required
VPC 명
Example : vpcName
string

9.2.27 - PortCreateRequest

NameDescriptionSchemaDefault
description
optional
설명
Example : Port Description
any of [string, null]
fixed_ip_address
optional
고정된 IP
Example :
any of [string, null]
name
required
Port 명
Example : portName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
security_groups
optional
Security Group 목록
array[string]
subnet_id
required
Subnet ID
Example :
string
tags
optional
태그 목록
array[Tag]

9.2.28 - PortList

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
attached_resource_id
required
연결된 자원 ID
Example : 9387e8f51de04a03994de8a9c3524935
string
attached_resource_type
required
연결된 자원 유형
Example :
string
created_at
required
생성일시
Example : 2024-01-15T10:30:00.000Z
string (date-time)
description
required
설명
Example : Port Description
Maximum length : 50
string
fixed_ip_address
required
고정된 IP
Example : 192.168.1.100
string
id
required
Port ID
Example : 023c57b1-4f11-4836-8933-8d085e061492
string
mac_address
required
MAC 주소
Example : fa:16:3e:00:00:01
string
modified_at
required
수정일시
Example : 2024-01-15T10:30:00.000Z
string (date-time)
name
required
Port 명
Example : portName
string
state
required
상태
Example :
string
subnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
string
subnet_name
required
Subnet 명
Example : subnetName
string
vpc_id
required
VPC ID
Example : 071bc63b767444c9afaab1c972d302d5
string
vpc_name
required
VPC 명
Example : vpcName
string

9.2.29 - PortListResponse

NameDescriptionSchemaDefault
count
optional
전체 개수
Example : 20
any of [integer, null]
links
optional
links
Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]
any of [array[object], null]
ports
required

array[PortList]

9.2.30 - PortSecurityGroup

NameDescriptionSchemaDefault
id
optional
Security Group ID
Example : 02fb574c-f30f-40e1-9f43-4d1572dee5bd
any of [string, null]
name
optional
Security Group 이름
Example : sgName
any of [string, null]

9.2.31 - PortSetRequest

NameDescriptionSchemaDefault
description
optional
설명
Example : Port Description
any of [string, null]
security_groups
optional
Security Group 목록
Example :
any of [array[string], null]

9.2.32 - PortShowResponse

NameDescriptionSchemaDefault
port
required

any of [Port, null]

9.2.33 - PortShowResponseV1Dot2

NameDescriptionSchemaDefault
port
required

any of [PortV1Dot2, null]

9.2.34 - PortV1Dot2

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
attached_resource_id
required
연결된 자원 ID
Example : 9387e8f51de04a03994de8a9c3524935
string
attached_resource_type
required
연결된 자원 유형
Example :
string
created_at
required
생성일시
Example : 2024-01-15T10:30:00.000Z
string (date-time)
description
required
설명
Example : Port Description
Maximum length : 50
string
fixed_ip_address
required
고정된 IP
Example : 192.168.1.100
string
id
required
Port ID
Example : 023c57b1-4f11-4836-8933-8d085e061492
string
mac_address
required
MAC 주소
Example : fa:16:3e:00:00:01
string
modified_at
required
수정일시
Example : 2024-01-15T10:30:00.000Z
string (date-time)
name
required
Port 명
Example : portName
string
security_groups
required
Security Group 목록
array[PortSecurityGroup]
state
required
상태
Example :
string
subnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
string
subnet_name
required
Subnet 명
Example : subnetName
string
virtual_ip_addresses
required
Virtual IP 주소
array[string]
vpc_id
required
VPC ID
Example : 071bc63b767444c9afaab1c972d302d5
string
vpc_name
required
VPC 명
Example : vpcName
string

9.2.35 - PrivateLinkEndpoint

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
approval_type
required
PrivateLink Service 승인 타입
Example : AUTO
enum (MANUAL, AUTO)
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
endpoint_ip_address
required
Endpoint IP 주소
Example : 192.167.1.5
string
id
required
PrivateLink Endpoint ID
Example : bba6d4de3ad64e41b3a1b6c88983ec02
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
PrivateLink Endpoint 명
Example : EndpointName
string
privatelink_service_id
required
PrivateLink Service ID
Example : e3df2e8e3b374fbb81d4e322b52ca50d
string
state
required
PrivateLink Endpoint 상태
Example : ACTIVE
enum (REQUESTING, CREATING, REJECTED, CANCELED, ACTIVE, DISCONNECTED, DELETING, DELETED, ERROR)
subnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
string
vpc_id
required
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string

9.2.36 - PrivateLinkEndpointApprovalRequest

NameDescriptionSchemaDefault
type
required
PrivateLink Endpoint Action Type
Example : APPROVE
enum (APPROVE, REJECT)

9.2.37 - PrivateLinkEndpointConnectionRequest

NameDescriptionSchemaDefault
type
required
PrivateLink Endpoint Action Type
Example : DISCONNECT
enum (DISCONNECT, RECONNECT)

9.2.38 - PrivateLinkEndpointCreateRequest

NameDescriptionSchemaDefault
description
optional
설명
Example : PrivateLink Endpoint Description
Maximum length : 50
string
endpoint_ip_address
required
Endpoint IP 주소
Example : 192.167.1.5
string
name
required
PrivateLink Endpoint 명
Example : EndpointName
Pattern : ^[a-zA-Z0-9]([a-zA-Z0-9-])*$
Minimum length : 3
Maximum length : 20
string
privatelink_service_id
optional
PrivateLink Service ID
Example : e3df2e8e3b374fbb81d4e322b52ca50d
string
security_group_ids
optional
Security Group 목록
Example : ['17776b52-0a64-440d-9e93-b4fc37be935b']
array[string]
subnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
string
tags
optional
태그 목록
Example : [{'key': 'key', 'value': 'value'}]
array[Tag]

9.2.39 - PrivateLinkEndpointDetail

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
approval_type
required
PrivateLink Service 승인 타입
Example : AUTO
enum (MANUAL, AUTO)
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
설명
Example : PrivateLink Endpoint Description
any of [string, null]
endpoint_ip_address
required
Endpoint IP 주소
Example : 192.167.1.5
string
endpoint_ip_port_id
optional
Endpoint IP Port ID
Example : b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e
any of [string, null]
id
required
PrivateLink Endpoint ID
Example : bba6d4de3ad64e41b3a1b6c88983ec02
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
PrivateLink Endpoint 명
Example : EndpointName
string
privatelink_service_id
required
PrivateLink Service ID
Example : e3df2e8e3b374fbb81d4e322b52ca50d
string
security_group_ids
optional
Security Group 목록
Example : ['17776b52-0a64-440d-9e93-b4fc37be935b']
array[string]
state
required
PrivateLink Endpoint 상태
Example : ACTIVE
enum (REQUESTING, CREATING, REJECTED, CANCELED, ACTIVE, DISCONNECTED, DELETING, DELETED, ERROR)
subnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
string
vpc_id
required
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string

9.2.40 - PrivateLinkEndpointListResponse

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
page
required
page
Example : 0
integer
privatelink_endpoints
required

array[PrivateLinkEndpoint]
size
required
size
Example : 20
integer
sort
optional
sort
Example : ['created_at:asc']
any of [array[string], null]

9.2.41 - PrivateLinkEndpointRequest

NameDescriptionSchemaDefault
type
required
PrivateLink Endpoint Action Type
Example : CANCEL
enum (CANCEL, RE_REQUEST)

9.2.42 - PrivateLinkEndpointSetRequest

NameDescriptionSchemaDefault
description
optional
설명
Example : PrivateLink Endpoint Description
Maximum length : 50
string

9.2.43 - PrivateLinkEndpointShowResponse

NameDescriptionSchemaDefault
privatelink_endpoint
required

PrivateLinkEndpointDetail

9.2.44 - PrivateLinkEndpointSummary

NameDescriptionSchemaDefault
created_at
required
생성일시
Example : 2024-06-16T02:55:13Z
string (date-time)
id
required
PrivateLink Endpoint ID
Example : bba6d4de3ad64e41b3a1b6c88983ec02
string
state
required
PrivateLink Endpoint 상태
Example : ACTIVE
enum (REQUESTING, CREATING, REJECTED, CANCELED, ACTIVE, DISCONNECTED, DELETING, DELETED, ERROR)

9.2.45 - PrivateLinkEndpointSummaryShowResponse

NameDescriptionSchemaDefault
privatelink_endpoint
required

PrivateLinkEndpointSummary

9.2.46 - PrivateLinkService

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
approval_type
required
PrivateLink Service 승인 타입
Example : AUTO
enum (MANUAL, AUTO)
connected_resource_id
optional
연결된 자원 ID
Example : a3e3a662a4f34442a94166df5ff9f577
any of [string, null]
connected_resource_ip_address
required
연결된 자원 IP 주소
Example : 192.167.0.10
string
connected_resource_name
required
연결된 자원명
Example : lbResourceName
string
connected_resource_type
required
연결된 자원 Type
Example : LB
enum (LB, IP)
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
id
required
PrivateLink Service ID
Example : e3df2e8e3b374fbb81d4e322b52ca50d
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
PrivateLink Service 명
Example : ServiceName
string
service_ip_address
required
Service IP 주소
Example : 192.167.0.5
string
state
required
PrivateLink Service 상태
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
subnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
string
vpc_id
required
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string

9.2.47 - PrivateLinkServiceCreateRequest

NameDescriptionSchemaDefault
approval_type
required
PrivateLink Service 승인 타입
Example : AUTO
enum (MANUAL, AUTO)
connected_resource_id
optional
연결된 자원 ID
Example : a3e3a662a4f34442a94166df5ff9f577
string
connected_resource_ip_address
optional
연결된 자원 IP 주소
Example : 192.167.0.10
string
connected_resource_type
required
연결된 자원 Type
Example : LB
enum (LB, IP)
description
optional
설명
Example : PrivateLink Service Description
Maximum length : 50
string
high_speed_transfer
optional
고속 데이터 전송 사용
Example : False
boolean
name
required
PrivateLink Service 명
Example : ServiceName
Pattern : ^[a-zA-Z0-9]([a-zA-Z0-9-])*$
Minimum length : 3
Maximum length : 20
string
security_group_ids
optional
Security Group 목록
Example : ['00b6af37-73b5-4de2-b080-c295a1a0382e']
array[string]
service_ip_address
required
Service IP 주소
Example : 192.167.0.5
string
subnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
string
tags
optional
태그 목록
Example : [{'key': 'key', 'value': 'value'}]
array[Tag]

9.2.48 - PrivateLinkServiceDetail

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
approval_type
required
PrivateLink Service 승인 타입
Example : AUTO
enum (MANUAL, AUTO)
connected_resource_id
optional
연결된 자원 ID
Example : a3e3a662a4f34442a94166df5ff9f577
any of [string, null]
connected_resource_ip_address
required
연결된 자원 IP 주소
Example : 192.167.0.10
string
connected_resource_name
required
연결된 자원명
Example : lbResourceName
string
connected_resource_type
required
연결된 자원 Type
Example : LB
enum (LB, IP)
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
설명
Example : PrivateLink Service Description
any of [string, null]
high_speed_transfer
required
고속 데이터 전송 사용
Example : False
boolean
id
required
PrivateLink Service ID
Example : e3df2e8e3b374fbb81d4e322b52ca50d
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
PrivateLink Service 명
Example : ServiceName
string
security_group_ids
optional
Security Group 목록
Example : ['00b6af37-73b5-4de2-b080-c295a1a0382e']
array[string]
service_ip_address
required
Service IP 주소
Example : 192.167.0.5
string
service_ip_port_id
optional
Service IP Port ID
Example : d21a4b81-f52a-43a8-b985-341e763458bb
any of [string, null]
state
required
PrivateLink Service 상태
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
subnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
string
vpc_id
required
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string

9.2.49 - PrivateLinkServiceListResponse

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
page
required
page
Example : 0
integer
privatelink_services
required

array[PrivateLinkService]
size
required
size
Example : 20
integer
sort
optional
sort
Example : ['created_at:asc']
any of [array[string], null]

9.2.50 - PrivateLinkServiceSetRequest

NameDescriptionSchemaDefault
description
optional
설명
Example : PrivateLink Service Description
Maximum length : 50
string

9.2.51 - PrivateLinkServiceShowResponse

NameDescriptionSchemaDefault
privatelink_service
required

PrivateLinkServiceDetail

9.2.52 - PrivateNat

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
cidr
required
Private NAT IP 대역
Example : 192.167.0.0/24
string
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
설명
Example : PrivateNat Description
any of [string, null]
direct_connect_id
required
Direct Connect ID
Example : fe860e0af0c04dcd8182b84f907f31f4
string
direct_connect_name
optional
Direct Connect명
Example : DirectConnectName
any of [string, null]
id
required
Private NAT ID
Example : 12f56e27070248a6a240a497e43fbe18
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Private NAT 명
Example : PrivateNatName
string
state
required
Private NAT 상태
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
vpc_id
required
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
vpc_name
optional
VPC 명
Example : vpcName
any of [string, null]

9.2.53 - PrivateNatCreateRequest

NameDescriptionSchemaDefault
cidr
required
Private NAT IP 대역
Example : 192.167.0.0/24
string
description
optional
설명
Example : PrivateNat Description
Maximum length : 50
string
direct_connect_id
required
Direct Connect ID
Example : fe860e0af0c04dcd8182b84f907f31f4
string
name
required
Private NAT 명
Example : PrivateNatName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
tags
optional
태그 목록
Example : [{'key': 'key', 'value': 'value'}]
array[Tag]

9.2.54 - PrivateNatCreateRequestV1Dot2

NameDescriptionSchemaDefault
cidr
required
Private NAT IP 대역
Example : 192.167.0.0/24
string
description
optional
설명
Example : PrivateNat Description
Maximum length : 50
string
name
required
Private NAT 명
Example : PrivateNatName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
service_resource_id
required
Private NAT에 연결된 Service Resource ID
Example : 3f342bf9a557405b997c2cf48c89cbc2
string
service_type
required
Private NAT에 연결된 Service Type
Example : DIRECT_CONNECT
enum (DIRECT_CONNECT, TRANSIT_GATEWAY)
tags
optional
태그 목록
Example : [{'key': 'key', 'value': 'value'}]
array[Tag]

9.2.55 - PrivateNatIp

NameDescriptionSchemaDefault
attached_resource_id
optional
Private NAT IP 연결된 자원 ID
Example :
any of [string, null]
attached_resource_name
optional
Private NAT IP 연결된 자원명
Example :
any of [string, null]
attached_resource_type
optional
Private NAT IP 연결된 자원 타입
Example : VM
any of [enum (VM, BM, ALB, GPU_SERVER), null]
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
id
required
Private NAT IP ID
Example :
string
ip_address
required
Private NAT IP 주소
Example :
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
private_nat_id
required
Private NAT ID
Example :
string
state
required
Private NAT IP 상태
Example : RESERVED
enum (RESERVED, ATTACHED, DELETED)

9.2.56 - PrivateNatIpCreateRequest

NameDescriptionSchemaDefault
ip_address
required
Private NAT IP 주소
Example :
Minimum length : 7
Maximum length : 15
string

9.2.57 - PrivateNatIpListResponse

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
page
required
page
Example : 0
integer
private_nat_ips
required

array[PrivateNatIp]
size
required
size
Example : 20
integer
sort
optional
sort
Example : ['created_at:asc']
any of [array[string], null]

9.2.58 - PrivateNatIpShowResponse

NameDescriptionSchemaDefault
private_nat_ip
required

PrivateNatIp

9.2.59 - PrivateNatListResponse

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
page
required
page
Example : 0
integer
private_nats
required

array[PrivateNat]
size
required
size
Example : 20
integer
sort
optional
sort
Example : ['created_at:asc']
any of [array[string], null]

9.2.60 - PrivateNatListResponseV1Dot2

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
page
required
page
Example : 0
integer
private_nats
required

array[PrivateNatV1Dot2]
size
required
size
Example : 20
integer
sort
optional
sort
Example : ['created_at:asc']
any of [array[string], null]

9.2.61 - PrivateNatSetRequest

NameDescriptionSchemaDefault
description
optional
설명
Example : PrivateNat Description
Maximum length : 50
string

9.2.62 - PrivateNatShowResponse

NameDescriptionSchemaDefault
private_nat
required

PrivateNat

9.2.63 - PrivateNatShowResponseV1Dot2

NameDescriptionSchemaDefault
private_nat
required

PrivateNatV1Dot2

9.2.64 - PrivateNatV1Dot2

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
cidr
required
Private NAT IP 대역
Example : 192.167.0.0/24
string
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
설명
Example : PrivateNat Description
any of [string, null]
id
required
Private NAT ID
Example : 12f56e27070248a6a240a497e43fbe18
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Private NAT 명
Example : PrivateNatName
string
service_resource_id
required
Private NAT에 연결된 Service Resource ID
Example : 3f342bf9a557405b997c2cf48c89cbc2
string
service_resource_name
required
Private NAT에 연결된 Service Resource 이름
Example : PrivateNatName
string
service_type
required
Private NAT에 연결된 Service Type
Example : DIRECT_CONNECT
enum (DIRECT_CONNECT, TRANSIT_GATEWAY)
state
required
Private NAT 상태
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)

9.2.65 - Publicip

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
attached_resource_id
optional
PublicIP 연결된 자원 ID
Example : 37e6db41f5124184a43251a63124cdc9
any of [string, null]
attached_resource_name
optional
PublicIP 연결된 자원명
Example : Attached NAT Gateway Name
any of [string, null]
attached_resource_type
optional
PublicIP 연결된 자원 타입
Example : NAT_GW
any of [enum (VM, ALB, LB, BM, DB, NAT_GW, GPU_NODE, VPN, GPU_SERVER, EPAS, POSTGRESQL, MARIADB, SQLSERVER, CACHESTORE, SCALABLEDB, EVENTSTREAMS, SEARCHENGINE, VERTICA, SUBNET, MYSQL), null]
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
PublicIP 상세 설명
Example : Public IP Description
any of [string, null]
id
required
PublicIP ID
Example : 12f56e27070248a6a240a497e43fbe18
string
ip_address
required
IP 주소
Example : 192.167.0.5
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
state
required
PublicIP 상태
Example : ATTACHED
enum (RESERVED, ATTACHED, DELETED)
type
required
PublicIP 타입
Example : IGW
enum (IGW, GGW, SIGW)

9.2.66 - PublicipCreateRequest

NameDescriptionSchemaDefault
description
optional
PublicIP 상세 설명
Example : Public IP Description
any of [string, null]
tags
optional
태그 목록
Example : [{'key': 'key', 'value': 'value'}]
array[Tag]
type
required
PublicIP 타입
Example : IGW
enum (IGW, GGW, SIGW)

9.2.67 - PublicipCreateRequestV1Dot3

NameDescriptionSchemaDefault
description
optional
PublicIP 상세 설명
Example : Public IP Description
any of [string, null]
tags
optional
태그 목록
Example : [{'key': 'key', 'value': 'value'}]
array[Tag]
type
required
PublicIP 타입
Example : IGW
enum (IGW, GGW, SIGW)
zone
required
Zone
Example : kr-west1-a
string

9.2.68 - PublicipListResponse

NameDescriptionSchemaDefault
count
optional
전체 개수
Example : 20
any of [integer, null]
links
optional
links
Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]
any of [array[object], null]
publicips
required

array[Publicip]

9.2.69 - PublicipListResponseV1Dot2

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
page
required
page
Example : 0
integer
publicips
required

array[Publicip]
size
required
size
Example : 20
integer
sort
optional
sort
Example : ['created_at:asc']
any of [array[string], null]

9.2.70 - PublicipListResponseV1Dot3

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
page
required
page
Example : 0
integer
publicips
required

array[PublicipV1Dot3]
size
required
size
Example : 20
integer
sort
optional
sort
Example : ['created_at:asc']
any of [array[string], null]

9.2.71 - PublicipSetRequest

NameDescriptionSchemaDefault
description
required
PublicIP 상세 설명
Example : Public IP Description
Maximum length : 50
string

9.2.72 - PublicipSetResponse

NameDescriptionSchemaDefault
description
optional
PublicIP 상세 설명
Example : Public IP Description
any of [string, null]

9.2.73 - PublicipShowResponse

NameDescriptionSchemaDefault
publicip
required

Publicip

9.2.74 - PublicipShowResponseV1Dot3

NameDescriptionSchemaDefault
publicip
required

PublicipV1Dot3

9.2.75 - PublicipV1Dot3

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
attached_resource_id
optional
PublicIP 연결된 자원 ID
Example : 37e6db41f5124184a43251a63124cdc9
any of [string, null]
attached_resource_name
optional
PublicIP 연결된 자원명
Example : Attached NAT Gateway Name
any of [string, null]
attached_resource_type
optional
PublicIP 연결된 자원 타입
Example : NAT_GW
any of [enum (VM, ALB, LB, BM, DB, NAT_GW, GPU_NODE, VPN, GPU_SERVER, EPAS, POSTGRESQL, MARIADB, SQLSERVER, CACHESTORE, SCALABLEDB, EVENTSTREAMS, SEARCHENGINE, VERTICA, SUBNET, MYSQL), null]
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
PublicIP 상세 설명
Example : Public IP Description
any of [string, null]
id
required
PublicIP ID
Example : 12f56e27070248a6a240a497e43fbe18
string
ip_address
required
IP 주소
Example : 192.167.0.5
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
state
required
PublicIP 상태
Example : ATTACHED
enum (RESERVED, ATTACHED, DELETED)
type
required
PublicIP 타입
Example : IGW
enum (IGW, GGW, SIGW)
zone
required
Zone
Example : kr-west1-a
string

9.2.76 - SapSecondarySubnet

NameDescriptionSchemaDefault
account_id
required
Account ID
Example :
string
cidr
required
CIDR
Example :
string
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
id
required
ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
state
required
Secondary Subnet State
Example : ACTIVE
enum (ACTIVE, DELETED)
subnet_id
required
Primary Subnet Id
Example :
string
vlan_no_id
required
VLAN ID of Primary Subnet
Example :
string
vpc_id
required
VPC ID
Example :
string

9.2.77 - SapSecondarySubnetListResponse

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
page
required
page
Example : 0
integer
secondary_subnets
required

array[SapSecondarySubnet]
size
required
size
Example : 20
integer
sort
optional
sort
Example : ['created_at:asc']
any of [array[string], null]

9.2.78 - StaticNatSummary

NameDescriptionSchemaDefault
external_ip_address
required
Static Nat 외부 IP 주소
Example : 100.112.9.84
string
id
required
Static Nat Id
Example : 0009e49548154745948e9722adefbf40
string
publicip_id
required
Publicip ID
Example : 12f56e27070248a6a240a497e43fbe18
string
state
required
Static Nat 상태
Example : ACTIVE
string

9.2.79 - Subnet

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
cidr
required
Subnet Cidr
Example : 192.167.1.0/24
string
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
gateway_ip_address
required
Gateway IP 주소
Example : 192.167.1.1
any of [string, null]
id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Subnet 명
Example : subnetName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
state
required
상태
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
type
required
Subnet 유형
Example : GENERAL
enum (GENERAL, LOCAL, VPC_ENDPOINT)
vpc_id
required
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
vpc_name
required
VPC 명
Example : vpcName
string

9.2.80 - SubnetCreateRequest

NameDescriptionSchemaDefault
allocation_pools
optional
IP 할당 범위
Example : [{"start":"192.167.1.2", "end":"192.167.1.100"}]
array[object]
cidr
required
Subnet Cidr
Example : 192.167.1.0/24
string
description
optional
설명
Example : Subnet Description
any of [string, null]
dns_nameservers
optional
DNS Name Server
Example : ["1.1.1.1", "2.2.2.2"]
array[string]
host_routes
optional
호스트 경로
Example : [{"destination":"192.168.10.0/24", "nexthop":"192.168.10.0"}]
array[object]
name
required
Subnet 명
Example : subnetName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
tags
optional
태그 목록
array[Tag]
type
required
Subnet 유형
Example : GENERAL
enum (GENERAL, LOCAL, VPC_ENDPOINT)
vpc_id
required
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string

9.2.81 - SubnetCreateRequestV1Dot2

NameDescriptionSchemaDefault
allocation_pools
optional
IP 할당 범위
Example : [{"start":"192.167.1.2", "end":"192.167.1.100"}]
array[object]
cidr
required
Subnet Cidr
Example : 192.167.1.0/24
string
description
optional
설명
Example : Subnet Description
any of [string, null]
dns_nameservers
optional
DNS Name Server
Example : ["1.1.1.1", "2.2.2.2"]
array[string]
gateway_ip_address
optional
Gateway IP 주소
Example : 192.167.1.1
any of [string, null]
host_routes
optional
호스트 경로
Example : [{"destination":"192.168.10.0/24", "nexthop":"192.168.10.0"}]
array[object]
name
required
Subnet 명
Example : subnetName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
tags
optional
태그 목록
array[Tag]
type
required
Subnet 유형
Example : GENERAL
enum (GENERAL, LOCAL, VPC_ENDPOINT)
vpc_id
required
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string

9.2.82 - SubnetCreateRequestV1Dot3

NameDescriptionSchemaDefault
allocation_pools
optional
IP 할당 범위
Example : [{"start":"192.167.1.2", "end":"192.167.1.100"}]
array[object]
category
required
Subnet 구분
Example : PRIMARY
enum (PRIMARY, SECONDARY)
cidr
required
Subnet Cidr
Example : 192.167.1.0/24
string
description
optional
설명
Example : Subnet Description
any of [string, null]
dns_nameservers
optional
DNS Name Server
Example : ["1.1.1.1", "2.2.2.2"]
array[string]
gateway_ip_address
optional
Gateway IP 주소
Example : 192.167.1.1
any of [string, null]
host_routes
optional
호스트 경로
Example : [{"destination":"192.168.10.0/24", "nexthop":"192.168.10.0"}]
array[object]
name
required
Subnet 명
Example : subnetName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
primary_subnet_id
optional
Primary Subnet ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]
tags
optional
태그 목록
array[Tag]
type
required
Subnet 유형
Example : PUBLIC
enum (PUBLIC, PRIVATE, LOCAL, VPC_ENDPOINT)
vpc_id
required
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string

9.2.83 - SubnetDetail

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
allocation_pools
optional
IP 할당 범위
array[object]
cidr
required
Subnet Cidr
Example : 192.167.1.0/24
string
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
설명
Example : Subnet Description
any of [string, null]
dns_nameservers
optional
DNS Name Server
array[string]
gateway_ip_address
required
Gateway IP 주소
Example : 192.167.1.1
any of [string, null]
host_routes
optional
호스트 경로
array[object]
id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Subnet 명
Example : subnetName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
state
required
상태
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
type
required
Subnet 유형
Example : GENERAL
enum (GENERAL, LOCAL, VPC_ENDPOINT)
vpc_id
required
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
vpc_name
required
VPC 명
Example : vpcName
string

9.2.84 - SubnetDetailV1Dot2

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
allocation_pools
optional
IP 할당 범위
array[object]
cidr
required
Subnet Cidr
Example : 192.167.1.0/24
string
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
설명
Example : Subnet Description
any of [string, null]
dhcp_ip_address
optional
DHCP IP 주소
Example :
any of [string, null]
dns_nameservers
optional
DNS Name Server
array[string]
gateway_ip_address
required
Gateway IP 주소
Example : 192.167.1.1
any of [string, null]
host_routes
optional
호스트 경로
array[object]
id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Subnet 명
Example : subnetName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
state
required
상태
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
type
required
Subnet 유형
Example : GENERAL
enum (GENERAL, LOCAL, VPC_ENDPOINT)
vpc_id
required
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
vpc_name
required
VPC 명
Example : vpcName
string

9.2.85 - SubnetDetailV1Dot3

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
allocation_pools
optional
IP 할당 범위
array[object]
category
required
Subnet 구분
Example : PRIMARY
string
cidr
required
Subnet Cidr
Example : 192.167.1.0/24
string
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
설명
Example : Subnet Description
any of [string, null]
dhcp_ip_address
optional
DHCP IP 주소
Example :
any of [string, null]
dns_nameservers
optional
DNS Name Server
array[string]
gateway_ip_address
required
Gateway IP 주소
Example : 192.167.1.1
any of [string, null]
host_routes
optional
호스트 경로
array[object]
id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Subnet 명
Example : subnetName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
primary_subnet_id
optional
Primary Subnet ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]
secondary_subnet_ids
optional
Secondary Subnet ID 목록
Example : ["522e102f680448a8804d18d4838baa78", "aec40baf53c243c1bb8401a703a2c888"]
any of [array[object], null]
state
required
상태
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
type
required
Subnet 유형
Example : PUBLIC
enum (PUBLIC, PRIVATE, LOCAL, VPC_ENDPOINT)
vpc_id
required
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
vpc_name
required
VPC 명
Example : vpcName
string
zones
optional
Subnet Zone 목록
Example : ["kr-west1-a", "kr-west1-b", "kr-west1-c"]
array[string]

9.2.86 - SubnetListResponse

NameDescriptionSchemaDefault
count
optional
전체 개수
Example : 20
any of [integer, null]
links
optional
links
Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]
any of [array[object], null]
subnets
required

array[Subnet]

9.2.87 - SubnetListResponseV1Dot2

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

array[Subnet]

9.2.88 - SubnetListResponseV1Dot3

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

array[SubnetV1Dot3]

9.2.89 - SubnetSetRequest

NameDescriptionSchemaDefault
description
required
설명
Example : Subnet Description
Maximum length : 50
string

9.2.90 - SubnetSetRequestV1Dot2

NameDescriptionSchemaDefault
description
optional
설명
Example : Subnet Description
any of [string, null]
dhcp_ip_address
optional
DHCP IP 주소
Example : 192.167.1.2
any of [string, null]

9.2.91 - SubnetSetResponse

NameDescriptionSchemaDefault
description
optional
설명
Example : Subnet Description
any of [string, null]
dhcp_ip_address
optional
DHCP IP 주소
Example : 192.167.1.2
any of [string, null]

9.2.92 - SubnetShowResponse

NameDescriptionSchemaDefault
subnet
required

SubnetDetail

9.2.93 - SubnetShowResponseV1Dot2

NameDescriptionSchemaDefault
subnet
required

SubnetDetailV1Dot2

9.2.94 - SubnetShowResponseV1Dot3

NameDescriptionSchemaDefault
subnet
required

SubnetDetailV1Dot3

9.2.95 - SubnetV1Dot3

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
category
required
Subnet 구분
Example : PRIMARY
string
cidr
required
Subnet Cidr
Example : 192.167.1.0/24
string
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
gateway_ip_address
required
Gateway IP 주소
Example : 192.167.1.1
any of [string, null]
id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Subnet 명
Example : subnetName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
primary_subnet_id
optional
Primary Subnet ID
Example : 023c57b14f11483689338d085e061492
any of [string, null]
state
required
상태
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
type
required
Subnet 유형
Example : PUBLIC
enum (PUBLIC, PRIVATE, LOCAL, VPC_ENDPOINT)
vpc_id
required
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
vpc_name
required
VPC 명
Example : vpcName
string
zones
optional
Subnet Zone 목록
Example : ["kr-west1-a", "kr-west1-b", "kr-west1-c"]
array[string]

9.2.96 - SubnetVipDetail

NameDescriptionSchemaDefault
connected_ports
required

array[ConnectedPortInfo]
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
설명
Example : Subnet VIP Description
any of [string, null]
id
required
Subnet Vip Id
Example : 0466a9448d9a4411a86055939e451c8f
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
state
required
상태
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
static_nat
optional
Static NAT 정보
any of [StaticNatSummary, null]
subnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
string
vip_port_id
required
Vip Port Id
Example : 35268a9f2eda4cde83b1d85c1f61f67d
string
virtual_ip_address
required
Virtual IP 주소
Example : 192.168.20.6
string

9.2.97 - SubnetVipSummary

NameDescriptionSchemaDefault
connected_port_count
optional
연결 Port 수
Example : 2
integer
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
id
required
Subnet Vip Id
Example : 0466a9448d9a4411a86055939e451c8f
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
state
required
상태
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
static_nat
optional
Static NAT 정보
any of [StaticNatSummary, null]
virtual_ip_address
required
Virtual IP 주소
Example : 192.168.20.6
string

9.2.98 - Tag

NameDescriptionSchemaDefault
key
required
tag key
Example :
string
value
required
tag value
Example :
string

9.2.99 - TransitGateway

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
bandwidth
optional
Transit Gateway 포트 용량
Example : 1
any of [integer, null]
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
Transit Gateway 상세 설명
Example : TransitGateway Description
any of [string, null]
firewall_ids
optional
Firewall IDs
Example : bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6
any of [string, null]
id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Transit Gateway 명
Example : TransitGatewayName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
state
required
상태
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING)
uplink_enabled
optional
Uplink 사용
Example : False
boolean

9.2.100 - TransitGatewayCreateRequest

NameDescriptionSchemaDefault
description
optional
설명
Example : TransitGateway Description
any of [string, null]
name
required
Transit Gateway 명
Example : TransitGatewayName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
tags
optional
태그 목록
Example : [{'key': 'key', 'value': 'value'}]
array[Tag]

9.2.101 - TransitGatewayFirewallConnectionCreateResponse

NameDescriptionSchemaDefault
firewall_connection_state
optional
Transit 연결 상태
Example : INACTIVE
any of [enum (ATTACHING, ACTIVE, DETACHING, DELETED, INACTIVE, ERROR), null]

9.2.102 - TransitGatewayFirewallCreateRequest

NameDescriptionSchemaDefault
product_type
required
Firewall Product Type
Example : TGW_DGW
enum (TGW_IGW, TGW_GGW, TGW_DGW, TGW_BM)

9.2.103 - TransitGatewayFirewallCreateRequestV1Dot3

NameDescriptionSchemaDefault
product_type
required
Firewall Product Type
Example : TGW_DGW
enum (TGW_IGW, TGW_GGW, TGW_DGW, TGW_BM)
uplink_active_zone
optional
Uplink Active Zone
Example : kr-west1-a
any of [string, null]
uplink_standby_zone
optional
Uplink Standby Zone
Example : kr-west1-b
any of [string, null]

9.2.104 - TransitGatewayFirewallCreateResponseV1Dot3

NameDescriptionSchemaDefault
state
optional
상태
Example : ACTIVE
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING), null]
uplink_active_zone
optional
Uplink Active Zone
Example : kr-west1-a
any of [string, null]
uplink_standby_zone
optional
Uplink Standby Zone
Example : kr-west1-b
any of [string, null]
uplink_zone_state
optional
Uplink Zone 연결 상태
Example : ACTIVE
any of [enum (ATTACHING, ACTIVE, DETACHING, DELETED, INACTIVE, ERROR, EDITING), null]

9.2.105 - TransitGatewayFirewallDeleteResponse

NameDescriptionSchemaDefault
state
optional
상태
Example : ACTIVE
any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING), null]
uplink_active_zone
optional
Uplink Active Zone
Example : kr-west1-a
any of [string, null]
uplink_standby_zone
optional
Uplink Standby Zone
Example : kr-west1-b
any of [string, null]
uplink_zone_state
optional
Uplink Zone 연결 상태
Example : ACTIVE
any of [enum (ATTACHING, ACTIVE, DETACHING, DELETED, INACTIVE, ERROR, EDITING), null]

9.2.106 - TransitGatewayListResponse

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

array[TransitGateway]

9.2.107 - TransitGatewayListResponseV1Dot2

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

array[TransitGatewayV1Dot2]

9.2.108 - TransitGatewayRule

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
required
설명
Example : Routing Rule Description
string
destination_cidr
required
목적지 CIDR
Example : 192.167.5.0/24
string
destination_resource_id
required
목적지 자원 ID
Example : ceb44ea5ecb34a49b16495f9a63b0718
any of [string, null]
destination_resource_name
optional
목적지 자원명
Example : VpcName
any of [string, null]
destination_type
required
목적지 타입
Example : VPC
enum (VPC, TGW, ON_PREMISE)
id
required
Routing Rule ID
Example : 43772aff4539403d9ba74bf1fdaa00c8
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
source_resource_id
required
출발지 자원 ID
Example : 8582cc5d89994a42ad53282fd4a8d8be
any of [string, null]
source_resource_name
optional
출발지 자원명
Example : TgwName
any of [string, null]
source_type
required
출발지 타입
Example : TGW
enum (VPC, TGW, ON_PREMISE)
state
required
상태
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
tgw_connection_vpc_id
required
Transit Gateway에 연결된 VPC ID.
Example : ffeced8e191c478eabd66b6e2cab8e34
any of [string, null]
tgw_connection_vpc_name
optional
Transit Gateway에 연결된 VPC명.
Example : ConnectedVpcName
any of [string, null]

9.2.109 - TransitGatewayRuleCreateRequest

NameDescriptionSchemaDefault
description
optional
설명
Example : Routing Rule Description
Maximum length : 50
string
destination_cidr
required
목적지 CIDR
Example : 192.167.5.0/24
string
destination_type
required
목적지 타입
Example : VPC
enum (VPC, TGW)
tgw_connection_vpc_id
required
Transit Gateway에 연결된 VPC ID.
Example : ffeced8e191c478eabd66b6e2cab8e34
string

9.2.110 - TransitGatewayRuleListResponse

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

array[TransitGatewayRule]

9.2.111 - TransitGatewayRuleListResponseV1Dot2

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

array[TransitGatewayRuleV1Dot2]

9.2.112 - TransitGatewayRuleShowResponse

NameDescriptionSchemaDefault
transit_gateway_rule
required

TransitGatewayVpcRule

9.2.113 - TransitGatewayRuleV1Dot2

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
required
설명
Example : Routing Rule Description
string
destination_cidr
required
목적지 CIDR
Example : 192.167.5.0/24
string
destination_resource_id
required
목적지 자원 ID
Example : ceb44ea5ecb34a49b16495f9a63b0718
any of [string, null]
destination_resource_name
optional
목적지 자원명
Example : VpcName
any of [string, null]
destination_type
required
목적지 타입
Example : VPC
enum (VPC, TGW, ON_PREMISE)
id
required
Routing Rule ID
Example : 43772aff4539403d9ba74bf1fdaa00c8
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
rule_type
required
규칙 타입
Example : TGW_VPC
enum (TGW_VPC, TGW_UPLINK)
source_resource_id
required
출발지 자원 ID
Example : 8582cc5d89994a42ad53282fd4a8d8be
any of [string, null]
source_resource_name
optional
출발지 자원명
Example : TgwName
any of [string, null]
source_type
required
출발지 타입
Example : TGW
enum (VPC, TGW, ON_PREMISE)
state
required
상태
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
tgw_connection_vpc_id
required
Transit Gateway에 연결된 VPC ID.
Example : ffeced8e191c478eabd66b6e2cab8e34
any of [string, null]
tgw_connection_vpc_name
optional
Transit Gateway에 연결된 VPC명.
Example : ConnectedVpcName
any of [string, null]

9.2.114 - TransitGatewaySetRequest

NameDescriptionSchemaDefault
description
optional
설명
Example : TransitGateway Description
Maximum length : 50
string

9.2.115 - TransitGatewaySetResponse

NameDescriptionSchemaDefault
description
optional
설명
Example : TransitGateway Description
any of [string, null]

9.2.116 - TransitGatewayShowResponse

NameDescriptionSchemaDefault
transit_gateway
required

TransitGateway

9.2.117 - TransitGatewayShowResponseV1Dot2

NameDescriptionSchemaDefault
transit_gateway
required

TransitGatewayV1Dot2

9.2.118 - TransitGatewayShowResponseV1Dot3

NameDescriptionSchemaDefault
transit_gateway
required

TransitGatewayV1Dot3

9.2.119 - TransitGatewayUplinkRule

NameDescriptionSchemaDefault
description
required
설명
Example : Routing Rule Description
string
destination_cidr
required
목적지 CIDR
Example : 192.167.5.0/24
string
destination_type
required
목적지 타입
Example : ON_PREMISE
enum (TGW, ON_PREMISE)
id
required
Routing Rule ID
Example : 43772aff4539403d9ba74bf1fdaa00c8
string
state
required
상태
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)

9.2.120 - TransitGatewayUplinkRuleCreateRequest

NameDescriptionSchemaDefault
description
optional
설명
Example : Routing Rule Description
Maximum length : 50
string
destination_cidr
required
목적지 CIDR
Example : 192.167.5.0/24
string
destination_type
required
목적지 타입
Example : ON_PREMISE
enum (TGW, ON_PREMISE)

9.2.121 - TransitGatewayUplinkRuleCreateResponse

NameDescriptionSchemaDefault
transit_gateway_rule
required

TransitGatewayUplinkRule

9.2.122 - TransitGatewayV1Dot2

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
bandwidth
optional
Transit Gateway 포트 용량
Example : 1
any of [integer, null]
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
Transit Gateway 상세 설명
Example : TransitGateway Description
any of [string, null]
firewall_connection_state
optional
Transit 연결 상태
Example : INACTIVE
any of [enum (ATTACHING, ACTIVE, DETACHING, DELETED, INACTIVE, ERROR), null]
firewall_ids
optional
Firewall IDs
Example : bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6
any of [string, null]
id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Transit Gateway 명
Example : TransitGatewayName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
state
required
상태
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING)
uplink_enabled
optional
Uplink 사용
Example : False
boolean

9.2.123 - TransitGatewayV1Dot3

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
bandwidth
optional
Transit Gateway 포트 용량
Example : 1
any of [integer, null]
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
Transit Gateway 상세 설명
Example : TransitGateway Description
any of [string, null]
firewall_connection_state
optional
Transit 연결 상태
Example : INACTIVE
any of [enum (ATTACHING, ACTIVE, DETACHING, DELETED, INACTIVE, ERROR), null]
firewall_ids
optional
Firewall IDs
Example : bbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6
any of [string, null]
id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Transit Gateway 명
Example : TransitGatewayName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
state
required
상태
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING)
uplink_active_zone
optional
Uplink Active Zone
Example : kr-west1-a
any of [string, null]
uplink_enabled
optional
Uplink 사용
Example : False
boolean
uplink_standby_zone
optional
Uplink Standby Zone
Example : kr-west1-b
any of [string, null]
uplink_zone_state
optional
Uplink Zone 연결 상태
Example : ACTIVE
any of [enum (ATTACHING, ACTIVE, DETACHING, DELETED, INACTIVE, ERROR, EDITING), null]

9.2.124 - TransitGatewayVpcConnection

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
id
required
Transit Gateway VPC 연결 ID
Example : ffeced8e191c478eabd66b6e2cab8e34
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
state
required
상태
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
transit_gateway_id
required
Transit Gateway ID
Example : fe860e0af0c04dcd8182b84f907f31f4
string
vpc_id
required
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
vpc_name
required
VPC 명
Example : vpcName
string

9.2.125 - TransitGatewayVpcConnectionCreateRequest

NameDescriptionSchemaDefault
vpc_id
required
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string

9.2.126 - TransitGatewayVpcConnectionListResponse

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

array[TransitGatewayVpcConnection]

9.2.127 - TransitGatewayVpcConnectionShowResponse

NameDescriptionSchemaDefault
transit_gateway_vpc_connection
required

TransitGatewayVpcConnection

9.2.128 - TransitGatewayVpcRule

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
description
required
설명
Example : Routing Rule Description
string
destination_cidr
required
목적지 CIDR
Example : 192.167.5.0/24
string
destination_resource_id
required
목적지 자원 ID
Example : ceb44ea5ecb34a49b16495f9a63b0718
any of [string, null]
destination_resource_name
optional
목적지 자원명
Example : VpcName
any of [string, null]
destination_type
required
목적지 타입
Example : VPC
enum (VPC, TGW)
id
required
Routing Rule ID
Example : 43772aff4539403d9ba74bf1fdaa00c8
string
source_resource_id
required
출발지 자원 ID
Example : 8582cc5d89994a42ad53282fd4a8d8be
any of [string, null]
source_resource_name
optional
출발지 자원명
Example : TgwName
any of [string, null]
source_type
required
출발지 타입
Example : TGW
enum (VPC, TGW)
state
required
상태
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
tgw_connection_vpc_id
required
Transit Gateway에 연결된 VPC ID.
Example : ffeced8e191c478eabd66b6e2cab8e34
any of [string, null]
tgw_connection_vpc_name
optional
Transit Gateway에 연결된 VPC명.
Example : ConnectedVpcName
any of [string, null]

9.2.129 - VipCreateRequest

NameDescriptionSchemaDefault
description
optional
설명
Example : Subnet VIP Description
any of [string, null]
virtual_ip_address
optional
Virtual IP 주소
Example : 192.168.20.6
any of [string, null]

9.2.130 - VipCreateResponse

NameDescriptionSchemaDefault
subnet_vip
required

SubnetVipDetail

9.2.131 - VipListResponse

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

array[SubnetVipSummary]

9.2.132 - VipNatCreateRequest

NameDescriptionSchemaDefault
nat_type
required
Nat 타입
Example : PUBLIC
string
publicip_id
required
Publicip ID
Example : 12f56e27070248a6a240a497e43fbe18
string

9.2.133 - VipNatCreateResponse

NameDescriptionSchemaDefault
id
required
Static Nat Id
Example : 0009e49548154745948e9722adefbf40
string
publicip_id
required
Publicip ID
Example : 12f56e27070248a6a240a497e43fbe18
string
state
required
Static Nat 상태
Example : ACTIVE
string

9.2.134 - VipPortRequest

NameDescriptionSchemaDefault
port_id
required
Port ID
Example : 35268a9f2eda4cde83b1d85c1f61f67d
string

9.2.135 - VipPortResponse

NameDescriptionSchemaDefault
id
required
연결 Port Id
Example : 35268a9f2eda4cde83b1d85c1f61f67d
string
subnet_vip_id
required
Subnet Vip Id
Example : 0466a9448d9a4411a86055939e451c8f
string

9.2.136 - VipSetRequest

NameDescriptionSchemaDefault
description
required
설명
Example : Subnet VIP Description
Maximum length : 50
string

9.2.137 - VipShowResponse

NameDescriptionSchemaDefault
subnet_vip
required

SubnetVipDetail

9.2.138 - Vpc

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
cidr
required
VPC Cidr
Example : 192.167.0.0/18
string
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
설명
Example : vpcDescription
any of [string, null]
id
required
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
VPC 명
Example : vpcName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
state
required
상태
Example : CREATING
enum (CREATING, ACTIVE, DELETED, ERROR)

9.2.139 - VpcCidr

NameDescriptionSchemaDefault
cidr
required
VPC Cidr
Example : 192.167.0.0/18
string
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 7df8abb4912e4709b1cb237daccca7a8
string
id
required
CIDR ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string

9.2.140 - VpcCidrCreateRequest

NameDescriptionSchemaDefault
cidr
required
VPC Cidr
Example : 192.167.0.0/18
string

9.2.141 - VpcCidrCreateResponse

NameDescriptionSchemaDefault
cidr
optional
VPC Cidr
Example : 192.167.0.0/18
any of [string, null]

9.2.142 - VpcCreateRequest

NameDescriptionSchemaDefault
cidr
required
VPC Cidr
Example : 192.167.0.0/18
string
description
optional
설명
Example : VPC Description
any of [string, null]
name
required
VPC 명
Example : vpcName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
tags
optional
태그 목록
array[Tag]

9.2.143 - VpcEndpoint

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
설명
Example : VpcEndpoint Description
any of [string, null]
endpoint_ip_address
required
VPC Endpoint IP 주소
Example : 192.167.0.5
string
id
required
VPC Endpoint ID
Example : 12f56e27070248a6a240a497e43fbe18
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
VPC Endpoint 명
Example : VpcEndpointName
string
resource_info
required
VPC Endpoint Resource Key 정보
Example : x.samsungsdscloud.com(Registry)
string
resource_key
required
VPC Endpoint Resource Key
Example : 07c5364702384471b650147321b52173
string
resource_type
required
VPC Endpoint 자원 타입
Example : FS
enum (FS, OBS, SCR, DNS)
state
required
VPC Endpoint 상태
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
subnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
string
subnet_name
required
Subnet 명
Example : subnetName
string
vpc_id
required
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
vpc_name
required
VPC 명
Example : vpcName
string

9.2.144 - VpcEndpointConnectableResourceDetail

NameDescriptionSchemaDefault
resource_info
required
VPC Endpoint Resource Key 정보
Example : x.samsungsdscloud.com(Registry)
string
resource_key
required
VPC Endpoint Resource Key
Example : 07c5364702384471b650147321b52173
string
resource_type
required
VPC Endpoint 자원 타입
Example : FS
enum (FS, OBS, SCR, DNS)

9.2.145 - VpcEndpointConnectableResourceListResponse

NameDescriptionSchemaDefault
count
optional
전체 개수
Example : 20
any of [integer, null]
links
optional
links
Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]
any of [array[object], null]
vpc_endpoint_connectable_resources
required

array[VpcEndpointConnectableResourceDetail]

9.2.146 - VpcEndpointConnectableResourceListResponseV1Dot2

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

array[VpcEndpointConnectableResourceDetail]

9.2.147 - VpcEndpointCreateRequest

NameDescriptionSchemaDefault
description
optional
설명
Example : VpcEndpoint Description
Maximum length : 50
string
endpoint_ip_address
required
VPC Endpoint IP 주소
Example : 192.167.0.5
string
name
required
VPC Endpoint 명
Example : VpcEndpointName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
resource_info
required
VPC Endpoint Resource Key 정보
Example : x.samsungsdscloud.com(Registry)
Maximum length : 200
string
resource_key
required
VPC Endpoint Resource Key
Example : 07c5364702384471b650147321b52173
string
resource_type
required
VPC Endpoint 자원 타입
Example : FS
enum (FS, OBS, SCR, DNS)
subnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
string
tags
optional
태그 목록
Example : [{'key': 'key', 'value': 'value'}]
array[Tag]
vpc_id
required
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string

9.2.148 - VpcEndpointListResponse

NameDescriptionSchemaDefault
count
optional
전체 개수
Example : 20
any of [integer, null]
links
optional
links
Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]
any of [array[object], null]
vpc_endpoints
required

array[VpcEndpoint]

9.2.149 - VpcEndpointListResponseV1Dot2

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

array[VpcEndpoint]

9.2.150 - VpcEndpointSetRequest

NameDescriptionSchemaDefault
description
optional
설명
Example : VpcEndpoint Description
Maximum length : 50
string

9.2.151 - VpcEndpointShowResponse

NameDescriptionSchemaDefault
vpc_endpoint
required

VpcEndpoint

9.2.152 - VpcListResponse

NameDescriptionSchemaDefault
count
optional
전체 개수
Example : 20
any of [integer, null]
links
optional
links
Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]
any of [array[object], null]
vpcs
required

array[Vpc]

9.2.153 - VpcListResponseV1Dot2

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

array[VpcV1Dot2]

9.2.154 - VpcListResponseV1Dot3

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

array[VpcV1Dot3]

9.2.155 - VpcPeering

NameDescriptionSchemaDefault
account_type
required
과제 유형
Example : SAME
enum (SAME, DIFFERENT)
approver_vpc_account_id
required
승인 VPC 과제 ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
approver_vpc_id
required
승인 VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
approver_vpc_name
required
승인 VPC 명
Example : vpcName
string
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
delete_requester_account_id
optional
요청 VPC 과제 ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
any of [string, null]
description
optional
VPC Peering 상세설명
Example : vpcPeering Description
any of [string, null]
id
required
VPC Peering ID
Example : 023c57b14f11483689338d085e061492
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
VPC Peering 명
Example : vpcPeeringName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
requester_vpc_account_id
required
요청 VPC 과제 ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
requester_vpc_id
required
요청 VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
requester_vpc_name
required
요청 VPC 명
Example : vpcName
string
state
required
상태
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING, CREATING_REQUESTING, REJECTED, CANCELED, DELETING_REQUESTING)

9.2.156 - VpcPeeringApprovalRequest

NameDescriptionSchemaDefault
type
required
승인 유형
Example : CREATE_APPROVE
enum (CREATE_APPROVE, CREATE_CANCEL, CREATE_REJECT, CREATE_RE_REQUEST, DELETE_APPROVE, DELETE_CANCEL, DELETE_REJECT)

9.2.157 - VpcPeeringCreateRequest

NameDescriptionSchemaDefault
approver_vpc_account_id
required
승인 VPC 과제 ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
approver_vpc_id
required
승인 VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
description
optional
설명
Example : vpcPeering Description
any of [string, null]
name
required
VPC Peering 명
Example : vpcPeeringName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
requester_vpc_id
required
요청 VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
tags
optional
태그 목록
array[Tag]

9.2.158 - VpcPeeringListResponse

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

array[VpcPeering]

9.2.159 - VpcPeeringRule

NameDescriptionSchemaDefault
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
destination_cidr
required
목적지 CIDR
Example :
string
destination_vpc_id
required
목적지 VPC ID
Example :
string
destination_vpc_name
required
목적지 VPC 명
Example :
string
destination_vpc_type
required
목적지 VPC 유형
Example : REQUESTER_VPC
enum (REQUESTER_VPC, APPROVER_VPC)
id
required
VPC Peering 규칙 ID
Example :
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
source_vpc_id
required
출발지 VPC ID
Example :
string
source_vpc_name
required
출발지 VPC 명
Example :
string
source_vpc_type
required
출발지 VPC 유형
Example : REQUESTER_VPC
enum (REQUESTER_VPC, APPROVER_VPC)
state
required
상태
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
vpc_peering_id
required
VPC Peering ID
Example :
string

9.2.160 - VpcPeeringRuleCreateRequest

NameDescriptionSchemaDefault
destination_cidr
required
목적지 CIDR
Example :
string
destination_vpc_type
required
목적지 VPC 유형
Example : REQUESTER_VPC
enum (REQUESTER_VPC, APPROVER_VPC)
tags
optional
태그 목록
array[Tag]

9.2.161 - VpcPeeringRuleListResponse

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

array[VpcPeeringRule]

9.2.162 - VpcPeeringRuleShowResponse

NameDescriptionSchemaDefault
vpc_peering_rule
required

VpcPeeringRule

9.2.163 - VpcPeeringSetRequest

NameDescriptionSchemaDefault
description
optional
설명
Example : vpcPeering Description
Maximum length : 50
string

9.2.164 - VpcPeeringShowResponse

NameDescriptionSchemaDefault
vpc_peering
required

VpcPeering

9.2.165 - VpcSetRequest

NameDescriptionSchemaDefault
description
optional
설명
Example : vpcDescription
any of [string, null]

9.2.166 - VpcSetResponse

NameDescriptionSchemaDefault
description
optional
설명
Example : vpcDescription
any of [string, null]

9.2.167 - VpcShowResponse

NameDescriptionSchemaDefault
vpc
required

Vpc

9.2.168 - VpcShowResponseV1Dot2

NameDescriptionSchemaDefault
vpc
required

VpcV1Dot2

9.2.169 - VpcShowResponseV1Dot3

NameDescriptionSchemaDefault
vpc
required

VpcV1Dot3

9.2.170 - VpcV1Dot2

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
cidr_count
required
CIDR 개수
Example : 20
integer
cidrs
required

array[VpcCidr]
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
설명
Example : vpcDescription
any of [string, null]
id
required
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
VPC 명
Example : vpcName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
state
required
상태
Example : CREATING
enum (CREATING, ACTIVE, DELETED, ERROR)

9.2.171 - VpcV1Dot3

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : f1e6c81a2b054582878cb9724dc2ce9f
string
cidr_count
required
CIDR 개수
Example : 20
integer
cidrs
required

array[VpcCidr]
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
설명
Example : vpcDescription
any of [string, null]
id
required
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
VPC 명
Example : vpcName
Pattern : ^[a-zA-Z0-9-]*$
Minimum length : 3
Maximum length : 20
string
state
required
상태
Example : CREATING
enum (CREATING, ACTIVE, DELETED, ERROR)
zone_type
optional
Vpc Zone 타입 정보
Example : PUBLIC
any of [string, null]
zones
required
Vpc Zones 정보
Example : ['zone-a', 'zone-b', 'zone-c']
array[string]

10 - VPN

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 VPN 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

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

VersionStatusNot Before
1.1CURRENT-
1.0DEPRECATED20251231

OpenAPI URL

https://vpn.{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

VPN API가 출시되었습니다.

변경사항

  • [신규] GET /v1/vpn-gateways - API가 추가되었습니다.
  • [신규] POST /v1/vpn-gateways - API가 추가되었습니다.
  • [신규] GET /v1/vpn-gateways/{vpn_gateway_id} - API가 추가되었습니다.
  • [신규] PUT /v1/vpn-gateways/{vpn_gateway_id} - API가 추가되었습니다.
  • [신규] DELETE /v1/vpn-gateways/{vpn_gateway_id} - API가 추가되었습니다.
  • [신규] GET /v1/vpn-tunnels - API가 추가되었습니다.
  • [신규] POST /v1/vpn-tunnels - API가 추가되었습니다.
  • [신규] GET /v1/vpn-tunnels/{vpn_tunnel_id} - API가 추가되었습니다.
  • [신규] PUT /v1/vpn-tunnels/{vpn_tunnel_id} - API가 추가되었습니다.
  • [신규] DELETE /v1/vpn-tunnels/{vpn_tunnel_id} - API가 추가되었습니다.

10.1 - APIs

10.1.1 - Create VPN Gateway

10.1.1.1 - 1.1

post /v1/vpn-gateways

Description

VPN gateway 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

VpnGatewayCreateRequest

Responses

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

Example HTTP request

Request path

/v1/vpn-gateways

Request header

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

Request body

{
    "description": "Example Description for VPN Gateway",
    "ip_address": "123.0.0.1",
    "ip_id": "fcde872f75c145a0893d656cc698f13e",
    "ip_type": "PUBLIC",
    "name": "ExampleVpnGW1",
    "tags": [],
    "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718"
}

Example HTTP response

Response 202

{
    "vpn_gateway": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Gateway",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "ip_address": "123.0.0.1",
        "ip_id": "fcde872f75c145a0893d656cc698f13e",
        "ip_type": "PUBLIC",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnGW1",
        "state": "ACTIVE",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1"
    }
}

10.1.1.2 - 1.0

post /v1/vpn-gateways

Description

VPN gateway 생성

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

VpnGatewayCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedVpnGatewayShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpn-gateways

Request header

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

Request body

{
    "description": "Example Description for VPN Gateway",
    "ip_address": "123.0.0.1",
    "ip_id": "fcde872f75c145a0893d656cc698f13e",
    "ip_type": "PUBLIC",
    "name": "ExampleVpnGW1",
    "tags": [],
    "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718"
}

Example HTTP response

Response 202

{
    "vpn_gateway": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Gateway",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "ip_address": "123.0.0.1",
        "ip_id": "fcde872f75c145a0893d656cc698f13e",
        "ip_type": "PUBLIC",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnGW1",
        "state": "ACTIVE",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1"
    }
}

10.1.2 - Create VPN Tunnel

10.1.2.1 - 1.1

post /v1/vpn-tunnels

Description

VPN tunnel 생성

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

VpnTunnelCreateRequestV1Dot1

Responses

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

Example HTTP request

Request path

/v1/vpn-tunnels

Request header

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

Request body

{
    "description": "Example Description for VPN Tunnel",
    "name": "ExampleVpnTunnel1",
    "phase1": {
        "dpd_retry_interval": 60,
        "ike_version": 2,
        "peer_gateway_ip": "123.0.0.2",
        "phase1_diffie_hellman_groups": [
            30,
            31,
            32
        ],
        "phase1_encryptions": [
            "des-md5",
            "chacha20poly1305-prfsha256"
        ],
        "phase1_life_time": 86400,
        "pre_shared_key": "PreSharedKey1"
    },
    "phase2": {
        "perfect_forward_secrecy": "ENABLE",
        "phase2_diffie_hellman_groups": [
            30,
            31,
            32
        ],
        "phase2_encryptions": [
            "null-md5",
            "aes128gcm",
            "chacha20poly1305"
        ],
        "phase2_life_time": 43200,
        "remote_subnets": [
            "10.1.1.0/24",
            "10.1.2.0/24",
            "10.1.3.0/24"
        ]
    },
    "tags": [],
    "vpn_gateway_id": "b156740b6335468d8354eb9ef8eddf5a"
}

Example HTTP response

Response 202

{
    "vpn_tunnel": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Tunnel",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnTunnel1",
        "phase1": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "dpd_retry_interval": 60,
            "encryptions": [
                "des-md5",
                "chacha20poly1305-prfsha256"
            ],
            "ike_version": 2,
            "life_time": 86400,
            "peer_gateway_ip": "123.0.0.2"
        },
        "phase2": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "encryptions": [
                "null-md5",
                "aes128gcm",
                "chacha20poly1305"
            ],
            "life_time": 43200,
            "perfect_forward_secrecy": "ENABLE",
            "remote_subnets": [
                "10.1.1.0/24",
                "10.1.2.0/24",
                "10.1.3.0/24"
            ]
        },
        "state": "ACTIVE",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1",
        "vpn_gateway_id": "b156740b6335468d8354eb9ef8eddf5a",
        "vpn_gateway_ip_address": "123.0.0.1",
        "vpn_gateway_name": "ExampleVpnGW1"
    }
}

10.1.2.2 - 1.0

post /v1/vpn-tunnels

Description

VPN tunnel 생성

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

VpnTunnelCreateRequest

Responses

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

Example HTTP request

Request path

/v1/vpn-tunnels

Request header

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

Request body

{
    "description": "Example Description for VPN Tunnel",
    "name": "ExampleVpnTunnel1",
    "phase1": {
        "dpd_retry_interval": 60,
        "ike_version": 2,
        "peer_gateway_ip": "123.0.0.2",
        "phase1_diffie_hellman_groups": [
            30,
            31,
            32
        ],
        "phase1_encryptions": [
            "des-md5",
            "chacha20poly1305-prfsha256"
        ],
        "phase1_life_time": 86400,
        "pre_shared_key": "PreSharedKey1"
    },
    "phase2": {
        "perfect_forward_secrecy": "ENABLE",
        "phase2_diffie_hellman_groups": [
            30,
            31,
            32
        ],
        "phase2_encryptions": [
            "null-md5",
            "aes128gcm",
            "chacha20poly1305"
        ],
        "phase2_life_time": 43200,
        "remote_subnet": "10.1.0.0/16"
    },
    "tags": [],
    "vpn_gateway_id": "b156740b6335468d8354eb9ef8eddf5a"
}

Example HTTP response

Response 202

{
    "vpn_tunnel": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Tunnel",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnTunnel1",
        "phase1": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "dpd_retry_interval": 60,
            "encryptions": [
                "des-md5",
                "chacha20poly1305-prfsha256"
            ],
            "ike_version": 2,
            "life_time": 86400,
            "peer_gateway_ip": "123.0.0.2"
        },
        "phase2": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "encryptions": [
                "null-md5",
                "aes128gcm",
                "chacha20poly1305"
            ],
            "life_time": 43200,
            "perfect_forward_secrecy": "ENABLE",
            "remote_subnet": "10.1.0.0/16"
        },
        "state": "ACTIVE",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1",
        "vpn_gateway_id": "b156740b6335468d8354eb9ef8eddf5a",
        "vpn_gateway_ip_address": "123.0.0.1",
        "vpn_gateway_name": "ExampleVpnGW1"
    }
}

10.1.3 - Delete VPN Gateway

10.1.3.1 - 1.1

delete /v1/vpn-gateways/{vpn_gateway_id}

Description

VPN gateway 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathvpn_gateway_id
required
VPN Gateway ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone

Responses

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

Example HTTP request

Request path

/v1/vpn-gateways/{vpn_gateway_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 = vpn 1.1"

Example HTTP response

Response 202

10.1.3.2 - 1.0

delete /v1/vpn-gateways/{vpn_gateway_id}

Description

VPN gateway 삭제

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathvpn_gateway_id
required
VPN Gateway ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone

Responses

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

Example HTTP request

Request path

/v1/vpn-gateways/{vpn_gateway_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 = vpn 1.0"

Example HTTP response

Response 202

10.1.4 - Delete VPN Tunnel

10.1.4.1 - 1.1

delete /v1/vpn-tunnels/{vpn_tunnel_id}

Description

VPN tunnel 삭제

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathvpn_tunnel_id
required
VPN Tunnel ID
Example : 2ade2919287040bc92e557fbbe6709c1
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/vpn-tunnels/{vpn_tunnel_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 = vpn 1.1"

Example HTTP response

Response 202

10.1.4.2 - 1.0

delete /v1/vpn-tunnels/{vpn_tunnel_id}

Description

VPN tunnel 삭제

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathvpn_tunnel_id
required
VPN Tunnel ID
Example : 2ade2919287040bc92e557fbbe6709c1
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/vpn-tunnels/{vpn_tunnel_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 = vpn 1.0"

Example HTTP response

Response 202

10.1.5 - List VPN Gateways

10.1.5.1 - 1.1

get /v1/vpn-gateways

Description

VPN gateway 목록 조회

상태 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
VPN Gateway Name
Example : ExampleVpnGW1
stringNone
queryip_address
optional
VPN Gateway IP 주소
Example : 123.0.0.1
stringNone
queryvpc_id
optional
VPC ID
Example : ceb44ea5ecb34a49b16495f9a63b0718
stringNone
queryvpc_name
optional
VPC 명
Example : ExampleVPC1
stringNone

Responses

HTTP CodeDescriptionSchema
200OKVpnGatewayListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpn-gateways

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpn_gateways": [
        {
            "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Example Description for VPN Gateway",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "ip_address": "123.0.0.1",
            "ip_id": "fcde872f75c145a0893d656cc698f13e",
            "ip_type": "PUBLIC",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ExampleVpnGW1",
            "state": "ACTIVE",
            "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
            "vpc_name": "ExampleVPC1"
        }
    ]
}

10.1.5.2 - 1.0

get /v1/vpn-gateways

Description

VPN gateway 목록 조회

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

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
VPN Gateway Name
Example : ExampleVpnGW1
stringNone
queryip_address
optional
VPN Gateway IP 주소
Example : 123.0.0.1
stringNone
queryvpc_id
optional
VPC ID
Example : ceb44ea5ecb34a49b16495f9a63b0718
stringNone
queryvpc_name
optional
VPC 명
Example : ExampleVPC1
stringNone

Responses

HTTP CodeDescriptionSchema
200OKVpnGatewayListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpn-gateways

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpn_gateways": [
        {
            "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Example Description for VPN Gateway",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "ip_address": "123.0.0.1",
            "ip_id": "fcde872f75c145a0893d656cc698f13e",
            "ip_type": "PUBLIC",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ExampleVpnGW1",
            "state": "ACTIVE",
            "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
            "vpc_name": "ExampleVPC1"
        }
    ]
}

10.1.6 - List VPN Tunnels

10.1.6.1 - 1.1

get /v1/vpn-tunnels

Description

VPN tunnel 목록 조회

상태 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
VPN Tunnel 이름
Example : ExampleVpnTunnel1
stringNone
queryvpn_gateway_id
optional
VPN Gateway ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone
queryvpn_gateway_name
optional
VPN Gateway Name
Example : ExampleVpnGW1
stringNone

Responses

HTTP CodeDescriptionSchema
200OKVpnTunnelListResponseV1Dot1
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpn-tunnels

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpn_tunnels": [
        {
            "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Example Description for VPN Tunnel",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ExampleVpnTunnel1",
            "phase1": {
                "dpd_retry_interval": 60,
                "ike_version": 2,
                "life_time": 86400,
                "peer_gateway_ip": "123.0.0.2"
            },
            "phase2": {
                "life_time": 43200,
                "perfect_forward_secrecy": "ENABLE",
                "remote_subnets": [
                    "10.1.1.0/24",
                    "10.1.2.0/24",
                    "10.1.3.0/24"
                ]
            },
            "state": "ACTIVE",
            "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
            "vpc_name": "ExampleVPC1",
            "vpn_gateway_id": "b156740b6335468d8354eb9ef8eddf5a",
            "vpn_gateway_ip_address": "123.0.0.1",
            "vpn_gateway_name": "ExampleVpnGW1"
        }
    ]
}

10.1.6.2 - 1.0

get /v1/vpn-tunnels

Description

VPN tunnel 목록 조회

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

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
VPN Tunnel 이름
Example : ExampleVpnTunnel1
stringNone
queryvpn_gateway_id
optional
VPN Gateway ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone
queryvpn_gateway_name
optional
VPN Gateway Name
Example : ExampleVpnGW1
stringNone
querypeer_gateway_ip
optional
VPN Tunnel Peer Gateway IP 주소
Example : 123.0.0.2
stringNone
queryremote_subnet
optional
VPN Tunnel IPSec Remote Subnet
Example : 10.1.0.0/16
stringNone

Responses

HTTP CodeDescriptionSchema
200OKVpnTunnelListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpn-tunnels

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpn_tunnels": [
        {
            "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Example Description for VPN Tunnel",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ExampleVpnTunnel1",
            "phase1": {
                "dpd_retry_interval": 60,
                "ike_version": 2,
                "life_time": 86400,
                "peer_gateway_ip": "123.0.0.2"
            },
            "phase2": {
                "life_time": 43200,
                "perfect_forward_secrecy": "ENABLE",
                "remote_subnet": "10.1.0.0/16"
            },
            "state": "ACTIVE",
            "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
            "vpc_name": "ExampleVPC1",
            "vpn_gateway_id": "b156740b6335468d8354eb9ef8eddf5a",
            "vpn_gateway_ip_address": "123.0.0.1",
            "vpn_gateway_name": "ExampleVpnGW1"
        }
    ]
}

10.1.7 - Set VPN Gateway

10.1.7.1 - 1.1

put /v1/vpn-gateways/{vpn_gateway_id}

Description

VPN gateway 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathvpn_gateway_id
required
VPN Gateway ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone
bodybody
required

VpnGatewaySetRequest

Responses

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

Example HTTP request

Request path

/v1/vpn-gateways/{vpn_gateway_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 = vpn 1.1"

Request body

{
    "description": "Example Description for VPN Gateway"
}

Example HTTP response

Response 200

{
    "vpn_gateway": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Gateway",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "ip_address": "123.0.0.1",
        "ip_id": "fcde872f75c145a0893d656cc698f13e",
        "ip_type": "PUBLIC",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnGW1",
        "state": "ACTIVE",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1"
    }
}

10.1.7.2 - 1.0

put /v1/vpn-gateways/{vpn_gateway_id}

Description

VPN gateway 수정

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathvpn_gateway_id
required
VPN Gateway ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone
bodybody
required

VpnGatewaySetRequest

Responses

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

Example HTTP request

Request path

/v1/vpn-gateways/{vpn_gateway_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 = vpn 1.0"

Request body

{
    "description": "Example Description for VPN Gateway"
}

Example HTTP response

Response 200

{
    "vpn_gateway": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Gateway",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "ip_address": "123.0.0.1",
        "ip_id": "fcde872f75c145a0893d656cc698f13e",
        "ip_type": "PUBLIC",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnGW1",
        "state": "ACTIVE",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1"
    }
}

10.1.8 - Set VPN Tunnel

10.1.8.1 - 1.1

put /v1/vpn-tunnels/{vpn_tunnel_id}

Description

VPN tunnel 수정

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathvpn_tunnel_id
required
VPN Tunnel ID
Example : 2ade2919287040bc92e557fbbe6709c1
stringNone
bodybody
required

VpnTunnelSetRequestV1Dot1

Responses

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

Example HTTP request

Request path

/v1/vpn-tunnels/{vpn_tunnel_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 = vpn 1.1"

Request body

{
    "description": "Example Description for VPN Tunnel",
    "phase1": {
        "dpd_retry_interval": 60,
        "ike_version": 2,
        "peer_gateway_ip": "123.0.0.2",
        "phase1_diffie_hellman_groups": [
            30,
            31,
            32
        ],
        "phase1_encryptions": [
            "des-md5",
            "chacha20poly1305-prfsha256"
        ],
        "phase1_life_time": 86400,
        "pre_shared_key": "PreSharedKey1"
    },
    "phase2": {
        "perfect_forward_secrecy": "ENABLE",
        "phase2_diffie_hellman_groups": [
            30,
            31,
            32
        ],
        "phase2_encryptions": [
            "null-md5",
            "aes128gcm",
            "chacha20poly1305"
        ],
        "phase2_life_time": 43200,
        "remote_subnets": [
            "10.1.1.0/24",
            "10.1.2.0/24",
            "10.1.3.0/24"
        ]
    }
}

Example HTTP response

Response 202

{
    "vpn_tunnel": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Tunnel",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnTunnel1",
        "phase1": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "dpd_retry_interval": 60,
            "encryptions": [
                "des-md5",
                "chacha20poly1305-prfsha256"
            ],
            "ike_version": 2,
            "life_time": 86400,
            "peer_gateway_ip": "123.0.0.2"
        },
        "phase2": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "encryptions": [
                "null-md5",
                "aes128gcm",
                "chacha20poly1305"
            ],
            "life_time": 43200,
            "perfect_forward_secrecy": "ENABLE",
            "remote_subnets": [
                "10.1.1.0/24",
                "10.1.2.0/24",
                "10.1.3.0/24"
            ]
        },
        "state": "ACTIVE",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1",
        "vpn_gateway_id": "b156740b6335468d8354eb9ef8eddf5a",
        "vpn_gateway_ip_address": "123.0.0.1",
        "vpn_gateway_name": "ExampleVpnGW1"
    }
}

10.1.8.2 - 1.0

put /v1/vpn-tunnels/{vpn_tunnel_id}

Description

VPN tunnel 수정

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathvpn_tunnel_id
required
VPN Tunnel ID
Example : 2ade2919287040bc92e557fbbe6709c1
stringNone
bodybody
required

VpnTunnelSetRequest

Responses

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

Example HTTP request

Request path

/v1/vpn-tunnels/{vpn_tunnel_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 = vpn 1.0"

Request body

{
    "description": "Example Description for VPN Tunnel",
    "phase1": {
        "dpd_retry_interval": 60,
        "ike_version": 2,
        "peer_gateway_ip": "123.0.0.2",
        "phase1_diffie_hellman_groups": [
            30,
            31,
            32
        ],
        "phase1_encryptions": [
            "des-md5",
            "chacha20poly1305-prfsha256"
        ],
        "phase1_life_time": 86400,
        "pre_shared_key": "PreSharedKey1"
    },
    "phase2": {
        "perfect_forward_secrecy": "ENABLE",
        "phase2_diffie_hellman_groups": [
            30,
            31,
            32
        ],
        "phase2_encryptions": [
            "null-md5",
            "aes128gcm",
            "chacha20poly1305"
        ],
        "phase2_life_time": 43200,
        "remote_subnet": "10.1.0.0/16"
    }
}

Example HTTP response

Response 202

{
    "vpn_tunnel": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Tunnel",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnTunnel1",
        "phase1": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "dpd_retry_interval": 60,
            "encryptions": [
                "des-md5",
                "chacha20poly1305-prfsha256"
            ],
            "ike_version": 2,
            "life_time": 86400,
            "peer_gateway_ip": "123.0.0.2"
        },
        "phase2": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "encryptions": [
                "null-md5",
                "aes128gcm",
                "chacha20poly1305"
            ],
            "life_time": 43200,
            "perfect_forward_secrecy": "ENABLE",
            "remote_subnet": "10.1.0.0/16"
        },
        "state": "ACTIVE",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1",
        "vpn_gateway_id": "b156740b6335468d8354eb9ef8eddf5a",
        "vpn_gateway_ip_address": "123.0.0.1",
        "vpn_gateway_name": "ExampleVpnGW1"
    }
}

10.1.9 - Show VPN Gateway

10.1.9.1 - 1.1

get /v1/vpn-gateways/{vpn_gateway_id}

Description

VPN gateway 상세 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathvpn_gateway_id
required
VPN Gateway ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone

Responses

HTTP CodeDescriptionSchema
200OKVpnGatewayShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/vpn-gateways/{vpn_gateway_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 = vpn 1.1"

Example HTTP response

Response 200

{
    "vpn_gateway": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Gateway",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "ip_address": "123.0.0.1",
        "ip_id": "fcde872f75c145a0893d656cc698f13e",
        "ip_type": "PUBLIC",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnGW1",
        "state": "ACTIVE",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1"
    }
}

10.1.9.2 - 1.0

get /v1/vpn-gateways/{vpn_gateway_id}

Description

VPN gateway 상세 조회

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathvpn_gateway_id
required
VPN Gateway ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone

Responses

HTTP CodeDescriptionSchema
200OKVpnGatewayShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/vpn-gateways/{vpn_gateway_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 = vpn 1.0"

Example HTTP response

Response 200

{
    "vpn_gateway": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Gateway",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "ip_address": "123.0.0.1",
        "ip_id": "fcde872f75c145a0893d656cc698f13e",
        "ip_type": "PUBLIC",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnGW1",
        "state": "ACTIVE",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1"
    }
}

10.1.10 - Show VPN Tunnel

10.1.10.1 - 1.1

get /v1/vpn-tunnels/{vpn_tunnel_id}

Description

VPN tunnel 상세 조회

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathvpn_tunnel_id
required
VPN Tunnel ID
Example : 2ade2919287040bc92e557fbbe6709c1
stringNone

Responses

HTTP CodeDescriptionSchema
200OKVpnTunnelShowWithStatusResponseV1Dot1
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/vpn-tunnels/{vpn_tunnel_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 = vpn 1.1"

Example HTTP response

Response 200

{
    "vpn_tunnel": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Tunnel",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnTunnel1",
        "phase1": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "dpd_retry_interval": 60,
            "encryptions": [
                "des-md5",
                "chacha20poly1305-prfsha256"
            ],
            "ike_version": 2,
            "life_time": 86400,
            "peer_gateway_ip": "123.0.0.2"
        },
        "phase2": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "encryptions": [
                "null-md5",
                "aes128gcm",
                "chacha20poly1305"
            ],
            "life_time": 43200,
            "perfect_forward_secrecy": "ENABLE",
            "remote_subnets": [
                "10.1.1.0/24",
                "10.1.2.0/24",
                "10.1.3.0/24"
            ]
        },
        "state": "ACTIVE",
        "status": "UP",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1",
        "vpn_gateway_id": "b156740b6335468d8354eb9ef8eddf5a",
        "vpn_gateway_ip_address": "123.0.0.1",
        "vpn_gateway_name": "ExampleVpnGW1"
    }
}

10.1.10.2 - 1.0

get /v1/vpn-tunnels/{vpn_tunnel_id}

Description

VPN tunnel 상세 조회

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathvpn_tunnel_id
required
VPN Tunnel ID
Example : 2ade2919287040bc92e557fbbe6709c1
stringNone

Responses

HTTP CodeDescriptionSchema
200OKVpnTunnelShowWithStatusResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/vpn-tunnels/{vpn_tunnel_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 = vpn 1.0"

Example HTTP response

Response 200

{
    "vpn_tunnel": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Tunnel",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnTunnel1",
        "phase1": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "dpd_retry_interval": 60,
            "encryptions": [
                "des-md5",
                "chacha20poly1305-prfsha256"
            ],
            "ike_version": 2,
            "life_time": 86400,
            "peer_gateway_ip": "123.0.0.2"
        },
        "phase2": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "encryptions": [
                "null-md5",
                "aes128gcm",
                "chacha20poly1305"
            ],
            "life_time": 43200,
            "perfect_forward_secrecy": "ENABLE",
            "remote_subnet": "10.1.0.0/16"
        },
        "state": "ACTIVE",
        "status": "UP",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1",
        "vpn_gateway_id": "b156740b6335468d8354eb9ef8eddf5a",
        "vpn_gateway_ip_address": "123.0.0.1",
        "vpn_gateway_name": "ExampleVpnGW1"
    }
}

10.2 - Models

10.2.1 - Tag

NameDescriptionSchemaDefault
key
required
tag key
Example :
string
value
required
tag value
Example :
string

10.2.2 - VpnGateway

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
description
optional
설명
Example : Example Description for VPN Gateway
any of [string, null]
id
required
ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
ip_address
required
VPN Gateway IP 주소
Example : 123.0.0.1
string
ip_id
required
VPN Gateway IP ID
Example : fcde872f75c145a0893d656cc698f13e
string
ip_type
required
VPN Gateway IP 타입
Example : PUBLIC
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
VPN Gateway Name
Example : ExampleVpnGW1
string
state
required
상태
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)
vpc_id
required
VPC ID
Example : ceb44ea5ecb34a49b16495f9a63b0718
string
vpc_name
required
VPC 명
Example : ExampleVPC1
string

10.2.3 - VpnGatewayCreateRequest

NameDescriptionSchemaDefault
description
optional
설명
Example : Example Description for VPN Gateway
any of [string, null]
ip_address
required
VPN Gateway IP 주소
Example : 123.0.0.1
string
ip_id
required
VPN Gateway IP ID
Example : fcde872f75c145a0893d656cc698f13e
string
ip_type
required
VPN Gateway IP 타입
Example : PUBLIC
string
name
required
VPN Gateway Name
Example : ExampleVpnGW1
string
tags
optional
태그 목록
array[Tag]
vpc_id
required
VPC ID
Example : ceb44ea5ecb34a49b16495f9a63b0718
string

10.2.4 - VpnGatewayListResponse

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

array[VpnGateway]

10.2.5 - VpnGatewaySetRequest

NameDescriptionSchemaDefault
description
optional
설명
Example : Example Description for VPN Gateway
string

10.2.6 - VpnGatewayShowResponse

NameDescriptionSchemaDefault
vpn_gateway
required

VpnGateway

10.2.7 - VpnPhase1

NameDescriptionSchemaDefault
dpd_retry_interval
required
VPN Tunnel Dead Peer Detection(DPD) 재시도 주기 (초)
Example : 60
integer
ike_version
required
VPN Tunnel IKE 버전
Example : 2
integer
life_time
required
VPN Tunnel ISAKMP Lifetime (초)
Example : 86400
integer
peer_gateway_ip
required
VPN Tunnel Peer Gateway IP 주소
Example : 123.0.0.2
string

10.2.8 - VpnPhase1CreateRequest

NameDescriptionSchemaDefault
dpd_retry_interval
required
VPN Tunnel Dead Peer Detection(DPD) 재시도 주기 (초)
Example : 60
integer
ike_version
required
VPN Tunnel IKE 버전
Example : 2
integer
peer_gateway_ip
required
VPN Tunnel Peer Gateway IP 주소
Example : 123.0.0.2
string
phase1_diffie_hellman_groups
required
VPN Tunnel ISAKMP Diffie-Hellman Group 목록
Example : [30, 31, 32]
array[integer]
phase1_encryptions
required
VPN Tunnel ISAKMP Proposal 목록
Example : ['des-md5', 'chacha20poly1305-prfsha256']
array[string]
phase1_life_time
required
VPN Tunnel ISAKMP Lifetime (초)
Example : 86400
integer
pre_shared_key
required
VPN Tunnel ISAKMP 인증 : Pre-shared Key
Example : PreSharedKey1
string

10.2.9 - VpnPhase1CreateRequestV1Dot1

NameDescriptionSchemaDefault
dpd_retry_interval
required
VPN Tunnel Dead Peer Detection(DPD) 재시도 주기 (초)
Example : 60
integer
ike_version
required
VPN Tunnel IKE 버전
Example : 2
integer
peer_gateway_ip
required
VPN Tunnel Peer Gateway IP 주소
Example : 123.0.0.2
string
phase1_diffie_hellman_groups
required
VPN Tunnel ISAKMP Diffie-Hellman Group 목록
Example : [30, 31, 32]
array[integer]
phase1_encryptions
required
VPN Tunnel ISAKMP Proposal 목록
Example : ['des-md5', 'chacha20poly1305-prfsha256']
array[string]
phase1_life_time
required
VPN Tunnel ISAKMP Lifetime (초)
Example : 86400
integer
pre_shared_key
required
VPN Tunnel ISAKMP 인증 : Pre-shared Key
Example : PreSharedKey1
string

10.2.10 - VpnPhase1Detail

NameDescriptionSchemaDefault
diffie_hellman_groups
required
VPN Tunnel ISAKMP Diffie-Hellman Group 목록
Example : [30, 31, 32]
array[integer]
dpd_retry_interval
required
VPN Tunnel Dead Peer Detection(DPD) 재시도 주기 (초)
Example : 60
integer
encryptions
required
VPN Tunnel ISAKMP Proposal 목록
Example : ['des-md5', 'chacha20poly1305-prfsha256']
array[string]
ike_version
required
VPN Tunnel IKE 버전
Example : 2
integer
life_time
required
VPN Tunnel ISAKMP Lifetime (초)
Example : 86400
integer
peer_gateway_ip
required
VPN Tunnel Peer Gateway IP 주소
Example : 123.0.0.2
string

10.2.11 - VpnPhase1DetailV1Dot1

NameDescriptionSchemaDefault
diffie_hellman_groups
required
VPN Tunnel ISAKMP Diffie-Hellman Group 목록
Example : [30, 31, 32]
array[integer]
dpd_retry_interval
required
VPN Tunnel Dead Peer Detection(DPD) 재시도 주기 (초)
Example : 60
integer
encryptions
required
VPN Tunnel ISAKMP Proposal 목록
Example : ['des-md5', 'chacha20poly1305-prfsha256']
array[string]
ike_version
required
VPN Tunnel IKE 버전
Example : 2
integer
life_time
required
VPN Tunnel ISAKMP Lifetime (초)
Example : 86400
integer
peer_gateway_ip
required
VPN Tunnel Peer Gateway IP 주소
Example : 123.0.0.2
string

10.2.12 - VpnPhase1SetRequest

NameDescriptionSchemaDefault
dpd_retry_interval
optional
VPN Tunnel Dead Peer Detection(DPD) 재시도 주기 (초)
Example : 60
any of [integer, null]
ike_version
optional
VPN Tunnel IKE 버전
Example : 2
any of [integer, null]
peer_gateway_ip
optional
VPN Tunnel Peer Gateway IP 주소
Example : 123.0.0.2
any of [string, null]
phase1_diffie_hellman_groups
optional
VPN Tunnel ISAKMP Diffie-Hellman Group 목록
Example : [30, 31, 32]
any of [array[integer], null]
phase1_encryptions
optional
VPN Tunnel ISAKMP Proposal 목록
Example : ['des-md5', 'chacha20poly1305-prfsha256']
any of [array[string], null]
phase1_life_time
optional
VPN Tunnel ISAKMP Lifetime (초)
Example : 86400
any of [integer, null]
pre_shared_key
optional
VPN Tunnel ISAKMP 인증 : Pre-shared Key
Example : PreSharedKey1
any of [string, null]

10.2.13 - VpnPhase1SetRequestV1Dot1

NameDescriptionSchemaDefault
dpd_retry_interval
optional
VPN Tunnel Dead Peer Detection(DPD) 재시도 주기 (초)
Example : 60
any of [integer, null]
ike_version
optional
VPN Tunnel IKE 버전
Example : 2
any of [integer, null]
peer_gateway_ip
optional
VPN Tunnel Peer Gateway IP 주소
Example : 123.0.0.2
any of [string, null]
phase1_diffie_hellman_groups
optional
VPN Tunnel ISAKMP Diffie-Hellman Group 목록
Example : [30, 31, 32]
any of [array[integer], null]
phase1_encryptions
optional
VPN Tunnel ISAKMP Proposal 목록
Example : ['des-md5', 'chacha20poly1305-prfsha256']
any of [array[string], null]
phase1_life_time
optional
VPN Tunnel ISAKMP Lifetime (초)
Example : 86400
any of [integer, null]
pre_shared_key
optional
VPN Tunnel ISAKMP 인증 : Pre-shared Key
Example : PreSharedKey1
any of [string, null]

10.2.14 - VpnPhase1V1Dot1

NameDescriptionSchemaDefault
dpd_retry_interval
required
VPN Tunnel Dead Peer Detection(DPD) 재시도 주기 (초)
Example : 60
integer
ike_version
required
VPN Tunnel IKE 버전
Example : 2
integer
life_time
required
VPN Tunnel ISAKMP Lifetime (초)
Example : 86400
integer
peer_gateway_ip
required
VPN Tunnel Peer Gateway IP 주소
Example : 123.0.0.2
string

10.2.15 - VpnPhase2

NameDescriptionSchemaDefault
life_time
required
VPN Tunnel IPSec Lifetime (초)
Example : 43200
integer
perfect_forward_secrecy
required
VPN Tunnel IPSec Perfect Forward Secrecy(PFS)
Example : ENABLE
string
remote_subnet
required
VPN Tunnel IPSec Remote Subnet
Example : 10.1.0.0/16
string

10.2.16 - VpnPhase2CreateRequest

NameDescriptionSchemaDefault
perfect_forward_secrecy
required
VPN Tunnel IPSec Perfect Forward Secrecy(PFS)
Example : ENABLE
enum (ENABLE, DISABLE)
phase2_diffie_hellman_groups
required
VPN Tunnel ISAKMP Diffie-Hellman Group 목록
Example : [30, 31, 32]
array[integer]
phase2_encryptions
required
VPN Tunnel ISAKMP Proposal 목록
Example : ['null-md5', 'aes128gcm', 'chacha20poly1305']
array[string]
phase2_life_time
required
VPN Tunnel IPSec Lifetime (초)
Example : 43200
integer
remote_subnet
required
VPN Tunnel IPSec Remote Subnet
Example : 10.1.0.0/16
string

10.2.17 - VpnPhase2CreateRequestV1Dot1

NameDescriptionSchemaDefault
perfect_forward_secrecy
required
VPN Tunnel IPSec Perfect Forward Secrecy(PFS)
Example : ENABLE
enum (ENABLE, DISABLE)
phase2_diffie_hellman_groups
required
VPN Tunnel ISAKMP Diffie-Hellman Group 목록
Example : [30, 31, 32]
array[integer]
phase2_encryptions
required
VPN Tunnel ISAKMP Proposal 목록
Example : ['null-md5', 'aes128gcm', 'chacha20poly1305']
array[string]
phase2_life_time
required
VPN Tunnel IPSec Lifetime (초)
Example : 43200
integer
remote_subnets
required
VPN Tunnel IPSec Remote Subnet
Example : ['10.1.1.0/24', '10.1.2.0/24', '10.1.3.0/24']
array[string]

10.2.18 - VpnPhase2Detail

NameDescriptionSchemaDefault
diffie_hellman_groups
optional
VPN Tunnel IPSec Diffie-Hellman Group 목록
Example : [30, 31, 32]
any of [array[integer], null]
encryptions
required
VPN Tunnel IPSec Proposal 목록
Example : ['null-md5', 'aes128gcm', 'chacha20poly1305']
array[string]
life_time
required
VPN Tunnel IPSec Lifetime (초)
Example : 43200
integer
perfect_forward_secrecy
required
VPN Tunnel IPSec Perfect Forward Secrecy(PFS)
Example : ENABLE
string
remote_subnet
required
VPN Tunnel IPSec Remote Subnet
Example : 10.1.0.0/16
string

10.2.19 - VpnPhase2DetailV1Dot1

NameDescriptionSchemaDefault
diffie_hellman_groups
optional
VPN Tunnel IPSec Diffie-Hellman Group 목록
Example : [30, 31, 32]
any of [array[integer], null]
encryptions
required
VPN Tunnel IPSec Proposal 목록
Example : ['null-md5', 'aes128gcm', 'chacha20poly1305']
array[string]
life_time
required
VPN Tunnel IPSec Lifetime (초)
Example : 43200
integer
perfect_forward_secrecy
required
VPN Tunnel IPSec Perfect Forward Secrecy(PFS)
Example : ENABLE
string
remote_subnets
required
VPN Tunnel IPSec Remote Subnet
Example : ['10.1.1.0/24', '10.1.2.0/24', '10.1.3.0/24']
array[string]

10.2.20 - VpnPhase2SetRequest

NameDescriptionSchemaDefault
perfect_forward_secrecy
optional
VPN Tunnel IPSec Perfect Forward Secrecy(PFS)
Example : ENABLE
any of [enum (ENABLE, DISABLE), null]
phase2_diffie_hellman_groups
optional
VPN Tunnel ISAKMP Diffie-Hellman Group 목록
Example : [30, 31, 32]
any of [array[integer], null]
phase2_encryptions
optional
VPN Tunnel ISAKMP Proposal 목록
Example : ['null-md5', 'aes128gcm', 'chacha20poly1305']
any of [array[string], null]
phase2_life_time
optional
VPN Tunnel IPSec Lifetime (초)
Example : 43200
any of [integer, null]
remote_subnet
optional
VPN Tunnel IPSec Remote Subnet
Example : 10.1.0.0/16
any of [string, null]

10.2.21 - VpnPhase2SetRequestV1Dot1

NameDescriptionSchemaDefault
perfect_forward_secrecy
optional
VPN Tunnel IPSec Perfect Forward Secrecy(PFS)
Example : ENABLE
any of [enum (ENABLE, DISABLE), null]
phase2_diffie_hellman_groups
optional
VPN Tunnel ISAKMP Diffie-Hellman Group 목록
Example : [30, 31, 32]
any of [array[integer], null]
phase2_encryptions
optional
VPN Tunnel ISAKMP Proposal 목록
Example : ['null-md5', 'aes128gcm', 'chacha20poly1305']
any of [array[string], null]
phase2_life_time
optional
VPN Tunnel IPSec Lifetime (초)
Example : 43200
any of [integer, null]
remote_subnets
optional
VPN Tunnel IPSec Remote Subnet
Example : ['10.1.1.0/24', '10.1.2.0/24', '10.1.3.0/24']
any of [array[string], null]

10.2.22 - VpnPhase2V1Dot1

NameDescriptionSchemaDefault
life_time
required
VPN Tunnel IPSec Lifetime (초)
Example : 43200
integer
perfect_forward_secrecy
required
VPN Tunnel IPSec Perfect Forward Secrecy(PFS)
Example : ENABLE
string
remote_subnets
required
VPN Tunnel IPSec Remote Subnet
Example : ['10.1.1.0/24', '10.1.2.0/24', '10.1.3.0/24']
array[string]

10.2.23 - VpnTunnel

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
description
required
설명
Example : Example Description for VPN Tunnel
any of [string, null]
id
required
ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
VPN Tunnel 이름
Example : ExampleVpnTunnel1
string
phase1
required
VPN Tunnel Phase1
VpnPhase1
phase2
required
VPN Tunnel Phase2
VpnPhase2
state
required
상태
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)
vpc_id
required
VPC ID
Example : ceb44ea5ecb34a49b16495f9a63b0718
string
vpc_name
required
VPC 명
Example : ExampleVPC1
string
vpn_gateway_id
required
VPN Gateway ID
Example : b156740b6335468d8354eb9ef8eddf5a
string
vpn_gateway_ip_address
required
VPN Gateway IP 주소
Example : 123.0.0.1
string
vpn_gateway_name
required
VPN Gateway Name
Example : ExampleVpnGW1
string

10.2.24 - VpnTunnelCreateRequest

NameDescriptionSchemaDefault
description
optional
설명
Example : Example Description for VPN Tunnel
any of [string, null]
name
required
VPN Tunnel 이름
Example : ExampleVpnTunnel1
string
phase1
required
VPN Tunnel Phase1
VpnPhase1CreateRequest
phase2
required
VPN Tunnel Phase2
VpnPhase2CreateRequest
tags
optional
태그 목록
array[Tag]
vpn_gateway_id
required
VPN Gateway ID
Example : b156740b6335468d8354eb9ef8eddf5a
string

10.2.25 - VpnTunnelCreateRequestV1Dot1

NameDescriptionSchemaDefault
description
optional
설명
Example : Example Description for VPN Tunnel
any of [string, null]
name
required
VPN Tunnel 이름
Example : ExampleVpnTunnel1
string
phase1
required
VPN Tunnel Phase1
VpnPhase1CreateRequestV1Dot1
phase2
required
VPN Tunnel Phase2
VpnPhase2CreateRequestV1Dot1
tags
optional
태그 목록
array[Tag]
vpn_gateway_id
required
VPN Gateway ID
Example : b156740b6335468d8354eb9ef8eddf5a
string

10.2.26 - VpnTunnelDetail

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
description
required
설명
Example : Example Description for VPN Tunnel
any of [string, null]
id
required
ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
VPN Tunnel 이름
Example : ExampleVpnTunnel1
string
phase1
required
VPN Tunnel Phase1
VpnPhase1Detail
phase2
required
VPN Tunnel Phase2
VpnPhase2Detail
state
required
상태
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)
vpc_id
required
VPC ID
Example : ceb44ea5ecb34a49b16495f9a63b0718
string
vpc_name
required
VPC 명
Example : ExampleVPC1
string
vpn_gateway_id
required
VPN Gateway ID
Example : b156740b6335468d8354eb9ef8eddf5a
string
vpn_gateway_ip_address
required
VPN Gateway IP 주소
Example : 123.0.0.1
string
vpn_gateway_name
required
VPN Gateway Name
Example : ExampleVpnGW1
string

10.2.27 - VpnTunnelDetailV1Dot1

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
description
required
설명
Example : Example Description for VPN Tunnel
any of [string, null]
id
required
ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
VPN Tunnel 이름
Example : ExampleVpnTunnel1
string
phase1
required
VPN Tunnel Phase1
VpnPhase1DetailV1Dot1
phase2
required
VPN Tunnel Phase2
VpnPhase2DetailV1Dot1
state
required
상태
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)
vpc_id
required
VPC ID
Example : ceb44ea5ecb34a49b16495f9a63b0718
string
vpc_name
required
VPC 명
Example : ExampleVPC1
string
vpn_gateway_id
required
VPN Gateway ID
Example : b156740b6335468d8354eb9ef8eddf5a
string
vpn_gateway_ip_address
required
VPN Gateway IP 주소
Example : 123.0.0.1
string
vpn_gateway_name
required
VPN Gateway Name
Example : ExampleVpnGW1
string

10.2.28 - VpnTunnelDetailWithStatus

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
description
required
설명
Example : Example Description for VPN Tunnel
any of [string, null]
id
required
ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
VPN Tunnel 이름
Example : ExampleVpnTunnel1
string
phase1
required
VPN Tunnel Phase1
VpnPhase1Detail
phase2
required
VPN Tunnel Phase2
VpnPhase2Detail
state
required
상태
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)
status
required
VPN Tunnel 상태
Example : UP
enum (UP, DOWN)
vpc_id
required
VPC ID
Example : ceb44ea5ecb34a49b16495f9a63b0718
string
vpc_name
required
VPC 명
Example : ExampleVPC1
string
vpn_gateway_id
required
VPN Gateway ID
Example : b156740b6335468d8354eb9ef8eddf5a
string
vpn_gateway_ip_address
required
VPN Gateway IP 주소
Example : 123.0.0.1
string
vpn_gateway_name
required
VPN Gateway Name
Example : ExampleVpnGW1
string

10.2.29 - VpnTunnelDetailWithStatusV1Dot1

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
description
required
설명
Example : Example Description for VPN Tunnel
any of [string, null]
id
required
ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
VPN Tunnel 이름
Example : ExampleVpnTunnel1
string
phase1
required
VPN Tunnel Phase1
VpnPhase1DetailV1Dot1
phase2
required
VPN Tunnel Phase2
VpnPhase2DetailV1Dot1
state
required
상태
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)
status
required
VPN Tunnel 상태
Example : UP
enum (UP, DOWN)
vpc_id
required
VPC ID
Example : ceb44ea5ecb34a49b16495f9a63b0718
string
vpc_name
required
VPC 명
Example : ExampleVPC1
string
vpn_gateway_id
required
VPN Gateway ID
Example : b156740b6335468d8354eb9ef8eddf5a
string
vpn_gateway_ip_address
required
VPN Gateway IP 주소
Example : 123.0.0.1
string
vpn_gateway_name
required
VPN Gateway Name
Example : ExampleVpnGW1
string

10.2.30 - VpnTunnelListResponse

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

array[VpnTunnel]

10.2.31 - VpnTunnelListResponseV1Dot1

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

array[VpnTunnelV1Dot1]

10.2.32 - VpnTunnelSetRequest

NameDescriptionSchemaDefault
description
optional
설명
Example : Example Description for VPN Tunnel
any of [string, null]
phase1
optional
VPN Tunnel Phase1
any of [VpnPhase1SetRequest, null]
phase2
optional
VPN Tunnel Phase2
any of [VpnPhase2SetRequest, null]

10.2.33 - VpnTunnelSetRequestV1Dot1

NameDescriptionSchemaDefault
description
optional
설명
Example : Example Description for VPN Tunnel
any of [string, null]
phase1
optional
VPN Tunnel Phase1
any of [VpnPhase1SetRequestV1Dot1, null]
phase2
optional
VPN Tunnel Phase2
any of [VpnPhase2SetRequestV1Dot1, null]

10.2.34 - VpnTunnelShowResponse

NameDescriptionSchemaDefault
vpn_tunnel
required

VpnTunnelDetail

10.2.35 - VpnTunnelShowResponseV1Dot1

NameDescriptionSchemaDefault
vpn_tunnel
required

VpnTunnelDetailV1Dot1

10.2.36 - VpnTunnelShowWithStatusResponse

NameDescriptionSchemaDefault
vpn_tunnel
required

VpnTunnelDetailWithStatus

10.2.37 - VpnTunnelShowWithStatusResponseV1Dot1

NameDescriptionSchemaDefault
vpn_tunnel
required

VpnTunnelDetailWithStatusV1Dot1

10.2.38 - VpnTunnelV1Dot1

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
description
required
설명
Example : Example Description for VPN Tunnel
any of [string, null]
id
required
ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
VPN Tunnel 이름
Example : ExampleVpnTunnel1
string
phase1
required
VPN Tunnel Phase1
VpnPhase1V1Dot1
phase2
required
VPN Tunnel Phase2
VpnPhase2V1Dot1
state
required
상태
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)
vpc_id
required
VPC ID
Example : ceb44ea5ecb34a49b16495f9a63b0718
string
vpc_name
required
VPC 명
Example : ExampleVPC1
string
vpn_gateway_id
required
VPN Gateway ID
Example : b156740b6335468d8354eb9ef8eddf5a
string
vpn_gateway_ip_address
required
VPN Gateway IP 주소
Example : 123.0.0.1
string
vpn_gateway_name
required
VPN Gateway Name
Example : ExampleVpnGW1
string