EditQueryStringUrlConfig_Domain Configuration

API Description

Modify query string setting configurations.

API URL: https://api.atomile.com/api/config/querystring/*
Method: PUT
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	the domain whoes need query config

Body Params

Name	Description
- *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: .*
file-typesString	File Type: Specify the file type to update string url config.File types include: gif png bmp jpeg jpg html htm shtml mp3 wma flv mp4 wmv zip exe rar css txt ico js swfIf you need all types, pass all directly. Multiples are separated by semicolons, and 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 needs outside of the specified file type. Can be used with file-type. If the file-type is also configured, the actual file type is the sum of the two parameters.
custom-patternString	Specify common types: Select the domain name that requires the anti-theft chain to be all files or the home page. : E.g: All: all files Homepage: homepage
specify-url-patternString	Specify URL cache: Specify url according to requirements for anti-theft chain setting INS format does not support URI format with http(s)://
directoriesString	Directory: Specify the directory for anti-theft chain settings Enter a legal directory format. Multiple separated by semicolons
priorityString	Indicates the priority execution order of multiple sets of redirected content by the customer. The higher the number, the higher the priority. When adding a new configuration item, the default is 10
ignore-letter-caseString	Whether to ignore letter case.
ignore-query-stringString	Define whether to cache with query strings, 'true' means ignore query strings, while 'false' means cache with all query strings.
query-string-keptString	Cache with the specified query string parameters. Multiple values separated by semicolons. 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. Multiple values separated by semicolons. 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. 1.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. 2.When ignore-query-string is false, this default setting is empty (input is invalid). 3.When the option "Use Original URL for Origin Fetch (source-with-query)" is set to true, the "Cache Key Keep Query String (query-string-kept)" configuration takes no effect. The actual caching behavior is equivalent to stripping the query string (i.e., caching without the question mark and subsequent parameters).
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-idLong	Data-id is to indicate a specific group configuration when the client has multiple groups of configurations. Data-id can be retrieved through a query interface. Note: A. If data-id is passed, it means that one group of configuration items is specified to be modified, and no other group configuration items need to be modified. B. If multiple groups of configurations are included, some of them are configured with data-id and others are not, then the expression of data-id is used to modify a specific group of configurations, and a new group of configurations is added on the original basis without the expression of data-id. C. If the data-id is not transmitted, it means that the original configuration will be fully covered by this configuration. D. If no configuration parameter is passed, only domain name and secondary label are passed, which means that all configuration of domain name secondary service corresponding to this interface is cleared. E. If there is no specific configuration item in a set of configurations, the data-id must be filled in, and the value is the actual data-id, which means clearing the value of the corresponding data-id configuration item; it is not allowed that there is no specific configuration item or data-id in a set of configurations.
descriptionString	description

Response parameter(s)

Body Params

Name	Description
codeString	The error code, when HTTPStatus is not 202, indicates the type of error the current request is calling.
messageString	Response information, when success is successful

Error code

Error code(code)	Description(message)	HTTP status	Semantic
NoSuchDomain	The specified domain does not exist.\n\n	404	The specified domain does not exist.\n\n
CustomerNoOwnDomain	customer not own domain name[www.example.com].\n\n	400	customer not own domain name[www.example.com].\n\n
ConfigError	The config {0} does not access.\n\n	400	The config {0} does not access.\n\n
InvalidParameter	example: 1. No domain was specified.2.The {0} is invalid.\n\n	400	example: 1. No domain was specified.2.The {0} is invalid.\n\n

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 "PUT" \ -u "$username:$password" \ -H "Date: $date" \ -H "Accept: application/json" \ -H "Content-Type:application/json" \ -d ' { "query-string-settings":[ { "path-pattern":"/test1/.*", "ignore-letter-case":"true", "ignore-query-string":"true", "source-with-query":"true" },{ "specify-url-pattern":"/test2/specifyurl", "ignore-letter-case":"true", "query-string-kept":"lang" } ], "description":"description" }'

#!/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 "PUT" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json" \
-H "Content-Type:application/json" \
-d '
{
  "query-string-settings":[
    {
      "path-pattern":"/test1/.*",
      "ignore-letter-case":"true",
      "ignore-query-string":"true",
      "source-with-query":"true"
    },{
      "specify-url-pattern":"/test2/specifyurl",
      "ignore-letter-case":"true",
      "query-string-kept":"lang"
    }
  ],
  "description":"description"
}'

Response example Copy Copy successHTTP/1.1 202 Accepted Date: Sun, 05 May 2019 09:08:53 GMT Content-Type: application/json;charset=utf-8 x-cnc-request-id: 83bbebc7-2c95-47d7 {"message":"success"}

HTTP/1.1 202 Accepted
Date: Sun, 05 May 2019 09:08:53 GMT
Content-Type: application/json;charset=utf-8
x-cnc-request-id: 83bbebc7-2c95-47d7
{"message":"success"}

CDN

Media Delivery

Management Tools

API Docs

EditQueryStringUrlConfig

Applicable Products

API Description

Call frequency

Request parameter(s)

Path Params

Body Params

Response parameter(s)

Body Params

Error code

Example

Directory