This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

APIs

1: AddLbServerGroupMembers

1.1: 1.4
1.2: 1.3

2: CreateLBHealthCheck

2.1: 1.4
2.2: 1.3

3: CreateLbListener

3.1: 1.4
3.2: 1.3

4: CreateLBServerGroup

4.1: 1.4
4.2: 1.3

5: CreateLoadbalancer

5.1: 1.4
5.2: 1.3

6: CreateLoadbalancerPrivateNatIp

6.1: 1.4
6.2: 1.3

7: CreateLoadbalancerPublicNatIp

7.1: 1.4
7.2: 1.3

8: DeleteLBHealthCheck

8.1: 1.4
8.2: 1.3

9: DeleteLbListener

9.1: 1.4
9.2: 1.3

10: DeleteLBServerGroup

10.1: 1.4
10.2: 1.3

11: DeleteLoadbalancer

11.1: 1.4
11.2: 1.3

12: DeleteLoadbalancerPrivateNatIp

12.1: 1.4
12.2: 1.3

13: DeleteLoadbalancerPublicNatIp

13.1: 1.4
13.2: 1.3

14: ListLBHealthChecks

14.1: 1.4
14.2: 1.3

15: ListLbListeners

15.1: 1.4
15.2: 1.3

16: ListLbServerGroupMembers

16.1: 1.4
16.2: 1.3

17: ListLBServerGroups

17.1: 1.4
17.2: 1.3

18: ListLoadbalancerCertificates

18.1: 1.4
18.2: 1.3

19: ListLoadbalancers

19.1: 1.4
19.2: 1.3

20: RemoveLbServerGroupMember

20.1: 1.4
20.2: 1.3

21: RemoveLbServerGroupMembers

21.1: 1.4
21.2: 1.3

22: SetLBHealthCheck

22.1: 1.4
22.2: 1.3

23: SetLbListener

23.1: 1.3

24: SetLbListenerCertificate

24.1: 1.4

25: SetLbListenerResource

25.1: 1.4

26: SetLbListenerRule

26.1: 1.4

27: SetLBServerGroup

27.1: 1.4
27.2: 1.3

28: SetLbServerGroupMember

28.1: 1.4
28.2: 1.3

29: SetLoadbalancer

29.1: 1.4
29.2: 1.3

30: ShowLBHealthCheck

30.1: 1.4
30.2: 1.3

31: ShowLbListener

31.1: 1.4
31.2: 1.3

32: ShowLBServerGroup

32.1: 1.4
32.2: 1.3

33: ShowLbServerGroupMember

33.1: 1.4
33.2: 1.3

34: ShowLoadbalancer

34.1: 1.4
34.2: 1.3

35: ShowLoadbalancerCertificate

35.1: 1.4
35.2: 1.3

36: ShowLoadbalancerPrivateNatIp

36.1: 1.4
36.2: 1.3

37: ShowLoadbalancerPublicNatIp

37.1: 1.4
37.2: 1.3

1 - AddLbServerGroupMembers

1.1 - 1.4

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

Description

Add Lb Server Group Member bulk

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

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

Request header

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

Request body

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

Example HTTP response

Response 202

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

1.2 - 1.3

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

Description

Add Lb Server Group Member bulk

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

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

Request header

"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": ""
        }
    ]
}

2 - CreateLBHealthCheck

2.1 - 1.4

post /v1/lb-health-checks

Description

Create LB Health Check

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
body	body required		LbHealthCheckCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	LbHealthCheckShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-health-checks

Request header

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

Request body

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

Example HTTP response

Response 202

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

2.2 - 1.3

post /v1/lb-health-checks

Description

Create LB Health Check

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

Parameters

Type	Name	Description	Schema	Default
body	body required		LbHealthCheckCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	LbHealthCheckShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-health-checks

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = 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"
    }
}

3 - CreateLbListener

3.1 - 1.4

post /v1/lb-listeners

Description

create LB listener

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
body	body required		LbListenerCreateRequestV1Dot4

Responses

HTTP Code	Description	Schema
202	Accepted	LbListenerShowResponseV1Dot4
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-listeners

Request header

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

Request body

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

Example HTTP response

Response 202

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

3.2 - 1.3

post /v1/lb-listeners

Description

create LB listener

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

Parameters

Type	Name	Description	Schema	Default
body	body required		LbListenerCreateRequestV1Dot3

Responses

HTTP Code	Description	Schema
201	Created	LbListenerShowResponseV1Dot3
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-listeners

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = 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": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "support_http2": false,
        "tags": [],
        "url_handler": "",
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

Example HTTP response

Response 201

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

4 - CreateLBServerGroup

4.1 - 1.4

post /v1/lb-server-groups

Description

Create LB Server Group

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
body	body required		LbServerGroupCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	LbServerGroupShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-server-groups

