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 | cache expiry time Example : Minimum : 3600Maximum : 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.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 | cdn service origin port Example : Minimum : 1Maximum : 65535 | integer | |
| cdn_origin_protocol required | cdn service origin protocol Example : | string | |
| cdn_service_domain_prefix required | cdn service domain prefix Example : global1Pattern : ^[a-z0-9]*$Minimum length : 4Maximum 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 : test1Pattern : ^[a-zA-Z0-9]*$Minimum length : 3Maximum 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 - CdnServiceDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
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 : | string |
6 - CdnServicePurgeRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
7 - CdnServiceResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
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 | resource id Example : | string | |
| workflow_id required | workflow id Example : | string |
10 - CdnServiceUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| cache_expiry_time required | cache expiry time Example : Minimum : 3600Maximum : 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.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 | cdn service origin port Example : Minimum : 1Maximum : 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] |
11 - Tag
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | tag key Example : | string | |
| value required | tag value Example : | string |