QueryPurgeResiduals_Cache Refresh_API Docs-Documentation

Documentation API Docs Cache Refresh QueryPurgeResiduals

Applicable Products

Content MGMT

API Description

Query url purge , directory purge and prefetch daily limit .

API URL: https://api.atomile.com/ccm/upperQuery
Method: GET

Call frequency

Single user trigger frequency: 1/5min

Request parameter(s)

Params Params

Name	Description
*typeString	Query the feature's daily limit: Purge: Query the number of daily purge Fetch: Query the number and size of daily prefetch

Response parameter(s)

Body Params

Name	Description
supplierString	It is the logo of our company.
codeInteger	The status code of the query result: 1) 0 means success, 2) 1 means failure.
messageString	Content system response message after query.
urlUpperInteger	The maximum number of the purge url today.
dirUpperInteger	The maximum number of the purge directory today.
urlRemainInteger	The number of urls that can be purged today.
dirRemainInteger	The number of directorys that can be purged today.
tagUpperInteger	The maximum number of the purge tag today.
tagRemainInteger	The number of urls that can be purged tag today.

Error code

Error code(code)	Description(message)	HTTP status	Semantic
0	success	200	success
1	username is error	200	username is error
1	query type is required	200	query type is required
1	query type is error	200	query type is error
1	system error	200	system error

Example

JSON1

Request example Copy Copy success#!/bin/bash username="{username}" apiKey='{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://api.atomile.com/ccm/upperQuery?type=purge" \ -X "GET" \ -u "$username:$password" \ -H "Date:$date" \ -H "Content-Type: application/json"

#!/bin/bash
username="{username}"
apiKey='{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://api.atomile.com/ccm/upperQuery?type=purge" \
-X "GET" \
-u "$username:$password" \
-H "Date:$date" \
-H "Content-Type: application/json"

Response example Copy Copy successHTTP/1.1 200 OK Date: Fri, 26 Oct 2012 06:33:26 GMT Content-Type: application/json;charset=UTF-8 x-cnc-request-id:{id string auto generated by cloud server} { "supplier":"${providercode}", "code": 0, "message": "success", "urlUpper": 3000, "urlRemain": 2900, "dirUpper": 500, "dirRemain": 500 }

HTTP/1.1 200 OK
Date: Fri, 26 Oct 2012 06:33:26 GMT
Content-Type: application/json;charset=UTF-8
x-cnc-request-id:{id string auto generated by cloud server}
{
 "supplier":"${providercode}",
    "code": 0,
    "message": "success",
    "urlUpper": 3000,
    "urlRemain": 2900,
    "dirUpper": 500,
    "dirRemain": 500
}

JSON2

Request example Copy Copy success#!/bin/bash username="{username}" apiKey="{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://api.atomile.com/ccm/upperQuery?type=fetch" \ -X "GET" \ -u "$username:$password" \ -H "Date:$date" \ -H "Content-Type: application/json"

#!/bin/bash
username="{username}"
apiKey="{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://api.atomile.com/ccm/upperQuery?type=fetch" \
-X "GET" \
-u "$username:$password" \
-H "Date:$date" \
-H "Content-Type: application/json"

Response example Copy Copy successHTTP/1.1 200 OK Date: Fri, 26 Oct 2012 06:33:26 GMT Content-Type: application/json;charset=UTF-8 x-cnc-request-id:{id string auto generated by cloud server} { "supplier":"${providercode}", "code": 0, "message": "success", "maxRuningFetch":10, "fetchCount":1500, "fetchUpper": 3000, "fetchRemain": 2900, "fetchSizeUpper": 500000000, "fetchSizeRemain": 5000 }

HTTP/1.1 200 OK
Date: Fri, 26 Oct 2012 06:33:26 GMT
Content-Type: application/json;charset=UTF-8
x-cnc-request-id:{id string auto generated by cloud server}
{
 "supplier":"${providercode}",
    "code": 0,
    "message": "success",
    "maxRuningFetch":10,
    "fetchCount":1500,
    "fetchUpper": 3000,
    "fetchRemain": 2900,
    "fetchSizeUpper": 500000000,
    "fetchSizeRemain": 5000
}

XML1

Request example Copy Copy success#!/bin/bash username="{username}" apiKey="{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://api.atomile.com/ccm/upperQuery?type=purge" \ -X "GET" \ -u "$username:$password" \ -H "Date:$date" \ -H "Content-Type: application/xml" \

#!/bin/bash
username="{username}"
apiKey="{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://api.atomile.com/ccm/upperQuery?type=purge" \
-X "GET" \
-u "$username:$password" \
-H "Date:$date" \
-H "Content-Type: application/xml" \

Response example Copy Copy successHTTP/1.1 200 OK Date: Fri, 26 Oct 2012 06:33:26 GMT Content-Type: application/json;charset=UTF-8 x-cnc-request-id:{id string auto generated by cloud server} <?xml version="1.0" encoding="utf-8"?> <quota-query> <supplier>${providercode}</supplier> <code>0</code> <message>success</message> <url-upper>3000</url-upper> <url-remain>2900</url-remain> <dir-upper>500</dir-upper> <dir-remain>500</dir-remain> </quota-query>

HTTP/1.1 200 OK
Date: Fri, 26 Oct 2012 06:33:26 GMT
Content-Type: application/json;charset=UTF-8
x-cnc-request-id:{id string auto generated by cloud server}
<?xml version="1.0" encoding="utf-8"?>
<quota-query>
 <supplier>${providercode}</supplier>
    <code>0</code>
    <message>success</message>
    <url-upper>3000</url-upper>
    <url-remain>2900</url-remain>
    <dir-upper>500</dir-upper>
    <dir-remain>500</dir-remain>
</quota-query>

XML2

#!/bin/bash
username="{username}"
apiKey="{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://api.atomile.com/ccm/upperQuery?type=fetch" \
-X "GET" \
-u "$username:$password" \
-H "Date:$date" \
-H "Content-Type: application/xml"

Response example Copy Copy successHTTP/1.1 200 OK Date: Fri, 26 Oct 2012 06:33:26 GMT Content-Type: application/json;charset=UTF-8 x-cnc-request-id:{id string auto generated by cloud server} <?xml version="1.0" encoding="utf-8"?> <quota-query> <supplier>${providercode}</supplier> <code>0</code> <message>success</message> <max-runing-fetch>10</max-runing-fetch> <fetch-count>1500</fetch-count> <fetch-upper>3000</fetch-upper> <fetch-remain>2900</fetch-remain> <fetch-size-upper>500000000</fetch-size-upper> <fetch-size-remain>5000</fetch-size-remain> </quota-query>

HTTP/1.1 200 OK
Date: Fri, 26 Oct 2012 06:33:26 GMT
Content-Type: application/json;charset=UTF-8
x-cnc-request-id:{id string auto generated by cloud server}
<?xml version="1.0" encoding="utf-8"?>
<quota-query>
 <supplier>${providercode}</supplier>
    <code>0</code>
    <message>success</message>
    <max-runing-fetch>10</max-runing-fetch>
    <fetch-count>1500</fetch-count>
    <fetch-upper>3000</fetch-upper>
    <fetch-remain>2900</fetch-remain>
    <fetch-size-upper>500000000</fetch-size-upper>
    <fetch-size-remain>5000</fetch-size-remain>
</quota-query>

Previous：QueryPurgeLimit Next：Prefetch

CDN

Media Delivery

Management Tools

API Docs

QueryPurgeResiduals