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

Return to the regular view of this page.

Global CDN

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 Global CDN 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.0CURRENT-

CLI Version History

1.0

CDN CLI has been released.

Changes

  • [New] cdn cdn service list - Command has been added.
  • [New] cdn cdn service create - Command has been added.
  • [New] cdn cdn service detail - Command has been added.
  • [New] cdn cdn service update - Command has been added.
  • [New] cdn cdn service delete - Command has been added.
  • [New] cdn cdn service start - Command has been added.
  • [New] cdn cdn service stop - Command has been added.
  • [New] cdn cdn service purge - Command has been added.
  • [New] cdn description update - Command has been added.

1 - CLIs

1.1 - Create Cdn Service

1.1.1 - 1.0

scp-cli cdn cdn service create
--range_request_allowed <value>
--query_string_ignored <value>
--origin_hostname_type <value>
--name <value>
--forward_host_header <value>
--content_policy <value>
--cdn_service_domain_prefix <value>
--cdn_origin_protocol <value>
--cdn_origin_port <value>
--cdn_origin_hostname <value>
--caching_option <value>
--cache_key_hostname <value>
--cache_expiry_time <value>
[--cdn_service_origin_path <value>]
[--custom_forward_host_header <value>]
[--description <value>]
[--request_custom_headers <value>]
[--response_custom_headers <value>]
[--tags <value>]

Description

Create CDN service resource for caching and delivering content from an origin server through edge locations.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
range_request_allowed
required
booleanIndicates whether range requests are allowed for content delivery.True
query_string_ignored
required
booleanIndicates whether the query string is ignored when caching content.True
origin_hostname_type
required
stringThe type of the origin hostname (e.g., DOMAIN, IP).-
name
required
stringThe name of the CDN service.test1
forward_host_header
required
stringThe host header forwarded to the origin server (e.g., ORIGIN_HOSTNAME, INCOMING_HOST_HEADER, CUSTOM).-
content_policy
required
stringThe content delivery policy for the CDN service (e.g., ONLY_VALIDATED_CONTENTS, ALL_CONTENTS).ONLY_VALIDATED_CONTENTS
cdn_service_domain_prefix
required
stringThe prefix of the CDN service domain.global1
cdn_origin_protocol
required
stringThe protocol used to connect to the origin server (e.g., HTTP, HTTPS).HTTPS
cdn_origin_port
required
integerThe port used to connect to the origin server.443
cdn_origin_hostname
required
stringThe hostname of the origin server from which the CDN retrieves content.test.example.com
caching_option
required
stringThe caching option for the CDN content (e.g., CACHE, NO_CACHE, BYPASS_CACHE).CACHE
cache_key_hostname
required
stringThe hostname used as part of the cache key (e.g., ORIGIN_HOSTNAME, INCOMING_HOST_HEADER).-
cache_expiry_time
required
integerThe cache expiry time in seconds for content stored at edge locations.86400
cdn_service_origin_path
optional
stringThe path on the origin server from which the CDN retrieves content./test/global/
custom_forward_host_header
optional
stringThe custom host header forwarded to the origin when forward host header is set to CUSTOM.-
description
optional
stringDescription추가 정보 입력 - 설명
request_custom_headers
optional
objectThe custom headers added to requests forwarded to the origin server.-
response_custom_headers
optional
objectThe custom headers added to responses returned to the client.-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
account_idAccount ID
resource_idThe identifier of the resource.
workflow_idThe identifier of the workflow processing the request.

1.2 - Delete Cdn Service

1.2.1 - 1.0

scp-cli cdn cdn service delete
--id <value>

Description

Delete CDN service resource

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
id
required
stringThe unique identifier of the CDN service.-

1.3 - Detail Cdn Service

1.3.1 - 1.0

scp-cli cdn cdn service detail
--id <value>

Description

Provides details about a specific CDN service.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
id
required
stringThe unique identifier of the CDN service.-

Responses

NameDescriptionExample
idThe unique identifier of the CDN service.
account_idAccount ID
cache_expiry_timeThe cache expiry time in seconds for content stored at edge locations.
cache_key_hostnameThe hostname used as part of the cache key (e.g., ORIGIN_HOSTNAME, INCOMING_HOST_HEADER).
caching_optionThe caching option for the CDN content (e.g., CACHE, NO_CACHE, BYPASS_CACHE).
cdn_origin_hostnameThe hostname of the origin server from which the CDN retrieves content.
cdn_origin_portThe port used to connect to the origin server.
cdn_origin_protocolThe protocol used to connect to the origin server (e.g., HTTP, HTTPS).
cdn_service_activation_stateThe activation state of the CDN service.
cdn_service_config_versionThe configuration version of the CDN service.
cdn_service_domainThe domain name through which the CDN service delivers content.
cdn_service_origin_pathThe path on the origin server from which the CDN retrieves content.
cdn_service_stateThe current state of the CDN service (e.g., RUNNING, STOPPED, CREATING, DELETING).
content_policyThe content delivery policy for the CDN service (e.g., ONLY_VALIDATED_CONTENTS, ALL_CONTENTS).
created_atThe timestamp when the resource was created, in ISO 8601 format.
created_byThe user id that created the resource.
custom_forward_host_headerThe custom host header forwarded to the origin when forward host header is set to CUSTOM.
descriptionDescription
forward_host_headerThe host header forwarded to the origin server (e.g., ORIGIN_HOSTNAME, INCOMING_HOST_HEADER, CUSTOM).
modified_atThe timestamp when the resource was last modified, in ISO 8601 format.
modified_byThe user id that last modified the resource.
nameThe name of the CDN service.
origin_hostname_typeThe type of the origin hostname (e.g., DOMAIN, IP).
query_string_ignoredIndicates whether the query string is ignored when caching content.
range_request_allowedIndicates whether range requests are allowed for content delivery.
regionThe region where the CDN service is provided.
request_custom_headersThe custom headers added to requests forwarded to the origin server.
response_custom_headersThe custom headers added to responses returned to the client.

