GSLB
Overview
Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of GSLB service and how to call CLI. The output is formatted as a JSON string
Version
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Status | Not Before |
|---|
| 1.1 | CURRENT | - |
| 1.0 | DEPRECATED | 20260531 |
CLI Version History
1.1
GSLB CLI has been updated to version 1.1.
Changes
- [Changed]
gslb gslb create - Command has been changed.- The following option has been added:
--routing-control-enabled
- [New]
gslb gslb regional routing list - Command has been added. - [New]
gslb gslb-regional-routing-set - Command has been added.
1.0
GSLB CLI has been released.
Changes
- [New]
gslb gslb list - Command has been added. - [New]
gslb gslb create - Command has been added. - [New]
gslb gslb show - Command has been added. - [New]
gslb gslb update - Command has been added. - [New]
gslb gslb delete - Command has been added. - [New]
gslb gslb-health-check update - Command has been added. - [New]
gslb gslb-resource list - Command has been added. - [New]
gslb gslb-resource update - Command has been added.
1 - CLIs
1.1 - CreateGslb
1.1.1 - 1.1
scp-cli gslb gslb create
--protocol <value>
--resources <value>
--name <value>
--env_usage <value>
--algorithm <value>
[--description <value>]
[--tags <value>]
[--health_check_interval <value>]
[--health_check_probe_timeout <value>]
[--health_check_user_id <value>]
[--health_check_user_password <value>]
[--receive_string <value>]
[--send_string <value>]
[--service_port <value>]
[--timeout <value>]
Description
Create a global Server Load Balancer resource for distributing traffic across multiple regions.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
protocol
required | string | The protocol used for health checks (e.g., ICMP, TCP, HTTP, HTTPS). | https |
resources
required | array | The list of resources for the GSLB. | '{"description": "", "destination": "192.168.1.100", "region": "KR-WEST-1", "weight": 10}' |
name
required | string | The name of the GSLB. | example.gslb.e.samsungsdscloud.com |
env_usage
required | string | The environment usage type for the GSLB (e.g., PUBLIC). | PUBLIC |
algorithm
required | string | The load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO). | ROUND_ROBIN |
description
optional | string | Description | Example Description for GSLB |
tags
optional | array | Tag List | '{"key": "", "value": ""}' |
health_check_interval
optional | integer | The GSLB Health Check Interval. | 5 |
health_check_probe_timeout
optional | integer | The GSLB Health Check Probe Timeout. | 5 |
health_check_user_id
optional | string | The GSLB Health Check User Name. | user |
health_check_user_password
optional | string | The GSLB Health Check Password. | Passw0rd! |
receive_string
optional | string | The GSLB Health Check Receive String. | OK |
send_string
optional | string | The GSLB Health Check Send String. If no input is provided, it operates as a “GET /” request. | GET / |
service_port
optional | integer | The GSLB Health Check Service Port. | 1 |
timeout
optional | integer | The GSLB Health Check Timeout. It must be greater than the Interval. | 6 |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| algorithm | The load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO). | ROUND_ROBIN |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Example Description for GSLB |
| env_usage | The environment usage type for the GSLB (e.g., PUBLIC). | PUBLIC |
| health_check | Health check configuration for monitoring GSLB endpoint availability. | |
| linked_resource_count | The number of resources linked to this GSLB. | 2 |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The name of the GSLB. | example.gslb.e.samsungsdscloud.com |
| state | The current state of the GSLB (e.g., ACTIVE, CREATING, EDITING, ERROR, DELETING). | ACTIVE |
1.1.2 - 1.0
scp-cli gslb gslb create
--protocol <value>
--resources <value>
--name <value>
--env_usage <value>
--algorithm <value>
[--description <value>]
[--tags <value>]
[--health_check_interval <value>]
[--health_check_probe_timeout <value>]
[--health_check_user_id <value>]
[--health_check_user_password <value>]
[--receive_string <value>]
[--send_string <value>]
[--service_port <value>]
[--timeout <value>]
Description
Create a global Server Load Balancer resource for distributing traffic across multiple regions.
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|
protocol
required | string | The protocol used for health checks (e.g., ICMP, TCP, HTTP, HTTPS). | https |
resources
required | array | | '{"description": "", "destination": "192.168.1.100", "disabled": false, "region": "KR-WEST-1", "weight": 10}' |
name
required | string | The name of the GSLB. | - |
env_usage
required | string | The environment usage type for the GSLB (e.g., PUBLIC). | - |
algorithm
required | string | The load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO). | - |
description
optional | string | Description | - |
tags
optional | array | Tag List | '{"key": "", "value": ""}' |
health_check_interval
optional | integer | The GSLB Health Check Interval. | 5 |
health_check_probe_timeout
optional | integer | The GSLB Health Check Probe Timeout. | 5 |
health_check_user_id
optional | string | The GSLB Health Check User Name. | user |
health_check_user_password
optional | string | The GSLB Health Check Password. | Passw0rd! |
receive_string
optional | string | The GSLB Health Check Receive String. | OK |
send_string
optional | string | The GSLB Health Check Send String. If no input is provided, it operates as a “GET /” request. | GET / |
service_port
optional | integer | The GSLB Health Check Service Port. | 1 |
timeout
optional | integer | The GSLB Health Check Timeout. It must be greater than the Interval. | 6 |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| algorithm | The load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO). | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | |
| env_usage | The environment usage type for the GSLB (e.g., PUBLIC). | |
| health_check | | |
| linked_resource_count | The number of resources linked to this GSLB. | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The name of the GSLB. | |
| state | The current state of the GSLB (e.g., ACTIVE, CREATING, EDITING, ERROR, DELETING). | |
1.2 - DeleteGslb
1.2.1 - 1.1
scp-cli gslb gslb delete
--gslb_id <value>
Description
Delete the Global Server Load Balancer resource.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
gslb_id
required | string | The unique identifier of the GSLB. | - |
1.2.2 - 1.0
scp-cli gslb gslb delete
--gslb_id <value>
Description
Delete the Global Server Load Balancer resource.
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|
gslb_id
required | string | The unique identifier of the GSLB. | - |
1.3 - ListGslbResources
1.3.1 - 1.1
scp-cli gslb gslb-resource list
--gslb_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
The list of resources for the GSLB.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
gslb_id
required | string | The unique identifier of the GSLB. | - |
size
optional | integer | size | 20 |
page
optional | integer | page | 0 |
sort
optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | |
| destination | The destination endpoint for the GSLB resource. | 192.168.1.100 |
| health_check_status | The health check status of the GSLB resource (e.g., CONNECTED, DISCONNECTED). | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| region | The region where the GSLB resource is located. | KR-WEST-1 |
| status | Whether to use the GSLB resource. (e.g., ENABLE, DISABLE) | |
| weight | The weight for load balancing distribution (0-100). | 10 |
1.3.2 - 1.0
scp-cli gslb gslb-resource list
--gslb_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
Description
The list of resources for the GSLB.
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|
gslb_id
required | string | The unique identifier of the GSLB. | - |
size
optional | integer | size | 20 |
page
optional | integer | page | 0 |
sort
optional | string | sort | created_at:desc |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | |
| destination | The destination endpoint for the GSLB resource. | 192.168.1.100 |
| disabled | The GSLB Resource disabled. | False |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| region | The region where the GSLB resource is located. | KR-WEST-1 |
| weight | The weight for load balancing distribution (0-100). | 10 |
1.4 - ListGslbs
1.4.1 - 1.1
scp-cli gslb gslb list
[--size <value>]
[--page <value>]
[--sort <value>]
[--state <value>]
[--name <value>]
Description
Gets a list of Global Server Load Balancers.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
size
optional | integer | size | 20 |
page
optional | integer | page | 0 |
sort
optional | string | sort | created_at:desc |
state
optional | string | The current state of the GSLB (e.g., ACTIVE, CREATING, EDITING, ERROR, DELETING). | - |
name
optional | string | The name of the GSLB. | - |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| algorithm | The load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO). | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | |
| env_usage | The environment usage type for the GSLB (e.g., PUBLIC). | |
| linked_resource_count | The number of resources linked to this GSLB. | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The name of the GSLB. | |
| state | The current state of the GSLB (e.g., ACTIVE, CREATING, EDITING, ERROR, DELETING). | |
1.4.2 - 1.0
scp-cli gslb gslb list
[--size <value>]
[--page <value>]
[--sort <value>]
[--state <value>]
[--name <value>]
Description
Gets a list of Global Server Load Balancers.
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|
size
optional | integer | size | 20 |
page
optional | integer | page | 0 |
sort
optional | string | sort | created_at:desc |
state
optional | string | The current state of the GSLB (e.g., ACTIVE, CREATING, EDITING, ERROR, DELETING). | - |
name
optional | string | The name of the GSLB. | - |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| algorithm | The load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO). | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | |
| env_usage | The environment usage type for the GSLB (e.g., PUBLIC). | |
| linked_resource_count | The number of resources linked to this GSLB. | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The name of the GSLB. | |
| state | The current state of the GSLB (e.g., ACTIVE, CREATING, EDITING, ERROR, DELETING). | |
1.5 - ListGslbsRegionalRoutingControl
1.5.1 - 1.1
scp-cli gslb gslb regional routing list
[--size <value>]
[--page <value>]
[--sort <value>]
[--region <value>]
[--status <value>]
[--name <value>]
Description
Gets a list of GSLB regional routing controls.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
size
optional | integer | size | 20 |
page
optional | integer | page | 0 |
sort
optional | string | sort | created_at:desc |
region
optional | string | The region where the GSLB resource is located. | - |
status
optional | **** | Whether to use the GSLB resource. (e.g., ENABLE, DISABLE) | - |
name
optional | string | The name of the GSLB. | - |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| algorithm | The load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO). | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | |
| env_usage | The environment usage type for the GSLB (e.g., PUBLIC). | |
| linked_regional_resource_count | The number of resources linked to this GSLB in the region. | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The name of the GSLB. | |
| region | The region where the GSLB resource is located. | |
| status | Whether to use the GSLB resource. (e.g., ENABLE, DISABLE) | |
1.6 - SetGslb
1.6.1 - 1.1
scp-cli gslb gslb update
--gslb_id <value>
[--algorithm <value>]
[--description <value>]
Description
Update the Global Server Load Balancer resource.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
gslb_id
required | string | The unique identifier of the GSLB. | - |
algorithm
optional | string | The load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO). | ROUND_ROBIN |
description
optional | string | Description | - |
1.6.2 - 1.0
scp-cli gslb gslb update
--gslb_id <value>
[--algorithm <value>]
[--description <value>]
Description
Update the Global Server Load Balancer resource.
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|
gslb_id
required | string | The unique identifier of the GSLB. | - |
algorithm
optional | string | The load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO). | ROUND_ROBIN |
description
optional | string | Description | - |
1.7 - SetGslbHealthCheck
1.7.1 - 1.1
scp-cli gslb gslb-health-check update
--gslb_id <value>
--protocol <value>
[--health_check_interval <value>]
[--health_check_probe_timeout <value>]
[--health_check_user_id <value>]
[--health_check_user_password <value>]
[--receive_string <value>]
[--send_string <value>]
[--service_port <value>]
[--timeout <value>]
Description
Set GSLB Health Checks.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
gslb_id
required | string | The unique identifier of the GSLB. | - |
protocol
required | string | The protocol used for health checks (e.g., ICMP, TCP, HTTP, HTTPS). | https |
health_check_interval
optional | integer | The GSLB Health Check Interval. | 5 |
health_check_probe_timeout
optional | integer | The GSLB Health Check Probe Timeout. | 5 |
health_check_user_id
optional | string | The GSLB Health Check User Name. | user |
health_check_user_password
optional | string | The GSLB Health Check Password. | Passw0rd! |
receive_string
optional | string | The GSLB Health Check Receive String. | OK |
send_string
optional | string | The GSLB Health Check Send String. If no input is provided, it operates as a “GET /” request. | GET / |
service_port
optional | integer | The GSLB Health Check Service Port. | 1 |
timeout
optional | integer | The GSLB Health Check Timeout. It must be greater than the Interval. | 6 |
1.7.2 - 1.0
scp-cli gslb gslb-health-check update
--gslb_id <value>
--protocol <value>
[--health_check_interval <value>]
[--health_check_probe_timeout <value>]
[--health_check_user_id <value>]
[--health_check_user_password <value>]
[--receive_string <value>]
[--send_string <value>]
[--service_port <value>]
[--timeout <value>]
Description
Set GSLB Health Checks.
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|
gslb_id
required | string | The unique identifier of the GSLB. | - |
protocol
required | string | The protocol used for health checks (e.g., ICMP, TCP, HTTP, HTTPS). | https |
health_check_interval
optional | integer | The GSLB Health Check Interval. | 5 |
health_check_probe_timeout
optional | integer | The GSLB Health Check Probe Timeout. | 5 |
health_check_user_id
optional | string | The GSLB Health Check User Name. | user |
health_check_user_password
optional | string | The GSLB Health Check Password. | Passw0rd! |
receive_string
optional | string | The GSLB Health Check Receive String. | OK |
send_string
optional | string | The GSLB Health Check Send String. If no input is provided, it operates as a “GET /” request. | GET / |
service_port
optional | integer | The GSLB Health Check Service Port. | 1 |
timeout
optional | integer | The GSLB Health Check Timeout. It must be greater than the Interval. | 6 |
1.8 - SetGslbRegionalRoutingControl
1.8.1 - 1.1
scp-cli gslb gslb-regional-routing-set
--gslb_id <value>
--status <value>
--region <value>
Description
Updates GSLB regional routing control settings.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
gslb_id
required | string | The unique identifier of the GSLB. | - |
status
required | string | Whether to use the GSLB resource. (e.g., ENABLE, DISABLE) | ENABLE |
region
required | string | The region where the GSLB resource is located. | KR-WEST-1 |
1.9 - SetGslbResources
1.9.1 - 1.1
scp-cli gslb gslb-resource update
--gslb_id <value>
--resources <value>
Description
Set GSLB Resources.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
gslb_id
required | string | The unique identifier of the GSLB. | - |
resources
required | array | The list of resources for the GSLB. | '{"description": "", "destination": "192.168.1.100", "region": "KR-WEST-1", "weight": 10}' |
1.9.2 - 1.0
scp-cli gslb gslb-resource update
--gslb_id <value>
--resources <value>
Description
Set GSLB Resources.
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|
gslb_id
required | string | The unique identifier of the GSLB. | - |
resources
required | array | | '{"description": "", "destination": "192.168.1.100", "disabled": false, "region": "KR-WEST-1", "weight": 10}' |
1.10 - ShowGslb
1.10.1 - 1.1
scp-cli gslb gslb show
--gslb_id <value>
Description
Shows details of a specific Global Server Load Balancer.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
gslb_id
required | string | The unique identifier of the GSLB. | - |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| algorithm | The load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO). | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | |
| env_usage | The environment usage type for the GSLB (e.g., PUBLIC). | |
| health_check | | |
| linked_resource_count | The number of resources linked to this GSLB. | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The name of the GSLB. | |
| state | The current state of the GSLB (e.g., ACTIVE, CREATING, EDITING, ERROR, DELETING). | |
1.10.2 - 1.0
scp-cli gslb gslb show
--gslb_id <value>
Description
Shows details of a specific Global Server Load Balancer.
State
ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|
gslb_id
required | string | The unique identifier of the GSLB. | - |
Responses
| Name | Description | Example |
|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| algorithm | The load balancing algorithm for GSLB traffic distribution (e.g., ROUND_ROBIN, RATIO). | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | |
| env_usage | The environment usage type for the GSLB (e.g., PUBLIC). | |
| health_check | | |
| linked_resource_count | The number of resources linked to this GSLB. | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The name of the GSLB. | |
| state | The current state of the GSLB (e.g., ACTIVE, CREATING, EDITING, ERROR, DELETING). | |