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

Return to the regular view of this page.

Models

1 - HstsConfig

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

2 - HttpsRedirection

NameDescriptionSchemaDefault
port
optional
port
Example :
any of [string, null]
protocol
optional
protocol
Example :
any of [string, null]
response_code
optional
response_code
Example :
any of [string, null]

3 - LbCertificateForShow

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

Example :
string
cn
optional

Example :
string
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
id
required
ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
optional

Example :
string
not_after_dt
optional

Example :
string (date-time)
not_before_dt
optional

Example :
string (date-time)
organization
required
The organization of the certificate
Example :
string
private_key
required
The private key of the certificate
Example :
string
state
optional

Example :
string

4 - LbCertificateListResponse

NameDescriptionSchemaDefault
certificates
required

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

5 - LbCertificateListResponseDetail

NameDescriptionSchemaDefault
cert_kind
required
Kind of certificate
Example :
string
cn
required
Common Name of certificate
Example :
string
created_at
optional
Created At
Example :
any of [string (date-time), null]
created_by
optional
Created By
Example :
any of [string, null]
id
required
ID of the certificate
Example :
string
modified_at
optional
Modified At
Example :
any of [string (date-time), null]
modified_by
optional
Modified By
Example :
any of [string, null]
name
required
Name of the certificate
Example :
string
not_after_dt
required
Expiration date and time of the certificate
Example :
string (date-time)
not_before_dt
required
Start date and time when the certificate becomes valid
Example :
string (date-time)
state
required
State of the certificate
Example :
string

6 - LbCertificateShowResponse

NameDescriptionSchemaDefault
certificate
required

LbCertificateForShow

7 - LbHealthCheckCreate

NameDescriptionSchemaDefault
description
optional
Description
Example : this is an lb server group
any of [string, null]
health_check_count
optional
LB Health Check count
Example : 3
Minimum : 1
Maximum : 10
integer3
health_check_interval
optional
LB Health Check interval
Example : 5
Minimum : 1
Maximum : 180
integer5
health_check_port
optional
LB Health Check port
Example : 80
any of [integer, null]
health_check_timeout
optional
LB Health Check timeout
Example : 5
Minimum : 1
Maximum : 180
integer5
health_check_url
optional
LB Health Check URL
Example : /test
Pattern : ^\/[A-Za-z0-9/._?&=-]*$
any of [string, null]
http_method
optional
LB Health Check HTTP Method
Example : GET
any of [enum (GET, POST), null]
name
required
LB Health Check name
Example : ServerGroup01
Pattern : ^[a-zA-Z0-9][-a-zA-Z0-9_]*[a-zA-Z0-9]$
Minimum length : 3
Maximum length : 63
string
protocol
required
LB Health Check Protocol
Example : TCP
enum (TCP, HTTP, HTTPS)
request_data
optional
LB Health Check Request data
Example : username=admin&password=1234
Pattern : ^[a-zA-Z0-9_\W]*$
any of [string, null]
response_code
optional
LB Health Check Response code
Example : 200
any of [string, null]
subnet_id
required
Service Subnet ID
Example : 60fba45cb6c811efba41ba92e4fe7200
string
tags
optional
Tag List
array[Tag]
vpc_id
required
VPC ID
Example : 8acceeb6920c4fc494490d864f67f0b5
string

8 - LbHealthCheckCreateRequest

NameDescriptionSchemaDefault
lb_health_check
required

LbHealthCheckCreate

9 - LbHealthCheckList

NameDescriptionSchemaDefault
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
health_check_type
required
LB Health Check type
Example : DEFAULT
enum (DEFAULT, CUSTOM)
id
required
LB Health Check ID
Example : 46c681018e33453085ca7c8db54e0076
string
lb_server_group_count
required
LB Server Group count
Example : 2
integer
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
LB Health Check name
Example : Test-LbMonitor-01
string
protocol
required
LB Health Check Protocol
Example : TCP
enum (TCP, HTTP, HTTPS)
state
required
LB Health Check state
Example : ACTIVE
string
subnet_id
required
Service Subnet ID
Example : 60fba45cb6c811efba41ba92e4fe7200
string

10 - LbHealthCheckListResponse

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
lb_health_checks
required

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

11 - LbHealthCheckSet

NameDescriptionSchemaDefault
description
optional
Description
Example : this is an lb server group
any of [string, null]
health_check_count
optional
LB Health Check count
Example : 3
any of [integer, null]
health_check_interval
optional
LB Health Check interval
Example : 5
any of [integer, null]
health_check_port
optional
LB Health Check port
Example : 80
any of [integer, null]
health_check_timeout
optional
LB Health Check timeout
Example : 5
any of [integer, null]
health_check_url
optional
LB Health Check URL
Example : /test
Pattern : ^\/[A-Za-z0-9/._?&=-]*$
any of [string, null]
http_method
optional
LB Health Check HTTP Method
Example : GET
any of [enum (GET, POST), null]
protocol
optional
LB Health Check Protocol
Example : TCP
any of [enum (TCP, HTTP, HTTPS), null]
request_data
optional
LB Health Check Request data
Example : username=admin&password=1234
Pattern : ^[a-zA-Z0-9_\W]*$
any of [string, null]
response_code
optional
LB Health Check Response code
Example : 200
any of [string, null]

12 - LbHealthCheckSetRequest