Request header

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

Request body

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

Example HTTP response

Response 202

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

4.2 - 1.3

post /v1/lb-server-groups

Description

Create LB Server Group

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

Parameters

Type	Name	Description	Schema	Default
body	body required		LbServerGroupCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	LbServerGroupShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-server-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = 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"
    }
}

5 - CreateLoadbalancer

5.1 - 1.4

post /v1/loadbalancers

Description

create Load Balancer

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
body	body required		LoadbalancerCreateRequestV1Dot4

Responses

HTTP Code	Description	Schema
202	Accepted	LoadbalancerCreateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/loadbalancers

Request header

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

Request body

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

Example HTTP response

Response 202

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

5.2 - 1.3

post /v1/loadbalancers

Description

create Load Balancer

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

Parameters

Type	Name	Description	Schema	Default
body	body required		LoadbalancerCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	LoadbalancerCreateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/loadbalancers

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = 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": ""
    }
}

6 - CreateLoadbalancerPrivateNatIp

6.1 - 1.4

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

Description

create Load Balancer Private NAT IP

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	ID Example :	string	None
body	body required		PrivateStaticNatCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	PrivateStaticNatCreateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 202

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

6.2 - 1.3

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

Description

create Load Balancer Private NAT IP

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	ID Example :	string	None
body	body required		PrivateStaticNatCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	PrivateStaticNatCreateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = 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": ""
    }
}

7 - CreateLoadbalancerPublicNatIp

7.1 - 1.4

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

Description

create Load Balancer Public NAT IP

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	ID Example :	string	None
body	body required		StaticNatCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	StaticNatCreateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 201

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

7.2 - 1.3

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

Description

create Load Balancer Public NAT IP

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	ID Example :	string	None
body	body required		StaticNatCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	StaticNatCreateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = 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": ""
    }
}

8 - DeleteLBHealthCheck

8.1 - 1.4

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

Description

Delete LB Health Check

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

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
202	Accepted	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}

Request header

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

Example HTTP response

Response 202

8.2 - 1.3

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

Description

Delete LB Health Check

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

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}

Request header

"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

9 - DeleteLbListener

9.1 - 1.4

delete /v1/lb-listeners/{listener_id}

Description

delete LB listener

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	listener_id required	The ID of the listener. 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-listeners/{listener_id}

Request header

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

Example HTTP response

Response 202

9.2 - 1.3

delete /v1/lb-listeners/{listener_id}

Description

delete LB listener

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

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}

Request header

"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

10 - DeleteLBServerGroup

10.1 - 1.4

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

Description

Delete LB Server Group

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

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}

Request header

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

Example HTTP response

Response 202

10.2 - 1.3

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

Description

Delete LB Server Group

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

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}

Request header

"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

11 - DeleteLoadbalancer

11.1 - 1.4

delete /v1/loadbalancers/{loadbalancer_id}

Description

delete Load Balancer

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

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}

Request header

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

Example HTTP response

Response 202

11.2 - 1.3

delete /v1/loadbalancers/{loadbalancer_id}

Description

delete Load Balancer

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

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}

Request header

"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

12 - DeleteLoadbalancerPrivateNatIp

12.1 - 1.4

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

Description

delete Load Balancer Private NAT IP

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

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

Request header

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

Example HTTP response

Response 202

12.2 - 1.3

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

Description

delete Load Balancer Private NAT IP

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

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

Request header

"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

13 - DeleteLoadbalancerPublicNatIp

13.1 - 1.4

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

Description

delete Load Balancer Public NAT IP

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

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

Request header

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

Example HTTP response

Response 204

13.2 - 1.3

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

Description

delete Load Balancer Public NAT IP

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

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

Request header

"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

14 - ListLBHealthChecks

14.1 - 1.4

get /v1/lb-health-checks

Description

List LB Health Checks

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

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

HTTP Code	Description	Schema
200	OK	LbHealthCheckListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-health-checks

Request header

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

Example HTTP response

Response 200

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

14.2 - 1.3

get /v1/lb-health-checks

Description

List LB Health Checks

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

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

HTTP Code	Description	Schema
200	OK	LbHealthCheckListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-health-checks

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = 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"
    ]
}

15 - ListLbListeners

15.1 - 1.4

get /v1/lb-listeners

Description

get LB listener list

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

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

HTTP Code	Description	Schema
200	OK	LbListenerListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-listeners

Request header

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

Example HTTP response

Response 200

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

15.2 - 1.3

get /v1/lb-listeners

Description

get LB listener list

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

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

HTTP Code	Description	Schema
200	OK	LbListenerListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-listeners

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = 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"
    ]
}

16 - ListLbServerGroupMembers

16.1 - 1.4

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

Description

Get Lb Server Group Member List

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

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

HTTP Code	Description	Schema
200	OK	MemberWithHealthStateListResponseV1Dot4
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

