PurgeUrlsMatchingRegex-Documentation

POST

https://api.cdnetworks.com/api/content/regular-url/purge

Online Call API

Clear the cached file content on CDN nodes according to the regular URL method.

Limit Description: Data format: Both requests and responses only support JSON. Usage advice: If it's the same regular URL, submission is only allowed after the previous cache - clearing is completed. Excessively high refresh frequencies can affect the performance of the content management system. Daily usage (in the time zone of UTC+8): The default is 500.
Limit of request rate per user: 10/5min
Applicable Products: Content MGMT

For API authentication details, please refer to: API Authentication Overview

Request

Body Params

Name	Description
urlRegularsList	The set of regular URLs for which the cache needs to be cleared. Requirements for the format of regular URLs:The URL should conform to a regular expression. Example input: http://www.a.com/(.).png. If you want to push the regular expression http://www.abc.com/test/..txt, when using the interface, you need to escape the backslash, that is, http://www.abc.com/test/.*\.txt.The domain name of each regular URL must be a domain name accelerated by our company.The maximum length of each regular URL is 2000 characters.If special characters are included in the regular URL, they need to be escaped in UTF - 8 format.For the same regular URL, the system will remove duplicates before submission.The default limit is 500 per day.

Name

Description

urlRegularsList

The set of regular URLs for which the cache needs to be cleared. Requirements for the format of regular URLs:The URL should conform to a regular expression. Example input: http://www.a.com/(.).png. If you want to push the regular expression http://www.abc.com/test/..txt, when using the interface, you need to escape the backslash, that is, http://www.abc.com/test/.*\.txt.The domain name of each regular URL must be a domain name accelerated by our company.The maximum length of each regular URL is 2000 characters.If special characters are included in the regular URL, they need to be escaped in UTF - 8 format.For the same regular URL, the system will remove duplicates before submission.The default limit is 500 per day.

Response

Body Params

Name	Description
CodeString	Status code indicating the result of the task creation
MessageString	Indicates the response message of the system after the task is submitted.
itemIdString	After the interface is called once and the task is successfully submitted, it will return an itemamId, which is the unique identifier of the task submitted at that time. The itemId can be used to query the status (success/failure) of the task in batches.

Error code

Error code(code)	Description(message)	HTTP status	Semantic
Success	Task submitted successfully	200	Task submitted successfully
UserNameInvalid	Username is empty or user is not enabled	400	Username is empty or user is not enabled
ParseParameterError	parse parameter json error	400	parse parameter json error
UrlRegularEmpty	url regular must not be empty	400	url regular must not be empty
OnceSubmitLessThan500	you can't submit more than 500 url regulars at a time	400	you can't submit more than 500 url regulars at a time
NumberOutOfLimit	the number of url regular out of today limit(500)	400	the number of url regular out of today limit(500)
NumberOutOfLimit	If the incoming header has a X-Time-Zone, the prompt includes a time interval corresponding to the time zone, such as the number of url regular out of 2018-10-17 01:00:00 GMT+09:00~2018-10-18 00:59: 59GMT+09:00 limit(500)	400	If the incoming header has a X-Time-Zone, the prompt includes a time interval corresponding to the time zone, such as the number of url regular out of 2018-10-17 01:00:00 GMT+09:00~2018-10-18 00:59: 59GMT+09:00 limit(500)
NumberPartlyOutOfLimit	The regular part of the submitted url exceeds the upper limit. If it is not exceeded, it can be executed normally.	400	The regular part of the submitted url exceeds the upper limit. If it is not exceeded, it can be executed normally.
RepeatUrlRegular	running url regular[xxx], please try again after one minute.	400	running url regular[xxx], please try again after one minute.
UserNotAllowedPush	user not allowed push	400	user not allowed push
ErrorChannel	error channel [xxx,xxx].	400	error channel [xxx,xxx].
InvalidUrlRegular	invalid url regular [url1,url2].	400	invalid url regular [url1,url2].
SystemException	system exception	500	system exception

Example

JSON

Request example Copy Copy success#!/bin/bash username="username_exmaple" apiKey='apiKey_exmaple' 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.cdnetworks.com/api/content/regular-url/purge" \ -X "POST" \ -u "$username:$password" \ -H "Date:$date" \ -H "Content-Type: application/json" \ -d'{ "urlRegulars":[ "http://www.abc.com/test/.*\.txt", "http://www.abc.com/test/.*\.png" ] }'

#!/bin/bash
username="username_exmaple"
apiKey='apiKey_exmaple'
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.cdnetworks.com/api/content/regular-url/purge" \
-X "POST" \
-u "$username:$password" \
-H "Date:$date" \
-H "Content-Type: application/json" \
-d'{
      "urlRegulars":[
          "http://www.abc.com/test/.*\.txt",
          "http://www.abc.com/test/.*\.png"
       ]   
}'

Response example Copy Copy success{ "Code":Success, "Message":"handle success", "itemId":"64ec364dd81d4052a3534c1e86167950" }

{
   "Code":Success,
   "Message":"handle success",
   "itemId":"64ec364dd81d4052a3534c1e86167950"
}

Is the content of this document helpful to you?

Yes

I have suggestion

PurgeUrlsMatchingRegex

Request

Body Params

Response

Body Params

Error code

Example

Directory