NameDescriptionSchemaDefault
lb_health_check
required

LbHealthCheckSet

13 - LbHealthCheckShow

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : e3cd678b11784734bc366148aa37580e
any of [string, null]
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
Description
Example : this is an lb server group
any of [string, null]
health_check_count
optional
LB Health Check count
Example : 3
integer3
health_check_interval
optional
LB Health Check interval
Example : 5
integer5
health_check_port
required
LB Health Check port
Example : 80
any of [integer, null]
health_check_timeout
optional
LB Health Check timeout
Example : 5
integer5
health_check_type
required
LB Health Check type
Example : DEFAULT
enum (DEFAULT, CUSTOM)
health_check_url
required
LB Health Check URL
Example : /test
any of [string, null]
http_method
required
LB Health Check HTTP Method
Example : GET
any of [string, null]
id
required
LB Health Check ID
Example : 46c681018e33453085ca7c8db54e0076
string
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
LB Health Check name
Example : Test-LbMonitor-01
string
protocol
optional
LB Health Check Protocol
Example : TCP
enum (TCP, HTTP, HTTPS)TCP
request_data
required
LB Health Check Request data
Example : username=admin&password=1234
any of [string, null]
response_code
required
LB Health Check Response code
Example : 200
any of [string, null]
state
required
LB Health Check state
Example : ACTIVE
string
subnet_id
required
Service Subnet ID
Example : 60fba45cb6c811efba41ba92e4fe7200
any of [string, null]
vpc_id
required
VPC ID
Example : 8acceeb6920c4fc494490d864f67f0b5
any of [string, null]

14 - LbHealthCheckShowResponse

NameDescriptionSchemaDefault
lb_health_check
required

LbHealthCheckShow

15 - LbListenerCertificateBase

NameDescriptionSchemaDefault
sni_certificate
optional
The sni certificate of the listener.
any of [array[SniCertificate], null]
ssl_certificate
optional
The ssl certificate of the listener.
any of [SslCertificate, null]

16 - LbListenerCertificateSetRequest

NameDescriptionSchemaDefault
listener
required

LbListenerCertificateBase

17 - LbListenerCreateRequestV1Dot3

NameDescriptionSchemaDefault
listener
required

ListenerForCreateV1Dot3

18 - LbListenerCreateRequestV1Dot4

NameDescriptionSchemaDefault
listener
required

ListenerForCreateV1Dot4

19 - LbListenerDistinctBase

NameDescriptionSchemaDefault
description
optional
description
Example :
any of [string, null]
hsts_config
optional
The hsts response header of the listener.
any of [HstsConfig, null]
idle_timeout
optional
The idle timeout(L7) of the listener.
Example :
any of [integer, null]
insert_client_ip
optional
Whether the client IP should be inserted.
Example :
any of [boolean, null]
persistence
optional
The persistence of the listener.
Example :
any of [string, null]
response_timeout
optional
The response timeout of the listener.
Example :
any of [integer, null]
session_duration_time
optional
The session duration time.
Example :
any of [integer, null]
support_http2
optional
Whether the HTTP 2.0 is supported
Example :
any of [boolean, null]
x_forwarded_for
optional
Whether the X-Forwarded-For should be inserted.
Example :
any of [boolean, null]
x_forwarded_port
optional
Whether the X-Forwarded-Port should be inserted.
Example :
any of [boolean, null]
x_forwarded_proto
optional
Whether the X-Forwarded-Protocol should be inserted.
Example :
any of [boolean, null]

20 - LbListenerListResponse

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
listeners
required
The list of the listener.
array[ListenerForList]
page
required
page
Example : 0
integer
size
required
size
Example : 20
integer
sort
optional
sort
Example : ['created_at:asc']
any of [array[string], null]

21 - LbListenerResourceSetRequest

NameDescriptionSchemaDefault
listener
required

LbListenerDistinctBase

22 - LbListenerRuleBase

NameDescriptionSchemaDefault
condition_type
optional
The condition type of the listener.
Example : URL_PATH
any of [enum (URL_PATH, HOST_HEADER, PROTOCOL_PORT), null]
https_redirection
optional
The https redirection of the listener.
any of [HttpsRedirection, null]
server_group_id
optional
The ID of the server group.
Example :
any of [string, null]
url_handler
optional
The URL handler of the listener.
any of [array[UrlHandler], null]
url_redirection
optional
The URL redirect of the listener.
Example :
any of [string, null]

23 - LbListenerRuleSetRequest

NameDescriptionSchemaDefault
listener
required

LbListenerRuleBase

24 - LbListenerSetRequestV1Dot3

NameDescriptionSchemaDefault
listener
required

ListenerForSetV1Dot3

25 - LbListenerShowResponseV1Dot3

NameDescriptionSchemaDefault
listener
required

ListenerForShowV1Dot3

26 - LbListenerShowResponseV1Dot4

NameDescriptionSchemaDefault
listener
required

ListenerForShow

27 - LbListenerSslCertificate

NameDescriptionSchemaDefault
client_cert_id
optional
Certificate id for client ssl
Example :
any of [string, null]
client_cert_level
optional
Certificate level for client ssl
Example :
any of [string, null]
server_cert_level
optional
Certificate level for server ssl
Example :
any of [string, null]

