接口描述
本接口(FlushCache) 更新或删除缓存文件。
请求域名:dsa.api.qcloud.com
可支持配置
• 刷新 URL
• 刷新目录
说明:该接口调用频次上限为100次/分钟,超出上限则会返回错误,请勿高频调用
输入参数
以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,详情请参见 公共请求参数 。
其中,此接口的 Action 字段为 FlushCache。
参数名称 | 是否必选 | 类型 | 描述 |
---|---|---|---|
urlList | 是 | String | 刷新 URL /目录列表(JSON)。 例如 ["http://www.abc.com/","https://www.mmm.com/"] |
flushType | 是 | Int | 刷新类型。 0:URL 刷新 1:目录刷新变更资源,会比对节点内容与源站内容的 Last-Modify,若未变化,则不会进行资源刷新 2:目录刷新所有资源,会直接删除目录下所有资源,此操作会导致源站压力增大,请谨慎操作 |
注意:请采用 POST 方式提交,防止出现 URL 长度越界问题。
输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 公共错误码,0表示成功,其他值表示失败。 详见错误码页面 公共错误码 |
message | String | 模块错误信息描述,与接口相关。 |
codeDesc | String | 英文错误信息,或业务侧错误码。 详见错误码页面 业务错误码 |
data | Array | 返回结果数据,详情见下方 Data 详细说明 |
Data 详细说明
参数名称 | 类型 | 描述 |
---|---|---|
count | Int | 此次刷新提交的 URL /目录数目 |
task_id | String | 此次刷新任务对应的 ID |
调用示例
GET 请求
由于 URL 长度限制,请不要采用 Get 方式提交请求。
POST 请求
POST 请求时,参数填充在 HTTP Request-body 中,请求地址:
https://dsa.api.qcloud.com/v2/index.php
参数支持 form-data、x-www-form-urlencoded 等格式,参数数组如下:
array (
'Action' => ' FlushCache ',
'SecretId' => 'SecretId',
'Timestamp' => 1462782282,
'Nonce' => 123456789,
'Signature' => 'Signature',
' urlList ' => ' ["http://www.abc.com/", "https://www.mmm.com/"]',
' flushType ' => 1
)
结果示例
{
"code": 0,
"message": "",
"codeDesc": "Success",
"data": {
"count": 2,
" task_id ": “xxxxxxxxxxxxxxx”
}
}