이 섹션의 다중 페이지 출력 화면임. 여기를 클릭하여 프린트.

이 페이지의 일반 화면으로 돌아가기.

Global CDN

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 Global CDN 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

OpenAPI URL

https://cdn.{region}.{environment}.samsungsdscloud.com

Environment and Region List

environmentregion
skr-west1
skr-east1
gkr-south1
gkr-south2
gkr-south3
ekr-west1
ekr-east1

1 - APIs

1.1 - Create Cdn Service

1.1.1 - 1.0

post /v1/cdns

Description

create cdn service

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
CdnServiceCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedCdnServiceResponseResult
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/cdns

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cdn 1.0"

Request body

{
    "cache_expiry_time": "",
    "cache_key_hostname": "REQUEST_HOST_HEADER",
    "caching_option": "",
    "cdn_origin_hostname": "test.example.com",
    "cdn_origin_port": "",
    "cdn_origin_protocol": "",
    "cdn_service_domain_prefix": "global1",
    "cdn_service_origin_path": "/test/global/",
    "content_policy": "",
    "custom_forward_host_header": "",
    "description": "",
    "forward_host_header": "REQUEST_HOST_HEADER",
    "name": "test1",
    "origin_hostname_type": "DOMAIN",
    "query_string_ignored": "",
    "range_request_allowed": "",
    "request_custom_headers": "",
    "response_custom_headers": "",
    "tags": []
}

Example HTTP response

Response 202

{
    "cdn": {
        "account_id": "",
        "resource_id": "",
        "workflow_id": ""
    }
}

1.2 - Delete Cdn Service

1.2.1 - 1.0

delete /v1/cdns/{id}

Description