28 - LbServerGroup

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : e3cd678b11784734bc366148aa37580e
string
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
Description
Example : this is an lb server group
any of [string, null]
id
required
LB Server Group ID
Example : 3d8d8754d0d54683a29f3dcc3dd95d5b
string
lb_health_check_id
required
LB Health Check ID
Example : 46c681018e33453085ca7c8db54e0076
any of [string, null]
lb_method
required
LB Method
Example : ROUND_ROBIN
enum (ROUND_ROBIN, LEAST_CONNECTION, SOURCE_IP_HASH, SOURCE_IP_PORT_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION)
lb_name
optional
Load Balancer name
Example : Test-LB-01
any of [string, null]
loadbalancer_id
optional
Load Balancer ID
Example : 82efa35c88834bc083020443e57faa10
any of [string, null]
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
LB Server Group name
Example : ServerGroup01
string
protocol
required
Protocol
Example : TCP
enum (TCP, UDP)
state
required
LB Server Group state
Example : ACTIVE
string
subnet_id
required
Service Subnet ID
Example : 60fba45cb6c811efba41ba92e4fe7200
string
vpc_id
required
VPC ID
Example : 8acceeb6920c4fc494490d864f67f0b5
string

29 - LbServerGroupCreate

NameDescriptionSchemaDefault
description
optional
Description
Example : this is an lb server group
any of [string, null]
lb_health_check_id
optional
LB Health Check ID
Example : 46c681018e33453085ca7c8db54e0076
any of [string, null]
lb_method
required
LB Method
Example : ROUND_ROBIN
enum (ROUND_ROBIN, LEAST_CONNECTION, SOURCE_IP_HASH, SOURCE_IP_PORT_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION)
name
required
LB Health Check name
Example : ServerGroup01
Pattern : ^[a-zA-Z0-9][-a-zA-Z0-9_]*[a-zA-Z0-9]$
Minimum length : 3
Maximum length : 63
string
protocol
required
Protocol
Example : TCP
enum (TCP, UDP)
subnet_id
required
Service Subnet ID
Example : 60fba45cb6c811efba41ba92e4fe7200
string
tags
optional
Tag List
array[Tag]
vpc_id
required
VPC ID
Example : 8acceeb6920c4fc494490d864f67f0b5
string

30 - LbServerGroupCreateRequest

NameDescriptionSchemaDefault
lb_server_group
required

LbServerGroupCreate

31 - LbServerGroupList

NameDescriptionSchemaDefault
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
id
required
LB Server Group ID
Example : 3d8d8754d0d54683a29f3dcc3dd95d5b
string
lb_health_check_id
required
LB Health Check ID
Example : 46c681018e33453085ca7c8db54e0076
any of [string, null]
lb_name
optional
Load Balancer name
Example : Test-LB-01
any of [string, null]
lb_server_group_member_count
required
LB Server Group Member count
Example : 2
integer
loadbalancer_id
optional
Load Balancer ID
Example : 82efa35c88834bc083020443e57faa10
any of [string, null]
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
LB Server Group name
Example : ServerGroup01
string
protocol
required
Protocol
Example : TCP
enum (TCP, UDP)
state
required
LB Server Group state
Example : ACTIVE
string
vpc_id
required
VPC ID
Example : 8acceeb6920c4fc494490d864f67f0b5
string

32 - LbServerGroupListResponse

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
lb_server_groups
required

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

33 - LbServerGroupSet

NameDescriptionSchemaDefault
description
optional
Description
Example : this is an lb server group
any of [string, null]
lb_health_check_id
optional
LB Health Check ID
Example : 46c681018e33453085ca7c8db54e0076
any of [string, null]
lb_method
optional
LB Method
Example : ROUND_ROBIN
any of [enum (ROUND_ROBIN, LEAST_CONNECTION, SOURCE_IP_HASH, SOURCE_IP_PORT_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION), null]

34 - LbServerGroupSetRequest

NameDescriptionSchemaDefault
lb_server_group
required

LbServerGroupSet

35 - LbServerGroupShowResponse

NameDescriptionSchemaDefault
lb_server_group
required

LbServerGroup

36 - ListenerForCreateV1Dot3

NameDescriptionSchemaDefault
condition_type
optional
The condition type of the listener.
Example : URL_PATH
any of [enum (URL_PATH, HOST_HEADER, PROTOCOL_PORT), null]
description
optional
description
Example :
any of [string, null]
hsts_max_age
optional
The hsts max_age of the listener.
Example :
any of [integer, null]
https_redirection
optional
The https redirection of the listener.
any of [HttpsRedirection, null]
idle_timeout
optional
The idle timeout(L7) of the listener.
Example :
any of [integer, null]
insert_client_ip
optional
Whether the client IP should be inserted.
Example :
any of [boolean, null]
loadbalancer_id
required
The ID of the load balancer.
Example :
string
name
required
The name of the listener.
Example :
Pattern : ^[a-zA-Z0-9-_]*$
Minimum length : 3
Maximum length : 63
string
persistence
optional
The persistence of the listener.
Example :
any of [string, null]
protocol
required
The protocol of the listener.
Example : TCP
enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY)
response_timeout
optional
The response timeout of the listener.
Example :
any of [integer, null]
routing_action
required
The routing action of the listener.
Example : LB_SERVER_GROUP
enum (LB_SERVER_GROUP, URL_REDIRECT)
server_group_id
optional
The ID of the server group.
Example :
any of [string, null]
service_port
required
The port of the listener.
Example :
Minimum : 1
Maximum : 65534
integer
session_duration_time
optional
The session duration time.
Example :
any of [integer, null]
sni_certificate
optional
The sni certificate of the listener.
any of [array[SniCertificate], null]
ssl_certificate
optional
The ssl certificate of the listener.
any of [SslCertificate, null]
support_http2
optional
Whether the HTTP 2.0 is supported
Example : False
any of [boolean, null]
tags
optional
Tag List
array[Tag]
url_handler
optional
The URL handler of the listener.
Example :
any of [array[object], null]
url_redirection
optional
The URL redirect of the listener.
Example :
any of [string, null]
x_forwarded_for
optional
Whether the X-Forwarded-For should be inserted.
Example :
any of [boolean, null]
x_forwarded_port
optional
Whether the X-Forwarded-Port should be inserted.
Example :
any of [boolean, null]
x_forwarded_proto
optional
Whether the X-Forwarded-Protocol should be inserted.
Example :
any of [boolean, null]

