This is the multi-page printable view of this section. Click here to print.
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 | Status | Supported Until |
|---|---|---|
| 1.0 | SUPPORTED | 20260531 |
| 1.1 | CURRENT | - |
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>]
The GSLB Create.
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| protocol required | string | The GSLB Health Check Protocol. | - |
| resources required | array | '{"description": "", "destination": "", "region": "", "weight": 0}' | |
| name required | string | The Name of the gslb. | - |
| env_usage required | string | The GSLB Environment Usage. | - |
| algorithm required | string | The GSLB Algorithm. | - |
| description optional | string | Description | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
| health_check_interval optional | integer | The GSLB Health Check Interval. | - |
| health_check_probe_timeout optional | integer | The GSLB Health Check Probe Timeout. | - |
| health_check_user_id optional | string | The GSLB Health Check User Name. | - |
| health_check_user_password optional | string | The GSLB Health Check Password. | - |
| receive_string optional | string | The GSLB Health Check Receive String. | - |
| send_string optional | string | The GSLB Health Check Send String. | - |
| service_port optional | integer | The GSLB Health Check Service Port. | - |
| timeout optional | integer | The GSLB Health Check Timeout. | - |
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| algorithm | The GSLB Algorithm. | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | |
| env_usage | The GSLB Environment Usage. | |
| health_check | ||
| linked_resource_count | The GSLB Linked Resource Count. | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The Name of the gslb. | |
| state | The GSLB State. |
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>]
The GSLB Create.
State ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|---|
| 1.0 | 20260531 |
| Name | Type | Description | Example |
|---|---|---|---|
| protocol required | string | The GSLB Health Check Protocol. | - |
| resources required | array | '{"description": "", "destination": "", "disabled": false, "region": "", "weight": 0}' | |
| name required | string | The Name of the gslb. | - |
| env_usage required | string | The GSLB Environment Usage. | - |
| algorithm required | string | The GSLB Algorithm. | - |
| description optional | string | Description | - |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
| health_check_interval optional | integer | The GSLB Health Check Interval. | - |
| health_check_probe_timeout optional | integer | The GSLB Health Check Probe Timeout. | - |
| health_check_user_id optional | string | The GSLB Health Check User Name. | - |
| health_check_user_password optional | string | The GSLB Health Check Password. | - |
| receive_string optional | string | The GSLB Health Check Receive String. | - |
| send_string optional | string | The GSLB Health Check Send String. | - |
| service_port optional | integer | The GSLB Health Check Service Port. | - |
| timeout optional | integer | The GSLB Health Check Timeout. | - |
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| algorithm | The GSLB Algorithm. | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | |
| env_usage | The GSLB Environment Usage. | |
| health_check | ||
| linked_resource_count | The GSLB Linked Resource Count. | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The Name of the gslb. | |
| state | The GSLB State. |
scpcli gslb gslb delete
--gslb_id <value>
The GSLB Delete.
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| gslb_id required | string | The GSLB ID. | - |
scpcli gslb gslb delete
--gslb_id <value>
The GSLB Delete.
State ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|---|
| 1.0 | 20260531 |
| Name | Type | Description | Example |
|---|---|---|---|
| gslb_id required | string | The GSLB ID. | - |
scpcli gslb gslb-resource list
--gslb_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
The GSLB Resource List.
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| gslb_id required | string | The GSLB ID. | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | |
| destination | The GSLB Resource Destination. | |
| health_check_status | The GSLB Resource Health Check Status. | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| region | The GSLB Resource Region. | |
| status | The GSLB Resource Status. | |
| weight | The GSLB Resource Weight. |
scpcli gslb gslb-resource list
--gslb_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
The GSLB Resource List.
State ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|---|
| 1.0 | 20260531 |
| Name | Type | Description | Example |
|---|---|---|---|
| gslb_id required | string | The GSLB ID. | - |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | |
| destination | The GSLB Resource Destination. | |
| disabled | The GSLB Resource disabled. | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| region | The GSLB Resource Region. | |
| weight | The GSLB Resource Weight. |
scpcli gslb gslb list
[--size <value>]
[--page <value>]
[--sort <value>]
[--state <value>]
[--name <value>]
The GSLB List.
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.1 | - |
| 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 GSLB State. | - |
| name optional | string | The Name of the gslb. | - |
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| algorithm | The GSLB Algorithm. | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | |
| env_usage | The GSLB Environment Usage. | |
| linked_resource_count | The GSLB Linked Resource Count. | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The Name of the gslb. | |
| state | The GSLB State. |
scpcli gslb gslb list
[--size <value>]
[--page <value>]
[--sort <value>]
[--state <value>]
[--name <value>]
The GSLB List.
State ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|---|
| 1.0 | 20260531 |
| 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 GSLB State. | - |
| name optional | string | The Name of the gslb. | - |
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| algorithm | The GSLB Algorithm. | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | |
| env_usage | The GSLB Environment Usage. | |
| linked_resource_count | The GSLB Linked Resource Count. | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The Name of the gslb. | |
| state | The GSLB State. |
scpcli gslb gslb regional routing list
[--size <value>]
[--page <value>]
[--sort <value>]
[--region <value>]
[--status <value>]
[--name <value>]
The GSLB Regional Resource List.
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.1 | - |
| 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 GSLB Resource Region. | - |
| status optional | string | The GSLB Resource Status. | - |
| name optional | string | The Name of the gslb. | - |
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| algorithm | The GSLB Algorithm. | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | |
| env_usage | The GSLB Environment Usage. | |
| linked_regional_resource_count | The GSLB Linked Resource Count Per Region. | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The Name of the gslb. | |
| region | The GSLB Resource Region. | |
| status | The GSLB Resource Status. |
scpcli gslb gslb update
--gslb_id <value>
[--algorithm <value>]
[--description <value>]
The GSLB Set.
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| gslb_id required | string | The GSLB ID. | - |
| algorithm optional | string | The GSLB Algorithm. | - |
| description optional | string | Description | - |
scpcli gslb gslb update
--gslb_id <value>
[--algorithm <value>]
[--description <value>]
The GSLB Set.
State ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|---|
| 1.0 | 20260531 |
| Name | Type | Description | Example |
|---|---|---|---|
| gslb_id required | string | The GSLB ID. | - |
| algorithm optional | string | The GSLB Algorithm. | - |
| description optional | string | Description | - |
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>]
Set GSLB Health Checks.
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| gslb_id required | string | The GSLB ID. | - |
| protocol required | string | The GSLB Health Check Protocol. | - |
| health_check_interval optional | integer | The GSLB Health Check Interval. | - |
| health_check_probe_timeout optional | integer | The GSLB Health Check Probe Timeout. | - |
| health_check_user_id optional | string | The GSLB Health Check User Name. | - |
| health_check_user_password optional | string | The GSLB Health Check Password. | - |
| receive_string optional | string | The GSLB Health Check Receive String. | - |
| send_string optional | string | The GSLB Health Check Send String. | - |
| service_port optional | integer | The GSLB Health Check Service Port. | - |
| timeout optional | integer | The GSLB Health Check Timeout. | - |
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>]
Set GSLB Health Checks.
State ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|---|
| 1.0 | 20260531 |
| Name | Type | Description | Example |
|---|---|---|---|
| gslb_id required | string | The GSLB ID. | - |
| protocol required | string | The GSLB Health Check Protocol. | - |
| health_check_interval optional | integer | The GSLB Health Check Interval. | - |
| health_check_probe_timeout optional | integer | The GSLB Health Check Probe Timeout. | - |
| health_check_user_id optional | string | The GSLB Health Check User Name. | - |
| health_check_user_password optional | string | The GSLB Health Check Password. | - |
| receive_string optional | string | The GSLB Health Check Receive String. | - |
| send_string optional | string | The GSLB Health Check Send String. | - |
| service_port optional | integer | The GSLB Health Check Service Port. | - |
| timeout optional | integer | The GSLB Health Check Timeout. | - |
scpcli gslb gslb-regional-routing-set
--gslb_id <value>
--status <value>
--region <value>
Set GSLB Regional Routing.
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| gslb_id required | string | The GSLB ID. | - |
| status required | string | The GSLB Resource Status. | - |
| region required | string | The GSLB Resource Region. | - |
scpcli gslb gslb-resource update
--gslb_id <value>
--resources <value>
Set GSLB Resources.
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| gslb_id required | string | The GSLB ID. | - |
| resources required | array | '{"description": "", "destination": "", "region": "", "weight": 0}' |
scpcli gslb gslb-resource update
--gslb_id <value>
--resources <value>
Set GSLB Resources.
State ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|---|
| 1.0 | 20260531 |
| Name | Type | Description | Example |
|---|---|---|---|
| gslb_id required | string | The GSLB ID. | - |
| resources required | array | '{"description": "", "destination": "", "disabled": false, "region": "", "weight": 0}' |
scpcli gslb gslb show
--gslb_id <value>
The GSLB Show.
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.1 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| gslb_id required | string | The GSLB ID. | - |
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| algorithm | The GSLB Algorithm. | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | |
| env_usage | The GSLB Environment Usage. | |
| health_check | ||
| linked_resource_count | The GSLB Linked Resource Count. | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The Name of the gslb. | |
| state | The GSLB State. |
scpcli gslb gslb show
--gslb_id <value>
The GSLB Show.
State ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|---|
| 1.0 | 20260531 |
| Name | Type | Description | Example |
|---|---|---|---|
| gslb_id required | string | The GSLB ID. | - |
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| algorithm | The GSLB Algorithm. | |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | |
| env_usage | The GSLB Environment Usage. | |
| health_check | ||
| linked_resource_count | The GSLB Linked Resource Count. | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | The Name of the gslb. | |
| state | The GSLB State. |