QueryQueryStringUrlConfig_Domain Configuration

API Description

Through the interface, the query string settings can be modified by self-service, realizing the customized cache function. With the query string URL, you can set whether to cache multiple copies or cache the URL after removing the question mark (to increase the hit rate), and you can set whether to use the original request to return to the source, etc. The * of the interface calling url can be the domain name or domain id.

API URL: https://api.atomile.com/api/config/querystring/*
Method: GET
Limit Description: · The accelerated domain name must have been filed. · Accelerated domain names must not contain the following information: sales of drugs and controlled tools, including illegal speech and information. · Video-accelerated domain names must have audiovisual licenses; blog forums or community-based accelerated domain names must have BBS special approval qualifications. · Interface requests and return results only accept xml format.

Call frequency

Single user trigger frequency: 300/5min

Request parameter(s)

Path Params

Name	Description
domain-nameString	Domain name or domain ID that needs to be queried for configuration.

Response parameter(s)

Body Params

Name	Description
domain-nameString	Domain name or domain ID that needs to be queried for configuration.
domain-idString	Domain name or domain ID that needs to be queried for configuration.
- query-string-settingsList	Query String Settings Configuration, parent node 1. When you need to configure the query string, this must be filled in. 2. Configuration of clearing query string settings for .
path-patternString	The url matching mode. If all matches, the input parameters can be configured as: .* Note: URL matching mode, file type (custom file type), commonly used type, specified url, directory, with and only one required
file-typesString	File Type: Specify the file types to query the string url config. Optional file types include: GIF PNG BMP JPEG JPG HTML HTM shtml MP3 WMA flv MP4 WMV zip exe rar CSS TXT ICO JS SWF m3u8 XML f4m bootstarps if all types are required. Multiple separated by semicolons, all and specific file types cannot be configured at the same time
custom-file-typesString	Custom file type: Fill in the appropriate identifiable file type according to your own needs outside the specified file type. It can be used with file-type. If file-type is also configured, the actual file type in effect is the sum of the two entries.
custom-patternString	Common types: optional values are home page and all All: All files types Homepage: home page
specify-url-patternString	Specify url, not http (s): // start, multiple separated by newline
directoriesString	directories, you can enter a legitimate directory format. Start and end with / and multiple separated by semicolons.
priorityInteger	Priority, which represents the priority execution order of the customer's multi-group configuration. The bigger the number, the higher the priority. No transmission defaults to 10, not empty.
ignore-letter-caseString	Whether to ignore letter case.
ignore-query-stringString	Define the file types to be compressed. 'text/' will be compressed by default.
query-string-keptString	Cache with the specified query string parameters. If the kept parameter values are the same, one copy will be cached. Note: 1. query-string-kept and query-string-removed are mutually exclusive, and only one of them has a value. 2. query-string-kept and ignore-query-string are mutually exclusive, and only one has a value.
query-string-removedString	Cache without the specified query string parameters. After deleting the specified parameter, if the other parameter values are the same, one copy will be cached. 1. query-string-kept and query string removed are mutually exclusive, and only one has a value. 2. query-string-removed and ignore-query-string are mutually exclusive.
source-with-queryString	Whether to use the original URL back source, the allowable values are true and false. When ignore-query-string is true or not set, source-with-query is true to indicate that the source is returned according to the original request, and false to indicate that the question mark is returned. When ignore-query-string is false, this default setting is empty (input is invalid)
source-key-keptString	Return to the source after specifying the reserved parameter value. Please separate them with semicolons, if no parameters reserved, please fill in:- . 1. Source-key-kept and ignore-query-string are mutually exclusive, and only one of them has a value. 2. Source-key-kept and source-key-removed are mutually exclusive, and only one of them has a value.
source-key-removedString	Return to the source after specifying the deleted parameter value. Please separate them with semicolons, and if you do not delete any parameters, please fill in:- . 1. Source-key-removed and ignore-query-string are mutually exclusive, and only one of them has a value. 2. Source-key-kept and source-key-removed are mutually exclusive, and only one of them has a value.
data-idInteger	When configuring multiple configurations, the ID of a specific group of configurations

Error code

Error code(code)	Description(message)	HTTP status	Semantic
InvalidParameter	No domain name was specified.	400	No domain name was specified.
NoSuchDomain	The specified domain does not exist.	404	The specified domain does not exist.
CustomerNoOwnDomain	customer not own domain name[{your customer code}]	400	customer not own domain name[{your customer code}]

Example

JSON

Request example Copy Copy success#!/bin/bash username="example_username" apiKey="example_apiKey" date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"` password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64` curl -i --url "https://{@apiDomain}/api/config/querystring/123344" \ -X "GET" \ -u "$username:$password" \ -H "Date: $date" \ -H "Accept: application/json" \ -H "Content-Type:application/json"

#!/bin/bash
username="example_username"
apiKey="example_apiKey"
date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"`
password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64`
curl -i --url "https://{@apiDomain}/api/config/querystring/123344" \
-X "GET" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json" \
-H "Content-Type:application/json"

Response example Copy Copy successHTTP/1.1 200 OK Date: Sun, 05 May 2019 09:08:53 GMT Content-Type: application/json;charset=utf-8 x-cnc-request-id: 83bbebc7-2c95-47d7 { "domain-name":"www.example.com", "domain-id":"123344", "query-string-settings":[ { "data-id":"111111", "path-pattern":"/test1/.*", "ignore-letter-case":"true", "ignore-query-string":"true", "source-with-query":"true" },{ "data-id":"111112", "specify-url-pattern":"/test2/specifyurl", "ignore-letter-case":"true", "query-string-kept":"lang" } ] }

HTTP/1.1 200 OK
Date: Sun, 05 May 2019 09:08:53 GMT
Content-Type: application/json;charset=utf-8
x-cnc-request-id: 83bbebc7-2c95-47d7
{
 "domain-name":"www.example.com",
 "domain-id":"123344",
 "query-string-settings":[
 {
 "data-id":"111111",
 "path-pattern":"/test1/.*",
 "ignore-letter-case":"true",
 "ignore-query-string":"true",
 "source-with-query":"true"
 },{
 "data-id":"111112",
 "specify-url-pattern":"/test2/specifyurl",
 "ignore-letter-case":"true",
 "query-string-kept":"lang"
}
]
}

CDN

Media Delivery

Management Tools

API Docs

QueryQueryStringUrlConfig

Applicable Products