1.4 - List Cdn Service

1.4.1 - 1.0

scp-cli cdn cdn service list
[--size <value>]
[--page <value>]
[--sort <value>]
[--created_by <value>]
[--name <value>]
[--cdn_service_domain <value>]
[--cdn_origin_hostname <value>]

Description

Provides a list of CDN services.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
created_by
optional
stringThe user id that created the resource.-
name
optional
stringThe name of the CDN service.-
cdn_service_domain
optional
stringThe domain name through which the CDN service delivers content.-
cdn_origin_hostname
optional
stringThe hostname of the origin server from which the CDN retrieves content.-

Responses

NameDescriptionExample
idThe unique identifier of the CDN service.
account_idAccount ID
cdn_origin_hostnameThe hostname of the origin server from which the CDN retrieves content.
cdn_service_domainThe domain name through which the CDN service delivers content.
cdn_service_stateThe current state of the CDN service (e.g., RUNNING, STOPPED, CREATING, DELETING).
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameThe name of the CDN service.
regionThe region where the CDN service is provided.

1.5 - Purge Cdn Service

1.5.1 - 1.0

scp-cli cdn cdn service purge
--id <value>
--target_url <value>
--target_content <value>
[--custom_url <value>]

Description

Purges cached content from the CDN service.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
id
required
stringThe unique identifier of the CDN service.-
target_url
required
stringThe target URL scope for the purge operation (e.g., ALL, CUSTOM).CUSTOM
target_content
required
stringThe target content type to purge (e.g., ALL_CONTENT, INVALIDATED_CONTENT).INVALIDATED_CONTENT
custom_url
optional
stringThe custom URL to purge when the target URL is set to CUSTOM./test/

Responses

NameDescriptionExample
account_idAccount ID
resource_idThe identifier of the resource.
workflow_idThe identifier of the workflow processing the request.

1.6 - Start Cdn Service

1.6.1 - 1.0

scp-cli cdn cdn service start
--id <value>

Description

Starts the CDN service.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
id
required
stringThe unique identifier of the CDN service.-

Responses

NameDescriptionExample
account_idAccount ID
resource_idThe identifier of the resource.
workflow_idThe identifier of the workflow processing the request.

1.7 - Stop Cdn Service

1.7.1 - 1.0

scp-cli cdn cdn service stop
--id <value>

Description

Stops the CDN service.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
id
required
stringThe unique identifier of the CDN service.-

Responses

NameDescriptionExample
account_idAccount ID
resource_idThe identifier of the resource.
workflow_idThe identifier of the workflow processing the request.

1.8 - Update Cdn Service

1.8.1 - 1.0

scp-cli cdn cdn service update
--id <value>
--range_request_allowed <value>
--query_string_ignored <value>
--origin_hostname_type <value>
--forward_host_header <value>
--content_policy <value>
--cdn_origin_protocol <value>
--cdn_origin_port <value>
--cdn_origin_hostname <value>
--caching_option <value>
--cache_key_hostname <value>
--cache_expiry_time <value>
[--cdn_service_origin_path <value>]
[--custom_forward_host_header <value>]
[--request_custom_headers <value>]
[--response_custom_headers <value>]

Description

Update a CDN service resource

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
id
required
stringThe unique identifier of the CDN service.-
range_request_allowed
required
booleanIndicates whether range requests are allowed for content delivery.True
query_string_ignored
required
booleanIndicates whether the query string is ignored when caching content.True
origin_hostname_type
required
stringThe type of the origin hostname (e.g., DOMAIN, IP).-
forward_host_header
required
stringThe host header forwarded to the origin server (e.g., ORIGIN_HOSTNAME, INCOMING_HOST_HEADER, CUSTOM).-
content_policy
required
stringThe content delivery policy for the CDN service (e.g., ONLY_VALIDATED_CONTENTS, ALL_CONTENTS).ONLY_VALIDATED_CONTENTS
cdn_origin_protocol
required
stringThe protocol used to connect to the origin server (e.g., HTTP, HTTPS).HTTPS
cdn_origin_port
required
integerThe port used to connect to the origin server.443
cdn_origin_hostname
required
stringThe hostname of the origin server from which the CDN retrieves content.test.example.com
caching_option
required
stringThe caching option for the CDN content (e.g., CACHE, NO_CACHE, BYPASS_CACHE).CACHE
cache_key_hostname
required
stringThe hostname used as part of the cache key (e.g., ORIGIN_HOSTNAME, INCOMING_HOST_HEADER).-
cache_expiry_time
required
integerThe cache expiry time in seconds for content stored at edge locations.86400
cdn_service_origin_path
optional
stringThe path on the origin server from which the CDN retrieves content./test/global/
custom_forward_host_header
optional
stringThe custom host header forwarded to the origin when forward host header is set to CUSTOM.-
request_custom_headers
optional
objectThe custom headers added to requests forwarded to the origin server.-
response_custom_headers
optional
objectThe custom headers added to responses returned to the client.-

1.9 - Update Description of Cdn Service

1.9.1 - 1.0

scp-cli cdn description update
--id <value>
--description <value>

Description

Updates the description of the CDN service.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
id
required
stringThe unique identifier of the CDN service.-
description
required
stringDescription추가 정보 입력 - 설명