Create Cache Control V2

This API is used to create cache control for website acceleration service.

Request

Request-Line

POST /cdn/v1.1/services/{serviceId}/cacheControl HTTP/1.1

Request Parameters

Path Parameters

Parameter	Type	Required	Description
serviceId	Integer	Mandatory	service id.

Body Parameters

Parameter	Type	Required	Description
policyName	String	Mandatory	Policy name for cache control.
priority	Integer	Mandatory	Priority weight for the rule. Rules with a higher weight take precedence. The weight must be non-zero.
matches	Array	Mandatory	Matching configuration that determines which requests the rule applies to. See Matches for details.
ttl	Long	Optional	The cache TTL for contents to be cached on edge server in seconds.
refererAcl	Object	Optional	Configure resource references by creating a domain list and selecting a configuration type (e.g.,whitelist,blacklist) to control whether a domain has permission to access the resource,thereby ensuring resource security. see Referer Acl for details
originAcl	Object	Optional	Configure origins by creating a domain list and selecting a configuration type (e.g.,whitelist,blacklist) to control whether a domain has permission to access data from origin,thereby ensuring resource security. see Origin Acl for details
ignoreClientNoCache	Boolean	Optional	True or false to ignore no-cache header(s) sent by the client. Default is false.
ignoreOriginNoCache	Boolean	Optional	True or false to ignore no-cache header(s) sent by the origin server. Default is false.
ignoreQueryString	Boolean	Optional	True or false to ignore any URL query string when caching contents. Default is false.
enableXCache	Boolean	Optional	When enabled all responses from the edge have X-Cache header with values like "HIT from da01.xy01.swiftserve.com", showing whether the response was served from the cache (at least partially) or not. Default is false.
noCache	Boolean	Optional	Do not cache the content even if the origin presents it as cacheable. Default is false.
autoGzipDisable	Boolean	Mandatory	Disable automatic gzipping on the CDN side. Default is false.
responseHeaders	Array	Optional	List of response header configuration. See Response Headers for details.
varyMIMEs	String[]	Optional	Configures so-called "vary for images" feature.Contains a list of mime types, preferred for objects matched by the policy.
enabled	Boolean	Optional	Flag defining if policy is active or no. default is true.

Object: Matches

Parameter	Type	Required	Description
	Array	Mandatory	See Match for details.

Object: Match

Parameter	Type	Required	Description
field	String	Mandatory	Which part of the request to match. Supported values: • req.path - Request path (excluding query string). • req.query - Request query parameters. • req.method - HTTP method (GET, POST, etc.). • client.ip - Client IP address. • req.host - Request host. • req.header.user-agent - User-Agent header. • req.header.cookie - Cookie header. • req.header.origin - Origin header. • req.header.via - Via header.
operator	String	Mandatory	Defines how to match the field. Supported values: • startswith - Succeeds if the what matches one of the prefixes listed in patterns. • not_startswith - Matches if field value does not starts with any of the specified prefixes. • istartswith - Case-independent version of startswith. • not_istartwith - Matches if the field value does not starts with any of the specified prefixes, ignoring letter case differences. • regex - Succeeds if what matches one of the regexes listed in patterns. • equals - Succeeds if the what matches one of the strings listed in patterns. • not_equals - Succeeds if the field value does not exactly match any of the specified strings. • iequals - Case-independent version of equals. • not_iequals - Succeeds if the field value does not exactly match any of the specified strings,ignoring letter case differences. • endswith - Succeeds if the what ends with one of the strings listed in patterns. Useful e.g. to match file extensions like ".mp4". • not_endswith - Succeeds if the what does not ends with one of the strings listed in patterns. • iendswith - Case-independent version of endswith. • not_iendswith - Succeeds if the what does not ends with one of the strings listed in patterns,ignoring letter case differences. • subnet - Succeeds if the what belongs to one of subnets, specified in patterns, like "1.222.94.98/32". • not_subnet - Succeeds if the what does not belongs to one of subnets. Note: subnet operator is applicable only to the client.ip match option.
values	String[]	Mandatory	List of values matching the URL path string.

Object: Referer/Origin Acl

Parameter	Type	Required	Description
aclType	String	Mandatory	Types of blacklist and whitelist.
domainList	String[]	Mandatory	List of domainName.

Object: Response Headers

Parameter	Type	Required	Description
name	String	Mandatory	Response Header Name.
operationType	String	Mandatory	Operation type of response header policy, could be "add" or "replace" or "delete"
value	String	Optional	Response Header Value.

Response

Response Body

