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

Return to the regular view of this page.

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.

VersionStatusNot Before
1.1CURRENT-
1.0DEPRECATED20260531

1 - CLIs

1.1 - CreateGslb

1.1.1 - 1.1

scpcli 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

The GSLB Create.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
protocol
required		stringThe GSLB Health Check Protocol.-
resources
required		arrayThe GSLB Resource List.'{"description": "", "destination": "", "region": "", "weight": 0}'
name
required		stringThe Name of the gslb.example.gslb.e.samsungsdscloud.com
env_usage
required		stringThe GSLB Environment Usage.PUBLIC
algorithm
required		stringThe GSLB Algorithm.ROUND_ROBIN
description
optional		stringDescriptionExample Description for GSLB
tags
optional		arrayTag List'{"key": "", "value": ""}'
health_check_interval
optional		integerThe GSLB Health Check Interval.-
health_check_probe_timeout
optional		integerThe GSLB Health Check Probe Timeout.-
health_check_user_id
optional		stringThe GSLB Health Check User Name.-
health_check_user_password
optional		stringThe GSLB Health Check Password.-
receive_string
optional		stringThe GSLB Health Check Receive String.-
send_string
optional		stringThe GSLB Health Check Send String.-
service_port
optional		integerThe GSLB Health Check Service Port.-
timeout
optional		integerThe GSLB Health Check Timeout.-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe GSLB Algorithm.ROUND_ROBIN
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for GSLB
env_usageThe GSLB Environment Usage.PUBLIC
health_checkThe GSLB Health Check.
linked_resource_countThe GSLB Linked Resource Count.2
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe Name of the gslb.example.gslb.e.samsungsdscloud.com
stateThe GSLB State.ACTIVE

1.1.2 - 1.0

scpcli 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

The GSLB Create.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
protocol
required		stringThe GSLB Health Check Protocol.-
resources
required		array'{"description": "", "destination": "", "disabled": false, "region": "", "weight": 0}'
name
required		stringThe Name of the gslb.-
env_usage
required		stringThe GSLB Environment Usage.-
algorithm
required		stringThe GSLB Algorithm.-
description
optional		stringDescription-
tags
optional		arrayTag List'{"key": "", "value": ""}'
health_check_interval
optional		integerThe GSLB Health Check Interval.-
health_check_probe_timeout
optional		integerThe GSLB Health Check Probe Timeout.-
health_check_user_id
optional		stringThe GSLB Health Check User Name.-
health_check_user_password
optional		stringThe GSLB Health Check Password.-
receive_string
optional		stringThe GSLB Health Check Receive String.-
send_string
optional		stringThe GSLB Health Check Send String.-
service_port
optional		integerThe GSLB Health Check Service Port.-
timeout
optional		integerThe GSLB Health Check Timeout.-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe GSLB Algorithm.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
env_usageThe GSLB Environment Usage.
health_check
linked_resource_countThe GSLB Linked Resource Count.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe Name of the gslb.
stateThe GSLB State.

1.2 - DeleteGslb

1.2.1 - 1.1

scpcli gslb gslb delete
--gslb_id <value>

Description

The GSLB Delete.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
gslb_id
required		stringThe GSLB ID.-

1.2.2 - 1.0

scpcli gslb gslb delete
--gslb_id <value>

Description

The GSLB Delete.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
gslb_id
required		stringThe GSLB ID.-

1.3 - ListGslbResources

1.3.1 - 1.1

scpcli gslb gslb-resource list
--gslb_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

The GSLB Resource List.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
gslb_id
required		stringThe GSLB ID.-
size
optional		integersize20
page
optional		integerpage0
sort
optional		stringsortcreated_at:desc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
destinationThe GSLB Resource Destination.
health_check_statusThe GSLB Resource Health Check Status.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
regionThe GSLB Resource Region.
statusThe GSLB Resource Status.
weightThe GSLB Resource Weight.

1.3.2 - 1.0

scpcli gslb gslb-resource list
--gslb_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

The GSLB Resource List.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
gslb_id
required		stringThe GSLB ID.-
size
optional		integersize20
page
optional		integerpage0
sort
optional		stringsortcreated_at:desc

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
destinationThe GSLB Resource Destination.
disabledThe GSLB Resource disabled.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
regionThe GSLB Resource Region.
weightThe GSLB Resource Weight.

1.4 - ListGslbs

1.4.1 - 1.1

scpcli gslb gslb list
[--size <value>]
[--page <value>]
[--sort <value>]
[--state <value>]
[--name <value>]

Description

The GSLB List.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
size
optional		integersize20
page
optional		integerpage0
sort
optional		stringsortcreated_at:desc
state
optional		stringThe GSLB State.-
name
optional		stringThe Name of the gslb.-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe GSLB Algorithm.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
env_usageThe GSLB Environment Usage.
linked_resource_countThe GSLB Linked Resource Count.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe Name of the gslb.
stateThe GSLB State.

1.4.2 - 1.0

scpcli gslb gslb list
[--size <value>]
[--page <value>]
[--sort <value>]
[--state <value>]
[--name <value>]