37 - ListenerForCreateV1Dot4

NameDescriptionSchemaDefault
condition_type
optional
The condition type of the listener.
Example : URL_PATH
any of [enum (URL_PATH, HOST_HEADER, PROTOCOL_PORT), null]
description
optional
description
Example :
any of [string, null]
https_redirection
optional
The https redirection of the listener.
any of [HttpsRedirection, null]
idle_timeout
optional
The idle timeout(L7) of the listener.
Example :
any of [integer, null]
insert_client_ip
optional
Whether the client IP should be inserted.
Example :
any of [boolean, null]
loadbalancer_id
required
The ID of the load balancer.
Example :
string
name
required
The name of the listener.
Example :
Pattern : ^[a-zA-Z0-9-_]*$
Minimum length : 3
Maximum length : 63
string
persistence
optional
The persistence of the listener.
Example :
any of [string, null]
protocol
required
The protocol of the listener.
Example : TCP
enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY)
response_timeout
optional
The response timeout of the listener.
Example :
any of [integer, null]
routing_action
required
The routing action of the listener.
Example : LB_SERVER_GROUP
enum (LB_SERVER_GROUP, URL_REDIRECT)
server_group_id
optional
The ID of the server group.
Example :
any of [string, null]
service_port
required
The port of the listener.
Example :
Minimum : 1
Maximum : 65534
integer
session_duration_time
optional
The session duration time.
Example :
any of [integer, null]
ssl_certificate
optional
The ssl certificate of the listener.
any of [SslCertificate, null]
support_http2
optional
Whether the HTTP 2.0 is supported
Example : False
any of [boolean, null]
tags
optional
Tag List
array[Tag]
url_handler
optional
The URL handler of the listener.
any of [array[UrlHandler], null]
url_redirection
optional
The URL redirect of the listener.
Example :
any of [string, null]
x_forwarded_for
optional
Whether the X-Forwarded-For should be inserted.
Example :
any of [boolean, null]
x_forwarded_port
optional
Whether the X-Forwarded-Port should be inserted.
Example :
any of [boolean, null]
x_forwarded_proto
optional
Whether the X-Forwarded-Protocol should be inserted.
Example :
any of [boolean, null]

38 - ListenerForList

NameDescriptionSchemaDefault
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
id
required
ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
The name of the listener.
Example :
Pattern : ^[a-zA-Z0-9-_]*$
Minimum length : 3
Maximum length : 63
string
protocol
required
The protocol of the listener.
Example : TCP
enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY)
service_port
required
The port of the listener.
Example :
Minimum : 1
Maximum : 65534
integer
state
optional
The State of the listener.
Example :
any of [string, null]

39 - ListenerForSetV1Dot3

NameDescriptionSchemaDefault
condition_type
optional
The condition type of the listener.
Example : URL_PATH
any of [enum (URL_PATH, HOST_HEADER, PROTOCOL_PORT), null]
description
optional
description
Example :
any of [string, null]
hsts_max_age
optional
The hsts max_age of the listener.
Example :
any of [integer, null]
https_redirection
optional
The https redirection of the listener.
any of [HttpsRedirection, null]
idle_timeout
optional
The idle timeout(L7) of the listener.
Example :
any of [integer, null]
insert_client_ip
optional
Whether the client IP should be inserted.
Example :
any of [boolean, null]
persistence
optional
The persistence of the listener.
Example :
any of [string, null]
response_timeout
optional
The response timeout of the listener.
Example :
any of [integer, null]
server_group_id
optional
The ID of the server group.
Example :
any of [string, null]
session_duration_time
optional
The session duration time.
Example :
any of [integer, null]
sni_certificate
optional
The sni certificate of the listener.
any of [array[SniCertificate], null]
ssl_certificate
optional
The ssl certificate of the listener.
any of [LbListenerSslCertificate, null]
support_http2
optional
Whether the HTTP 2.0 is supported
Example :
boolean
url_handler
optional
The URL handler of the listener.
Example :
any of [array[object], null]
url_redirection
optional
The URL redirect of the listener.
Example :
any of [string, null]
x_forwarded_for
optional
Whether the X-Forwarded-For should be inserted.
Example :
any of [boolean, null]
x_forwarded_port
optional
Whether the X-Forwarded-Port should be inserted.
Example :
any of [boolean, null]
x_forwarded_proto
optional
Whether the X-Forwarded-Protocol should be inserted.
Example :
any of [boolean, null]

