Load Balancer
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.
본 가이드는 LOADBALANCER 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다.
API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.
Version
| Version | Status | Supported Until |
|---|
| 1.0 | DEPRECATED | 20251023 |
| 1.1 | DEPRECATED | 20260331 |
| 1.2 | CURRENT | - |
OpenAPI URL
https://loadbalancer.{region}.{environment}.samsungsdscloud.com
Environment and Region List
| environment | region |
|---|
| s | kr-west1 |
| s | kr-east1 |
| g | kr-south1 |
| g | kr-south2 |
| g | kr-south3 |
| e | kr-west1 |
| e | kr-east1 |
1 - APIs
1.1 - AddLbServerGroupMembers
1.1.1 - 1.2
post /v1/lb-server-groups/{lb_server_group_id}/members
Description
Member를 생성한다
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id required | Lb Server Group ID Example :
| string | None |
| body | body required |
| MemberListCreateRequestV1Dot1 | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | MemberListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/lb-server-groups/{lb_server_group_id}/members
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"
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": ""
}
]
}
1.1.2 - 1.1
post /v1/lb-server-groups/{lb_server_group_id}/members
Description
Member를 생성한다
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id required | Lb Server Group ID Example :
| string | None |
| body | body required |
| MemberListCreateRequestV1Dot1 | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | MemberListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/lb-server-groups/{lb_server_group_id}/members
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"
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": ""
}
]
}
1.2 - CreateLBHealthCheck
1.2.1 - 1.2
post /v1/lb-health-checks
Description
LB 헬스 체크를 생성한다
상태
ACTIVE (CURRENT)
Parameters
Responses
Example HTTP request
Request path
/v1/lb-health-checks
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"
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"
}
}
1.2.2 - 1.1
post /v1/lb-health-checks
Description
LB 헬스 체크를 생성한다
상태
ACTIVE (DEPRECATED)
Parameters
Responses
Example HTTP request
Request path
/v1/lb-health-checks
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"
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"
}
}
1.3 - CreateLbListener
1.3.1 - 1.2
post /v1/lb-listeners
Description
Listener를 생성한다
상태
ACTIVE (CURRENT)
Parameters
Responses
Example HTTP request
Request path
/v1/lb-listeners
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"
Request body
{
"listener": {
"condition_type": "URL_PATH",
"description": "",
"https_redirection": {
"port": "",
"protocol": "",
"response_code": ""
},
"insert_client_ip": "",
"loadbalancer_id": "",
"name": "",
"persistence": "",
"protocol": "",
"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": "",
"https_redirection": {
"port": "",
"protocol": "",
"response_code": ""
},
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"insert_client_ip": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"persistence": "",
"protocol": "",
"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": ""
}
}
1.3.2 - 1.1
post /v1/lb-listeners
Description
Listener를 생성한다
상태
ACTIVE (DEPRECATED)
Parameters
Responses
Example HTTP request
Request path
/v1/lb-listeners
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"
Request body
{
"listener": {
"condition_type": "URL_PATH",
"description": "",
"https_redirection": {
"port": "",
"protocol": "",
"response_code": ""
},
"insert_client_ip": "",
"loadbalancer_id": "",
"name": "",
"persistence": "",
"protocol": "",
"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": "",
"https_redirection": {
"port": "",
"protocol": "",
"response_code": ""
},
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"insert_client_ip": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"persistence": "",
"protocol": "",
"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": ""
}
}
1.4 - CreateLBServerGroup
1.4.1 - 1.2
post /v1/lb-server-groups
Description
LB 서버 그룹을 생성한다
상태
ACTIVE (CURRENT)
Parameters
Responses
Example HTTP request
Request path
/v1/lb-server-groups
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"
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"
}
}
1.4.2 - 1.1
post /v1/lb-server-groups
Description
LB 서버 그룹을 생성한다
상태
ACTIVE (DEPRECATED)
Parameters
Responses
Example HTTP request
Request path
/v1/lb-server-groups
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"
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"
}
}
1.5 - CreateLoadbalancer
1.5.1 - 1.2
post /v1/loadbalancers
Description
LoadBalancer를 생성한다
상태
ACTIVE (CURRENT)
Parameters
Responses
Example HTTP request
Request path
/v1/loadbalancers
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"
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": ""
}
}
1.5.2 - 1.1
post /v1/loadbalancers
Description
LoadBalancer를 생성한다
상태
ACTIVE (DEPRECATED)
Parameters
Responses
Example HTTP request
Request path
/v1/loadbalancers
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"
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": ""
}
}
1.6 - CreateLoadbalancerPublicNatIp
1.6.1 - 1.2
post /v1/loadbalancers/{loadbalancer_id}/static-nats
Description
LoadBalancer Public NAT를 생성한다
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | loadbalancer_id required | 자원 ID Example :
| string | None |
| body | body required |
| StaticNatCreateRequest | |
Responses
Example HTTP request
Request path
/v1/loadbalancers/{loadbalancer_id}/static-nats
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"
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": ""
}
}
1.6.2 - 1.1
post /v1/loadbalancers/{loadbalancer_id}/static-nats
Description
LoadBalancer Public NAT를 생성한다
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | loadbalancer_id required | 자원 ID Example :
| string | None |
| body | body required |
| StaticNatCreateRequest | |
Responses
Example HTTP request
Request path
/v1/loadbalancers/{loadbalancer_id}/static-nats
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"
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": ""
}
}
1.7 - DeleteLBHealthCheck
1.7.1 - 1.2
delete /v1/lb-health-checks/{lb_health_check_id}
Description
LB 헬스 체크를 삭제한다
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_health_check_id required | LB 헬스 체크 ID Example : e3cd678b11784734bc366148aa37580e
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/lb-health-checks/{lb_health_check_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"
Example HTTP response
Response 204
1.7.2 - 1.1
delete /v1/lb-health-checks/{lb_health_check_id}
Description
LB 헬스 체크를 삭제한다
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_health_check_id required | LB 헬스 체크 ID Example : e3cd678b11784734bc366148aa37580e
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/lb-health-checks/{lb_health_check_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"
Example HTTP response
Response 204
1.8 - DeleteLbListener
1.8.1 - 1.2
delete /v1/lb-listeners/{listener_id}
Description
Listener를 삭제한다
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | listener_id required | Listener 아이디 Example :
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/lb-listeners/{listener_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"
Example HTTP response
Response 204
1.8.2 - 1.1
delete /v1/lb-listeners/{listener_id}
Description
Listener를 삭제한다
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | listener_id required | Listener 아이디 Example :
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/lb-listeners/{listener_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"
Example HTTP response
Response 204
1.9 - DeleteLBServerGroup
1.9.1 - 1.2
delete /v1/lb-server-groups/{lb_server_group_id}
Description
LB 서버 그룹을 삭제한다
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id required | LB 서버 그룹 ID Example : 3d8d8754d0d54683a29f3dcc3dd95d5b
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/lb-server-groups/{lb_server_group_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"
Example HTTP response
Response 202
1.9.2 - 1.1
delete /v1/lb-server-groups/{lb_server_group_id}
Description
LB 서버 그룹을 삭제한다
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id required | LB 서버 그룹 ID Example : 3d8d8754d0d54683a29f3dcc3dd95d5b
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/lb-server-groups/{lb_server_group_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"
Example HTTP response
Response 202
1.10 - DeleteLoadbalancer
1.10.1 - 1.2
delete /v1/loadbalancers/{loadbalancer_id}
Description
LoadBalancer를 삭제한다
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | loadbalancer_id required | 자원 ID Example :
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/loadbalancers/{loadbalancer_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"
Example HTTP response
Response 202
1.10.2 - 1.1
delete /v1/loadbalancers/{loadbalancer_id}
Description
LoadBalancer를 삭제한다
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | loadbalancer_id required | 자원 ID Example :
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/loadbalancers/{loadbalancer_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"
Example HTTP response
Response 202
1.11 - DeleteLoadbalancerPublicNatIp
1.11.1 - 1.2
delete /v1/loadbalancers/{loadbalancer_id}/static-nats
Description
LoadBalancer Public NAT를 삭제한다
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | loadbalancer_id required | 자원 ID Example :
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/loadbalancers/{loadbalancer_id}/static-nats
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"
Example HTTP response
Response 204
1.11.2 - 1.1
delete /v1/loadbalancers/{loadbalancer_id}/static-nats
Description
LoadBalancer Public NAT를 삭제한다
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | loadbalancer_id required | 자원 ID Example :
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/loadbalancers/{loadbalancer_id}/static-nats
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"
Example HTTP response
Response 204
1.12 - ListLBHealthChecks
1.12.1 - 1.2
get /v1/lb-health-checks
Description
LB 헬스 체크 목록을 조회한다.
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | size optional | size Example : 20
| any of [integer, null] | 20 |
| query | page optional | page Example : 0
| any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc
| any of [string, null] | None |
| query | name optional | LB 헬스 체크명 Example : Test-LbMonitor-01
| any of [string, null] | None |
| query | protocol optional | 프로토콜 Example : ['TCP', 'UDP']
| any of [array[enum (TCP, HTTP, HTTPS)], enum (TCP, HTTP, HTTPS), null] | None |
| query | subnet_id optional | Service Subnet ID Example : 60fba45cb6c811efba41ba92e4fe7200
| any of [string, null] | None |
Responses
Example HTTP request
Request path
/v1/lb-health-checks
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"
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"
]
}
1.12.2 - 1.1
get /v1/lb-health-checks
Description
LB 헬스 체크 목록을 조회한다.
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | size optional | size Example : 20
| any of [integer, null] | 20 |
| query | page optional | page Example : 0
| any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc
| any of [string, null] | None |
| query | name optional | LB 헬스 체크명 Example : Test-LbMonitor-01
| any of [string, null] | None |
| query | protocol optional | 프로토콜 Example : ['TCP', 'UDP']
| any of [array[enum (TCP, HTTP, HTTPS)], enum (TCP, HTTP, HTTPS), null] | None |
| query | subnet_id optional | Service Subnet ID Example : 60fba45cb6c811efba41ba92e4fe7200
| any of [string, null] | None |
Responses
Example HTTP request
Request path
/v1/lb-health-checks
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"
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"
]
}
1.13 - ListLbListeners
1.13.1 - 1.2
get /v1/lb-listeners
Description
Listener 목록을 조회한다
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | size optional | size Example : 20
| any of [integer, null] | 20 |
| query | page optional | page Example : 0
| any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc
| any of [string, null] | None |
| query | loadbalancer_id optional | LB 아이디 Example :
| any of [string, null] | None |
| query | state optional | Listener 상태 Example :
| any of [string, null] | None |
| query | name optional | Listener 명 Example :
| any of [string, null] | None |
| query | service_port optional | 서비스 포트 Example :
| any of [integer, null] | None |
| query | protocol optional | 프로토콜 Example : ['TCP', 'UDP']
| any of [array[enum (TCP, UDP, HTTP, HTTPS, TLS)], enum (TCP, UDP, HTTP, HTTPS, TLS), null] | None |
Responses
Example HTTP request
Request path
/v1/lb-listeners
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"
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": "",
"service_port": "",
"state": ""
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
1.13.2 - 1.1
get /v1/lb-listeners
Description
Listener 목록을 조회한다
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | size optional | size Example : 20
| any of [integer, null] | 20 |
| query | page optional | page Example : 0
| any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc
| any of [string, null] | None |
| query | loadbalancer_id optional | LB 아이디 Example :
| any of [string, null] | None |
| query | state optional | Listener 상태 Example :
| any of [string, null] | None |
| query | name optional | Listener 명 Example :
| any of [string, null] | None |
| query | service_port optional | 서비스 포트 Example :
| any of [integer, null] | None |
| query | protocol optional | 프로토콜 Example : ['TCP', 'UDP']
| any of [array[enum (TCP, UDP, HTTP, HTTPS, TLS)], enum (TCP, UDP, HTTP, HTTPS, TLS), null] | None |
Responses
Example HTTP request
Request path
/v1/lb-listeners
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"
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": "",
"service_port": "",
"state": ""
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
1.14 - ListLbServerGroupMembers
1.14.1 - 1.2
get /v1/lb-server-groups/{lb_server_group_id}/members
Description
Member 목록을 조회한다
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id required | Lb Server Group ID Example :
| string | None |
| query | size optional | size Example : 20
| any of [integer, null] | 20 |
| query | page optional | page Example : 0
| any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc
| any of [string, null] | None |
| query | name optional | Member 명 Example :
| any of [string, null] | None |
| query | member_ip optional | Member ID Example :
| any of [string, null] | None |
| query | member_port optional | Member 포트 Example :
| any of [integer, null] | None |
Responses
Example HTTP request
Request path
/v1/lb-server-groups/{lb_server_group_id}/members
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"
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"
]
}
1.14.2 - 1.1
get /v1/lb-server-groups/{lb_server_group_id}/members
Description
Member 목록을 조회한다
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id required | Lb Server Group ID Example :
| string | None |
| query | size optional | size Example : 20
| any of [integer, null] | 20 |
| query | page optional | page Example : 0
| any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc
| any of [string, null] | None |
| query | name optional | Member 명 Example :
| any of [string, null] | None |
| query | member_ip optional | Member ID Example :
| any of [string, null] | None |
| query | member_port optional | Member 포트 Example :
| any of [integer, null] | None |
Responses
Example HTTP request
Request path
/v1/lb-server-groups/{lb_server_group_id}/members
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"
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"
]
}
1.15 - ListLBServerGroups
1.15.1 - 1.2
get /v1/lb-server-groups
Description
LB 서버 그룹 목록을 조회한다
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | size optional | size Example : 20
| any of [integer, null] | 20 |
| query | page optional | page Example : 0
| any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc
| any of [string, null] | None |
| query | name optional | LB 서버 그룹 명 Example : ServerGroup01
| any of [string, null] | None |
| query | protocol optional | 프로토콜 Example : ['TCP', 'UDP']
| any of [array[enum (TCP, UDP)], enum (TCP, UDP), null] | None |
| query | subnet_id optional | Service Subnet ID Example : 60fba45cb6c811efba41ba92e4fe7200
| any of [string, null] | None |
| query | vpc_id optional | VPC ID Example : 8acceeb6920c4fc494490d864f67f0b5
| any of [string, null] | None |
| query | lb_health_check_id optional | LB 헬스 체크 ID Example : 46c681018e33453085ca7c8db54e0076
| string | None |
| query | lb_method optional | 부하 분산 Example : ROUND_ROBIN
| any of [array[enum (ROUND_ROBIN, LEAST_CONNECTION, IP_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION)], enum (ROUND_ROBIN, LEAST_CONNECTION, IP_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION), null] | None |
Responses
Example HTTP request
Request path
/v1/lb-server-groups
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"
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"
]
}
1.15.2 - 1.1
get /v1/lb-server-groups
Description
LB 서버 그룹 목록을 조회한다
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | size optional | size Example : 20
| any of [integer, null] | 20 |
| query | page optional | page Example : 0
| any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc
| any of [string, null] | None |
| query | name optional | LB 서버 그룹 명 Example : ServerGroup01
| any of [string, null] | None |
| query | protocol optional | 프로토콜 Example : ['TCP', 'UDP']
| any of [array[enum (TCP, UDP)], enum (TCP, UDP), null] | None |
| query | subnet_id optional | Service Subnet ID Example : 60fba45cb6c811efba41ba92e4fe7200
| any of [string, null] | None |
| query | vpc_id optional | VPC ID Example : 8acceeb6920c4fc494490d864f67f0b5
| any of [string, null] | None |
| query | lb_health_check_id optional | LB 헬스 체크 ID Example : 46c681018e33453085ca7c8db54e0076
| string | None |
| query | lb_method optional | 부하 분산 Example : ROUND_ROBIN
| any of [array[enum (ROUND_ROBIN, LEAST_CONNECTION, IP_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION)], enum (ROUND_ROBIN, LEAST_CONNECTION, IP_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION), null] | None |
Responses
Example HTTP request
Request path
/v1/lb-server-groups
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"
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"
]
}
1.16 - ListLoadbalancerCertificates
1.16.1 - 1.2
get /v1/loadbalancers/certificates
Description
인증서 목록을 조회한다
상태
ACTIVE (CURRENT)
Responses
Example HTTP request
Request path
/v1/loadbalancers/certificates
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"
Example HTTP response
Response 200
{
"certificates": [
{
"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": "2026-02-11T06:42:52.611Z",
"not_before_dt": "2026-02-11T06:42:52.611Z",
"state": ""
}
],
"count": 20,
"links": [
{
"href": "http://scp.samsungsdscloud.com/v1/notices",
"rel": "self"
}
]
}
1.16.2 - 1.1
get /v1/loadbalancers/certificates
Description
인증서 목록을 조회한다
상태
ACTIVE (DEPRECATED)
Responses
Example HTTP request
Request path
/v1/loadbalancers/certificates
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"
Example HTTP response
Response 200
{
"certificates": [
{
"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": "2026-02-11T06:42:52.611Z",
"not_before_dt": "2026-02-11T06:42:52.611Z",
"state": ""
}
],
"count": 20,
"links": [
{
"href": "http://scp.samsungsdscloud.com/v1/notices",
"rel": "self"
}
]
}
1.17 - ListLoadbalancers
1.17.1 - 1.2
get /v1/loadbalancers
Description
LoadBalancer 목록을 조회한다
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | size optional | size Example : 20
| any of [integer, null] | 20 |
| query | page optional | page Example : 0
| any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc
| any of [string, null] | None |
| query | name optional | LoadBalancer 명 Example :
| any of [string, null] | None |
| query | state optional | The state of the load balancer. Example :
| any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), array[enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)]] | |
| query | service_ip optional | LoadBalancer 서비스 IP Example :
| any of [string, null] | None |
| query | subnet_id optional | Subnet ID Example :
| any of [string, null] | None |
| query | layer_type optional | 계층 타입 Example :
| any of [enum (L4, L7), array[enum (L4, L7)]] | |
| query | vpc_id optional | VPC ID Example :
| any of [string, null] | None |
Responses
Example HTTP request
Request path
/v1/loadbalancers
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"
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"
]
}
1.17.2 - 1.1
get /v1/loadbalancers
Description
LoadBalancer 목록을 조회한다
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | size optional | size Example : 20
| any of [integer, null] | 20 |
| query | page optional | page Example : 0
| any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc
| any of [string, null] | None |
| query | name optional | LoadBalancer 명 Example :
| any of [string, null] | None |
| query | state optional | The state of the load balancer. Example :
| any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), array[enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)]] | |
| query | service_ip optional | LoadBalancer 서비스 IP Example :
| any of [string, null] | None |
| query | subnet_id optional | Subnet ID Example :
| any of [string, null] | None |
| query | layer_type optional | 계층 타입 Example :
| any of [enum (L4, L7), array[enum (L4, L7)]] | |
| query | vpc_id optional | VPC ID Example :
| any of [string, null] | None |
Responses
Example HTTP request
Request path
/v1/loadbalancers
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"
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"
]
}
1.18 - RemoveLbServerGroupMember
1.18.1 - 1.2
delete /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}
Description
Member를 삭제한다
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id required | Lb Server Group ID Example :
| string | None |
| path | member_id required | ID of Member Example :
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/lb-server-groups/{lb_server_group_id}/members/{member_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"
Example HTTP response
Response 202
1.18.2 - 1.1
delete /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}
Description
Member를 삭제한다
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id required | Lb Server Group ID Example :
| string | None |
| path | member_id required | ID of Member Example :
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/lb-server-groups/{lb_server_group_id}/members/{member_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"
Example HTTP response
Response 202
1.19 - RemoveLbServerGroupMembers
1.19.1 - 1.2
delete /v1/lb-server-groups/{lb_server_group_id}/members
Description
Remove Lb Server Group Members
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id required | Lb Server Group ID Example :
| string | None |
| body | body required |
| MemberDeleteBulkRequestV1Dot2 | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/lb-server-groups/{lb_server_group_id}/members
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"
Request body
{
"member_id_list": [
""
]
}
Example HTTP response
Response 202
1.20 - SetLBHealthCheck
1.20.1 - 1.2
put /v1/lb-health-checks/{lb_health_check_id}
Description
LB 헬스 체크를 수정한다.
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_health_check_id required | LB 헬스 체크 ID Example : e3cd678b11784734bc366148aa37580e
| string | None |
| body | body required |
| LbHealthCheckSetRequest | |
Responses
Example HTTP request
Request path
/v1/lb-health-checks/{lb_health_check_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"
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"
}
}
1.20.2 - 1.1
put /v1/lb-health-checks/{lb_health_check_id}
Description
LB 헬스 체크를 수정한다.
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_health_check_id required | LB 헬스 체크 ID Example : e3cd678b11784734bc366148aa37580e
| string | None |
| body | body required |
| LbHealthCheckSetRequest | |
Responses
Example HTTP request
Request path
/v1/lb-health-checks/{lb_health_check_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"
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"
}
}
1.21 - SetLbListener
1.21.1 - 1.2
put /v1/lb-listeners/{listener_id}
Description
리스너 목록을 수정한다
상태
ACTIVE (CURRENT)
Parameters
Responses
Example HTTP request
Request path
/v1/lb-listeners/{listener_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"
Request body
{
"listener": {
"condition_type": "URL_PATH",
"description": "",
"https_redirection": {
"port": "",
"protocol": "",
"response_code": ""
},
"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": "",
"https_redirection": {
"port": "",
"protocol": "",
"response_code": ""
},
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"insert_client_ip": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"persistence": "",
"protocol": "",
"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": ""
}
}
1.21.2 - 1.1
put /v1/lb-listeners/{listener_id}
Description
리스너 목록을 수정한다
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | listener_id required | Listener 아이디 Example :
| string | None |
| body | body required |
| LbListenerSetRequest | |
Responses
Example HTTP request
Request path
/v1/lb-listeners/{listener_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"
Request body
{
"listener": {
"condition_type": "URL_PATH",
"description": "",
"https_redirection": {
"port": "",
"protocol": "",
"response_code": ""
},
"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": "",
"https_redirection": {
"port": "",
"protocol": "",
"response_code": ""
},
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"insert_client_ip": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"persistence": "",
"protocol": "",
"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": ""
}
}
1.22 - SetLBServerGroup
1.22.1 - 1.2
put /v1/lb-server-groups/{lb_server_group_id}
Description
LB 서버 그룹을 수정한다
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id required | LB 서버 그룹 ID Example : 3d8d8754d0d54683a29f3dcc3dd95d5b
| string | None |
| body | body required |
| LbServerGroupSetRequest | |
Responses
Example HTTP request
Request path
/v1/lb-server-groups/{lb_server_group_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"
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"
}
}
1.22.2 - 1.1
put /v1/lb-server-groups/{lb_server_group_id}
Description
LB 서버 그룹을 수정한다
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id required | LB 서버 그룹 ID Example : 3d8d8754d0d54683a29f3dcc3dd95d5b
| string | None |
| body | body required |
| LbServerGroupSetRequest | |
Responses
Example HTTP request
Request path
/v1/lb-server-groups/{lb_server_group_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"
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"
}
}
1.23 - SetLbServerGroupMember
1.23.1 - 1.2
put /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}
Description
Member를 수정한다
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id required | Lb Server Group ID Example :
| string | None |
| path | member_id required | ID of Member Example :
| string | None |
| body | body required |
| MemberSetRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | MemberShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/lb-server-groups/{lb_server_group_id}/members/{member_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"
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": ""
}
}
1.23.2 - 1.1
put /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}
Description
Member를 수정한다
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id required | Lb Server Group ID Example :
| string | None |
| path | member_id required | ID of Member Example :
| string | None |
| body | body required |
| MemberSetRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | MemberShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/lb-server-groups/{lb_server_group_id}/members/{member_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"
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": ""
}
}
1.24 - SetLoadbalancer
1.24.1 - 1.1
put /v1/loadbalancers/{loadbalancer_id}
Description
LoadBalancer를 수정한다
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | loadbalancer_id required | 자원 ID Example :
| string | None |
| body | body required |
| LoadbalancerUpdateRequest | |
Responses
Example HTTP request
Request path
/v1/loadbalancers/{loadbalancer_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"
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": ""
}
}
1.25 - ShowLBHealthCheck
1.25.1 - 1.2
get /v1/lb-health-checks/{lb_health_check_id}
Description
LB 헬스 체크를 상세 조회한다.
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_health_check_id required | LB 헬스 체크 ID Example : e3cd678b11784734bc366148aa37580e
| string | None |
Responses
Example HTTP request
Request path
/v1/lb-health-checks/{lb_health_check_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"
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"
}
}
1.25.2 - 1.1
get /v1/lb-health-checks/{lb_health_check_id}
Description
LB 헬스 체크를 상세 조회한다.
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_health_check_id required | LB 헬스 체크 ID Example : e3cd678b11784734bc366148aa37580e
| string | None |
Responses
Example HTTP request
Request path
/v1/lb-health-checks/{lb_health_check_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"
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"
}
}
1.26 - ShowLbListener
1.26.1 - 1.2
get /v1/lb-listeners/{listener_id}
Description
Listener를 조회한다
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | listener_id required | Listener 아이디 Example :
| string | None |
Responses
Example HTTP request
Request path
/v1/lb-listeners/{listener_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"
Example HTTP response
Response 200
{
"listener": {
"condition_type": "URL_PATH",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"https_redirection": {
"port": "",
"protocol": "",
"response_code": ""
},
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"insert_client_ip": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"persistence": "",
"protocol": "",
"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": ""
}
}
1.26.2 - 1.1
get /v1/lb-listeners/{listener_id}
Description
Listener를 조회한다
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | listener_id required | Listener 아이디 Example :
| string | None |
Responses
Example HTTP request
Request path
/v1/lb-listeners/{listener_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"
Example HTTP response
Response 200
{
"listener": {
"condition_type": "URL_PATH",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"https_redirection": {
"port": "",
"protocol": "",
"response_code": ""
},
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"insert_client_ip": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"persistence": "",
"protocol": "",
"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": ""
}
}
1.27 - ShowLBServerGroup
1.27.1 - 1.2
get /v1/lb-server-groups/{lb_server_group_id}
Description
LB 서버 그룹을 조회한다.
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id required | LB 서버 그룹 ID Example : 3d8d8754d0d54683a29f3dcc3dd95d5b
| string | None |
Responses
Example HTTP request
Request path
/v1/lb-server-groups/{lb_server_group_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"
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"
}
}
1.27.2 - 1.1
get /v1/lb-server-groups/{lb_server_group_id}
Description
LB 서버 그룹을 조회한다.
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id required | LB 서버 그룹 ID Example : 3d8d8754d0d54683a29f3dcc3dd95d5b
| string | None |
Responses
Example HTTP request
Request path
/v1/lb-server-groups/{lb_server_group_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"
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"
}
}
1.28 - ShowLbServerGroupMember
1.28.1 - 1.2
get /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}
Description
Member를 조회한다.
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id required | Lb Server Group ID Example :
| string | None |
| path | member_id required | ID of Member Example :
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | MemberShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/lb-server-groups/{lb_server_group_id}/members/{member_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"
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": ""
}
}
1.28.2 - 1.1
get /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}
Description
Member를 조회한다.
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id required | Lb Server Group ID Example :
| string | None |
| path | member_id required | ID of Member Example :
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | MemberShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/lb-server-groups/{lb_server_group_id}/members/{member_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"
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": ""
}
}
1.29 - ShowLoadbalancer
1.29.1 - 1.2
get /v1/loadbalancers/{loadbalancer_id}
Description
LoadBalancer를 조회한다
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | loadbalancer_id required | 자원 ID Example :
| string | None |
Responses
Example HTTP request
Request path
/v1/loadbalancers/{loadbalancer_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"
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": ""
}
}
1.29.2 - 1.1
get /v1/loadbalancers/{loadbalancer_id}
Description
LoadBalancer를 조회한다
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | loadbalancer_id required | 자원 ID Example :
| string | None |
Responses
Example HTTP request
Request path
/v1/loadbalancers/{loadbalancer_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"
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": ""
}
}
1.30 - ShowLoadbalancerCertificate
1.30.1 - 1.2
get /v1/loadbalancers/certificates/{lb_certificate_id}
Description
인증서를 조회한다
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_certificate_id required | 인증서 아이디 Example :
| string | None |
Responses
Example HTTP request
Request path
/v1/loadbalancers/certificates/{lb_certificate_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"
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": "2026-02-11T06:42:52.642Z",
"not_before_dt": "2026-02-11T06:42:52.642Z",
"organization": "",
"private_key": "",
"state": ""
}
}
1.30.2 - 1.1
get /v1/loadbalancers/certificates/{lb_certificate_id}
Description
인증서를 조회한다
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_certificate_id required | 인증서 아이디 Example :
| string | None |
Responses
Example HTTP request
Request path
/v1/loadbalancers/certificates/{lb_certificate_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"
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": "2026-02-11T06:42:52.642Z",
"not_before_dt": "2026-02-11T06:42:52.642Z",
"organization": "",
"private_key": "",
"state": ""
}
}
1.31 - ShowLoadbalancerPublicNatIp
1.31.1 - 1.2
get /v1/loadbalancers/{loadbalancer_id}/static-nats
Description
Show Load Balancer Public NAT IP
상태
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | loadbalancer_id required | 자원 ID Example :
| string | None |
Responses
Example HTTP request
Request path
/v1/loadbalancers/{loadbalancer_id}/static-nats
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.2"
Example HTTP response
Response 200
{
"static_nat": {
"external_ip_address": "",
"publicip_id": "",
"state": ""
}
}
1.31.2 - 1.1
get /v1/loadbalancers/{loadbalancer_id}/static-nats
Description
Show Load Balancer Public NAT IP
상태
ACTIVE (DEPRECATED)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | loadbalancer_id required | 자원 ID Example :
| string | None |
Responses
Example HTTP request
Request path
/v1/loadbalancers/{loadbalancer_id}/static-nats
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loadbalancer 1.1"
Example HTTP response
Response 200
{
"static_nat": {
"external_ip_address": "",
"publicip_id": "",
"state": ""
}
}
2 - Models
2.1 - HttpsRedirection
| Name | Description | Schema | Default |
|---|
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] | |
2.2 - LbCertificate
| Name | Description | Schema | Default |
|---|
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 : 2026-02-11T06:42:52.611Z
| string (date-time) | |
not_before_dt optional | Example : 2026-02-11T06:42:52.611Z
| string (date-time) | |
state optional | Example :
| string | |
2.3 - LbCertificateForShow
| Name | Description | Schema | Default |
|---|
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 : 2026-02-11T06:42:52.642Z
| string (date-time) | |
not_before_dt optional | Example : 2026-02-11T06:42:52.642Z
| string (date-time) | |
organization required | The organization of the certificate Example :
| string | |
private_key required | 인증서 개인키 Example :
| string | |
state optional | Example :
| string | |
2.4 - LbCertificateListResponse
| Name | Description | Schema | Default |
|---|
certificates required |
| array[LbCertificate] | |
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] | |
2.5 - LbCertificateShowResponse
2.6 - LbHealthCheckCreate
| Name | Description | Schema | Default |
|---|
description optional | 설명 Example : this is an lb server group
| any of [string, null] | |
health_check_count optional | 탐지 횟수 Example : 3 Minimum : 1 Maximum : 10
| integer | 3 |
health_check_interval optional | 헬스 체크 주기가 유효하지 않습니다. 입력 조건을 확인하세요. Example : 5 Minimum : 1 Maximum : 180
| integer | 5 |
health_check_port optional | 헬스 체크 포트 Example : 80
| any of [integer, null] | |
health_check_timeout optional | 대기 시간 Example : 5 Minimum : 1 Maximum : 180
| integer | 5 |
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 | |
2.7 - LbHealthCheckCreateRequest
2.8 - LbHealthCheckList
| Name | Description | Schema | Default |
|---|
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 | |
2.9 - LbHealthCheckListResponse
| Name | Description | Schema | Default |
|---|
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] | |
2.10 - LbHealthCheckSet
| Name | Description | Schema | Default |
|---|
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] | |
2.11 - LbHealthCheckSetRequest
2.12 - LbHealthCheckShow
| Name | Description | Schema | Default |
|---|
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
| integer | 3 |
health_check_interval optional | 헬스 체크 주기가 유효하지 않습니다. 입력 조건을 확인하세요. Example : 5
| integer | 5 |
health_check_port required | 헬스 체크 포트 Example : 80
| any of [integer, null] | |
health_check_timeout optional | 대기 시간 Example : 5
| integer | 5 |
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] | |
2.13 - LbHealthCheckShowResponse
2.14 - LbListenerCreateRequest
2.15 - LbListenerCreateRequestV1Dot2
2.16 - LbListenerListResponse
| Name | Description | Schema | Default |
|---|
count required | count Example : 20
| integer | |
listeners required | 리스너 목록
| 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] | |
2.17 - LbListenerSetRequest
2.18 - LbListenerSetRequestV1Dot2
2.19 - LbListenerShowResponse
2.20 - LbServerGroup
| Name | Description | Schema | Default |
|---|
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, IP_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 | |
2.21 - LbServerGroupCreate
| Name | Description | Schema | Default |
|---|
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, IP_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 | |
2.22 - LbServerGroupCreateRequest
2.23 - LbServerGroupList
| Name | Description | Schema | Default |
|---|
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 | |
2.24 - LbServerGroupListResponse
| Name | Description | Schema | Default |
|---|
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] | |
2.25 - LbServerGroupSet
| Name | Description | Schema | Default |
|---|
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, IP_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION), null] | |
2.26 - LbServerGroupSetRequest
2.27 - LbServerGroupShowResponse
2.28 - ListenerForCreate
| Name | Description | Schema | Default |
|---|
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] | |
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 :
| string | |
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] | |
2.29 - ListenerForList
| Name | Description | Schema | Default |
|---|
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 :
| string | |
service_port required | 서비스 포트 Example : Minimum : 1 Maximum : 65534
| integer | |
state optional | Listener 상태 Example :
| any of [string, null] | |
2.30 - ListenerForSet
| Name | Description | Schema | Default |
|---|
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] | |
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 [SslCertificate, 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] | |
2.31 - ListenerForShow
| Name | Description | Schema | Default |
|---|
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] | |
https_redirection optional | The https redirection of the listener.
| any of [HttpsRedirection, null] | |
id required | 자원 ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
| string | |
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 :
| string | |
response_timeout optional | 응답 시간 초과 Example :
| any of [integer, null] | |
routing_action optional | The routing action of the listener. Example : LB_SERVER_GROUP
| any of [enum (LB_SERVER_GROUP, URL_REDIRECT), null] | |
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] | |
2.32 - Loadbalancer
| Name | Description | Schema | Default |
|---|
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 | |
2.33 - LoadbalancerCreateRequest
2.34 - LoadbalancerCreateRequestDetail
| Name | Description | Schema | Default |
|---|
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 | |
2.35 - LoadbalancerCreateResponse
2.36 - LoadbalancerCreateResponseDetail
| Name | Description | Schema | Default |
|---|
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 | |
2.37 - LoadbalancerListResponse
| Name | Description | Schema | Default |
|---|
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] | |
2.38 - LoadbalancerListResponseDetail
| Name | Description | Schema | Default |
|---|
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] | |
2.39 - LoadbalancerShowResponse
| Name | Description | Schema | Default |
|---|
loadbalancer required |
| Loadbalancer | |
2.40 - LoadbalancerStaticNatResponse
| Name | Description | Schema | Default |
|---|
static_nat required |
| StaticNat | |
2.41 - LoadbalancerUpdateRequest
2.42 - LoadbalancerUpdateRequestDetail
| Name | Description | Schema | Default |
|---|
description required | 설명 Example : Maximum length : 255
| string | |
2.43 - Member
| Name | Description | Schema | Default |
|---|
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 | |
2.44 - MemberCreateRequestV1Dot1
| Name | Description | Schema | Default |
|---|
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 | |
2.45 - MemberDeleteBulkRequestV1Dot2
| Name | Description | Schema | Default |
|---|
member_id_list required | ID list of Member
| array[string] | |
2.46 - MemberListCreateRequestV1Dot1
2.47 - MemberListResponse
| Name | Description | Schema | Default |
|---|
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] | |
2.48 - MemberSet
| Name | Description | Schema | Default |
|---|
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] | |
2.49 - MemberSetRequest
| Name | Description | Schema | Default |
|---|
member required |
| MemberSet | |
2.50 - MemberShowResponse
| Name | Description | Schema | Default |
|---|
member required |
| any of [Member, null] | |
2.51 - MemberWithHealthState
| Name | Description | Schema | Default |
|---|
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) | |
2.52 - MemberWithHealthStateListResponse
| Name | Description | Schema | Default |
|---|
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] | |
2.53 - SniCertificate
| Name | Description | Schema | Default |
|---|
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] | |
2.54 - SslCertificate
| Name | Description | Schema | Default |
|---|
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] | |
2.55 - StaticNat
| Name | Description | Schema | Default |
|---|
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 | |
2.56 - StaticNatCreateRequest
2.57 - StaticNatCreateRequestDetail
| Name | Description | Schema | Default |
|---|
publicip_id required | publicip_id Example :
| string | |
2.58 - StaticNatCreateResponse
2.59 - StaticNatCreateResponseDetail
| Name | Description | Schema | Default |
|---|
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] | |
2.60 - Tag
| Name | Description | Schema | Default |
|---|
key required | tag key Example :
| string | |
value required | tag value Example :
| string | |