Parameter	Type	Description
policyId	Integer	Policy ID number for cache control.
policyName	String	Policy name for cache control.
matches	Array	Matching configuration that determines which requests the rule applies to. See Matches for details.
priority	Integer	Priority weight for the rule. Rules with a higher weight take precedence. The weight must be non-zero.
ignoreClientNoCache	Boolean	True or false to ignore no-cache header(s) sent by the client. Default is false.
ignoreOriginNoCache	Boolean	True or false to ignore no-cache header(s) sent by the origin server. Default is false.
ignoreQueryString	Boolean	True or false to ignore any URL query string when caching contents. Default is false.
enableXCache	Boolean	When enabled all responses from the edge have X-Cache header with values like "HIT from da01.xy01.swiftserve.com", showing whether the response was served from the cache (at least partially) or not. Default is false.
noCache	Boolean	Do not cache the content even if the origin presents it as cacheable. Default is false.
autoGzipDisable	Boolean	Disable automatic gzipping on the CDN side. Default is false.
responseHeaders	Array	List of response header configuration. See Response Headers for details.
refererAcl	Object	Configure resource references by creating a domain list and selecting a configuration type (e.g.,whitelist,blacklist) to control whether a domain has permission to access the resource,thereby ensuring resource security. see Referer Acl for details
originAcl	Object	Configure origins by creating a domain list and selecting a configuration type (e.g.,whitelist,blacklist) to control whether a domain has permission to access data from origin,thereby ensuring resource security. see Origin Acl for details
ttl	Long	The cache TTL for contents to be cached on edge server in seconds.
varyMIMEs	String[]	Configures so-called "vary for images" feature.Contains a list of mime types, preferred for objects matched by the policy.
enabled	Boolean	Flag defining if policy is active or no. default is true.

Status Codes, Error Codes and Error Messages

Status Code	Error Code	Error Message
400	Request.BadRequest	Bad request.
400	InvalidCustomer.IdEmpty	Customer id can be empty or invalid.
400	InvalidService.IdIncorrect	Service id is empty or invalid.
400	ServiceId.IdPermission	ServiceId can not be found or unknown.
400	Invalid.PolicyName	Policy name is required.
400	InvalidPolicy.MatchURLIncorrect	The matchUrlPath can not be empty.
400	InvalidPolicy.Operator	Operator must be one of the following: prefix,regex,equals or suffix.
400	InvalidPolicy.Patterns	Patterns cannot be empty or invalid.
400	InvalidPolicy.RefererAcl	Invalid AclType, must be in 'whitelist' or 'blacklist'.
400	InvalidPolicy.AclDomainList	The AclDomainList array and every element in it must not be empty.
400	InvalidPolicy.AclDomainType	The AclDomainList cannot be start with '-'
400	InvalidPolicy.RefererAcl	Invalid AclType, must be in 'whitelist' or 'blacklist'.
400	InvalidPolicy.Priority	Priority is required.
400	InvalidService.VaryMiME	VaryMiME cannot be empty.
400	InvalidPolicy.ResponseHeader	Response header cannot be empty or invalid.
400	InvalidPolicy.MatchesIncorrect	The matches can not be empty or incorrect.
400	InvalidPolicy.MatchFieldIncorrect	The match field can not be empty or use the specified value.
400	InvalidPolicy.MatchOperatorIncorrect	The match operator required or use the specified value.
400	InvalidPolicy.MatchValuesIncorrect	The match values required or can not be empty.
400	InvalidPolicy.MatchValueIncorrect	All match values must not be empty.

Examples

Create Cache Control V2

Request

POST /cdn/v1.1/services/229033/cacheControl HTTP/1.1

{   "priority":5,
    "policyName":"cacheInfo",
    "matches":[
        {
            "field":"req.path",
            "operator":"startswith",
            "values":["/css/","/images/abc/"]
        },
        {
            "field":"req.host",
            "operator":"iequals",
            "values":["expamle.com"]
        },
        {
            "field":"req.method",
            "operator":"equals",
            "values":["get"]
        }
    ],
    "ignoreClientNoCache":false,
    "ignoreOriginNoCache":false,
    "ignoreQueryString":true,
    "enableXCache":true,
    "noCache":false,
    "autoGzipDisable":false,
    "responseHeaders":[{
      "name": "Content-Type",
      "operationType": "add",
      "value": "application/json"
    }]
}

Successful Response Body

{
    "policyId": 262285,
    "policyName": "cacheInfo",
    "ttl": 0,
    "originAcl": {
        "aclType": "",
        "domainList": []
    },
    "ignoreClientNoCache": false,
    "ignoreOriginNoCache": false,
    "ignoreQueryString": true,
    "enableXCache": true,
    "noCache": false,
    "autoGzipDisable": false,
    "responseHeaders": [
        {
            "name": "Content-Type",
            "value": "application/json",
            "operationType": "Add"
        }
    ],
    "matches": [
        {
            "field": "req.path",
            "operator": "startswith",
            "values": [
                "/css/",
                "/images/abc/"
            ]
        },
        {
            "field": "req.host",
            "operator": "iequals",
            "values": [
                "expamle.com"
            ]
        },
        {
            "field": "req.method",
            "operator": "equals",
            "values": [
                "get"
            ]
        }
    ],
    "varyMIMEs": [],
    "priority": 5,
    "enabled": true
}