EditIgnoreProtocol
Update time: 2026-08-14 11:20:30
Applicable Products
Media Acceleration VoD,Media Acceleration Live Broadcast,Content Acceleration,Dynamic Web Acceleration
API Description
Modify ignore protocol cache and push configuration.
- API URL: https://api.atomile.com/api/config/ignoreprotocol/*
- 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 |
|---|---|
*ignore-protocol-rulesList | Ignore protocol caching and push configuration, parent tags
1. This must be filled when protocol cache and push configuration need to be ignored
2. |
*path-patternString | Url matching pattern, support regular, if all matches, input parameters can be configured as:.* |
except-path-patternString | The exception url matches the pattern in the same format as the path-pattern |
cache-ignore-protocolString | Whether to ignore the protocol cache, with allowable values of true and false. True turns on the HTTP/HTTPS Shared cache. Not on by default. |
purge-ignore-protocolString | It is recommended to use with cache-ignore protocol to avoid push failure.
Note:
1. Once configured, the global effect is not applied to the matched path-pattern.
2. Directory push does not distinguish protocols, while url push can distinguish protocols |
data-idLong | When configuring multiple groups of configurations, specify the id of a particular group of configurations |
Response parameter(s)
Body Params
| Name | Description |
|---|---|
httpStatusInteger | httpstatus=202; Indicates that the new domain API was successfully invoked, and the current deployment of the new domain can be viewed using x-cnc-request-id in the header |
x-cnc-request-idString | Uniquely identified id for querying tasks per request (for all API) |
locationString | The URL used to access the domain information, where domain-id is the unique token generated by our cloud platform for the domain name and whose value is a string. |
codeString | Error code, which appears when HTTPStatus is not 202, represents the error type of the current request call |
messageString | Response information, success when 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. | 400 | example: 1. No domain was specified.2.The {0} is invalid. |
Example
JSON
- Request example 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/ignoreprotocol/123344" \ -X "PUT" \ -u "$username:$password" \ -H "Date: $date" \ -H "Accept: application/json" \ -H "Content-Type:application/json" \ -d ' { "ignore-protocol-rules":[ { "path-pattern":".*", "except-path-pattern":"", "cache-ignore-protocol":"true", "purge-ignore-protocol":"true" } ] }'- Response example Copy 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","code":""}