This is the multi-page printable view of this section. Click here to print.
Models
- 1: GslbCreateRequest
- 2: GslbCreateRequestV1Dot1
- 3: GslbDetail
- 4: GslbHealthCheck
- 5: GslbHeathCheckShowResponse
- 6: GslbListResponse
- 7: GslbResource
- 8: GslbResourceListResponse
- 9: GslbResourceListResponseV1Dot1
- 10: GslbResourceResponse
- 11: GslbResourceResponseV1Dot1
- 12: GslbResourceSetRequest
- 13: GslbResourceSetRequestV1Dot1
- 14: GslbResourcesSetRequest
- 15: GslbResourcesSetResponse
- 16: GslbResourceV1Dot1
- 17: GslbResourceWithStatus
- 18: GslbResponseCommon
- 19: GslbRoutingControlListResponse
- 20: GslbRoutingControlRequest
- 21: GslbRoutingControlResponse
- 22: GslbRoutingControlResponseCommon
- 23: GslbSetRequest
- 24: GslbShowResponse
- 25: GslbShowResponseV1Dot1
- 26: GslbV1Dot1
- 27: Tag
1 - GslbCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| algorithm required | The load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO). Example : | string | |
| description optional | Description Example : | any of [string, null] | |
| env_usage required | The environment usage type for the GSLB (e.g., PUBLIC). Example : | string | |
| health_check optional | Health check configuration for monitoring GSLB endpoint availability. | any of [GslbHealthCheck, null] | |
| name required | The name of the GSLB. Example : | string | |
| resources required | array[GslbResource] | ||
| tags optional | Tag List | array[Tag] |
2 - GslbCreateRequestV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| algorithm required | The load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO). Example : ROUND_ROBIN | enum (RATIO, ROUND_ROBIN) | |
| description optional | Description Example : Example Description for GSLB | any of [string, null] | |
| env_usage required | The environment usage type for the GSLB (e.g., PUBLIC). Example : PUBLIC | enum (PUBLIC, PRIVATE) | |
| health_check optional | Health check configuration for monitoring GSLB endpoint availability. | any of [GslbHealthCheck, null] | |
| name required | The name of the GSLB. Example : example.gslb.e.samsungsdscloud.com | string | |
| resources required | The list of resources for the GSLB. | array[GslbResourceV1Dot1] | |
| tags optional | Tag List | array[Tag] |
3 - GslbDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| algorithm required | The load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO). 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] | |
| env_usage required | The environment usage type for the GSLB (e.g., PUBLIC). Example : | string | |
| health_check required | any of [GslbHeathCheckShowResponse, null] | ||
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| linked_resource_count required | The number of resources linked to this GSLB. 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 | The name of the GSLB. Example : | string | |
| state required | The current state of the GSLB (e.g., ACTIVE, CREATING, EDITING, ERROR, DELETING). Example : | string |
4 - GslbHealthCheck
| Name | Description | Schema | Default |
|---|---|---|---|
| health_check_interval optional | The GSLB Health Check Interval. Example : 5 | any of [integer, null] | |
| health_check_probe_timeout optional | The GSLB Health Check Probe Timeout. Example : 5 | any of [integer, null] | |
| health_check_user_id optional | The GSLB Health Check User Name. Example : user | any of [string, null] | |
| health_check_user_password optional | The GSLB Health Check Password. Example : Passw0rd! | any of [string, null] | |
| protocol required | The protocol used for health checks (e.g., ICMP, TCP, HTTP, HTTPS). Example : https | string | |
| receive_string optional | The GSLB Health Check Receive String. Example : OKPattern : ^[a-zA-Z\d]+$ | any of [string, null] | |
| send_string optional | The GSLB Health Check Send String. If no input is provided, it operates as a “GET /” request. Example : GET /Pattern : ^[^\u1100-\u11FF\uAC00-\uD7A3\uA960-\uA97C\uD7B0-\uD7FF\u3130-\u318F#<>]*$ | any of [string, null] | |
| service_port optional | The GSLB Health Check Service Port. Example : 1 | any of [integer, null] | |
| timeout optional | The GSLB Health Check Timeout. It must be greater than the Interval. Example : 6 | any of [integer, null] |
5 - GslbHeathCheckShowResponse
| 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_interval optional | The GSLB Health Check Interval. Example : | any of [integer, null] | |
| health_check_probe_timeout optional | The GSLB Health Check Probe Timeout. Example : | any of [integer, null] | |
| health_check_user_id optional | The GSLB Health Check User Name. Example : | any of [string, null] | |
| health_check_user_password optional | The GSLB Health Check Password. Example : | any of [string, null] | |
| 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 | |
| protocol required | The protocol used for health checks (e.g., ICMP, TCP, HTTP, HTTPS). Example : | string | |
| receive_string optional | The GSLB Health Check Receive String. Example : | any of [string, null] | |
| send_string optional | The GSLB Health Check Send String. If no input is provided, it operates as a “GET /” request. Example : | any of [string, null] | |
| service_port optional | The GSLB Health Check Service Port. Example : | any of [integer, null] | |
| timeout optional | The GSLB Health Check Timeout. It must be greater than the Interval. Example : | any of [integer, null] |
6 - GslbListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| gslbs required | array[GslbResponseCommon] | ||
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
7 - GslbResource
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : | any of [string, null] | |
| destination required | The destination endpoint for the GSLB resource. Example : 192.168.1.100 | string | |
| disabled optional | The GSLB Resource disabled. Example : False | any of [boolean, null] | |
| region required | The region where the GSLB resource is located. Example : KR-WEST-1 | string | |
| weight optional | The weight for load balancing distribution (0-100). Example : 10 | any of [integer, null] |
8 - GslbResourceListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| gslb_resources required | array[GslbResourceResponse] | ||
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
9 - GslbResourceListResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| gslb_resources required | array[GslbResourceResponseV1Dot1] | ||
| 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 - GslbResourceResponse
| 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 | |
| description optional | Description Example : | any of [string, null] | |
| destination required | The destination endpoint for the GSLB resource. Example : 192.168.1.100 | string | |
| disabled optional | The GSLB Resource disabled. Example : False | any of [boolean, null] | |
| 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 | |
| region required | The region where the GSLB resource is located. Example : KR-WEST-1 | string | |
| weight optional | The weight for load balancing distribution (0-100). Example : 10 | any of [integer, null] |
11 - GslbResourceResponseV1Dot1
| 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 | |
| description optional | Description Example : | any of [string, null] | |
| destination required | The destination endpoint for the GSLB resource. Example : 192.168.1.100 | string | |
| health_check_status required | The health check status of the GSLB resource (e.g., CONNECTED, DISCONNECTED). Example : CONNECTED | enum (CONNECTED, DISCONNECTED) | |
| 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 | |
| region required | The region where the GSLB resource is located. Example : KR-WEST-1 | string | |
| status required | Whether to use the GSLB resource. (e.g., ENABLE, DISABLE) Example : ENABLE | enum (ENABLE, DISABLE) | |
| weight optional | The weight for load balancing distribution (0-100). Example : 10 | any of [integer, null] |
12 - GslbResourceSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| resources required | array[GslbResource] |
13 - GslbResourceSetRequestV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : | any of [string, null] | |
| destination required | The destination endpoint for the GSLB resource. Example : 192.168.1.100 | string | |
| region required | The region where the GSLB resource is located. Example : KR-WEST-1 | string | |
| weight optional | The weight for load balancing distribution (0-100). Example : 10 | any of [integer, null] |
14 - GslbResourcesSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| resources required | The list of resources for the GSLB. | array[GslbResourceSetRequestV1Dot1] |
15 - GslbResourcesSetResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| gslb_resources required | array[GslbResourceWithStatus] |
16 - GslbResourceV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : | any of [string, null] | |
| destination required | The destination endpoint for the GSLB resource. Example : 192.168.1.100 | string | |
| region required | The region where the GSLB resource is located. Example : KR-WEST-1 | string | |
| weight optional | The weight for load balancing distribution (0-100). Example : 10 | any of [integer, null] |
17 - GslbResourceWithStatus
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description Example : | any of [string, null] | |
| destination required | The destination endpoint for the GSLB resource. Example : 192.168.1.100 | string | |
| region required | The region where the GSLB resource is located. Example : KR-WEST-1 | string | |
| status required | Whether to use the GSLB resource. (e.g., ENABLE, DISABLE) Example : ENABLE | enum (ENABLE, DISABLE) | |
| weight optional | The weight for load balancing distribution (0-100). Example : 10 | any of [integer, null] |
18 - GslbResponseCommon
| Name | Description | Schema | Default |
|---|---|---|---|
| algorithm required | The load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO). 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] | |
| env_usage required | The environment usage type for the GSLB (e.g., PUBLIC). Example : | string | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| linked_resource_count required | The number of resources linked to this GSLB. 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 | The name of the GSLB. Example : | string | |
| state required | The current state of the GSLB (e.g., ACTIVE, CREATING, EDITING, ERROR, DELETING). Example : | string |
19 - GslbRoutingControlListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| regional_gslbs required | array[GslbRoutingControlResponseCommon] | ||
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
20 - GslbRoutingControlRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| region required | The region where the GSLB resource is located. Example : KR-WEST-1 | string | |
| status required | Whether to use the GSLB resource. (e.g., ENABLE, DISABLE) Example : ENABLE | enum (ENABLE, DISABLE) |
21 - GslbRoutingControlResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| regional_gslb required | GslbRoutingControlResponseCommon |
22 - GslbRoutingControlResponseCommon
| Name | Description | Schema | Default |
|---|---|---|---|
| algorithm required | The load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO). 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] | |
| env_usage required | The environment usage type for the GSLB (e.g., PUBLIC). Example : | string | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| linked_regional_resource_count required | The number of resources linked to this GSLB in the region. 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 | The name of the GSLB. Example : | string | |
| region required | The region where the GSLB resource is located. Example : | string | |
| status required | Whether to use the GSLB resource. (e.g., ENABLE, DISABLE) Example : ENABLE | enum (ENABLE, DISABLE) |
23 - GslbSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| algorithm optional | The load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO). Example : ROUND_ROBIN | any of [string, null] | |
| description optional | Description Example : | any of [string, null] |
24 - GslbShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| gslb required | GslbDetail |
25 - GslbShowResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| gslb required | GslbV1Dot1 |
26 - GslbV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| algorithm required | The load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO). Example : ROUND_ROBIN | enum (RATIO, ROUND_ROBIN) | |
| 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 : Example Description for GSLB | any of [string, null] | |
| env_usage required | The environment usage type for the GSLB (e.g., PUBLIC). Example : PUBLIC | enum (PUBLIC, PRIVATE) | |
| health_check optional | Health check configuration for monitoring GSLB endpoint availability. | any of [GslbHeathCheckShowResponse, null] | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| linked_resource_count required | The number of resources linked to this GSLB. 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 | The name of the GSLB. Example : example.gslb.e.samsungsdscloud.com | string | |
| state required | The current state of the GSLB (e.g., ACTIVE, CREATING, EDITING, ERROR, DELETING). Example : ACTIVE | enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING) |
27 - Tag
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | tag key Example : | string | |
| value required | tag value Example : | string |