40 - ListenerForShow

NameDescriptionSchemaDefault
condition_type
optional
The condition type of the listener.
Example : URL_PATH
any of [enum (URL_PATH, HOST_HEADER, PROTOCOL_PORT), null]
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
description
Example :
any of [string, null]
hsts_config
optional
The hsts response header of the listener.
any of [HstsConfig, null]
https_redirection
optional
The https redirection of the listener.
any of [HttpsRedirection, null]
id
required
ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
idle_timeout
optional
The idle timeout(L7) of the listener.
Example :
any of [integer, null]
insert_client_ip
optional
Whether the client IP should be inserted.
Example :
any of [boolean, null]
loadbalancer_id
required
The ID of the load balancer.
Example :
string
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
The name of the listener.
Example :
Pattern : ^[a-zA-Z0-9-_]*$
Minimum length : 3
Maximum length : 63
string
persistence
optional
The persistence of the listener.
Example :
any of [string, null]
protocol
required
The protocol of the listener.
Example : TCP
enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY)
response_timeout
optional
The response timeout of the listener.
Example :
any of [integer, null]
routing_action
required
The routing action of the listener.
Example : LB_SERVER_GROUP
enum (LB_SERVER_GROUP, URL_REDIRECT)
server_group_id
optional
The ID of the server group.
Example :
any of [string, null]
server_group_name
optional
The Name of the server group.
Example :
any of [string, null]
service_port
required
The port of the listener.
Example :
Minimum : 1
Maximum : 65534
integer
session_duration_time
optional
The session duration time.
Example :
any of [integer, null]
sni_certificate
optional
The sni certificate of the listener.
any of [array[SniCertificateResponse], null]
ssl_certificate
optional
The ssl certificate of the listener.
any of [SslCertificate, null]
state
required
The State of the listener.
Example :
string
support_http2
optional
Whether the HTTP 2.0 is supported
Example :
any of [boolean, null]
tags
optional
Tag List
array[Tag]
url_handler
optional
URL handler list
any of [array[UrlHandlerResponse], null]
url_redirection
optional
The URL redirect of the listener.
Example :
any of [string, null]
x_forwarded_for
optional
Whether the X-Forwarded-For should be inserted.
Example :
any of [boolean, null]
x_forwarded_port
optional
Whether the X-Forwarded-Port should be inserted.
Example :
any of [boolean, null]
x_forwarded_proto
optional
Whether the X-Forwarded-Protocol should be inserted.
Example :
any of [boolean, null]

41 - ListenerForShowV1Dot3

NameDescriptionSchemaDefault
condition_type
optional
The condition type of the listener.
Example : URL_PATH
any of [enum (URL_PATH, HOST_HEADER, PROTOCOL_PORT), null]
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
description
Example :
any of [string, null]
hsts_max_age
optional
The hsts max_age of the listener.
Example :
any of [integer, null]
https_redirection
optional
The https redirection of the listener.
any of [HttpsRedirection, null]
id
required
ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
idle_timeout
optional
The idle timeout(L7) of the listener.
Example :
any of [integer, null]
insert_client_ip
optional
Whether the client IP should be inserted.
Example :
any of [boolean, null]
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
The name of the listener.
Example :
Pattern : ^[a-zA-Z0-9-_]*$
Minimum length : 3
Maximum length : 63
string
persistence
optional
The persistence of the listener.
Example :
any of [string, null]
protocol
required
The protocol of the listener.
Example : TCP
enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY)
response_timeout
optional
The response timeout of the listener.
Example :
any of [integer, null]
routing_action
required
The routing action of the listener.
Example : LB_SERVER_GROUP
enum (LB_SERVER_GROUP, URL_REDIRECT)
server_group_id
optional
The ID of the server group.
Example :
any of [string, null]
server_group_name
optional
The Name of the server group.
Example :
any of [string, null]
service_port
required
The port of the listener.
Example :
Minimum : 1
Maximum : 65534
integer
session_duration_time
optional
The session duration time.
Example :
any of [integer, null]
sni_certificate
optional
The sni certificate of the listener.
any of [array[SniCertificate], null]
ssl_certificate
optional
The ssl certificate of the listener.
any of [SslCertificate, null]
state
required
The State of the listener.
Example :
string
support_http2
optional
Whether the HTTP 2.0 is supported
Example : False
any of [boolean, null]
url_handler
optional
The URL handler of the listener.
Example :
any of [array[object], null]
url_redirection
optional
The URL redirect of the listener.
Example :
any of [string, null]
x_forwarded_for
optional
Whether the X-Forwarded-For should be inserted.
Example :
any of [boolean, null]
x_forwarded_port
optional
Whether the X-Forwarded-Port should be inserted.
Example :
any of [boolean, null]
x_forwarded_proto
optional
Whether the X-Forwarded-Protocol should be inserted.
Example :
any of [boolean, null]

42 - Loadbalancer