Description

The GSLB List.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
size
optional		integersize20
page
optional		integerpage0
sort
optional		stringsortcreated_at:desc
state
optional		stringThe GSLB State.-
name
optional		stringThe Name of the gslb.-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe GSLB Algorithm.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
env_usageThe GSLB Environment Usage.
linked_resource_countThe GSLB Linked Resource Count.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe Name of the gslb.
stateThe GSLB State.

1.5 - ListGslbsRegionalRoutingControl

1.5.1 - 1.1

scpcli gslb gslb regional routing list
[--size <value>]
[--page <value>]
[--sort <value>]
[--region <value>]
[--status <value>]
[--name <value>]

Description

The GSLB Regional Resource List.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
size
optional		integersize20
page
optional		integerpage0
sort
optional		stringsortcreated_at:desc
region
optional		stringThe GSLB Resource Region.-
status
optional		****The GSLB Resource Status.-
name
optional		stringThe Name of the gslb.-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe GSLB Algorithm.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
env_usageThe GSLB Environment Usage.
linked_regional_resource_countThe GSLB Linked Resource Count Per Region.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe Name of the gslb.
regionThe GSLB Resource Region.
statusThe GSLB Resource Status.

1.6 - SetGslb

1.6.1 - 1.1

scpcli gslb gslb update
--gslb_id <value>
[--algorithm <value>]
[--description <value>]

Description

The GSLB Set.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
gslb_id
required		stringThe GSLB ID.-
algorithm
optional		stringThe GSLB Algorithm.-
description
optional		stringDescription-

1.6.2 - 1.0

scpcli gslb gslb update
--gslb_id <value>
[--algorithm <value>]
[--description <value>]

Description

The GSLB Set.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
gslb_id
required		stringThe GSLB ID.-
algorithm
optional		stringThe GSLB Algorithm.-
description
optional		stringDescription-

1.7 - SetGslbHealthCheck

1.7.1 - 1.1

scpcli 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)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
gslb_id
required		stringThe GSLB ID.-
protocol
required		stringThe GSLB Health Check Protocol.-
health_check_interval
optional		integerThe GSLB Health Check Interval.-
health_check_probe_timeout
optional		integerThe GSLB Health Check Probe Timeout.-
health_check_user_id
optional		stringThe GSLB Health Check User Name.-
health_check_user_password
optional		stringThe GSLB Health Check Password.-
receive_string
optional		stringThe GSLB Health Check Receive String.-
send_string
optional		stringThe GSLB Health Check Send String.-
service_port
optional		integerThe GSLB Health Check Service Port.-
timeout
optional		integerThe GSLB Health Check Timeout.-

1.7.2 - 1.0

scpcli 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.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
gslb_id
required		stringThe GSLB ID.-
protocol
required		stringThe GSLB Health Check Protocol.-
health_check_interval
optional		integerThe GSLB Health Check Interval.-
health_check_probe_timeout
optional		integerThe GSLB Health Check Probe Timeout.-
health_check_user_id
optional		stringThe GSLB Health Check User Name.-
health_check_user_password
optional		stringThe GSLB Health Check Password.-
receive_string
optional		stringThe GSLB Health Check Receive String.-
send_string
optional		stringThe GSLB Health Check Send String.-
service_port
optional		integerThe GSLB Health Check Service Port.-
timeout
optional		integerThe GSLB Health Check Timeout.-

1.8 - SetGslbRegionalRoutingControl

1.8.1 - 1.1

scpcli gslb gslb-regional-routing-set
--gslb_id <value>
--status <value>
--region <value>

Description

Set GSLB Regional Routing.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
gslb_id
required		stringThe GSLB ID.-
status
required		stringThe GSLB Resource Status.-
region
required		stringThe GSLB Resource Region.-

1.9 - SetGslbResources

1.9.1 - 1.1

scpcli gslb gslb-resource update
--gslb_id <value>
--resources <value>

Description

Set GSLB Resources.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
gslb_id
required		stringThe GSLB ID.-
resources
required		array'{"description": "", "destination": "", "region": "", "weight": 0}'

1.9.2 - 1.0

scpcli 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.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
gslb_id
required		stringThe GSLB ID.-
resources
required		array'{"description": "", "destination": "", "disabled": false, "region": "", "weight": 0}'

1.10 - ShowGslb

1.10.1 - 1.1

scpcli gslb gslb show
--gslb_id <value>

Description

The GSLB Show.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
gslb_id
required		stringThe GSLB ID.-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe GSLB Algorithm.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
env_usageThe GSLB Environment Usage.
health_check
linked_resource_countThe GSLB Linked Resource Count.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe Name of the gslb.
stateThe GSLB State.

1.10.2 - 1.0

scpcli gslb gslb show
--gslb_id <value>

Description

The GSLB Show.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
gslb_id
required		stringThe GSLB ID.-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
algorithmThe GSLB Algorithm.
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
env_usageThe GSLB Environment Usage.
health_check
linked_resource_countThe GSLB Linked Resource Count.
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe Name of the gslb.
stateThe GSLB State.