This is the multi-page printable view of this section. Click here to print.
Models
1 - CdnServiceCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| cache_expiry_time required | The cache expiry time in seconds for content stored at edge locations. Example : 86400Minimum : 3600Maximum : 2592000 | integer | |
| cache_key_hostname required | The hostname used as part of the cache key (e.g., ORIGIN_HOSTNAME, INCOMING_HOST_HEADER). Example : REQUEST_HOST_HEADER | enum (REQUEST_HOST_HEADER, ORIGIN_HOSTNAME) | |
| caching_option required | The caching option for the CDN content (e.g., CACHE, NO_CACHE, BYPASS_CACHE). Example : CACHE | string | |
| cdn_origin_hostname required | The hostname of the origin server from which the CDN retrieves content. Example : test.example.comPattern : ^(([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 | The port used to connect to the origin server. Example : 443Minimum : 1Maximum : 65535 | integer | |
| cdn_origin_protocol required | The protocol used to connect to the origin server (e.g., HTTP, HTTPS). Example : HTTPS | string | |
| cdn_service_domain_prefix required | The prefix of the CDN service domain. Example : global1Pattern : ^[a-z0-9]*$Minimum length : 4Maximum length : 40 | string | |
| cdn_service_origin_path optional | The path on the origin server from which the CDN retrieves content. Example : /test/global/Pattern : ^/$|^(/[a-zA-Z0-9-._]+)+/$ | any of [string, null] | |
| content_policy required | The content delivery policy for the CDN service (e.g., ONLY_VALIDATED_CONTENTS, ALL_CONTENTS). Example : ONLY_VALIDATED_CONTENTS | string | |
| custom_forward_host_header optional | The custom host header forwarded to the origin when forward host header is set to CUSTOM. Example : | any of [string, null] | |
| description optional | Description Example : 추가 정보 입력 - 설명 | any of [string, null] | |
| forward_host_header required | The host header forwarded to the origin server (e.g., ORIGIN_HOSTNAME, INCOMING_HOST_HEADER, CUSTOM). Example : REQUEST_HOST_HEADER | enum (REQUEST_HOST_HEADER, ORIGIN_HOSTNAME, CUSTOM) | |
| name required | The name of the CDN service. Example : test1Pattern : ^[a-zA-Z0-9]*$Minimum length : 3Maximum length : 20 | string | |
| origin_hostname_type required | The type of the origin hostname (e.g., DOMAIN, IP). Example : DOMAIN | enum (DOMAIN, IP) | |
| query_string_ignored required | Indicates whether the query string is ignored when caching content. Example : True | boolean | |
| range_request_allowed required | Indicates whether range requests are allowed for content delivery. Example : True | boolean | |
| request_custom_headers optional | The custom headers added to requests forwarded to the origin server. Example : | object | |
| response_custom_headers optional | The custom headers added to responses returned to the client. Example : | object | |
| tags optional | Tag List | array[Tag] |
2 - CdnServiceDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : | string | |
| cache_expiry_time required | The cache expiry time in seconds for content stored at edge locations. Example : | integer | |
| cache_key_hostname required | The hostname used as part of the cache key (e.g., ORIGIN_HOSTNAME, INCOMING_HOST_HEADER). Example : | string | |
| caching_option required | The caching option for the CDN content (e.g., CACHE, NO_CACHE, BYPASS_CACHE). Example : | string | |
| cdn_origin_hostname required | The hostname of the origin server from which the CDN retrieves content. Example : | string | |
| cdn_origin_port required | The port used to connect to the origin server. Example : | integer | |
| cdn_origin_protocol required | The protocol used to connect to the origin server (e.g., HTTP, HTTPS). Example : | string | |
| cdn_service_activation_state required | The activation state of the CDN service. Example : | string | |
| cdn_service_config_version required | The configuration version of the CDN service. Example : | integer | |
| cdn_service_domain required | The domain name through which the CDN service delivers content. Example : | string | |
| cdn_service_origin_path required | The path on the origin server from which the CDN retrieves content. Example : | string | |
| cdn_service_state required | The current state of the CDN service (e.g., RUNNING, STOPPED, CREATING, DELETING). Example : | string | |
| content_policy required | The content delivery policy for the CDN service (e.g., ONLY_VALIDATED_CONTENTS, ALL_CONTENTS). Example : | string | |
| created_at required | The timestamp when the resource was created, in ISO 8601 format. Example : | string | |
| created_by required | The user id that created the resource. Example : | string | |
| custom_forward_host_header required | The custom host header forwarded to the origin when forward host header is set to CUSTOM. Example : | string | |
| description required | Description Example : | string | |
| forward_host_header required | The host header forwarded to the origin server (e.g., ORIGIN_HOSTNAME, INCOMING_HOST_HEADER, CUSTOM). Example : | string | |
| id required | The unique identifier of the CDN service. Example : | string | |
| modified_at required | The timestamp when the resource was last modified, in ISO 8601 format. Example : | string | |
| modified_by required | The user id that last modified the resource. Example : | string | |
| name required | The name of the CDN service. Example : | string | |
| origin_hostname_type required | The type of the origin hostname (e.g., DOMAIN, IP). Example : | string | |
| query_string_ignored required | Indicates whether the query string is ignored when caching content. Example : | boolean | |
| range_request_allowed required | Indicates whether range requests are allowed for content delivery. Example : | boolean | |
| region required | The region where the CDN service is provided. Example : | string | |
| request_custom_headers required | The custom headers added to requests forwarded to the origin server. Example : | object | |
| response_custom_headers required | The custom headers added to responses returned to the client. Example : | object |
3 - CdnServiceDetailResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| cdn required | CdnServiceDetail |
4 - CdnServiceListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
5 - CdnServiceModifyDescriptionRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description required | Description Example : 추가 정보 입력 - 설명Maximum length : 50 | string |
6 - CdnServicePurgeRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| custom_url optional | The custom URL to purge when the target URL is set to CUSTOM. Example : /test/Pattern : ^/[a-zA-Z0-9-._/]*$ | any of [string, null] | |
| target_content required | The target content type to purge (e.g., ALL_CONTENT, INVALIDATED_CONTENT). Example : INVALIDATED_CONTENT | string | |
| target_url required | The target URL scope for the purge operation (e.g., ALL, CUSTOM). Example : CUSTOM | string |
7 - CdnServiceResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : | string | |
| cdn_origin_hostname required | The hostname of the origin server from which the CDN retrieves content. Example : | string | |
| cdn_service_domain required | The domain name through which the CDN service delivers content. Example : | string | |
| cdn_service_state required | The current state of the CDN service (e.g., RUNNING, STOPPED, CREATING, DELETING). 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 | The unique identifier of the CDN service. 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 | The name of the CDN service. Example : | string | |
| region required | The region where the CDN service is provided. Example : | string |
8 - CdnServiceResponseResult
| Name | Description | Schema | Default |
|---|---|---|---|
| cdn required | CdnServiceResult |
9 - CdnServiceResult
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : | string | |
| resource_id required | The identifier of the resource. Example : | string | |
| workflow_id required | The identifier of the workflow processing the request. Example : | string |
10 - CdnServiceUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| cache_expiry_time required | The cache expiry time in seconds for content stored at edge locations. Example : 86400Minimum : 3600Maximum : 2592000 | integer | |
| cache_key_hostname required | The hostname used as part of the cache key (e.g., ORIGIN_HOSTNAME, INCOMING_HOST_HEADER). Example : REQUEST_HOST_HEADER | enum (REQUEST_HOST_HEADER, ORIGIN_HOSTNAME) | |
| caching_option required | The caching option for the CDN content (e.g., CACHE, NO_CACHE, BYPASS_CACHE). Example : CACHE | string | |
| cdn_origin_hostname required | The hostname of the origin server from which the CDN retrieves content. Example : test.example.comPattern : ^(([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 | The port used to connect to the origin server. Example : 443Minimum : 1Maximum : 65535 | integer | |
| cdn_origin_protocol required | The protocol used to connect to the origin server (e.g., HTTP, HTTPS). Example : HTTPS | string | |
| cdn_service_origin_path optional | The path on the origin server from which the CDN retrieves content. Example : /test/global/Pattern : ^/$|^(/[a-zA-Z0-9-._]+)+/$ | any of [string, null] | |
| content_policy required | The content delivery policy for the CDN service (e.g., ONLY_VALIDATED_CONTENTS, ALL_CONTENTS). Example : ONLY_VALIDATED_CONTENTS | string | |
| custom_forward_host_header optional | The custom host header forwarded to the origin when forward host header is set to CUSTOM. Example : | any of [string, null] | |
| forward_host_header required | The host header forwarded to the origin server (e.g., ORIGIN_HOSTNAME, INCOMING_HOST_HEADER, CUSTOM). Example : REQUEST_HOST_HEADER | enum (REQUEST_HOST_HEADER, ORIGIN_HOSTNAME, CUSTOM) | |
| origin_hostname_type required | The type of the origin hostname (e.g., DOMAIN, IP). Example : DOMAIN | enum (DOMAIN, IP) | |
| query_string_ignored required | Indicates whether the query string is ignored when caching content. Example : True | boolean | |
| range_request_allowed required | Indicates whether range requests are allowed for content delivery. Example : True | boolean | |
| request_custom_headers optional | The custom headers added to requests forwarded to the origin server. Example : | any of [object, null] | |
| response_custom_headers optional | The custom headers added to responses returned to the client. Example : | any of [object, null] |
11 - Tag
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | tag key Example : | string | |
| value required | tag value Example : | string |