GSLB
Overview
Provides an Application Programming Interface (API) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of GSLB service and how to call API.
The API is provided as a RESTful API, and it responds in JSON format.
Version
| Version | Status | Supported Until |
|---|
| 1.0 | SUPPORTED | 20260531 |
| 1.1 | CURRENT | - |
OpenAPI URL
https://gslb.{region}.{environment}.samsungsdscloud.com
Environment and Region List
| environment | region |
|---|
| s | kr-west1 |
| s | kr-east1 |
| g | kr-south1 |
| g | kr-south2 |
| g | kr-south3 |
| e | kr-west1 |
| e | kr-east1 |
1.1.1 - 1.1
post /v1/gslbs
Description
The GSLB Create.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | GslbShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/gslbs
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = gslb 1.1"
Request body
{
"algorithm": "",
"description": "",
"env_usage": "",
"health_check": {
"health_check_interval": "",
"health_check_probe_timeout": "",
"health_check_user_id": "",
"health_check_user_password": "",
"protocol": "",
"receive_string": "",
"send_string": "",
"service_port": "",
"timeout": ""
},
"name": "",
"resources": [
{
"description": "",
"destination": "",
"region": "",
"weight": 0
}
],
"tags": []
}
Example HTTP response
Response 202
{
"gslb": {
"algorithm": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"env_usage": "",
"health_check": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"health_check_interval": "",
"health_check_probe_timeout": "",
"health_check_user_id": "",
"health_check_user_password": "",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"protocol": "",
"receive_string": "",
"send_string": "",
"service_port": "",
"timeout": ""
},
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"linked_resource_count": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"state": ""
}
}
1.1.2 - 1.0
post /v1/gslbs
Description
The GSLB Create.
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 1.0 | 20260531 |
Parameters
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | GslbShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/gslbs
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = gslb 1.0"
Request body
{
"algorithm": "",
"description": "",
"env_usage": "",
"health_check": {
"health_check_interval": "",
"health_check_probe_timeout": "",
"health_check_user_id": "",
"health_check_user_password": "",
"protocol": "",
"receive_string": "",
"send_string": "",
"service_port": "",
"timeout": ""
},
"name": "",
"resources": [
{
"description": "",
"destination": "",
"disabled": false,
"region": "",
"weight": 0
}
],
"tags": []
}
Example HTTP response
Response 202
{
"gslb": {
"algorithm": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"env_usage": "",
"health_check": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"health_check_interval": "",
"health_check_probe_timeout": "",
"health_check_user_id": "",
"health_check_user_password": "",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"protocol": "",
"receive_string": "",
"send_string": "",
"service_port": "",
"timeout": ""
},
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"linked_resource_count": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"state": ""
}
}
1.2.1 - 1.1
delete /v1/gslbs/{gslb_id}
Description
The GSLB Delete.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | gslb_id required | The GSLB ID. Example :
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | GslbShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/gslbs/{gslb_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = gslb 1.1"
Example HTTP response
Response 202
{
"gslb": {
"algorithm": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"env_usage": "",
"health_check": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"health_check_interval": "",
"health_check_probe_timeout": "",
"health_check_user_id": "",
"health_check_user_password": "",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"protocol": "",
"receive_string": "",
"send_string": "",
"service_port": "",
"timeout": ""
},
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"linked_resource_count": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"state": ""
}
}
1.2.2 - 1.0
delete /v1/gslbs/{gslb_id}
Description
The GSLB Delete.
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 1.0 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | gslb_id required | The GSLB ID. Example :
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | GslbShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/gslbs/{gslb_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = gslb 1.0"
Example HTTP response
Response 202
{
"gslb": {
"algorithm": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"env_usage": "",
"health_check": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"health_check_interval": "",
"health_check_probe_timeout": "",
"health_check_user_id": "",
"health_check_user_password": "",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"protocol": "",
"receive_string": "",
"send_string": "",
"service_port": "",
"timeout": ""
},
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"linked_resource_count": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"state": ""
}
}
1.3.1 - 1.1
get /v1/gslbs/{gslb_id}/resources
Description
The GSLB Resource List.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | gslb_id required | The GSLB ID. Example :
| string | None |
| query | size optional | size Example : 20
| any of [integer, null] | 20 |
| query | page optional | page Example : 0
| any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc
| any of [string, null] | None |
Responses
Example HTTP request
Request path
/v1/gslbs/{gslb_id}/resources
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = gslb 1.1"
Example HTTP response
Response 200
{
"count": 20,
"gslb_resources": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"destination": "",
"health_check_status": "CONNECTED",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"region": "",
"status": "ENABLE",
"weight": 0
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
1.3.2 - 1.0
get /v1/gslbs/{gslb_id}/resources
Description
The GSLB Resource List.
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 1.0 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | gslb_id required | The GSLB ID. Example :
| string | None |
| query | size optional | size Example : 20
| any of [integer, null] | 20 |
| query | page optional | page Example : 0
| any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc
| any of [string, null] | None |
Responses
Example HTTP request
Request path
/v1/gslbs/{gslb_id}/resources
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = gslb 1.0"
Example HTTP response
Response 200
{
"count": 20,
"gslb_resources": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"destination": "",
"disabled": false,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"region": "",
"weight": 0
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
1.4.1 - 1.1
get /v1/gslbs
Description
The GSLB List.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | size optional | size Example : 20
| any of [integer, null] | 20 |
| query | page optional | page Example : 0
| any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc
| any of [string, null] | None |
| query | state optional | The GSLB State. Example :
| any of [string, null] | None |
| query | name optional | The Name of the gslb. Example :
| any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | GslbListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/gslbs
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = gslb 1.1"
Example HTTP response
Response 200
{
"count": 20,
"gslbs": [
{
"algorithm": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"env_usage": "",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"linked_resource_count": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"state": ""
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
1.4.2 - 1.0
get /v1/gslbs
Description
The GSLB List.
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 1.0 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | size optional | size Example : 20
| any of [integer, null] | 20 |
| query | page optional | page Example : 0
| any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc
| any of [string, null] | None |
| query | state optional | The GSLB State. Example :
| any of [string, null] | None |
| query | name optional | The Name of the gslb. Example :
| any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | GslbListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/gslbs
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = gslb 1.0"
Example HTTP response
Response 200
{
"count": 20,
"gslbs": [
{
"algorithm": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"env_usage": "",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"linked_resource_count": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"state": ""
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
1.5.1 - 1.1
get /v1/gslbs/routing-control
Description
The GSLB Regional Resource List.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| query | size optional | size Example : 20
| any of [integer, null] | 20 |
| query | page optional | page Example : 0
| any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc
| any of [string, null] | None |
| query | region optional | The GSLB Resource Region. Example :
| any of [string, null] | None |
| query | status optional | The GSLB Resource Status. Example :
| any of [string, null] | None |
| query | name optional | The Name of the gslb. Example :
| any of [string, null] | None |
Responses
Example HTTP request
Request path
/v1/gslbs/routing-control
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = gslb 1.1"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"regional_gslbs": [
{
"algorithm": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"env_usage": "",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"linked_regional_resource_count": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"region": "",
"status": ""
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
1.6.1 - 1.1
put /v1/gslbs/{gslb_id}
Description
The GSLB Set.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | gslb_id required | The GSLB ID. Example :
| string | None |
| body | body required |
| GslbSetRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | GslbShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/gslbs/{gslb_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = gslb 1.1"
Request body
{
"algorithm": "",
"description": ""
}
Example HTTP response
Response 200
{
"gslb": {
"algorithm": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"env_usage": "",
"health_check": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"health_check_interval": "",
"health_check_probe_timeout": "",
"health_check_user_id": "",
"health_check_user_password": "",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"protocol": "",
"receive_string": "",
"send_string": "",
"service_port": "",
"timeout": ""
},
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"linked_resource_count": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"state": ""
}
}
1.6.2 - 1.0
put /v1/gslbs/{gslb_id}
Description
The GSLB Set.
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 1.0 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | gslb_id required | The GSLB ID. Example :
| string | None |
| body | body required |
| GslbSetRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | GslbShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/gslbs/{gslb_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = gslb 1.0"
Request body
{
"algorithm": "",
"description": ""
}
Example HTTP response
Response 200
{
"gslb": {
"algorithm": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"env_usage": "",
"health_check": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"health_check_interval": "",
"health_check_probe_timeout": "",
"health_check_user_id": "",
"health_check_user_password": "",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"protocol": "",
"receive_string": "",
"send_string": "",
"service_port": "",
"timeout": ""
},
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"linked_resource_count": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"state": ""
}
}
1.7.1 - 1.1
put /v1/gslbs/{gslb_id}/health-check
Description
Set GSLB Health Checks.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | gslb_id required | The GSLB ID. Example :
| string | None |
| body | body required |
| GslbHealthCheck | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | GslbShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/gslbs/{gslb_id}/health-check
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = gslb 1.1"
Request body
{
"health_check_interval": "",
"health_check_probe_timeout": "",
"health_check_user_id": "",
"health_check_user_password": "",
"protocol": "",
"receive_string": "",
"send_string": "",
"service_port": "",
"timeout": ""
}
Example HTTP response
Response 202
{
"gslb": {
"algorithm": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"env_usage": "",
"health_check": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"health_check_interval": "",
"health_check_probe_timeout": "",
"health_check_user_id": "",
"health_check_user_password": "",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"protocol": "",
"receive_string": "",
"send_string": "",
"service_port": "",
"timeout": ""
},
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"linked_resource_count": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"state": ""
}
}
1.7.2 - 1.0
put /v1/gslbs/{gslb_id}/health-check
Description
Set GSLB Health Checks.
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 1.0 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | gslb_id required | The GSLB ID. Example :
| string | None |
| body | body required |
| GslbHealthCheck | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | GslbShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/gslbs/{gslb_id}/health-check
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = gslb 1.0"
Request body
{
"health_check_interval": "",
"health_check_probe_timeout": "",
"health_check_user_id": "",
"health_check_user_password": "",
"protocol": "",
"receive_string": "",
"send_string": "",
"service_port": "",
"timeout": ""
}
Example HTTP response
Response 202
{
"gslb": {
"algorithm": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"env_usage": "",
"health_check": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"health_check_interval": "",
"health_check_probe_timeout": "",
"health_check_user_id": "",
"health_check_user_password": "",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"protocol": "",
"receive_string": "",
"send_string": "",
"service_port": "",
"timeout": ""
},
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"linked_resource_count": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"state": ""
}
}
1.8.1 - 1.1
put /v1/gslbs/{gslb_id}/routing-control
Description
Set GSLB Regional Routing.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
Responses
Example HTTP request
Request path
/v1/gslbs/{gslb_id}/routing-control
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = gslb 1.1"
Request body
{
"region": "",
"status": ""
}
Example HTTP response
Response 202
{
"regional_gslb": {
"algorithm": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"env_usage": "",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"linked_regional_resource_count": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"region": "",
"status": ""
}
}
1.9.1 - 1.1
put /v1/gslbs/{gslb_id}/resources
Description
Set GSLB Resources.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | gslb_id required | The GSLB ID. Example :
| string | None |
| body | body required |
| GslbResourcesSetRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | GslbShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/gslbs/{gslb_id}/resources
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = gslb 1.1"
Request body
{
"resources": [
{
"description": "",
"destination": "",
"region": "",
"weight": 0
}
]
}
Example HTTP response
Response 202
{
"gslb": {
"algorithm": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"env_usage": "",
"health_check": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"health_check_interval": "",
"health_check_probe_timeout": "",
"health_check_user_id": "",
"health_check_user_password": "",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"protocol": "",
"receive_string": "",
"send_string": "",
"service_port": "",
"timeout": ""
},
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"linked_resource_count": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"state": ""
}
}
1.9.2 - 1.0
put /v1/gslbs/{gslb_id}/resources
Description
Set GSLB Resources.
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 1.0 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | gslb_id required | The GSLB ID. Example :
| string | None |
| body | body required |
| GslbResourceSetRequest | |
Responses
| HTTP Code | Description | Schema |
|---|
| 202 | Accepted | GslbShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/gslbs/{gslb_id}/resources
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = gslb 1.0"
Request body
{
"resources": [
{
"description": "",
"destination": "",
"disabled": false,
"region": "",
"weight": 0
}
]
}
Example HTTP response
Response 202
{
"gslb": {
"algorithm": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"env_usage": "",
"health_check": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"health_check_interval": "",
"health_check_probe_timeout": "",
"health_check_user_id": "",
"health_check_user_password": "",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"protocol": "",
"receive_string": "",
"send_string": "",
"service_port": "",
"timeout": ""
},
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"linked_resource_count": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"state": ""
}
}
1.10.1 - 1.1
get /v1/gslbs/{gslb_id}
Description
The GSLB Show.
State
ACTIVE (CURRENT)
| Version | Supported Until |
|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | gslb_id required | The GSLB ID. Example :
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | GslbShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/gslbs/{gslb_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = gslb 1.1"
Example HTTP response
Response 200
{
"gslb": {
"algorithm": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"env_usage": "",
"health_check": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"health_check_interval": "",
"health_check_probe_timeout": "",
"health_check_user_id": "",
"health_check_user_password": "",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"protocol": "",
"receive_string": "",
"send_string": "",
"service_port": "",
"timeout": ""
},
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"linked_resource_count": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"state": ""
}
}
1.10.2 - 1.0
get /v1/gslbs/{gslb_id}
Description
The GSLB Show.
State
ACTIVE (SUPPORTED)
| Version | Supported Until |
|---|
| 1.0 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|
| path | gslb_id required | The GSLB ID. Example :
| string | None |
Responses
| HTTP Code | Description | Schema |
|---|
| 200 | OK | GslbShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/gslbs/{gslb_id}
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = gslb 1.0"
Example HTTP response
Response 200
{
"gslb": {
"algorithm": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"env_usage": "",
"health_check": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"health_check_interval": "",
"health_check_probe_timeout": "",
"health_check_user_id": "",
"health_check_user_password": "",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"protocol": "",
"receive_string": "",
"send_string": "",
"service_port": "",
"timeout": ""
},
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"linked_resource_count": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"state": ""
}
}