This is the multi-page printable view of this section. Click here to print.
Models
- 1: HttpsRedirection
- 2: LbCertificate
- 3: LbCertificateForShow
- 4: LbCertificateListResponse
- 5: LbCertificateShowResponse
- 6: LbHealthCheckCreate
- 7: LbHealthCheckCreateRequest
- 8: LbHealthCheckList
- 9: LbHealthCheckListResponse
- 10: LbHealthCheckSet
- 11: LbHealthCheckSetRequest
- 12: LbHealthCheckShow
- 13: LbHealthCheckShowResponse
- 14: LbListenerCreateRequest
- 15: LbListenerCreateRequestV1Dot2
- 16: LbListenerListResponse
- 17: LbListenerSetRequest
- 18: LbListenerSetRequestV1Dot2
- 19: LbListenerShowResponse
- 20: LbServerGroup
- 21: LbServerGroupCreate
- 22: LbServerGroupCreateRequest
- 23: LbServerGroupList
- 24: LbServerGroupListResponse
- 25: LbServerGroupSet
- 26: LbServerGroupSetRequest
- 27: LbServerGroupShowResponse
- 28: ListenerForCreate
- 29: ListenerForList
- 30: ListenerForSet
- 31: ListenerForShow
- 32: Loadbalancer
- 33: LoadbalancerCreateRequest
- 34: LoadbalancerCreateRequestDetail
- 35: LoadbalancerCreateResponse
- 36: LoadbalancerCreateResponseDetail
- 37: LoadbalancerListResponse
- 38: LoadbalancerListResponseDetail
- 39: LoadbalancerShowResponse
- 40: LoadbalancerStaticNatResponse
- 41: LoadbalancerUpdateRequest
- 42: LoadbalancerUpdateRequestDetail
- 43: Member
- 44: MemberCreateRequestV1Dot1
- 45: MemberDeleteBulkRequestV1Dot2
- 46: MemberListCreateRequestV1Dot1
- 47: MemberListResponse
- 48: MemberSet
- 49: MemberSetRequest
- 50: MemberShowResponse
- 51: MemberWithHealthState
- 52: MemberWithHealthStateListResponse
- 53: SniCertificate
- 54: SslCertificate
- 55: StaticNat
- 56: StaticNatCreateRequest
- 57: StaticNatCreateRequestDetail
- 58: StaticNatCreateResponse
- 59: StaticNatCreateResponseDetail
- 60: Tag
1 - HttpsRedirection
| Name | Description | Schema | Default |
|---|---|---|---|
| port optional | port Example : | any of [string, null] | |
| protocol optional | protocol Example : | any of [string, null] | |
| response_code optional | response_code Example : | any of [string, null] |
2 - LbCertificate
| Name | Description | Schema | Default |
|---|---|---|---|
| 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) | |
| state optional | Example : | string |
3 - LbCertificateForShow
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | The project ID of the certificate Example : | string | |
| cert_body required | The body of the certificate Example : | string | |
| cert_chain optional | The chain of the certificate Example : | any of [string, null] | |
| cert_kind optional | Example : | string | |
| cn optional | Example : | string | |
| created_at required | 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
| Name | Description | Schema | Default |
|---|---|---|---|
| certificates required | array[LbCertificate] | ||
| 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 - LbCertificateShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| certificate required | LbCertificateForShow |
6 - LbHealthCheckCreate
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : this is an lb server group | any of [string, null] | |
| health_check_count optional | LB Health Check count Example : 3Minimum : 1Maximum : 10 | integer | 3 |
| health_check_interval optional | LB Health Check interval Example : 5Minimum : 1Maximum : 180 | integer | 5 |
| health_check_port optional | LB Health Check port Example : 80 | any of [integer, null] | |
| health_check_timeout optional | LB Health Check timeout Example : 5Minimum : 1Maximum : 180 | integer | 5 |
| health_check_url optional | LB Health Check URL Example : /testPattern : ^\/[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 : ServerGroup01Pattern : ^[a-zA-Z0-9][-a-zA-Z0-9_]*[a-zA-Z0-9]$Minimum length : 3Maximum 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=1234Pattern : ^[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 |
7 - LbHealthCheckCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| lb_health_check required | LbHealthCheckCreate |
8 - LbHealthCheckList
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| health_check_type required | LB Health Check type Example : DEFAULT | enum (DEFAULT, CUSTOM) | |
| id required | LB Health Check ID Example : 46c681018e33453085ca7c8db54e0076 | string | |
| lb_server_group_count required | LB Server Group count Example : 2 | integer | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | LB Health Check name Example : Test-LbMonitor-01 | string | |
| protocol required | LB Health Check Protocol Example : TCP | enum (TCP, HTTP, HTTPS) | |
| state required | LB Health Check state Example : ACTIVE | string | |
| subnet_id required | Service Subnet ID Example : 60fba45cb6c811efba41ba92e4fe7200 | string |
9 - LbHealthCheckListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| lb_health_checks required | array[LbHealthCheckList] | ||
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
10 - LbHealthCheckSet
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : this is an lb server group | any of [string, null] | |
| health_check_count optional | LB Health Check count Example : 3 | any of [integer, null] | |
| health_check_interval optional | LB Health Check interval Example : 5 | any of [integer, null] | |
| health_check_port optional | LB Health Check port Example : 80 | any of [integer, null] | |
| health_check_timeout optional | LB Health Check timeout Example : 5 | any of [integer, null] | |
| health_check_url optional | LB Health Check URL Example : /testPattern : ^\/[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=1234Pattern : ^[a-zA-Z0-9_\W]*$ | any of [string, null] | |
| response_code optional | LB Health Check Response code Example : 200 | any of [string, null] |
11 - LbHealthCheckSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| lb_health_check required | LbHealthCheckSet |
12 - LbHealthCheckShow
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : e3cd678b11784734bc366148aa37580e | any of [string, null] | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| description optional | Description Example : this is an lb server group | any of [string, null] | |
| health_check_count optional | LB Health Check count Example : 3 | integer | 3 |
| health_check_interval optional | LB Health Check interval Example : 5 | integer | 5 |
| health_check_port required | LB Health Check port Example : 80 | any of [integer, null] | |
| health_check_timeout optional | LB Health Check timeout Example : 5 | integer | 5 |
| health_check_type required | LB Health Check type Example : DEFAULT | enum (DEFAULT, CUSTOM) | |
| health_check_url required | LB Health Check URL Example : /test | any of [string, null] | |
| http_method required | LB Health Check HTTP Method Example : GET | any of [string, null] | |
| id required | LB Health Check ID Example : 46c681018e33453085ca7c8db54e0076 | string | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | LB Health Check name Example : Test-LbMonitor-01 | string | |
| protocol optional | LB Health Check Protocol Example : TCP | enum (TCP, HTTP, HTTPS) | TCP |
| request_data required | LB Health Check Request data Example : username=admin&password=1234 | any of [string, null] | |
| response_code required | LB Health Check Response code Example : 200 | any of [string, null] | |
| state required | LB Health Check state Example : ACTIVE | string | |
| subnet_id required | Service Subnet ID Example : 60fba45cb6c811efba41ba92e4fe7200 | any of [string, null] | |
| vpc_id required | VPC ID Example : 8acceeb6920c4fc494490d864f67f0b5 | any of [string, null] |
13 - LbHealthCheckShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| lb_health_check required | LbHealthCheckShow |
14 - LbListenerCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| listener required | ListenerForCreate |
15 - LbListenerCreateRequestV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| listener required | ListenerForCreate |
16 - LbListenerListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| listeners required | A list of listeners. | 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] |
17 - LbListenerSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| listener required | ListenerForSet |
18 - LbListenerSetRequestV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| listener required | ListenerForSet |
19 - LbListenerShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| listener required | ListenerForShow |
20 - LbServerGroup
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : e3cd678b11784734bc366148aa37580e | string | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| description optional | Description Example : this is an lb server group | any of [string, null] | |
| id required | LB Server Group ID Example : 3d8d8754d0d54683a29f3dcc3dd95d5b | string | |
| lb_health_check_id required | LB Health Check ID Example : 46c681018e33453085ca7c8db54e0076 | any of [string, null] | |
| lb_method required | LB Method Example : ROUND_ROBIN | enum (ROUND_ROBIN, LEAST_CONNECTION, IP_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION) | |
| lb_name optional | Load Balancer name Example : Test-LB-01 | any of [string, null] | |
| loadbalancer_id optional | Load Balancer ID Example : 82efa35c88834bc083020443e57faa10 | any of [string, null] | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | LB Server Group name Example : ServerGroup01 | string | |
| protocol required | Protocol Example : TCP | enum (TCP, UDP) | |
| state required | LB Server Group state Example : ACTIVE | string | |
| subnet_id required | Service Subnet ID Example : 60fba45cb6c811efba41ba92e4fe7200 | string | |
| vpc_id required | VPC ID Example : 8acceeb6920c4fc494490d864f67f0b5 | string |
21 - LbServerGroupCreate
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : this is an lb server group | any of [string, null] | |
| lb_health_check_id optional | LB Health Check ID Example : 46c681018e33453085ca7c8db54e0076 | any of [string, null] | |
| lb_method required | LB Method Example : ROUND_ROBIN | enum (ROUND_ROBIN, LEAST_CONNECTION, IP_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION) | |
| name required | LB Health Check name Example : ServerGroup01Pattern : ^[a-zA-Z0-9][-a-zA-Z0-9_]*[a-zA-Z0-9]$Minimum length : 3Maximum 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 |
22 - LbServerGroupCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| lb_server_group required | LbServerGroupCreate |
23 - LbServerGroupList
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| id required | LB Server Group ID Example : 3d8d8754d0d54683a29f3dcc3dd95d5b | string | |
| lb_health_check_id required | LB Health Check ID Example : 46c681018e33453085ca7c8db54e0076 | any of [string, null] | |
| lb_name optional | Load Balancer name Example : Test-LB-01 | any of [string, null] | |
| lb_server_group_member_count required | LB Server Group Member count Example : 2 | integer | |
| loadbalancer_id optional | Load Balancer ID Example : 82efa35c88834bc083020443e57faa10 | any of [string, null] | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | LB Server Group name Example : ServerGroup01 | string | |
| protocol required | Protocol Example : TCP | enum (TCP, UDP) | |
| state required | LB Server Group state Example : ACTIVE | string | |
| vpc_id required | VPC ID Example : 8acceeb6920c4fc494490d864f67f0b5 | string |
24 - LbServerGroupListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| lb_server_groups required | array[LbServerGroupList] | ||
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
25 - LbServerGroupSet
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : this is an lb server group | any of [string, null] | |
| lb_health_check_id optional | LB Health Check ID Example : 46c681018e33453085ca7c8db54e0076 | any of [string, null] | |
| lb_method optional | LB Method Example : ROUND_ROBIN | any of [enum (ROUND_ROBIN, LEAST_CONNECTION, IP_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION), null] |
26 - LbServerGroupSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| lb_server_group required | LbServerGroupSet |
27 - LbServerGroupShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| lb_server_group required | LbServerGroup |
28 - ListenerForCreate
| Name | Description | Schema | Default |
|---|---|---|---|
| condition_type optional | The condition type of the listener. Example : URL_PATH | any of [enum (URL_PATH, HOST_HEADER, PROTOCOL_PORT), null] | |
| description optional | description Example : | any of [string, null] | |
| https_redirection optional | The https redirection of the listener. | any of [HttpsRedirection, null] | |
| insert_client_ip optional | Whether the client IP should be inserted. Example : | any of [boolean, null] | |
| loadbalancer_id required | The ID of the load balancer. Example : | string | |
| name required | The name of the listener. Example : Pattern : ^[a-zA-Z0-9-_]*$Minimum length : 3Maximum length : 63 | string | |
| persistence optional | The persistence of the listener. Example : | any of [string, null] | |
| protocol required | The protocol of the listener. Example : | string | |
| response_timeout optional | The response timeout of the listener. Example : | any of [integer, null] | |
| routing_action required | The routing action of the listener. Example : LB_SERVER_GROUP | enum (LB_SERVER_GROUP, URL_REDIRECT) | |
| server_group_id optional | The ID of the server group. Example : | any of [string, null] | |
| service_port required | The port of the listener. Example : Minimum : 1Maximum : 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] |
29 - ListenerForList
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | The name of the listener. Example : Pattern : ^[a-zA-Z0-9-_]*$Minimum length : 3Maximum length : 63 | string | |
| protocol required | The protocol of the listener. Example : | string | |
| service_port required | The port of the listener. Example : Minimum : 1Maximum : 65534 | integer | |
| state optional | The State of the listener. Example : | any of [string, null] |
30 - ListenerForSet
| Name | Description | Schema | Default |
|---|---|---|---|
| condition_type optional | The condition type of the listener. Example : URL_PATH | any of [enum (URL_PATH, HOST_HEADER, PROTOCOL_PORT), null] | |
| description optional | description Example : | any of [string, null] | |
| https_redirection optional | The https redirection of the listener. | any of [HttpsRedirection, null] | |
| insert_client_ip optional | Whether the client IP should be inserted. Example : | any of [boolean, null] | |
| persistence optional | The persistence of the listener. Example : | any of [string, null] | |
| response_timeout optional | The response timeout of the listener. Example : | any of [integer, null] | |
| server_group_id optional | The ID of the server group. Example : | any of [string, null] | |
| session_duration_time optional | The session duration time. Example : | any of [integer, null] | |
| sni_certificate optional | The sni certificate of the listener. | any of [array[SniCertificate], null] | |
| ssl_certificate optional | The ssl certificate of the listener. | any of [SslCertificate, 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] |
31 - ListenerForShow
| Name | Description | Schema | Default |
|---|---|---|---|
| condition_type optional | The condition type of the listener. Example : URL_PATH | any of [enum (URL_PATH, HOST_HEADER, PROTOCOL_PORT), null] | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| description optional | description Example : | any of [string, null] | |
| https_redirection optional | The https redirection of the listener. | any of [HttpsRedirection, null] | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| insert_client_ip optional | Whether the client IP should be inserted. Example : | any of [boolean, null] | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | The name of the listener. Example : Pattern : ^[a-zA-Z0-9-_]*$Minimum length : 3Maximum length : 63 | string | |
| persistence optional | The persistence of the listener. Example : | any of [string, null] | |
| protocol required | The protocol of the listener. Example : | string | |
| response_timeout optional | The response timeout of the listener. Example : | any of [integer, null] | |
| routing_action optional | The routing action of the listener. Example : LB_SERVER_GROUP | any of [enum (LB_SERVER_GROUP, URL_REDIRECT), null] | |
| server_group_id optional | The ID of the server group. Example : | any of [string, null] | |
| server_group_name optional | The Name of the server group. Example : | any of [string, null] | |
| service_port required | The port of the listener. Example : Minimum : 1Maximum : 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] |
32 - Loadbalancer
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | The account ID of the load balancer. Example : | string | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| description optional | description Example : | any of [string, null] | |
| firewall_id optional | Firewall ID Example : | any of [string, null] | |
| health_check_ip required | Health check IP | array[string] | |
| id required | ID Example : | string | |
| layer_type required | Layer type Example : | string | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | name Example : | string | |
| public_nat_enabled optional | Public NAT Enabled Status Example : | any of [boolean, null] | |
| service_ip optional | The service IP of the load balancer. Example : | any of [string, null] | |
| source_nat_ip optional | Source NAT IP Example : | any of [string, null] | |
| state required | The state of the load balancer. Example : | string | |
| subnet_id required | Subnet ID Example : | string | |
| vpc_id required | VPC ID Example : | string |
33 - LoadbalancerCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| loadbalancer required | LoadbalancerCreateRequestDetail |
34 - LoadbalancerCreateRequestDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | description Example : | any of [string, null] | |
| firewall_enabled optional | Firewall enabled Example : True | any of [boolean, null] | True |
| firewall_logging_enabled optional | Firewall logging enabled Example : True | any of [boolean, null] | True |
| health_check_ip_1 optional | Health check IP Example : | any of [string, null] | |
| health_check_ip_2 optional | Health check IP Example : | any of [string, null] | |
| layer_type required | Layer type Example : | string | |
| name required | name Example : Pattern : ^[a-zA-Z0-9-_]*$Minimum length : 3Maximum 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 |
35 - LoadbalancerCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| loadbalancer required | LoadbalancerCreateResponseDetail |
36 - LoadbalancerCreateResponseDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | The account ID of the load balancer. Example : | string | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| description optional | description Example : | any of [string, null] | |
| id required | ID Example : | string | |
| layer_type required | Layer type Example : | string | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | name Example : | string | |
| state required | The state of the load balancer. Example : | string | |
| subnet_id required | Subnet ID Example : | string | |
| vpc_id required | VPC ID Example : | string |
37 - LoadbalancerListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| loadbalancers required | array[LoadbalancerListResponseDetail] | ||
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
38 - LoadbalancerListResponseDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| firewall_id optional | Firewall ID Example : | any of [string, null] | |
| id required | ID Example : | string | |
| layer_type optional | Layer type Example : | any of [string, null] | |
| listener_count optional | The number of listeners. Example : | any of [integer, null] | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name optional | The name of the load balancer. Example : | any of [string, null] | |
| public_nat_enabled optional | Public NAT Enabled Status Example : | any of [boolean, null] | |
| service_ip optional | The service IP of the load balancer. Example : | any of [string, null] | |
| source_nat_ip optional | Source NAT IP Example : | any of [string, null] | |
| state optional | The state of the load balancer. Example : | any of [string, null] | |
| subnet_id optional | Subnet ID Example : | any of [string, null] | |
| vpc_id optional | VPC ID Example : | any of [string, null] |
39 - LoadbalancerShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| loadbalancer required | Loadbalancer |
40 - LoadbalancerStaticNatResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| static_nat required | StaticNat |
41 - LoadbalancerUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| loadbalancer required | LoadbalancerUpdateRequestDetail |
42 - LoadbalancerUpdateRequestDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| description required | description Example : Maximum length : 255 | string |
43 - Member
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| lb_server_group_id required | ID of Lb Server Group Example : | string | |
| member_ip required | IP of Member Example : | string | |
| member_port required | Protocol port of Member Example : | integer | |
| member_state required | Member State of Member Example : | string | |
| member_weight required | Weight of Member Example : | integer | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | Name of Member Example : | string | |
| object_id optional | Object ID of Member Example : | any of [string, null] | |
| object_type required | Object Type of Member Example : VM | enum (VM, BM, MANUAL, MNGC) | |
| state required | State of Member Example : CREATING | enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR) | |
| subnet_id required | ID of Subnet Example : | string | |
| uuid required | UUID of Member Example : | string |
44 - MemberCreateRequestV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| member_ip required | IP of Member Example : 192.168.0.1 | string | |
| member_port required | Protocol port of Member Example : 80Minimum : 1Maximum : 65534 | integer | |
| member_state optional | Member State of Member Example : ENABLE | any of [enum (ENABLE, DISABLE), null] | |
| member_weight optional | Weight of Member Example : 100Minimum : 1Maximum : 1000 | integer | |
| name required | Name of Member Example : virtualserver-1Pattern : ^[a-zA-Z0-9\s\-_\.]*$Minimum length : 1Maximum length : 63 | string | |
| object_id optional | Object ID of Member Example : 1 | string | |
| object_type required | Object Type of Member Example : VM | string |
45 - MemberDeleteBulkRequestV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| member_id_list required | ID list of Member | array[string] |
46 - MemberListCreateRequestV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| members required | array[MemberCreateRequestV1Dot1] |
47 - MemberListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count optional | total count Example : 20 | any of [integer, null] | |
| links optional | links Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}] | any of [array[object], null] | |
| members required | array[Member] |
48 - MemberSet
| Name | Description | Schema | Default |
|---|---|---|---|
| member_port optional | Protocol port of Member Example : 80 | any of [integer, null] | |
| member_state optional | Member State of Member Example : ENABLE | any of [enum (ENABLE, DISABLE), null] | |
| member_weight optional | Weight of Member Example : 100 | any of [integer, null] |
49 - MemberSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| member required | MemberSet |
50 - MemberShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| member required | any of [Member, null] |
51 - MemberWithHealthState
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| health_state required | Health State of Member Example : | string | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| lb_server_group_id required | ID of Lb Server Group Example : | string | |
| member_ip required | IP of Member Example : | string | |
| member_port required | Protocol port of Member Example : | integer | |
| member_state required | Member State of Member Example : | string | |
| member_weight required | Weight of Member Example : | integer | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | Name of Member Example : | string | |
| object_id required | Object ID of Member Example : | any of [string, null] | |
| object_type required | Object Type of Member Example : VM | enum (VM, BM, MANUAL, MNGC) | |
| state required | State of Member Example : CREATING | enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR) |
52 - MemberWithHealthStateListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| members required | array[MemberWithHealthState] | ||
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
53 - SniCertificate
| Name | Description | Schema | Default |
|---|---|---|---|
| domain_name optional | Domain name for sni ssl Example : Pattern : ^[a-zA-Z0-9](?:[a-zA-Z0-9.-]{0,61}[a-zA-Z0-9])?$ | any of [string, null] | |
| sni_cert_id optional | Certificate id for sni ssl Example : | any of [string, null] |
54 - SslCertificate
| Name | Description | Schema | Default |
|---|---|---|---|
| client_cert_id optional | Certificate id for client ssl Example : | any of [string, null] | |
| client_cert_level optional | Certificate level for client ssl Example : | any of [string, null] | |
| server_cert_level optional | Certificate level for server ssl Example : | any of [string, null] |
55 - StaticNat
| Name | Description | Schema | Default |
|---|---|---|---|
| external_ip_address required | Static Nat External Ip Address Example : | string | |
| publicip_id optional | Publicip ID Example : | any of [string, null] | |
| state required | Static Nat State Example : | string |
56 - StaticNatCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| static_nat required | StaticNatCreateRequestDetail |
57 - StaticNatCreateRequestDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| publicip_id required | publicip_id Example : | string |
58 - StaticNatCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| static_nat required | StaticNatCreateResponseDetail |
59 - StaticNatCreateResponseDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id optional | account_id Example : | any of [string, null] | |
| action_type optional | action_type Example : | any of [string, null] | |
| created_at required | 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] |
60 - Tag
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | tag key Example : | string | |
| value required | tag value Example : | string |