Request header

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

Example HTTP response

Response 200

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

16.2 - 1.3

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

Description

Get Lb Server Group Member List

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

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

HTTP Code	Description	Schema
200	OK	MemberWithHealthStateListResponse
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

Request header

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

17 - ListLBServerGroups

17.1 - 1.4

get /v1/lb-server-groups

Description

Get LB Server Group list

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

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	state optional	LB Server Group state Example : `ACTIVE`	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, SOURCE_IP_HASH, SOURCE_IP_PORT_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION)], enum (ROUND_ROBIN, LEAST_CONNECTION, SOURCE_IP_HASH, SOURCE_IP_PORT_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION), null]	None

Responses

HTTP Code	Description	Schema
200	OK	LbServerGroupListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-server-groups

Request header

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

Example HTTP response

Response 200

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

17.2 - 1.3

get /v1/lb-server-groups

Description

Get LB Server Group list

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

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	state optional	LB Server Group state Example : `ACTIVE`	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, SOURCE_IP_HASH, SOURCE_IP_PORT_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION)], enum (ROUND_ROBIN, LEAST_CONNECTION, SOURCE_IP_HASH, SOURCE_IP_PORT_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION), null]	None

Responses

HTTP Code	Description	Schema
200	OK	LbServerGroupListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-server-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = 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"
    ]
}

18 - ListLoadbalancerCertificates

18.1 - 1.4

get /v1/loadbalancers/certificates

Description

get Load Balancer certificate list

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Responses

HTTP Code	Description	Schema
200	OK	LbCertificateListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/loadbalancers/certificates

Request header

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

Example HTTP response

Response 200

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

18.2 - 1.3

get /v1/loadbalancers/certificates

Description

get Load Balancer certificate list

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

Responses

HTTP Code	Description	Schema
200	OK	LbCertificateListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/loadbalancers/certificates

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = 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"
        }
    ]
}

19 - ListLoadbalancers

19.1 - 1.4

get /v1/loadbalancers

Description

get Load Balancer list

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

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

HTTP Code	Description	Schema
200	OK	LoadbalancerListResponseV1Dot4
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/loadbalancers

Request header

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

Example HTTP response

Response 200

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

19.2 - 1.3

get /v1/loadbalancers

Description

get Load Balancer list

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

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

HTTP Code	Description	Schema
200	OK	LoadbalancerListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/loadbalancers

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = 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"
    ]
}

20 - RemoveLbServerGroupMember

20.1 - 1.4

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

Description

Remove Lb Server Group Member

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

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}

Request header

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

Example HTTP response

Response 202

20.2 - 1.3

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

Description

Remove Lb Server Group Member

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

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}

Request header

"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

21 - RemoveLbServerGroupMembers

21.1 - 1.4

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

Description

Remove Lb Server Group Members

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

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

Request header

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

Request body

{
    "member_id_list": [
        ""
    ]
}

Example HTTP response

Response 202

21.2 - 1.3

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

Description

Remove Lb Server Group Members

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

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

Request header

"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

22 - SetLBHealthCheck

22.1 - 1.4

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

Description

Set LB Health Check

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

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

HTTP Code	Description	Schema
202	Accepted	LbHealthCheckShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 202

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

22.2 - 1.3

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

Description

Set LB Health Check

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

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

HTTP Code	Description	Schema
202	Accepted	LbHealthCheckShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = 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"
    }
}

23 - SetLbListener

23.1 - 1.3

put /v1/lb-listeners/{listener_id}

Description

set loadbalancer listener

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

Parameters

Type	Name	Description	Schema	Default
path	listener_id required	The ID of the listener. Example :	string	None
body	body required		LbListenerSetRequestV1Dot3

Responses

HTTP Code	Description	Schema
200	OK	LbListenerShowResponseV1Dot3
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-listeners/{listener_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = 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": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "support_http2": "",
        "url_handler": "",
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

Example HTTP response

Response 200

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

24 - SetLbListenerCertificate

24.1 - 1.4

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

Description

set loadbalancer listener certificate

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	listener_id required	The ID of the listener. Example :	string	None
body	body required		LbListenerCertificateSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	LbListenerShowResponseV1Dot4
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 202

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

25 - SetLbListenerResource

25.1 - 1.4

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

Description

set loadbalancer listener resource

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	listener_id required	The ID of the listener. Example :	string	None
body	body required		LbListenerResourceSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	LbListenerShowResponseV1Dot4
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 202

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

26 - SetLbListenerRule

26.1 - 1.4

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

Description

set loadbalancer listener rule

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	listener_id required	The ID of the listener. Example :	string	None
body	body required		LbListenerRuleSetRequest

Responses

HTTP Code	Description	Schema
202	Accepted	LbListenerShowResponseV1Dot4
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 202

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

27 - SetLBServerGroup

27.1 - 1.4

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

Description

Set LB Server Group

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

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

HTTP Code	Description	Schema
202	Accepted	LbServerGroupShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

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

Request header

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

Request body

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

Example HTTP response

Response 202

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

27.2 - 1.3

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

Description

Set LB Server Group

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

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

HTTP Code	Description	Schema
202	Accepted	LbServerGroupShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = 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"
    }
}