NameDescriptionSchemaDefault
account_id
required
The account ID of the load balancer.
Example :
string
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
description
Example :
any of [string, null]
firewall_id
optional
Firewall ID
Example :
any of [string, null]
health_check_ip
required
Health check IP
array[string]
id
required
ID
Example :
string
layer_type
required
Layer type
Example :
string
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
name
Example :
string
public_nat_enabled
optional
Public NAT Enabled Status
Example :
any of [boolean, null]
service_ip
optional
The service IP of the load balancer.
Example :
any of [string, null]
source_nat_ip
optional
Source NAT IP
Example :
any of [string, null]
state
required
The state of the load balancer.
Example :
string
subnet_id
required
Subnet ID
Example :
string
vpc_id
required
VPC ID
Example :
string

43 - LoadbalancerCreateRequest

NameDescriptionSchemaDefault
loadbalancer
required

LoadbalancerCreateRequestDetail

44 - LoadbalancerCreateRequestDetail

NameDescriptionSchemaDefault
description
optional
description
Example :
any of [string, null]
firewall_enabled
optional
Firewall enabled
Example : True
any of [boolean, null]True
firewall_logging_enabled
optional
Firewall logging enabled
Example : True
any of [boolean, null]True
health_check_ip_1
optional
Health check IP
Example :
any of [string, null]
health_check_ip_2
optional
Health check IP
Example :
any of [string, null]
layer_type
required
Layer type
Example :
string
name
required
name
Example :
Pattern : ^[a-zA-Z0-9-_]*$
Minimum length : 3
Maximum length : 63
string
publicip_id
optional
Public IP ID
Example :
any of [string, null]
service_ip
optional
The service IP of the load balancer.
Example :
any of [string, null]
source_nat_ip
optional
Source NAT IP
Example :
any of [string, null]
subnet_id
required
Subnet ID
Example :
string
tags
optional
Tag List
array[Tag]
vpc_id
required
VPC ID
Example :
string

45 - LoadbalancerCreateRequestDetailV1Dot4

NameDescriptionSchemaDefault
description
optional
description
Example :
any of [string, null]
firewall_enabled
optional
Firewall enabled
Example : True
any of [boolean, null]True
firewall_logging_enabled
optional
Firewall logging enabled
Example : True
any of [boolean, null]True
health_check_ips
optional
The list of Health check IPs
Example :
any of [array[string], null]
layer_type
required
Layer type
Example :
string
name
required
name
Example :
Pattern : ^[a-zA-Z0-9-_]*$
Minimum length : 3
Maximum length : 63
string
publicip_id
optional
Public IP ID
Example :
any of [string, null]
service_ip
optional
The service IP of the load balancer.
Example :
any of [string, null]
source_nat_ip
optional
Source NAT IP
Example :
any of [string, null]
subnet_id
required
Subnet ID
Example :
string
tags
optional
Tag List
array[Tag]
vpc_id
required
VPC ID
Example :
string
zones
optional
Availability Zones
array[string]

46 - LoadbalancerCreateRequestV1Dot4

NameDescriptionSchemaDefault
loadbalancer
required

LoadbalancerCreateRequestDetailV1Dot4

47 - LoadbalancerCreateResponse

NameDescriptionSchemaDefault
loadbalancer
required

LoadbalancerCreateResponseDetail

48 - LoadbalancerCreateResponseDetail

NameDescriptionSchemaDefault
account_id
required
The account ID of the load balancer.
Example :
string
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
description
Example :
any of [string, null]
id
required
ID
Example :
string
layer_type
required
Layer type
Example :
string
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
name
Example :
string
state
required
The state of the load balancer.
Example :
string
subnet_id
required
Subnet ID
Example :
string
vpc_id
required
VPC ID
Example :
string

49 - LoadbalancerListResponse

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
loadbalancers
required

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

50 - LoadbalancerListResponseDetail

NameDescriptionSchemaDefault
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
firewall_id
optional
Firewall ID
Example :
any of [string, null]
id
required
ID
Example :
string
layer_type
optional
Layer type
Example :
any of [string, null]
listener_count
optional
The number of listeners.
Example :
any of [integer, null]
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
optional
The name of the load balancer.
Example :
any of [string, null]
public_nat_enabled
optional
Public NAT Enabled Status
Example :
any of [boolean, null]
service_ip
optional
The service IP of the load balancer.
Example :
any of [string, null]
source_nat_ip
optional
Source NAT IP
Example :
any of [string, null]
state
optional
The state of the load balancer.
Example :
any of [string, null]
subnet_id
optional
Subnet ID
Example :
any of [string, null]
vpc_id
optional
VPC ID
Example :
any of [string, null]

51 - LoadbalancerListResponseDetailV1Dot4

NameDescriptionSchemaDefault
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
firewall_id
optional
Firewall ID
Example :
any of [string, null]
id
required
ID
Example :
string
layer_type
optional
Layer type
Example :
any of [string, null]
listener_count
optional
The number of listeners.
Example :
any of [integer, null]
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
optional
The name of the load balancer.
Example :
any of [string, null]
public_nat_enabled
optional
Public NAT Enabled Status
Example :
any of [boolean, null]
service_ip
optional
The service IP of the load balancer.
Example :
any of [string, null]
source_nat_ip
optional
Source NAT IP
Example :
any of [string, null]
state
optional
The state of the load balancer.
Example :
any of [string, null]
subnet_id
optional
Subnet ID
Example :
any of [string, null]
vpc_id
optional
VPC ID
Example :
any of [string, null]
zones
optional
Availability Zones
array[string]