delete cdn service

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathid
required		cdn service id
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedCdnServiceResponseResult
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/cdns/{id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cdn 1.0"

Example HTTP response

Response 202

{
    "cdn": {
        "account_id": "",
        "resource_id": "",
        "workflow_id": ""
    }
}

1.3 - Detail Cdn Service

1.3.1 - 1.0

get /v1/cdns/{id}

Description

detail cdn service

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathid
required		cdn service id
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
200OKCdnServiceDetailResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/cdns/{id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cdn 1.0"

Example HTTP response

Response 200

{
    "cdn": {
        "account_id": "",
        "cache_expiry_time": "",
        "cache_key_hostname": "",
        "caching_option": "",
        "cdn_origin_hostname": "",
        "cdn_origin_port": "",
        "cdn_origin_protocol": "",
        "cdn_service_activation_state": "",
        "cdn_service_config_version": "",
        "cdn_service_domain": "",
        "cdn_service_origin_path": "",
        "cdn_service_state": "",
        "content_policy": "",
        "created_at": "",
        "created_by": "",
        "custom_forward_host_header": "",
        "description": "",
        "forward_host_header": "",
        "id": "",
        "modified_at": "",
        "modified_by": "",
        "name": "",
        "origin_hostname_type": "",
        "query_string_ignored": "",
        "range_request_allowed": "",
        "region": "",
        "request_custom_headers": "",
        "response_custom_headers": ""
    }
}

1.4 - List Cdn Service

1.4.1 - 1.0

get /v1/cdns

Description

list cdn service

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
querycreated_by
optional		create by
Example :
any of [string, null]None
queryname
optional		cdn service name
Example :
any of [string, null]None
querycdn_service_domain
optional		cdn service domain
Example :
any of [string, null]None
querycdn_origin_hostname
optional		cdn service origin host name
Example :
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKCdnServiceListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/cdns

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cdn 1.0"

Example HTTP response

Response 200

{
    "cdn": [
        {
            "account_id": "",
            "cdn_origin_hostname": "",
            "cdn_service_domain": "",
            "cdn_service_state": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "region": ""
        }
    ],
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.5 - Purge Cdn Service

1.5.1 - 1.0

post /v1/cdns/{id}/purge

Description

purge cdn service

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathid
required		cdn service id
Example :
stringNone
bodybody
required
CdnServicePurgeRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedCdnServiceResponseResult
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/cdns/{id}/purge

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cdn 1.0"

Request body

{
    "custom_url": "/test/",
    "target_content": "",
    "target_url": ""
}

Example HTTP response

Response 202

{
    "cdn": {
        "account_id": "",
        "resource_id": "",
        "workflow_id": ""
    }
}

1.6 - Start Cdn Service

1.6.1 - 1.0

post /v1/cdns/{id}/start

Description

start cdn service

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathid
required		cdn service id
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedCdnServiceResponseResult
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/cdns/{id}/start

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cdn 1.0"

Example HTTP response

Response 202

{
    "cdn": {
        "account_id": "",
        "resource_id": "",
        "workflow_id": ""
    }
}

1.7 - Stop Cdn Service

1.7.1 - 1.0

post /v1/cdns/{id}/stop

Description

stop cdn service

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathid
required		cdn service id
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedCdnServiceResponseResult
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/cdns/{id}/stop

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cdn 1.0"

Example HTTP response

Response 202

{
    "cdn": {
        "account_id": "",
        "resource_id": "",
        "workflow_id": ""
    }
}

1.8 - Update Cdn Service

1.8.1 - 1.0

put /v1/cdns/{id}

Description

update cdn service

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathid
required		cdn service id
Example :
stringNone
bodybody
required
CdnServiceUpdateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedCdnServiceResponseResult
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/cdns/{id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cdn 1.0"

Request body

{
    "cache_expiry_time": "",
    "cache_key_hostname": "REQUEST_HOST_HEADER",
    "caching_option": "",
    "cdn_origin_hostname": "test.example.com",
    "cdn_origin_port": "",
    "cdn_origin_protocol": "",
    "cdn_service_origin_path": "/test/global/",
    "content_policy": "",
    "custom_forward_host_header": "",
    "forward_host_header": "REQUEST_HOST_HEADER",
    "origin_hostname_type": "DOMAIN",
    "query_string_ignored": "",
    "range_request_allowed": "",
    "request_custom_headers": "",
    "response_custom_headers": ""
}

Example HTTP response

Response 202

{
    "cdn": {
        "account_id": "",
        "resource_id": "",
        "workflow_id": ""
    }
}

1.9 - Update Description of Cdn Service

1.9.1 - 1.0

put /v1/cdns/{id}/description

Description

Update description of cdn service

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathid
required		cdn service id
Example :
stringNone
bodybody
required
CdnServiceModifyDescriptionRequest

Responses

HTTP CodeDescriptionSchema
200OKCdnServiceDetailResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/cdns/{id}/description

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cdn 1.0"

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "cdn": {
        "account_id": "",
        "cache_expiry_time": "",
        "cache_key_hostname": "",
        "caching_option": "",
        "cdn_origin_hostname": "",
        "cdn_origin_port": "",
        "cdn_origin_protocol": "",
        "cdn_service_activation_state": "",
        "cdn_service_config_version": "",
        "cdn_service_domain": "",
        "cdn_service_origin_path": "",
        "cdn_service_state": "",
        "content_policy": "",
        "created_at": "",
        "created_by": "",
        "custom_forward_host_header": "",
        "description": "",
        "forward_host_header": "",
        "id": "",
        "modified_at": "",
        "modified_by": "",
        "name": "",
        "origin_hostname_type": "",
        "query_string_ignored": "",
        "range_request_allowed": "",
        "region": "",
        "request_custom_headers": "",
        "response_custom_headers": ""
    }
}

2 - Models

2.1 - CdnServiceCreateRequest

NameDescriptionSchemaDefault
cache_expiry_time
required		cache expiry time
Example :
Minimum : 3600
Maximum : 2592000
integer
cache_key_hostname
required		cache key hostname
Example : REQUEST_HOST_HEADER
enum (REQUEST_HOST_HEADER, ORIGIN_HOSTNAME)
caching_option
required		caching option
Example :
string
cdn_origin_hostname
required		cdn service origin host name
Example : test.example.com
Pattern : ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$
Maximum length : 253
string
cdn_origin_port
required		cdn service origin port
Example :
Minimum : 1
Maximum : 65535
integer
cdn_origin_protocol
required		cdn service origin protocol
Example :
string
cdn_service_domain_prefix
required		cdn service domain prefix
Example : global1
Pattern : ^[a-z0-9]*$
Minimum length : 4
Maximum length : 40
string
cdn_service_origin_path
optional		cdn service origin path
Example : /test/global/
Pattern : ^/$|^(/[a-zA-Z0-9-._]+)+/$
any of [string, null]
content_policy
required		content policy
Example :
string
custom_forward_host_header
optional		custom forward host header
Example :
any of [string, null]
description
optional		Description
Example :
any of [string, null]
forward_host_header
required		forward host header
Example : REQUEST_HOST_HEADER
enum (REQUEST_HOST_HEADER, ORIGIN_HOSTNAME, CUSTOM)
name
required		cdn service name
Example : test1
Pattern : ^[a-zA-Z0-9]*$
Minimum length : 3
Maximum length : 20
string
origin_hostname_type
required		origin hostname type
Example : DOMAIN
enum (DOMAIN, IP)
query_string_ignored
required		query string ignored
Example :
boolean
range_request_allowed
required		range request allowed
Example :
boolean
request_custom_headers
optional		request custom headers
Example :
object
response_custom_headers
optional		response custom header
Example :
object
tags
optional		Tag List
array[Tag]

2.2 - CdnServiceDetail

NameDescriptionSchemaDefault
account_id
required		Account ID
Example :
string
cache_expiry_time
required		cache expiry time
Example :
integer
cache_key_hostname
required		cache key hostname
Example :
string
caching_option
required		caching option
Example :
string
cdn_origin_hostname
required		cdn service origin host name
Example :
string
cdn_origin_port
required		cdn service origin port
Example :
integer
cdn_origin_protocol
required		cdn service origin protocol
Example :
string
cdn_service_activation_state
required		cdn service activation state
Example :
string
cdn_service_config_version
required		cdn service config version
Example :
integer
cdn_service_domain
required		cdn service domain
Example :
string
cdn_service_origin_path
required		cdn service origin path
Example :
string
cdn_service_state
required		cdn service state
Example :
string
content_policy
required		content policy
Example :
string
created_at
required		create at
Example :
string
created_by
required		create by
Example :
string
custom_forward_host_header
required		custom forward host header
Example :
string
description
required		Description
Example :
string
forward_host_header
required		forward host header
Example :
string
id
required		cdn service id
Example :
string
modified_at
required		modified at
Example :
string
modified_by
required		modified by
Example :
string
name
required		cdn service name
Example :
string
origin_hostname_type
required		origin hostname type
Example :
string
query_string_ignored
required		query string ignored
Example :
boolean
range_request_allowed
required		range request allowed
Example :
boolean
region
required		region
Example :
string
request_custom_headers
required		request custom headers
Example :
object
response_custom_headers
required		response custom header
Example :
object

2.3 - CdnServiceDetailResponse

NameDescriptionSchemaDefault
cdn
required
CdnServiceDetail

2.4 - CdnServiceListResponse

NameDescriptionSchemaDefault
cdn
required
array[CdnServiceResponse]
count
required		count
Example : 20
integer
page
required		page
Example : 0
integer
size
required		size
Example : 20
integer
sort
optional		sort
Example : ['created_at:asc']
any of [array[string], null]

2.5 - CdnServiceModifyDescriptionRequest

NameDescriptionSchemaDefault
description
required		Description
Example :
string

2.6 - CdnServicePurgeRequest

NameDescriptionSchemaDefault
custom_url
optional		custom url
Example : /test/
Pattern : ^/[a-zA-Z0-9-._/]*$
any of [string, null]
target_content
required		target content
Example :
string
target_url
required		target url
Example :
string

2.7 - CdnServiceResponse

NameDescriptionSchemaDefault
account_id
required		Account ID
Example :
string
cdn_origin_hostname
required		cdn service origin host name
Example :
string
cdn_service_domain
required		cdn service domain
Example :
string
cdn_service_state
required		cdn service state
Example :
string
created_at
required		Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required		Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional		Description
Example :
any of [string, null]
id
required		cdn service id
Example :
string
modified_at
required		Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required		Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required		cdn service name
Example :
string
region
required		region
Example :
string

2.8 - CdnServiceResponseResult

NameDescriptionSchemaDefault
cdn
required
CdnServiceResult

2.9 - CdnServiceResult

NameDescriptionSchemaDefault
account_id
required		Account ID
Example :
string
resource_id
required		resource id
Example :
string
workflow_id
required		workflow id
Example :
string

2.10 - CdnServiceUpdateRequest

NameDescriptionSchemaDefault
cache_expiry_time
required		cache expiry time
Example :
Minimum : 3600
Maximum : 2592000
integer
cache_key_hostname
required		cache key hostname
Example : REQUEST_HOST_HEADER
enum (REQUEST_HOST_HEADER, ORIGIN_HOSTNAME)
caching_option
required		caching option
Example :
string
cdn_origin_hostname
required		cdn service origin host name
Example : test.example.com
Pattern : ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$
Maximum length : 253
string
cdn_origin_port
required		cdn service origin port
Example :
Minimum : 1
Maximum : 65535
integer
cdn_origin_protocol
required		cdn service origin protocol
Example :
string
cdn_service_origin_path
optional		cdn service origin path
Example : /test/global/
Pattern : ^/$|^(/[a-zA-Z0-9-._]+)+/$
any of [string, null]
content_policy
required		content policy
Example :
string
custom_forward_host_header
optional		custom forward host header
Example :
any of [string, null]
forward_host_header
required		forward host header
Example : REQUEST_HOST_HEADER
enum (REQUEST_HOST_HEADER, ORIGIN_HOSTNAME, CUSTOM)
origin_hostname_type
required		origin hostname type
Example : DOMAIN
enum (DOMAIN, IP)
query_string_ignored
required		query string ignored
Example :
boolean
range_request_allowed
required		range request allowed
Example :
boolean
request_custom_headers
optional		request custom headers
Example :
any of [object, null]
response_custom_headers
optional		response custom header
Example :
any of [object, null]

2.11 - Tag

NameDescriptionSchemaDefault
key
required		tag key
Example :
string
value
required		tag value
Example :
string