28 - SetLbServerGroupMember

28.1 - 1.4

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

Description

Set Lb Server Group Member

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

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}

Request header

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

Request body

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

Example HTTP response

Response 202

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

28.2 - 1.3

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

Description

Set Lb Server Group Member

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

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}

Request header

"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": ""
    }
}

29 - SetLoadbalancer

29.1 - 1.4

put /v1/loadbalancers/{loadbalancer_id}

Description

Set Load Balancer

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	ID Example :	string	None
body	body required		LoadbalancerUpdateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	LoadbalancerShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_id}

Request header

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

Request body

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

Example HTTP response

Response 202

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

29.2 - 1.3

put /v1/loadbalancers/{loadbalancer_id}

Description

Set Load Balancer

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	ID Example :	string	None
body	body required		LoadbalancerUpdateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	LoadbalancerShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = 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": ""
    }
}

30 - ShowLBHealthCheck

30.1 - 1.4

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

Description

Get LB Health Check

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

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
200	OK	LbHealthCheckShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

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

Request header

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

Example HTTP response

Response 200

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

30.2 - 1.3

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

Description

Get LB Health Check

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

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
200	OK	LbHealthCheckShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = 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"
    }
}

31 - ShowLbListener

31.1 - 1.4

get /v1/lb-listeners/{listener_id}

Description

show LB listener

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	listener_id required	The ID of the listener. Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	LbListenerShowResponseV1Dot4
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-listeners/{listener_id}

Request header

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

Example HTTP response

Response 200

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

31.2 - 1.3

get /v1/lb-listeners/{listener_id}

Description

show LB listener

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

Parameters

Type	Name	Description	Schema	Default
path	listener_id required	The ID of the listener. Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	LbListenerShowResponseV1Dot3
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-listeners/{listener_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = 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": "",
                "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": ""
    }
}

32 - ShowLBServerGroup

32.1 - 1.4

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

Description

Show LB Server Group

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

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
200	OK	LbServerGroupShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

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

Request header

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

Example HTTP response

Response 200

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

32.2 - 1.3

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

Description

Show LB Server Group

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

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
200	OK	LbServerGroupShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = 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"
    }
}

33 - ShowLbServerGroupMember

33.1 - 1.4

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

Description

Show Lb Server Group Member

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

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}

Request header

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

Example HTTP response

Response 200

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

33.2 - 1.3

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

Description

Show Lb Server Group Member

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

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}

Request header

"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": ""
    }
}

34 - ShowLoadbalancer

34.1 - 1.4

get /v1/loadbalancers/{loadbalancer_id}

Description

show Load Balancer

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	LoadbalancerShowResponseV1Dot4
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_id}

Request header

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

Example HTTP response

Response 200

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

34.2 - 1.3

get /v1/loadbalancers/{loadbalancer_id}

Description

show Load Balancer

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	LoadbalancerShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = 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": ""
    }
}

35 - ShowLoadbalancerCertificate

35.1 - 1.4

get /v1/loadbalancers/certificates/{lb_certificate_id}

Description

show Load Balancer certificate

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	lb_certificate_id required	The ID of the certificate Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	LbCertificateShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/loadbalancers/certificates/{lb_certificate_id}

Request header

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

Example HTTP response

Response 200

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

35.2 - 1.3

get /v1/loadbalancers/certificates/{lb_certificate_id}

Description

show Load Balancer certificate

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

Parameters

Type	Name	Description	Schema	Default
path	lb_certificate_id required	The ID of the certificate Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	LbCertificateShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/loadbalancers/certificates/{lb_certificate_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = 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": ""
    }
}

36 - ShowLoadbalancerPrivateNatIp

36.1 - 1.4

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

Description

Show Load Balancer Private NAT IP

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateStaticNatShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

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

Request header

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

Example HTTP response

Response 200

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

36.2 - 1.3

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

Description

Show Load Balancer Private NAT IP

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateStaticNatShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

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

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = 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": ""
    }
}

37 - ShowLoadbalancerPublicNatIp

37.1 - 1.4

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

Description

Show Load Balancer Public NAT IP

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	LoadbalancerStaticNatResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

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

Request header

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

Example HTTP response

Response 200

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

37.2 - 1.3

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

Description

Show Load Balancer Public NAT IP

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20261031

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	LoadbalancerStaticNatResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

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

Request header

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

Example HTTP response

Response 200

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