52 - LoadbalancerListResponseV1Dot4

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
loadbalancers
required

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

53 - LoadbalancerShowResponse

NameDescriptionSchemaDefault
loadbalancer
required

Loadbalancer

54 - LoadbalancerShowResponseV1Dot4

NameDescriptionSchemaDefault
loadbalancer
required

LoadbalancerV1Dot4

55 - LoadbalancerStaticNatResponse

NameDescriptionSchemaDefault
static_nat
required

StaticNat

56 - LoadbalancerUpdateRequest

NameDescriptionSchemaDefault
loadbalancer
required

LoadbalancerUpdateRequestDetail

57 - LoadbalancerUpdateRequestDetail

NameDescriptionSchemaDefault
description
required
description
Example :
Maximum length : 255
string

58 - LoadbalancerV1Dot4

NameDescriptionSchemaDefault
account_id
required
The account ID of the load balancer.
Example :
string
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
description
Example :
any of [string, null]
firewall_id
optional
Firewall ID
Example :
any of [string, null]
health_check_ips
required
Health check IP
array[string]
id
required
ID
Example :
string
layer_type
required
Layer type
Example :
string
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
name
Example :
string
public_nat_enabled
optional
Public NAT Enabled Status
Example :
any of [boolean, null]
service_ip
optional
The service IP of the load balancer.
Example :
any of [string, null]
source_nat_ip
optional
Source NAT IP
Example :
any of [string, null]
state
required
The state of the load balancer.
Example :
string
subnet_id
required
Subnet ID
Example :
string
vpc_id
required
VPC ID
Example :
string
zones
optional
Availability Zones
array[string]

59 - Member

NameDescriptionSchemaDefault
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
id
required
ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
lb_server_group_id
required
ID of Lb Server Group
Example :
string
member_ip
required
IP of Member
Example :
string
member_port
required
Protocol port of Member
Example :
integer
member_state
required
Member State of Member
Example :
string
member_weight
required
Weight of Member
Example :
integer
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Name of Member
Example :
string
object_id
optional
Object ID of Member
Example :
any of [string, null]
object_type
required
Object Type of Member
Example : VM
enum (VM, BM, MANUAL, MNGC)
state
required
State of Member
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)
subnet_id
required
ID of Subnet
Example :
string
uuid
required
UUID of Member
Example :
string

60 - MemberCreateRequestV1Dot1

NameDescriptionSchemaDefault
member_ip
required
IP of Member
Example : 192.168.0.1
string
member_port
required
Protocol port of Member
Example : 80
Minimum : 1
Maximum : 65534
integer
member_state
optional
Member State of Member
Example : ENABLE
any of [enum (ENABLE, DISABLE), null]
member_weight
optional
Weight of Member
Example : 100
Minimum : 1
Maximum : 1000
integer
name
required
Name of Member
Example : virtualserver-1
Pattern : ^[a-zA-Z0-9\s\-_\.]*$
Minimum length : 1
Maximum length : 63
string
object_id
optional
Object ID of Member
Example : 1
string
object_type
required
Object Type of Member
Example : VM
string

61 - MemberDeleteBulkRequestV1Dot2

NameDescriptionSchemaDefault
member_id_list
required
ID list of Member
array[string]

62 - MemberListCreateRequestV1Dot1

NameDescriptionSchemaDefault
members
required

array[MemberCreateRequestV1Dot1]

63 - MemberListResponse

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

array[Member]

64 - MemberSet

NameDescriptionSchemaDefault
member_port
optional
Protocol port of Member
Example : 80
any of [integer, null]
member_state
optional
Member State of Member
Example : ENABLE
any of [enum (ENABLE, DISABLE), null]
member_weight
optional
Weight of Member
Example : 100
any of [integer, null]

65 - MemberSetRequest

NameDescriptionSchemaDefault
member
required

MemberSet

66 - MemberShowResponse

NameDescriptionSchemaDefault
member
required

any of [Member, null]

67 - MemberWithHealthState

NameDescriptionSchemaDefault
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
health_state
required
Health State of Member
Example :
string
id
required
ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
lb_server_group_id
required
ID of Lb Server Group
Example :
string
member_ip
required
IP of Member
Example :
string
member_port
required
Protocol port of Member
Example :
integer
member_state
required
Member State of Member
Example :
string
member_weight
required
Weight of Member
Example :
integer
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Name of Member
Example :
string
object_id
required
Object ID of Member
Example :
any of [string, null]
object_type
required
Object Type of Member
Example : VM
enum (VM, BM, MANUAL, MNGC)
state
required
State of Member
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)

68 - MemberWithHealthStateListResponse

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
members
required

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

69 - MemberWithHealthStateListResponseV1Dot4

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
members
required

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

70 - MemberWithHealthStateV1Dot4

NameDescriptionSchemaDefault
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
health_state
required
Health State of Member
Example :
string
id
required
ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
lb_server_group_id
required
ID of Lb Server Group
Example :
string
member_ip
required
IP of Member
Example :
string
member_port
required
Protocol port of Member
Example :
integer
member_state
required
Member State of Member
Example :
string
member_weight
required
Weight of Member
Example :
integer
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Name of Member
Example :
string
object_az
optional
Object AZ of Member
Example :
any of [string, null]
object_id
required
Object ID of Member
Example :
any of [string, null]
object_type
required
Object Type of Member
Example : VM
enum (VM, BM, MANUAL, MNGC)
state
required
State of Member
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)

