Load Balancer
Overview
Provides an Application Programming Interface (API) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of LOADBALANCER service and how to call API.
The API is provided as a RESTful API, and it responds in JSON format.
Version
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Status | Not Before |
|---|
| 1.3 | CURRENT | - |
| 1.2 | DEPRECATED | 20260319 |
| 1.1 | DEPRECATED | 20260319 |
| 1.0 | DEPRECATED | 20251023 |
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.3
post /v1/lb-server-groups/{lb_server_group_id}/members
Description
Add Lb Server Group Member bulk
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id
required | ID of Lb Server Group
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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Request body
{
"members": [
{
"member_ip": "192.168.0.1",
"member_port": 80,
"member_state": "ENABLE",
"member_weight": 100,
"name": "virtualserver-1",
"object_id": "1",
"object_type": "VM"
}
]
}
Example HTTP response
Response 202
{
"count": 20,
"links": [
{
"href": "http://scp.samsungsdscloud.com/v1/notices",
"rel": "self"
}
],
"members": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"lb_server_group_id": "",
"member_ip": "",
"member_port": "",
"member_state": "",
"member_weight": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"object_id": "",
"object_type": "VM",
"state": "CREATING",
"subnet_id": "",
"uuid": ""
}
]
}
1.1.2 - 1.2
post /v1/lb-server-groups/{lb_server_group_id}/members
Description
Add Lb Server Group Member bulk
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.2 | 20260319 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id
required | ID of Lb Server Group
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 = en-US",
"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.3 - 1.1
post /v1/lb-server-groups/{lb_server_group_id}/members
Description
Add Lb Server Group Member bulk
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.1 | 20260319 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id
required | ID of Lb Server Group
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 = en-US",
"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.3
post /v1/lb-health-checks
Description
Create LB Health Check
State
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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Request body
{
"lb_health_check": {
"description": "this is an lb server group",
"health_check_count": 3,
"health_check_interval": 5,
"health_check_port": 80,
"health_check_timeout": 5,
"health_check_url": "/test",
"http_method": "GET",
"name": "ServerGroup01",
"protocol": "TCP",
"request_data": "username=admin&password=1234",
"response_code": "200",
"subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
"tags": [],
"vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
}
}
Example HTTP response
Response 201
{
"lb_health_check": {
"account_id": "e3cd678b11784734bc366148aa37580e",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "this is an lb server group",
"health_check_count": 3,
"health_check_interval": 5,
"health_check_port": 80,
"health_check_timeout": 5,
"health_check_type": "DEFAULT",
"health_check_url": "/test",
"http_method": "GET",
"id": "46c681018e33453085ca7c8db54e0076",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "Test-LbMonitor-01",
"protocol": "TCP",
"request_data": "username=admin&password=1234",
"response_code": "200",
"state": "ACTIVE",
"subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
"vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
}
}
1.2.2 - 1.2
post /v1/lb-health-checks
Description
Create LB Health Check
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.2 | 20260319 |
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 = en-US",
"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.3 - 1.1
post /v1/lb-health-checks
Description
Create LB Health Check
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.1 | 20260319 |
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 = en-US",
"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.3
post /v1/lb-listeners
Description
create LB listener
State
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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Request body
{
"listener": {
"condition_type": "URL_PATH",
"description": "",
"hsts_max_age": "",
"https_redirection": {
"port": "",
"protocol": "",
"response_code": ""
},
"idle_timeout": "",
"insert_client_ip": "",
"loadbalancer_id": "",
"name": "",
"persistence": "",
"protocol": "TCP",
"response_timeout": "",
"routing_action": "LB_SERVER_GROUP",
"server_group_id": "",
"service_port": "",
"session_duration_time": "",
"sni_certificate": [
{
"domain_name": "",
"not_after_dt": "",
"sni_cert_id": ""
}
],
"ssl_certificate": {
"client_cert_id": "",
"client_cert_level": "",
"server_cert_level": ""
},
"support_http2": false,
"tags": [],
"url_handler": "",
"url_redirection": "",
"x_forwarded_for": "",
"x_forwarded_port": "",
"x_forwarded_proto": ""
}
}
Example HTTP response
Response 201
{
"listener": {
"condition_type": "URL_PATH",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"hsts_max_age": "",
"https_redirection": {
"port": "",
"protocol": "",
"response_code": ""
},
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"idle_timeout": "",
"insert_client_ip": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"persistence": "",
"protocol": "TCP",
"response_timeout": "",
"routing_action": "LB_SERVER_GROUP",
"server_group_id": "",
"server_group_name": "",
"service_port": "",
"session_duration_time": "",
"sni_certificate": [
{
"domain_name": "",
"not_after_dt": "",
"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.2
post /v1/lb-listeners
Description
create LB listener
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.2 | 20260319 |
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 = en-US",
"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": "",
"not_after_dt": "",
"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": "",
"not_after_dt": "",
"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.3 - 1.1
post /v1/lb-listeners
Description
create LB listener
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.1 | 20260319 |
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 = en-US",
"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": "",
"not_after_dt": "",
"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": "",
"not_after_dt": "",
"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.3
post /v1/lb-server-groups
Description
Create LB Server Group
State
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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Request body
{
"lb_server_group": {
"description": "this is an lb server group",
"lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
"lb_method": "ROUND_ROBIN",
"name": "ServerGroup01",
"protocol": "TCP",
"subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
"tags": [],
"vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
}
}
Example HTTP response
Response 202
{
"lb_server_group": {
"account_id": "e3cd678b11784734bc366148aa37580e",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "this is an lb server group",
"id": "3d8d8754d0d54683a29f3dcc3dd95d5b",
"lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
"lb_method": "ROUND_ROBIN",
"lb_name": "Test-LB-01",
"loadbalancer_id": "82efa35c88834bc083020443e57faa10",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "ServerGroup01",
"protocol": "TCP",
"state": "ACTIVE",
"subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
"vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
}
}
1.4.2 - 1.2
post /v1/lb-server-groups
Description
Create LB Server Group
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.2 | 20260319 |
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 = en-US",
"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.3 - 1.1
post /v1/lb-server-groups
Description
Create LB Server Group
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.1 | 20260319 |
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 = en-US",
"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.3
post /v1/loadbalancers
Description
create Load Balancer
State
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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Request body
{
"loadbalancer": {
"description": "",
"firewall_enabled": true,
"firewall_logging_enabled": true,
"health_check_ip_1": "",
"health_check_ip_2": "",
"layer_type": "",
"name": "",
"publicip_id": "",
"service_ip": "",
"source_nat_ip": "",
"subnet_id": "",
"tags": [],
"vpc_id": ""
}
}
Example HTTP response
Response 202
{
"loadbalancer": {
"account_id": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"id": "",
"layer_type": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"state": "",
"subnet_id": "",
"vpc_id": ""
}
}
1.5.2 - 1.2
post /v1/loadbalancers
Description
create Load Balancer
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.2 | 20260319 |
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 = en-US",
"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.3 - 1.1
post /v1/loadbalancers
Description
create Load Balancer
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.1 | 20260319 |
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 = en-US",
"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 - CreateLoadbalancerPrivateNatIp
1.6.1 - 1.3
post /v1/loadbalancers/{loadbalancer_id}/private-static-nats
Description
create Load Balancer Private NAT IP
State
ACTIVE (CURRENT)
Parameters
Responses
Example HTTP request
Request path
/v1/loadbalancers/{loadbalancer_id}/private-static-nats
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Request body
{
"static_nat": {
"private_nat_id": "",
"private_nat_ip_id": ""
}
}
Example HTTP response
Response 202
{
"static_nat": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"external_ip_address": "",
"id": "",
"internal_ip_address": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"private_nat_ip_id": "",
"state": "",
"subnet_id": ""
}
}
1.7 - CreateLoadbalancerPublicNatIp
1.7.1 - 1.3
post /v1/loadbalancers/{loadbalancer_id}/static-nats
Description
create Load Balancer Public NAT IP
State
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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Request body
{
"static_nat": {
"publicip_id": ""
}
}
Example HTTP response
Response 201
{
"static_nat": {
"account_id": "",
"action_type": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"external_ip_address": "",
"id": "",
"internal_ip_address": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"owner_id": "",
"owner_name": "",
"owner_type": "",
"publicip_id": "",
"service_ip_port_id": "",
"state": "",
"subnet_id": "",
"type": "",
"vpc_id": ""
}
}
1.7.2 - 1.2
post /v1/loadbalancers/{loadbalancer_id}/static-nats
Description
create Load Balancer Public NAT IP
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.2 | 20260319 |
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 = en-US",
"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.7.3 - 1.1
post /v1/loadbalancers/{loadbalancer_id}/static-nats
Description
create Load Balancer Public NAT IP
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.1 | 20260319 |
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 = en-US",
"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.8 - DeleteLBHealthCheck
1.8.1 - 1.3
delete /v1/lb-health-checks/{lb_health_check_id}
Description
Delete LB Health Check
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_health_check_id
required | LB Health Check 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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Example HTTP response
Response 204
1.8.2 - 1.2
delete /v1/lb-health-checks/{lb_health_check_id}
Description
Delete LB Health Check
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.2 | 20260319 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_health_check_id
required | LB Health Check 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 = en-US",
"Scp-Api-Version = loadbalancer 1.2"
Example HTTP response
Response 204
1.8.3 - 1.1
delete /v1/lb-health-checks/{lb_health_check_id}
Description
Delete LB Health Check
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.1 | 20260319 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_health_check_id
required | LB Health Check 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 = en-US",
"Scp-Api-Version = loadbalancer 1.1"
Example HTTP response
Response 204
1.9 - DeleteLbListener
1.9.1 - 1.3
delete /v1/lb-listeners/{listener_id}
Description
delete LB listener
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | listener_id
required | The ID of the 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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Example HTTP response
Response 204
1.9.2 - 1.2
delete /v1/lb-listeners/{listener_id}
Description
delete LB listener
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.2 | 20260319 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | listener_id
required | The ID of the 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 = en-US",
"Scp-Api-Version = loadbalancer 1.2"
Example HTTP response
Response 204
1.9.3 - 1.1
delete /v1/lb-listeners/{listener_id}
Description
delete LB listener
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.1 | 20260319 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | listener_id
required | The ID of the 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 = en-US",
"Scp-Api-Version = loadbalancer 1.1"
Example HTTP response
Response 204
1.10 - DeleteLBServerGroup
1.10.1 - 1.3
delete /v1/lb-server-groups/{lb_server_group_id}
Description
Delete LB Server Group
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id
required | LB Server Group 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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Example HTTP response
Response 202
1.10.2 - 1.2
delete /v1/lb-server-groups/{lb_server_group_id}
Description
Delete LB Server Group
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.2 | 20260319 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id
required | LB Server Group 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 = en-US",
"Scp-Api-Version = loadbalancer 1.2"
Example HTTP response
Response 202
1.10.3 - 1.1
delete /v1/lb-server-groups/{lb_server_group_id}
Description
Delete LB Server Group
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.1 | 20260319 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id
required | LB Server Group 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 = en-US",
"Scp-Api-Version = loadbalancer 1.1"
Example HTTP response
Response 202
1.11 - DeleteLoadbalancer
1.11.1 - 1.3
delete /v1/loadbalancers/{loadbalancer_id}
Description
delete Load Balancer
State
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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Example HTTP response
Response 202
1.11.2 - 1.2
delete /v1/loadbalancers/{loadbalancer_id}
Description
delete Load Balancer
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.2 | 20260319 |
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 = en-US",
"Scp-Api-Version = loadbalancer 1.2"
Example HTTP response
Response 202
1.11.3 - 1.1
delete /v1/loadbalancers/{loadbalancer_id}
Description
delete Load Balancer
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.1 | 20260319 |
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 = en-US",
"Scp-Api-Version = loadbalancer 1.1"
Example HTTP response
Response 202
1.12 - DeleteLoadbalancerPrivateNatIp
1.12.1 - 1.3
delete /v1/loadbalancers/{loadbalancer_id}/private-static-nats
Description
delete Load Balancer Private NAT IP
State
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}/private-static-nats
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Example HTTP response
Response 202
1.13 - DeleteLoadbalancerPublicNatIp
1.13.1 - 1.3
delete /v1/loadbalancers/{loadbalancer_id}/static-nats
Description
delete Load Balancer Public NAT IP
State
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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Example HTTP response
Response 204
1.13.2 - 1.2
delete /v1/loadbalancers/{loadbalancer_id}/static-nats
Description
delete Load Balancer Public NAT IP
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.2 | 20260319 |
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 = en-US",
"Scp-Api-Version = loadbalancer 1.2"
Example HTTP response
Response 204
1.13.3 - 1.1
delete /v1/loadbalancers/{loadbalancer_id}/static-nats
Description
delete Load Balancer Public NAT IP
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.1 | 20260319 |
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 = en-US",
"Scp-Api-Version = loadbalancer 1.1"
Example HTTP response
Response 204
1.14 - ListLBHealthChecks
1.14.1 - 1.3
get /v1/lb-health-checks
Description
List LB Health Checks
State
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 Health Check name
Example : Test-LbMonitor-01
| any of [string, null] | None |
| query | protocol
optional | LB Health Check Protocol
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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Example HTTP response
Response 200
{
"count": 20,
"lb_health_checks": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"health_check_type": "DEFAULT",
"id": "46c681018e33453085ca7c8db54e0076",
"lb_server_group_count": 2,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "Test-LbMonitor-01",
"protocol": "TCP",
"state": "ACTIVE",
"subnet_id": "60fba45cb6c811efba41ba92e4fe7200"
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
1.14.2 - 1.2
get /v1/lb-health-checks
Description
List LB Health Checks
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.2 | 20260319 |
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 Health Check name
Example : Test-LbMonitor-01
| any of [string, null] | None |
| query | protocol
optional | LB Health Check Protocol
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 = en-US",
"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.14.3 - 1.1
get /v1/lb-health-checks
Description
List LB Health Checks
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.1 | 20260319 |
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 Health Check name
Example : Test-LbMonitor-01
| any of [string, null] | None |
| query | protocol
optional | LB Health Check Protocol
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 = en-US",
"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.15 - ListLbListeners
1.15.1 - 1.3
get /v1/lb-listeners
Description
get LB listener list
State
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 | The ID of the load balancer.
Example :
| any of [string, null] | None |
| query | state
optional | The State of the listener.
Example :
| any of [string, null] | None |
| query | name
optional | The name of the listener.
Example :
| any of [string, null] | None |
| query | service_port
optional | The port of the listener.
Example :
| any of [integer, null] | None |
| query | protocol
optional | Protocol
Example : ['TCP', 'UDP']
| any of [array[enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY)], enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY), null] | None |
| query | not_protocol
optional | The protocol of the listener to exclude.
Example : TCP
| any of [enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY), 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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Example HTTP response
Response 200
{
"count": 20,
"listeners": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"protocol": "TCP",
"service_port": "",
"state": ""
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
1.15.2 - 1.2
get /v1/lb-listeners
Description
get LB listener list
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.2 | 20260319 |
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 | The ID of the load balancer.
Example :
| any of [string, null] | None |
| query | state
optional | The State of the listener.
Example :
| any of [string, null] | None |
| query | name
optional | The name of the listener.
Example :
| any of [string, null] | None |
| query | service_port
optional | The port of the listener.
Example :
| any of [integer, null] | None |
| query | protocol
optional | Protocol
Example : ['TCP', 'UDP']
| any of [array[enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY)], enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY), null] | None |
| query | not_protocol
optional | The protocol of the listener to exclude.
Example : TCP
| any of [enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY), 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 = en-US",
"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": "TCP",
"service_port": "",
"state": ""
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
1.15.3 - 1.1
get /v1/lb-listeners
Description
get LB listener list
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.1 | 20260319 |
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 | The ID of the load balancer.
Example :
| any of [string, null] | None |
| query | state
optional | The State of the listener.
Example :
| any of [string, null] | None |
| query | name
optional | The name of the listener.
Example :
| any of [string, null] | None |
| query | service_port
optional | The port of the listener.
Example :
| any of [integer, null] | None |
| query | protocol
optional | Protocol
Example : ['TCP', 'UDP']
| any of [array[enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY)], enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY), null] | None |
| query | not_protocol
optional | The protocol of the listener to exclude.
Example : TCP
| any of [enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY), 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 = en-US",
"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": "TCP",
"service_port": "",
"state": ""
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
1.16 - ListLbServerGroupMembers
1.16.1 - 1.3
get /v1/lb-server-groups/{lb_server_group_id}/members
Description
Get Lb Server Group Member List
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id
required | ID of Lb Server Group
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 | Name of Member
Example :
| any of [string, null] | None |
| query | member_ip
optional | IP of Member
Example :
| any of [string, null] | None |
| query | member_port
optional | Protocol port of 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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Example HTTP response
Response 200
{
"count": 20,
"members": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"health_state": "",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"lb_server_group_id": "",
"member_ip": "",
"member_port": "",
"member_state": "",
"member_weight": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"object_id": "",
"object_type": "VM",
"state": "CREATING"
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
1.16.2 - 1.2
get /v1/lb-server-groups/{lb_server_group_id}/members
Description
Get Lb Server Group Member List
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.2 | 20260319 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id
required | ID of Lb Server Group
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 | Name of Member
Example :
| any of [string, null] | None |
| query | member_ip
optional | IP of Member
Example :
| any of [string, null] | None |
| query | member_port
optional | Protocol port of 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 = en-US",
"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.16.3 - 1.1
get /v1/lb-server-groups/{lb_server_group_id}/members
Description
Get Lb Server Group Member List
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.1 | 20260319 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id
required | ID of Lb Server Group
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 | Name of Member
Example :
| any of [string, null] | None |
| query | member_ip
optional | IP of Member
Example :
| any of [string, null] | None |
| query | member_port
optional | Protocol port of 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 = en-US",
"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.17 - ListLBServerGroups
1.17.1 - 1.3
get /v1/lb-server-groups
Description
Get LB Server Group list
State
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 Server Group name
Example : ServerGroup01
| any of [string, null] | None |
| query | protocol
optional | Protocol
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 Health Check ID
Example : 46c681018e33453085ca7c8db54e0076
| string | None |
| query | lb_method
optional | LB Method
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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Example HTTP response
Response 200
{
"count": 20,
"lb_server_groups": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "3d8d8754d0d54683a29f3dcc3dd95d5b",
"lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
"lb_name": "Test-LB-01",
"lb_server_group_member_count": 2,
"loadbalancer_id": "82efa35c88834bc083020443e57faa10",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "ServerGroup01",
"protocol": "TCP",
"state": "ACTIVE",
"vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
1.17.2 - 1.2
get /v1/lb-server-groups
Description
Get LB Server Group list
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.2 | 20260319 |
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 Server Group name
Example : ServerGroup01
| any of [string, null] | None |
| query | protocol
optional | Protocol
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 Health Check ID
Example : 46c681018e33453085ca7c8db54e0076
| string | None |
| query | lb_method
optional | LB Method
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 = en-US",
"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.17.3 - 1.1
get /v1/lb-server-groups
Description
Get LB Server Group list
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.1 | 20260319 |
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 Server Group name
Example : ServerGroup01
| any of [string, null] | None |
| query | protocol
optional | Protocol
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 Health Check ID
Example : 46c681018e33453085ca7c8db54e0076
| string | None |
| query | lb_method
optional | LB Method
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 = en-US",
"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.18 - ListLoadbalancerCertificates
1.18.1 - 1.3
get /v1/loadbalancers/certificates
Description
get Load Balancer certificate list
State
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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Example HTTP response
Response 200
{
"certificates": [
{
"cert_kind": "",
"cn": "",
"created_at": "",
"created_by": "",
"id": "",
"modified_at": "",
"modified_by": "",
"name": "",
"not_after_dt": "2024-01-15T10:30:00.000Z",
"not_before_dt": "2024-01-15T10:30:00.000Z",
"state": ""
}
],
"count": 20,
"links": [
{
"href": "http://scp.samsungsdscloud.com/v1/notices",
"rel": "self"
}
]
}
1.18.2 - 1.2
get /v1/loadbalancers/certificates
Description
get Load Balancer certificate list
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.2 | 20260319 |
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 = en-US",
"Scp-Api-Version = loadbalancer 1.2"
Example HTTP response
Response 200
{
"certificates": [
{
"cert_kind": "",
"cn": "",
"created_at": "",
"created_by": "",
"id": "",
"modified_at": "",
"modified_by": "",
"name": "",
"not_after_dt": "2024-01-15T10:30:00.000Z",
"not_before_dt": "2024-01-15T10:30:00.000Z",
"state": ""
}
],
"count": 20,
"links": [
{
"href": "http://scp.samsungsdscloud.com/v1/notices",
"rel": "self"
}
]
}
1.18.3 - 1.1
get /v1/loadbalancers/certificates
Description
get Load Balancer certificate list
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.1 | 20260319 |
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 = en-US",
"Scp-Api-Version = loadbalancer 1.1"
Example HTTP response
Response 200
{
"certificates": [
{
"cert_kind": "",
"cn": "",
"created_at": "",
"created_by": "",
"id": "",
"modified_at": "",
"modified_by": "",
"name": "",
"not_after_dt": "2024-01-15T10:30:00.000Z",
"not_before_dt": "2024-01-15T10:30:00.000Z",
"state": ""
}
],
"count": 20,
"links": [
{
"href": "http://scp.samsungsdscloud.com/v1/notices",
"rel": "self"
}
]
}
1.19 - ListLoadbalancers
1.19.1 - 1.3
get /v1/loadbalancers
Description
get Load Balancer list
State
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 | The name of the load balancer.
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 | The service IP of the load balancer.
Example :
| any of [string, null] | None |
| query | subnet_id
optional | Subnet ID
Example :
| any of [string, null] | None |
| query | layer_type
optional | Layer type
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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Example HTTP response
Response 200
{
"count": 20,
"loadbalancers": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"firewall_id": "",
"id": "",
"layer_type": "",
"listener_count": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"public_nat_enabled": "",
"service_ip": "",
"source_nat_ip": "",
"state": "",
"subnet_id": "",
"vpc_id": ""
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
1.19.2 - 1.2
get /v1/loadbalancers
Description
get Load Balancer list
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.2 | 20260319 |
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 | The name of the load balancer.
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 | The service IP of the load balancer.
Example :
| any of [string, null] | None |
| query | subnet_id
optional | Subnet ID
Example :
| any of [string, null] | None |
| query | layer_type
optional | Layer type
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 = en-US",
"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.19.3 - 1.1
get /v1/loadbalancers
Description
get Load Balancer list
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.1 | 20260319 |
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 | The name of the load balancer.
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 | The service IP of the load balancer.
Example :
| any of [string, null] | None |
| query | subnet_id
optional | Subnet ID
Example :
| any of [string, null] | None |
| query | layer_type
optional | Layer type
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 = en-US",
"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.20 - RemoveLbServerGroupMember
1.20.1 - 1.3
delete /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}
Description
Remove Lb Server Group Member
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id
required | ID of Lb Server Group
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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Example HTTP response
Response 202
1.20.2 - 1.2
delete /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}
Description
Remove Lb Server Group Member
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.2 | 20260319 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id
required | ID of Lb Server Group
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 = en-US",
"Scp-Api-Version = loadbalancer 1.2"
Example HTTP response
Response 202
1.20.3 - 1.1
delete /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}
Description
Remove Lb Server Group Member
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.1 | 20260319 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id
required | ID of Lb Server Group
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 = en-US",
"Scp-Api-Version = loadbalancer 1.1"
Example HTTP response
Response 202
1.21 - RemoveLbServerGroupMembers
1.21.1 - 1.3
delete /v1/lb-server-groups/{lb_server_group_id}/members
Description
Remove Lb Server Group Members
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id
required | ID of Lb Server Group
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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Request body
{
"member_id_list": [
""
]
}
Example HTTP response
Response 202
1.21.2 - 1.2
delete /v1/lb-server-groups/{lb_server_group_id}/members
Description
Remove Lb Server Group Members
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.2 | 20260319 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id
required | ID of Lb Server Group
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 = en-US",
"Scp-Api-Version = loadbalancer 1.2"
Request body
{
"member_id_list": [
""
]
}
Example HTTP response
Response 202
1.22 - SetLBHealthCheck
1.22.1 - 1.3
put /v1/lb-health-checks/{lb_health_check_id}
Description
Set LB Health Check
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_health_check_id
required | LB Health Check 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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Request body
{
"lb_health_check": {
"description": "this is an lb server group",
"health_check_count": 3,
"health_check_interval": 5,
"health_check_port": 80,
"health_check_timeout": 5,
"health_check_url": "/test",
"http_method": "GET",
"protocol": "TCP",
"request_data": "username=admin&password=1234",
"response_code": "200"
}
}
Example HTTP response
Response 202
{
"lb_health_check": {
"account_id": "e3cd678b11784734bc366148aa37580e",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "this is an lb server group",
"health_check_count": 3,
"health_check_interval": 5,
"health_check_port": 80,
"health_check_timeout": 5,
"health_check_type": "DEFAULT",
"health_check_url": "/test",
"http_method": "GET",
"id": "46c681018e33453085ca7c8db54e0076",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "Test-LbMonitor-01",
"protocol": "TCP",
"request_data": "username=admin&password=1234",
"response_code": "200",
"state": "ACTIVE",
"subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
"vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
}
}
1.22.2 - 1.2
put /v1/lb-health-checks/{lb_health_check_id}
Description
Set LB Health Check
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.2 | 20260319 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_health_check_id
required | LB Health Check 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 = en-US",
"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.22.3 - 1.1
put /v1/lb-health-checks/{lb_health_check_id}
Description
Set LB Health Check
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.1 | 20260319 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_health_check_id
required | LB Health Check 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 = en-US",
"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.23 - SetLbListener
1.23.1 - 1.3
put /v1/lb-listeners/{listener_id}
Description
set loadbalancer listener
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | listener_id
required | The ID of the listener.
Example :
| string | None |
| body | body
required |
| LbListenerSetRequestV1Dot3 | |
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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Request body
{
"listener": {
"condition_type": "URL_PATH",
"description": "",
"hsts_max_age": "",
"https_redirection": {
"port": "",
"protocol": "",
"response_code": ""
},
"idle_timeout": "",
"insert_client_ip": "",
"persistence": "",
"response_timeout": "",
"server_group_id": "",
"session_duration_time": "",
"sni_certificate": [
{
"domain_name": "",
"not_after_dt": "",
"sni_cert_id": ""
}
],
"ssl_certificate": {
"client_cert_id": "",
"client_cert_level": "",
"server_cert_level": ""
},
"support_http2": "",
"url_handler": "",
"url_redirection": "",
"x_forwarded_for": "",
"x_forwarded_port": "",
"x_forwarded_proto": ""
}
}
Example HTTP response
Response 200
{
"listener": {
"condition_type": "URL_PATH",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"hsts_max_age": "",
"https_redirection": {
"port": "",
"protocol": "",
"response_code": ""
},
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"idle_timeout": "",
"insert_client_ip": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"persistence": "",
"protocol": "TCP",
"response_timeout": "",
"routing_action": "LB_SERVER_GROUP",
"server_group_id": "",
"server_group_name": "",
"service_port": "",
"session_duration_time": "",
"sni_certificate": [
{
"domain_name": "",
"not_after_dt": "",
"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.23.2 - 1.2
put /v1/lb-listeners/{listener_id}
Description
set loadbalancer listener
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.2 | 20260319 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | listener_id
required | The ID of the listener.
Example :
| string | None |
| body | body
required |
| LbListenerSetRequestV1Dot2 | |
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 = en-US",
"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": "",
"not_after_dt": "",
"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": "",
"not_after_dt": "",
"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.23.3 - 1.1
put /v1/lb-listeners/{listener_id}
Description
set loadbalancer listener
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.1 | 20260319 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | listener_id
required | The ID of the 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 = en-US",
"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": "",
"routing_action": "LB_SERVER_GROUP",
"server_group_id": "",
"session_duration_time": "",
"sni_certificate": [
{
"domain_name": "",
"not_after_dt": "",
"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": "",
"not_after_dt": "",
"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.24 - SetLBServerGroup
1.24.1 - 1.3
put /v1/lb-server-groups/{lb_server_group_id}
Description
Set LB Server Group
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id
required | LB Server Group 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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Request body
{
"lb_server_group": {
"description": "this is an lb server group",
"lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
"lb_method": "ROUND_ROBIN"
}
}
Example HTTP response
Response 202
{
"lb_server_group": {
"account_id": "e3cd678b11784734bc366148aa37580e",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "this is an lb server group",
"id": "3d8d8754d0d54683a29f3dcc3dd95d5b",
"lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
"lb_method": "ROUND_ROBIN",
"lb_name": "Test-LB-01",
"loadbalancer_id": "82efa35c88834bc083020443e57faa10",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "ServerGroup01",
"protocol": "TCP",
"state": "ACTIVE",
"subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
"vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
}
}
1.24.2 - 1.2
put /v1/lb-server-groups/{lb_server_group_id}
Description
Set LB Server Group
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.2 | 20260319 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id
required | LB Server Group 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 = en-US",
"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.24.3 - 1.1
put /v1/lb-server-groups/{lb_server_group_id}
Description
Set LB Server Group
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.1 | 20260319 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id
required | LB Server Group 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 = en-US",
"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.25 - SetLbServerGroupMember
1.25.1 - 1.3
put /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}
Description
Set Lb Server Group Member
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id
required | ID of Lb Server Group
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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Request body
{
"member": {
"member_port": 80,
"member_state": "ENABLE",
"member_weight": 100
}
}
Example HTTP response
Response 202
{
"member": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"lb_server_group_id": "",
"member_ip": "",
"member_port": "",
"member_state": "",
"member_weight": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"object_id": "",
"object_type": "VM",
"state": "CREATING",
"subnet_id": "",
"uuid": ""
}
}
1.25.2 - 1.2
put /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}
Description
Set Lb Server Group Member
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.2 | 20260319 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id
required | ID of Lb Server Group
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 = en-US",
"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.25.3 - 1.1
put /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}
Description
Set Lb Server Group Member
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.1 | 20260319 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id
required | ID of Lb Server Group
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 = en-US",
"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.26 - SetLoadbalancer
1.26.1 - 1.3
put /v1/loadbalancers/{loadbalancer_id}
Description
Set Load Balancer
State
ACTIVE (CURRENT)
Parameters
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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Request body
{
"loadbalancer": {
"description": ""
}
}
Example HTTP response
Response 202
{
"loadbalancer": {
"account_id": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"firewall_id": "",
"health_check_ip": [
""
],
"id": "",
"layer_type": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"public_nat_enabled": "",
"service_ip": "",
"source_nat_ip": "",
"state": "",
"subnet_id": "",
"vpc_id": ""
}
}
1.26.2 - 1.2
put /v1/loadbalancers/{loadbalancer_id}
Description
Set Load Balancer
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.2 | 20260319 |
Parameters
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 = en-US",
"Scp-Api-Version = loadbalancer 1.2"
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.26.3 - 1.1
put /v1/loadbalancers/{loadbalancer_id}
Description
Set Load Balancer
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.1 | 20260319 |
Parameters
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 = en-US",
"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.27 - ShowLBHealthCheck
1.27.1 - 1.3
get /v1/lb-health-checks/{lb_health_check_id}
Description
Get LB Health Check
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_health_check_id
required | LB Health Check 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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Example HTTP response
Response 200
{
"lb_health_check": {
"account_id": "e3cd678b11784734bc366148aa37580e",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "this is an lb server group",
"health_check_count": 3,
"health_check_interval": 5,
"health_check_port": 80,
"health_check_timeout": 5,
"health_check_type": "DEFAULT",
"health_check_url": "/test",
"http_method": "GET",
"id": "46c681018e33453085ca7c8db54e0076",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "Test-LbMonitor-01",
"protocol": "TCP",
"request_data": "username=admin&password=1234",
"response_code": "200",
"state": "ACTIVE",
"subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
"vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
}
}
1.27.2 - 1.2
get /v1/lb-health-checks/{lb_health_check_id}
Description
Get LB Health Check
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.2 | 20260319 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_health_check_id
required | LB Health Check 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 = en-US",
"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.27.3 - 1.1
get /v1/lb-health-checks/{lb_health_check_id}
Description
Get LB Health Check
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.1 | 20260319 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_health_check_id
required | LB Health Check 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 = en-US",
"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.28 - ShowLbListener
1.28.1 - 1.3
get /v1/lb-listeners/{listener_id}
Description
show LB listener
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | listener_id
required | The ID of the 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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Example HTTP response
Response 200
{
"listener": {
"condition_type": "URL_PATH",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"hsts_max_age": "",
"https_redirection": {
"port": "",
"protocol": "",
"response_code": ""
},
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"idle_timeout": "",
"insert_client_ip": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"persistence": "",
"protocol": "TCP",
"response_timeout": "",
"routing_action": "LB_SERVER_GROUP",
"server_group_id": "",
"server_group_name": "",
"service_port": "",
"session_duration_time": "",
"sni_certificate": [
{
"domain_name": "",
"not_after_dt": "",
"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.28.2 - 1.2
get /v1/lb-listeners/{listener_id}
Description
show LB listener
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.2 | 20260319 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | listener_id
required | The ID of the 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 = en-US",
"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": "",
"not_after_dt": "",
"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.28.3 - 1.1
get /v1/lb-listeners/{listener_id}
Description
show LB listener
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.1 | 20260319 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | listener_id
required | The ID of the 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 = en-US",
"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": "",
"not_after_dt": "",
"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.29 - ShowLBServerGroup
1.29.1 - 1.3
get /v1/lb-server-groups/{lb_server_group_id}
Description
Show LB Server Group
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id
required | LB Server Group 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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Example HTTP response
Response 200
{
"lb_server_group": {
"account_id": "e3cd678b11784734bc366148aa37580e",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "this is an lb server group",
"id": "3d8d8754d0d54683a29f3dcc3dd95d5b",
"lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
"lb_method": "ROUND_ROBIN",
"lb_name": "Test-LB-01",
"loadbalancer_id": "82efa35c88834bc083020443e57faa10",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "ServerGroup01",
"protocol": "TCP",
"state": "ACTIVE",
"subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
"vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
}
}
1.29.2 - 1.2
get /v1/lb-server-groups/{lb_server_group_id}
Description
Show LB Server Group
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.2 | 20260319 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id
required | LB Server Group 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 = en-US",
"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.29.3 - 1.1
get /v1/lb-server-groups/{lb_server_group_id}
Description
Show LB Server Group
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.1 | 20260319 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id
required | LB Server Group 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 = en-US",
"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.30 - ShowLbServerGroupMember
1.30.1 - 1.3
get /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}
Description
Show Lb Server Group Member
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id
required | ID of Lb Server Group
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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Example HTTP response
Response 200
{
"member": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"lb_server_group_id": "",
"member_ip": "",
"member_port": "",
"member_state": "",
"member_weight": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"object_id": "",
"object_type": "VM",
"state": "CREATING",
"subnet_id": "",
"uuid": ""
}
}
1.30.2 - 1.2
get /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}
Description
Show Lb Server Group Member
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.2 | 20260319 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id
required | ID of Lb Server Group
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 = en-US",
"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.30.3 - 1.1
get /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}
Description
Show Lb Server Group Member
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.1 | 20260319 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_server_group_id
required | ID of Lb Server Group
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 = en-US",
"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.31 - ShowLoadbalancer
1.31.1 - 1.3
get /v1/loadbalancers/{loadbalancer_id}
Description
show Load Balancer
State
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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Example HTTP response
Response 200
{
"loadbalancer": {
"account_id": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"firewall_id": "",
"health_check_ip": [
""
],
"id": "",
"layer_type": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"public_nat_enabled": "",
"service_ip": "",
"source_nat_ip": "",
"state": "",
"subnet_id": "",
"vpc_id": ""
}
}
1.31.2 - 1.2
get /v1/loadbalancers/{loadbalancer_id}
Description
show Load Balancer
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.2 | 20260319 |
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 = en-US",
"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.31.3 - 1.1
get /v1/loadbalancers/{loadbalancer_id}
Description
show Load Balancer
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.1 | 20260319 |
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 = en-US",
"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.32 - ShowLoadbalancerCertificate
1.32.1 - 1.3
get /v1/loadbalancers/certificates/{lb_certificate_id}
Description
show Load Balancer certificate
State
ACTIVE (CURRENT)
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_certificate_id
required | The ID of the certificate
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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Example HTTP response
Response 200
{
"certificate": {
"account_id": "",
"cert_body": "",
"cert_chain": "",
"cert_kind": "",
"cn": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"not_after_dt": "2024-01-15T10:30:00.000Z",
"not_before_dt": "2024-01-15T10:30:00.000Z",
"organization": "",
"private_key": "",
"state": ""
}
}
1.32.2 - 1.2
get /v1/loadbalancers/certificates/{lb_certificate_id}
Description
show Load Balancer certificate
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.2 | 20260319 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_certificate_id
required | The ID of the certificate
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 = en-US",
"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": "2024-01-15T10:30:00.000Z",
"not_before_dt": "2024-01-15T10:30:00.000Z",
"organization": "",
"private_key": "",
"state": ""
}
}
1.32.3 - 1.1
get /v1/loadbalancers/certificates/{lb_certificate_id}
Description
show Load Balancer certificate
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.1 | 20260319 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | lb_certificate_id
required | The ID of the certificate
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 = en-US",
"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": "2024-01-15T10:30:00.000Z",
"not_before_dt": "2024-01-15T10:30:00.000Z",
"organization": "",
"private_key": "",
"state": ""
}
}
1.33 - ShowLoadbalancerPrivateNatIp
1.33.1 - 1.3
get /v1/loadbalancers/{loadbalancer_id}/private-static-nats
Description
Show Load Balancer Private NAT IP
State
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}/private-static-nats
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Example HTTP response
Response 200
{
"static_nat": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"external_ip_address": "",
"id": "",
"internal_ip_address": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"private_nat_ip_id": "",
"state": ""
}
}
1.34 - ShowLoadbalancerPublicNatIp
1.34.1 - 1.3
get /v1/loadbalancers/{loadbalancer_id}/static-nats
Description
Show Load Balancer Public NAT IP
State
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 = en-US",
"Scp-Api-Version = loadbalancer 1.3"
Example HTTP response
Response 200
{
"static_nat": {
"external_ip_address": "",
"publicip_id": "",
"state": ""
}
}
1.34.2 - 1.2
get /v1/loadbalancers/{loadbalancer_id}/static-nats
Description
Show Load Balancer Public NAT IP
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.2 | 20260319 |
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 = en-US",
"Scp-Api-Version = loadbalancer 1.2"
Example HTTP response
Response 200
{
"static_nat": {
"external_ip_address": "",
"publicip_id": "",
"state": ""
}
}
1.34.3 - 1.1
get /v1/loadbalancers/{loadbalancer_id}/static-nats
Description
Show Load Balancer Public NAT IP
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.1 | 20260319 |
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 = en-US",
"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 | protocol
Example :
| any of [string, null] | |
response_code
optional | response_code
Example :
| any of [string, null] | |
2.2 - 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 | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
id
required | ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
| string | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
name
optional |
Example :
| string | |
not_after_dt
optional |
Example :
| string (date-time) | |
not_before_dt
optional |
Example :
| string (date-time) | |
organization
required | The organization of the certificate
Example :
| string | |
private_key
required | The private key of the certificate
Example :
| string | |
state
optional |
Example :
| string | |
2.3 - LbCertificateListResponse
| Name | Description | Schema | Default |
|---|
certificates
required |
| array[LbCertificateListResponseDetail] | |
count
optional | total count
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.4 - LbCertificateListResponseDetail
| Name | Description | Schema | Default |
|---|
cert_kind
required | Kind of certificate
Example :
| string | |
cn
required | Common Name of certificate
Example :
| string | |
created_at
optional | Created At
Example :
| any of [string (date-time), null] | |
created_by
optional | Created By
Example :
| any of [string, null] | |
id
required | ID of the certificate
Example :
| string | |
modified_at
optional | Modified At
Example :
| any of [string (date-time), null] | |
modified_by
optional | Modified By
Example :
| any of [string, null] | |
name
required | Name of the certificate
Example :
| string | |
not_after_dt
required | Expiration date and time of the certificate
Example :
| string (date-time) | |
not_before_dt
required | Start date and time when the certificate becomes valid
Example :
| string (date-time) | |
state
required | State of the certificate
Example :
| string | |
2.5 - LbCertificateShowResponse
2.6 - LbHealthCheckCreate
| Name | Description | Schema | Default |
|---|
description
optional | Description
Example : this is an lb server group
| any of [string, null] | |
health_check_count
optional | LB Health Check count
Example : 3
Minimum : 1
Maximum : 10
| integer | 3 |
health_check_interval
optional | LB Health Check interval
Example : 5
Minimum : 1
Maximum : 180
| integer | 5 |
health_check_port
optional | LB Health Check port
Example : 80
| any of [integer, null] | |
health_check_timeout
optional | LB Health Check timeout
Example : 5
Minimum : 1
Maximum : 180
| integer | 5 |
health_check_url
optional | LB Health Check URL
Example : /test
Pattern : ^\/[A-Za-z0-9/._?&=-]*$
| any of [string, null] | |
http_method
optional | LB Health Check HTTP Method
Example : GET
| any of [enum (GET, POST), null] | |
name
required | LB Health Check name
Example : ServerGroup01
Pattern : ^[a-zA-Z0-9][-a-zA-Z0-9_]*[a-zA-Z0-9]$
Minimum length : 3
Maximum length : 63
| string | |
protocol
required | LB Health Check Protocol
Example : TCP
| enum (TCP, HTTP, HTTPS) | |
request_data
optional | LB Health Check Request data
Example : username=admin&password=1234
Pattern : ^[a-zA-Z0-9_\W]*$
| any of [string, null] | |
response_code
optional | LB Health Check Response code
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 | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
health_check_type
required | LB Health Check type
Example : DEFAULT
| enum (DEFAULT, CUSTOM) | |
id
required | LB Health Check ID
Example : 46c681018e33453085ca7c8db54e0076
| string | |
lb_server_group_count
required | LB Server Group count
Example : 2
| integer | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
name
required | LB Health Check name
Example : Test-LbMonitor-01
| string | |
protocol
required | LB Health Check Protocol
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 | Description
Example : this is an lb server group
| any of [string, null] | |
health_check_count
optional | LB Health Check count
Example : 3
| any of [integer, null] | |
health_check_interval
optional | LB Health Check interval
Example : 5
| any of [integer, null] | |
health_check_port
optional | LB Health Check port
Example : 80
| any of [integer, null] | |
health_check_timeout
optional | LB Health Check timeout
Example : 5
| any of [integer, null] | |
health_check_url
optional | LB Health Check URL
Example : /test
Pattern : ^\/[A-Za-z0-9/._?&=-]*$
| any of [string, null] | |
http_method
optional | LB Health Check HTTP Method
Example : GET
| any of [enum (GET, POST), null] | |
protocol
optional | LB Health Check Protocol
Example : TCP
| any of [enum (TCP, HTTP, HTTPS), null] | |
request_data
optional | LB Health Check Request data
Example : username=admin&password=1234
Pattern : ^[a-zA-Z0-9_\W]*$
| any of [string, null] | |
response_code
optional | LB Health Check Response code
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 | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
description
optional | Description
Example : this is an lb server group
| any of [string, null] | |
health_check_count
optional | LB Health Check count
Example : 3
| integer | 3 |
health_check_interval
optional | LB Health Check interval
Example : 5
| integer | 5 |
health_check_port
required | LB Health Check port
Example : 80
| any of [integer, null] | |
health_check_timeout
optional | LB Health Check timeout
Example : 5
| integer | 5 |
health_check_type
required | LB Health Check type
Example : DEFAULT
| enum (DEFAULT, CUSTOM) | |
health_check_url
required | LB Health Check URL
Example : /test
| any of [string, null] | |
http_method
required | LB Health Check HTTP Method
Example : GET
| any of [string, null] | |
id
required | LB Health Check ID
Example : 46c681018e33453085ca7c8db54e0076
| string | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
name
required | LB Health Check name
Example : Test-LbMonitor-01
| string | |
protocol
optional | LB Health Check Protocol
Example : TCP
| enum (TCP, HTTP, HTTPS) | TCP |
request_data
required | LB Health Check Request data
Example : username=admin&password=1234
| any of [string, null] | |
response_code
required | LB Health Check Response code
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 - LbListenerCreateRequestV1Dot3
2.17 - LbListenerListResponse
| Name | Description | Schema | Default |
|---|
count
required | count
Example : 20
| integer | |
listeners
required | The list of the listener.
| array[ListenerForList] | |
page
required | page
Example : 0
| integer | |
size
required | size
Example : 20
| integer | |
sort
optional | sort
Example : ['created_at:asc']
| any of [array[string], null] | |
2.18 - LbListenerSetRequest
2.19 - LbListenerSetRequestV1Dot2
2.20 - LbListenerSetRequestV1Dot3
2.21 - LbListenerShowResponse
2.22 - LbListenerShowResponseV1Dot3
2.23 - LbListenerSslCertificate
| 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.24 - LbServerGroup
| Name | Description | Schema | Default |
|---|
account_id
required | Account ID
Example : e3cd678b11784734bc366148aa37580e
| string | |
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
description
optional | Description
Example : this is an lb server group
| any of [string, null] | |
id
required | LB Server Group ID
Example : 3d8d8754d0d54683a29f3dcc3dd95d5b
| string | |
lb_health_check_id
required | LB Health Check ID
Example : 46c681018e33453085ca7c8db54e0076
| any of [string, null] | |
lb_method
required | LB Method
Example : ROUND_ROBIN
| enum (ROUND_ROBIN, LEAST_CONNECTION, IP_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION) | |
lb_name
optional | Load Balancer name
Example : Test-LB-01
| any of [string, null] | |
loadbalancer_id
optional | Load Balancer ID
Example : 82efa35c88834bc083020443e57faa10
| any of [string, null] | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
name
required | LB Server Group name
Example : ServerGroup01
| string | |
protocol
required | Protocol
Example : TCP
| enum (TCP, UDP) | |
state
required | LB Server Group state
Example : ACTIVE
| string | |
subnet_id
required | Service Subnet ID
Example : 60fba45cb6c811efba41ba92e4fe7200
| string | |
vpc_id
required | VPC ID
Example : 8acceeb6920c4fc494490d864f67f0b5
| string | |
2.25 - LbServerGroupCreate
| Name | Description | Schema | Default |
|---|
description
optional | Description
Example : this is an lb server group
| any of [string, null] | |
lb_health_check_id
optional | LB Health Check ID
Example : 46c681018e33453085ca7c8db54e0076
| any of [string, null] | |
lb_method
required | LB Method
Example : ROUND_ROBIN
| enum (ROUND_ROBIN, LEAST_CONNECTION, IP_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION) | |
name
required | LB Health Check name
Example : ServerGroup01
Pattern : ^[a-zA-Z0-9][-a-zA-Z0-9_]*[a-zA-Z0-9]$
Minimum length : 3
Maximum length : 63
| string | |
protocol
required | Protocol
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.26 - LbServerGroupCreateRequest
2.27 - LbServerGroupList
| Name | Description | Schema | Default |
|---|
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
id
required | LB Server Group ID
Example : 3d8d8754d0d54683a29f3dcc3dd95d5b
| string | |
lb_health_check_id
required | LB Health Check ID
Example : 46c681018e33453085ca7c8db54e0076
| any of [string, null] | |
lb_name
optional | Load Balancer name
Example : Test-LB-01
| any of [string, null] | |
lb_server_group_member_count
required | LB Server Group Member count
Example : 2
| integer | |
loadbalancer_id
optional | Load Balancer ID
Example : 82efa35c88834bc083020443e57faa10
| any of [string, null] | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
name
required | LB Server Group name
Example : ServerGroup01
| string | |
protocol
required | Protocol
Example : TCP
| enum (TCP, UDP) | |
state
required | LB Server Group state
Example : ACTIVE
| string | |
vpc_id
required | VPC ID
Example : 8acceeb6920c4fc494490d864f67f0b5
| string | |
2.28 - 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.29 - LbServerGroupSet
| Name | Description | Schema | Default |
|---|
description
optional | Description
Example : this is an lb server group
| any of [string, null] | |
lb_health_check_id
optional | LB Health Check ID
Example : 46c681018e33453085ca7c8db54e0076
| any of [string, null] | |
lb_method
optional | LB Method
Example : ROUND_ROBIN
| any of [enum (ROUND_ROBIN, LEAST_CONNECTION, IP_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION), null] | |
2.30 - LbServerGroupSetRequest
2.31 - LbServerGroupShowResponse
2.32 - 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 | description
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 | The ID of the load balancer.
Example :
| string | |
name
required | The name of the listener.
Example :
Pattern : ^[a-zA-Z0-9-_]*$
Minimum length : 3
Maximum length : 63
| string | |
persistence
optional | The persistence of the listener.
Example :
| any of [string, null] | |
protocol
required | The protocol of the listener.
Example :
| string | |
response_timeout
optional | The response timeout of the listener.
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 | The ID of the server group.
Example :
| any of [string, null] | |
service_port
required | The port of the listener.
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 | The ssl certificate of the listener.
| 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 | The URL handler of the listener.
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.33 - ListenerForCreateV1Dot2
| 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 | description
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 | The ID of the load balancer.
Example :
| string | |
name
required | The name of the listener.
Example :
Pattern : ^[a-zA-Z0-9-_]*$
Minimum length : 3
Maximum length : 63
| string | |
persistence
optional | The persistence of the listener.
Example :
| any of [string, null] | |
protocol
required | The protocol of the listener.
Example :
| string | |
response_timeout
optional | The response timeout of the listener.
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 | The ID of the server group.
Example :
| any of [string, null] | |
service_port
required | The port of the listener.
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 | The ssl certificate of the listener.
| 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 | The URL handler of the listener.
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.34 - ListenerForCreateV1Dot3
| 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 | description
Example :
| any of [string, null] | |
hsts_max_age
optional | The hsts_max_age of the listener.
Example :
| any of [integer, null] | |
https_redirection
optional | The https redirection of the listener.
| any of [HttpsRedirection, null] | |
idle_timeout
optional | The idle timeout(L7) of the listener.
Example :
| any of [integer, null] | |
insert_client_ip
optional | Whether the client IP should be inserted.
Example :
| any of [boolean, null] | |
loadbalancer_id
required | The ID of the load balancer.
Example :
| string | |
name
required | The name of the listener.
Example :
Pattern : ^[a-zA-Z0-9-_]*$
Minimum length : 3
Maximum length : 63
| string | |
persistence
optional | The persistence of the listener.
Example :
| any of [string, null] | |
protocol
required | The protocol of the listener.
Example : TCP
| enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY) | |
response_timeout
optional | The response timeout of the listener.
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 | The ID of the server group.
Example :
| any of [string, null] | |
service_port
required | The port of the listener.
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 | The ssl certificate of the listener.
| 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 | The URL handler of the listener.
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.35 - ListenerForList
| Name | Description | Schema | Default |
|---|
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
id
required | ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
| string | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
name
required | The name of the listener.
Example :
Pattern : ^[a-zA-Z0-9-_]*$
Minimum length : 3
Maximum length : 63
| string | |
protocol
required | The protocol of the listener.
Example : TCP
| enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY) | |
service_port
required | The port of the listener.
Example :
Minimum : 1
Maximum : 65534
| integer | |
state
optional | The State of the listener.
Example :
| any of [string, null] | |
2.36 - 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 | description
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 | The persistence of the listener.
Example :
| any of [string, null] | |
response_timeout
optional | The response timeout of the listener.
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 | The ID of the server group.
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 | The ssl certificate of the listener.
| any of [LbListenerSslCertificate, null] | |
support_http2
optional | Whether the HTTP 2.0 is supported
Example :
| boolean | |
url_handler
optional | The URL handler of the listener.
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.37 - ListenerForSetV1Dot2
| 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 | description
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 | The persistence of the listener.
Example :
| any of [string, null] | |
response_timeout
optional | The response timeout of the listener.
Example :
| any of [integer, null] | |
server_group_id
optional | The ID of the server group.
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 | The ssl certificate of the listener.
| any of [LbListenerSslCertificate, null] | |
support_http2
optional | Whether the HTTP 2.0 is supported
Example :
| boolean | |
url_handler
optional | The URL handler of the listener.
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.38 - ListenerForSetV1Dot3
| 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 | description
Example :
| any of [string, null] | |
hsts_max_age
optional | The hsts_max_age of the listener.
Example :
| any of [integer, null] | |
https_redirection
optional | The https redirection of the listener.
| any of [HttpsRedirection, null] | |
idle_timeout
optional | The idle timeout(L7) of the listener.
Example :
| any of [integer, null] | |
insert_client_ip
optional | Whether the client IP should be inserted.
Example :
| any of [boolean, null] | |
persistence
optional | The persistence of the listener.
Example :
| any of [string, null] | |
response_timeout
optional | The response timeout of the listener.
Example :
| any of [integer, null] | |
server_group_id
optional | The ID of the server group.
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 | The ssl certificate of the listener.
| any of [LbListenerSslCertificate, null] | |
support_http2
optional | Whether the HTTP 2.0 is supported
Example :
| boolean | |
url_handler
optional | The URL handler of the listener.
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.39 - 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 | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
description
optional | description
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 | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
name
required | The name of the listener.
Example :
Pattern : ^[a-zA-Z0-9-_]*$
Minimum length : 3
Maximum length : 63
| string | |
persistence
optional | The persistence of the listener.
Example :
| any of [string, null] | |
protocol
required | The protocol of the listener.
Example :
| string | |
response_timeout
optional | The response timeout of the listener.
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 | The ID of the server group.
Example :
| any of [string, null] | |
server_group_name
optional | The Name of the server group.
Example :
| any of [string, null] | |
service_port
required | The port of the listener.
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 | The ssl certificate of the listener.
| any of [SslCertificate, null] | |
state
required | The State of the listener.
Example :
| string | |
support_http2
optional | Whether the HTTP 2.0 is supported
Example : False
| any of [boolean, null] | |
url_handler
optional | The URL handler of the listener.
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.40 - ListenerForShowV1Dot3
| 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 | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
description
optional | description
Example :
| any of [string, null] | |
hsts_max_age
optional | The hsts_max_age of the listener.
Example :
| any of [integer, null] | |
https_redirection
optional | The https redirection of the listener.
| any of [HttpsRedirection, null] | |
id
required | ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
| string | |
idle_timeout
optional | The idle timeout(L7) of the listener.
Example :
| any of [integer, null] | |
insert_client_ip
optional | Whether the client IP should be inserted.
Example :
| any of [boolean, null] | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
name
required | The name of the listener.
Example :
Pattern : ^[a-zA-Z0-9-_]*$
Minimum length : 3
Maximum length : 63
| string | |
persistence
optional | The persistence of the listener.
Example :
| any of [string, null] | |
protocol
required | The protocol of the listener.
Example : TCP
| enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY) | |
response_timeout
optional | The response timeout of the listener.
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 | The ID of the server group.
Example :
| any of [string, null] | |
server_group_name
optional | The Name of the server group.
Example :
| any of [string, null] | |
service_port
required | The port of the listener.
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 | The ssl certificate of the listener.
| any of [SslCertificate, null] | |
state
required | The State of the listener.
Example :
| string | |
support_http2
optional | Whether the HTTP 2.0 is supported
Example : False
| any of [boolean, null] | |
url_handler
optional | The URL handler of the listener.
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.41 - Loadbalancer
| Name | Description | Schema | Default |
|---|
account_id
required | The account ID of the load balancer.
Example :
| string | |
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
description
optional | description
Example :
| any of [string, null] | |
firewall_id
optional | Firewall ID
Example :
| any of [string, null] | |
health_check_ip
required | Health check IP
| array[string] | |
id
required | ID
Example :
| string | |
layer_type
required | Layer type
Example :
| string | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
name
required | name
Example :
| string | |
public_nat_enabled
optional | Public NAT Enabled Status
Example :
| any of [boolean, null] | |
service_ip
optional | The service IP of the load balancer.
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.42 - LoadbalancerCreateRequest
2.43 - LoadbalancerCreateRequestDetail
| Name | Description | Schema | Default |
|---|
description
optional | description
Example :
| any of [string, null] | |
firewall_enabled
optional | Firewall enabled
Example : True
| any of [boolean, null] | True |
firewall_logging_enabled
optional | Firewall logging enabled
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 | Layer type
Example :
| string | |
name
required | name
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 | The service IP of the load balancer.
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.44 - LoadbalancerCreateResponse
2.45 - LoadbalancerCreateResponseDetail
| Name | Description | Schema | Default |
|---|
account_id
required | The account ID of the load balancer.
Example :
| string | |
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
description
optional | description
Example :
| any of [string, null] | |
id
required | ID
Example :
| string | |
layer_type
required | Layer type
Example :
| string | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
name
required | name
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.46 - 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.47 - LoadbalancerListResponseDetail
| Name | Description | Schema | Default |
|---|
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
firewall_id
optional | Firewall ID
Example :
| any of [string, null] | |
id
required | ID
Example :
| string | |
layer_type
optional | Layer type
Example :
| any of [string, null] | |
listener_count
optional | The number of listeners.
Example :
| any of [integer, null] | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
name
optional | The name of the load balancer.
Example :
| any of [string, null] | |
public_nat_enabled
optional | Public NAT Enabled Status
Example :
| any of [boolean, null] | |
service_ip
optional | The service IP of the load balancer.
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.48 - LoadbalancerShowResponse
| Name | Description | Schema | Default |
|---|
loadbalancer
required |
| Loadbalancer | |
2.49 - LoadbalancerStaticNatResponse
| Name | Description | Schema | Default |
|---|
static_nat
required |
| StaticNat | |
2.50 - LoadbalancerUpdateRequest
2.51 - LoadbalancerUpdateRequestDetail
| Name | Description | Schema | Default |
|---|
description
required | description
Example :
Maximum length : 255
| string | |
2.52 - Member
| Name | Description | Schema | Default |
|---|
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
id
required | ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
| string | |
lb_server_group_id
required | ID of Lb Server Group
Example :
| string | |
member_ip
required | IP of Member
Example :
| string | |
member_port
required | Protocol port of Member
Example :
| integer | |
member_state
required | Member State of Member
Example :
| string | |
member_weight
required | Weight of Member
Example :
| integer | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
name
required | Name of Member
Example :
| string | |
object_id
optional | Object ID of Member
Example :
| any of [string, null] | |
object_type
required | Object Type of 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 | ID of Subnet
Example :
| string | |
uuid
required | UUID of Member
Example :
| string | |
2.53 - MemberCreateRequestV1Dot1
| Name | Description | Schema | Default |
|---|
member_ip
required | IP of Member
Example : 192.168.0.1
| string | |
member_port
required | Protocol port of 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 | Name of Member
Example : virtualserver-1
Pattern : ^[a-zA-Z0-9\s\-_\.]*$
Minimum length : 1
Maximum length : 63
| string | |
object_id
optional | Object ID of Member
Example : 1
| string | |
object_type
required | Object Type of Member
Example : VM
| string | |
2.54 - MemberDeleteBulkRequestV1Dot2
| Name | Description | Schema | Default |
|---|
member_id_list
required | ID list of Member
| array[string] | |
2.55 - MemberListCreateRequestV1Dot1
2.56 - MemberListResponse
| Name | Description | Schema | Default |
|---|
count
optional | total count
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.57 - MemberSet
| Name | Description | Schema | Default |
|---|
member_port
optional | Protocol port of 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.58 - MemberSetRequest
| Name | Description | Schema | Default |
|---|
member
required |
| MemberSet | |
2.59 - MemberShowResponse
| Name | Description | Schema | Default |
|---|
member
required |
| any of [Member, null] | |
2.60 - MemberWithHealthState
| Name | Description | Schema | Default |
|---|
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
health_state
required | Health State of Member
Example :
| string | |
id
required | ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
| string | |
lb_server_group_id
required | ID of Lb Server Group
Example :
| string | |
member_ip
required | IP of Member
Example :
| string | |
member_port
required | Protocol port of Member
Example :
| integer | |
member_state
required | Member State of Member
Example :
| string | |
member_weight
required | Weight of Member
Example :
| integer | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
name
required | Name of Member
Example :
| string | |
object_id
required | Object ID of Member
Example :
| any of [string, null] | |
object_type
required | Object Type of Member
Example : VM
| enum (VM, BM, MANUAL, MNGC) | |
state
required | State of Member
Example : CREATING
| enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR) | |
2.61 - 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.62 - PrivateStaticNatCreateRequest
2.63 - PrivateStaticNatCreateRequestDetail
| Name | Description | Schema | Default |
|---|
private_nat_id
required | private_nat_id
Example :
| string | |
private_nat_ip_id
required | private_nat_ip_id
Example :
| string | |
2.64 - PrivateStaticNatCreateResponse
2.65 - PrivateStaticNatCreateResponseDetail
| Name | Description | Schema | Default |
|---|
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
external_ip_address
optional | external_ip_address
Example :
| any of [string, null] | |
id
optional | ID
Example :
| any of [string, null] | |
internal_ip_address
optional | internal_ip_address
Example :
| any of [string, null] | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
private_nat_ip_id
optional | private_nat_ip_id
Example :
| any of [string, null] | |
state
optional | state
Example :
| any of [string, null] | |
subnet_id
optional | subnet_id
Example :
| any of [string, null] | |
2.66 - PrivateStaticNatShowResponse
2.67 - PrivateStaticNatShowResponseDetail
| Name | Description | Schema | Default |
|---|
created_at
required | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
external_ip_address
optional | external_ip_address
Example :
| any of [string, null] | |
id
optional | ID
Example :
| any of [string, null] | |
internal_ip_address
optional | internal_ip_address
Example :
| any of [string, null] | |
modified_at
required | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
private_nat_ip_id
optional | private_nat_ip_id
Example :
| any of [string, null] | |
state
optional | state
Example :
| any of [string, null] | |
2.68 - 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] | |
not_after_dt
optional | The expiration date and time of the certificate
Example :
| any of [string (date-time), null] | |
sni_cert_id
optional | Certificate id for sni ssl
Example :
| any of [string, null] | |
2.69 - 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.70 - 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.71 - StaticNatCreateRequest
2.72 - StaticNatCreateRequestDetail
| Name | Description | Schema | Default |
|---|
publicip_id
required | publicip_id
Example :
| string | |
2.73 - StaticNatCreateResponse
2.74 - 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 | Created At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
created_by
required | Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
description
optional | description
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 | Modified At
Example : 2024-05-17T00:23:17Z
| string (date-time) | |
modified_by
required | Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
| string | |
name
optional | name
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.75 - Tag
| Name | Description | Schema | Default |
|---|
key
required | tag key
Example :
| string | |
value
required | tag value
Example :
| string | |