71 - PrivateStaticNatCreateRequest

NameDescriptionSchemaDefault
static_nat
required

PrivateStaticNatCreateRequestDetail

72 - PrivateStaticNatCreateRequestDetail

NameDescriptionSchemaDefault
private_nat_id
required
private_nat_id
Example :
string
private_nat_ip_id
required
private_nat_ip_id
Example :
string

73 - PrivateStaticNatCreateResponse

NameDescriptionSchemaDefault
static_nat
required

PrivateStaticNatCreateResponseDetail

74 - PrivateStaticNatCreateResponseDetail

NameDescriptionSchemaDefault
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
external_ip_address
optional
external_ip_address
Example :
any of [string, null]
id
optional
ID
Example :
any of [string, null]
internal_ip_address
optional
internal_ip_address
Example :
any of [string, null]
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
private_nat_ip_id
optional
private_nat_ip_id
Example :
any of [string, null]
state
optional
state
Example :
any of [string, null]
subnet_id
optional
subnet_id
Example :
any of [string, null]

75 - PrivateStaticNatShowResponse

NameDescriptionSchemaDefault
static_nat
required

any of [PrivateStaticNatShowResponseDetail, null]

76 - PrivateStaticNatShowResponseDetail

NameDescriptionSchemaDefault
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
external_ip_address
optional
external_ip_address
Example :
any of [string, null]
id
optional
ID
Example :
any of [string, null]
internal_ip_address
optional
internal_ip_address
Example :
any of [string, null]
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
private_nat_ip_id
optional
private_nat_ip_id
Example :
any of [string, null]
state
optional
state
Example :
any of [string, null]

77 - SniCertificate

NameDescriptionSchemaDefault
domain_name
optional
Domain name for sni ssl
Example :
Pattern : ^[a-zA-Z0-9](?:[a-zA-Z0-9.-]{0,61}[a-zA-Z0-9])?$
any of [string, null]
sni_cert_id
optional
Certificate id for sni ssl
Example :
any of [string, null]

78 - SniCertificateResponse

NameDescriptionSchemaDefault
domain_name
optional
Domain name for sni ssl
Example :
Pattern : ^[a-zA-Z0-9](?:[a-zA-Z0-9.-]{0,61}[a-zA-Z0-9])?$
any of [string, null]
not_after_dt
optional
The expiration date and time of the certificate
Example :
any of [string (date-time), null]
sni_cert_id
optional
Certificate id for sni ssl
Example :
any of [string, null]

79 - SslCertificate

NameDescriptionSchemaDefault
client_cert_id
optional
Certificate id for client ssl
Example :
any of [string, null]
client_cert_level
optional
Certificate level for client ssl
Example :
any of [string, null]
server_cert_level
optional
Certificate level for server ssl
Example :
any of [string, null]

80 - StaticNat

NameDescriptionSchemaDefault
external_ip_address
required
Static Nat External Ip Address
Example :
string
publicip_id
optional
Publicip ID
Example :
any of [string, null]
state
required
Static Nat State
Example :
string

81 - StaticNatCreateRequest

NameDescriptionSchemaDefault
static_nat
required

StaticNatCreateRequestDetail

82 - StaticNatCreateRequestDetail

NameDescriptionSchemaDefault
publicip_id
required
publicip_id
Example :
string

83 - StaticNatCreateResponse

NameDescriptionSchemaDefault
static_nat
required

StaticNatCreateResponseDetail

84 - StaticNatCreateResponseDetail

NameDescriptionSchemaDefault
account_id
optional
account_id
Example :
any of [string, null]
action_type
optional
action_type
Example :
any of [string, null]
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional
description
Example :
any of [string, null]
external_ip_address
optional
external_ip_address
Example :
any of [string, null]
id
optional
ID
Example :
any of [string, null]
internal_ip_address
optional
internal_ip_address
Example :
any of [string, null]
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
optional
name
Example :
any of [string, null]
owner_id
optional
owner_id
Example :
any of [string, null]
owner_name
optional
owner_name
Example :
any of [string, null]
owner_type
optional
owner_type
Example :
any of [string, null]
publicip_id
optional
publicip_id
Example :
any of [string, null]
service_ip_port_id
optional
service_ip_port_id
Example :
any of [string, null]
state
optional
state
Example :
any of [string, null]
subnet_id
optional
subnet_id
Example :
any of [string, null]
type
optional
type
Example :
any of [string, null]
vpc_id
optional
vpc_id
Example :
any of [string, null]

85 - Tag

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

86 - UrlHandler

NameDescriptionSchemaDefault
seq
required
Sequence number for ordering
Example :
integer
server_group_id
optional
The ID of the server group.
Example :
any of [string, null]
url_pattern
required
URL pattern for routing action
Example :
Minimum length : 1
Maximum length : 63
string

87 - UrlHandlerResponse

NameDescriptionSchemaDefault
seq
optional
Sequence number for ordering
Example :
any of [integer, null]
server_group_id
optional
The ID of the server group.
Example :
any of [string, null]
server_group_name
optional
The Name of the server group.
Example :
any of [string, null]
url_pattern
required
URL pattern for routing
Example :
string