德胜云开发者文档刷新预热
URL 刷新与内容预热相关接口与额度说明。
说明
鉴权
参考 签名&鉴权
接口响应
参考 接口说明
QPS
单用户调用频率限制：20 次/秒。
API
额度
查询额度
PATH: /refreshpreload/quota/v1/quota
Method: GET
参数：无
返回：
{
"data": {
"dayRefreshUrlQuota": 100,
"dayRefreshDirQuota": 100,
"dayPreloadQuota": 100,
"dayRefreshUrlSurplus": 100,
"dayRefreshDirSurplus": 100,
"dayPreloadSurplus": 100
},
"reqId": "1234567890"
}| 字段 | 类型 | 含义 |
|---|---|---|
| dayRefreshUrlQuota | number | 每日刷新 URL 限额 |
| dayRefreshDirQuota | number | 每日刷新目录限额 |
| dayPreloadQuota | number | 每日预热 URL 限额 |
| dayRefreshUrlSurplus | number | 每天的刷新 URL 次数余额 |
| dayRefreshDirSurplus | number | 每天的目录刷新次数余额 |
| dayPreloadSurplus | number | 每天的预取次数余额 |
刷新&预热
刷新
PATH: /refreshpreload/refresh/v1/create
Method: POST
参数：
{
"urls": ["http://example.com"]
}或者目录刷新：
{
"dirs": ["http://example.com/"]
}参数说明：
| 字段 | 类型 | 含义 |
|---|---|---|
| urls | array | URL 列表，每次最多提交 500 条 |
| dirs | array | 目录列表，每次最多提交 30 条 |
每条 URL 要以 http:// 或 https:// 开头，目录刷新要以 / 结尾。
返回：
{
"data": {
"taskId": "1234567890"
},
"reqId": "1234567890"
}| 字段 | 类型 | 含义 |
|---|---|---|
| taskId | string | 任务 ID，用于后续查询任务状态 |
预热
PATH: /refreshpreload/preload/v1/create
Method: POST
参数：
{"urls": ["http://example.com"]}参数说明：
| 字段 | 类型 | 含义 |
|---|---|---|
| urls | array | URL 列表，每次最多提交 30 条 |
返回：
{"data": {"taskId": "1234567890"},"reqId": "1234567890"}| 字段 | 类型 | 含义 |
|---|---|---|
| taskId | string | 任务 ID，用于后续查询任务状态 |
查询任务状态
PATH: /refreshpreload/search/v1/tasks
Method: GET
参数：
{"type": "file","page": 1,"size": 100,"taskId": "1234567890"}参数说明：
| 字段 | 类型 | 是否必传 | 含义 |
|---|---|---|---|
| page | number | 是 | 页码，从 1 开始 |
| size | number | 是 | 每页大小，最大 100 |
| type | string | 是 | 任务类型，值：file、dir、preload |
| taskId | string | 否 | 任务 ID |
返回：
{
"data": {
"tasks": [
{
"taskId": "1234567890",
"type": "file",
"status": "processing",
"resource": "http://example.com",
"process": "0%",
"domain": "example.com",
"createTime": 1633072800,
"updateTime": 1633072800
}
],
"total": 1
},
"reqId": "1234567890"
}| 字段 | 类型 | 含义 |
|---|---|---|
| tasks | array | task 列表，参见 task 字段说明 |
| total | number | 总数 |
task 字段说明：
| 字段 | 类型 | 含义 |
|---|---|---|
| taskId | string | 任务 ID |
| type | string | 任务类型，可能的值：file、dir、preload |
| status | string | 任务状态，可能的值：processing、completed、failed |
| resource | string | 任务资源，提交的刷新或者预热的 URL |
| process | string | 任务进度，0% ~ 100% |
| domain | string | 任务域名 |
| createTime | number | 创建时间，unix 时间戳，精确到秒 |
| updateTime | number | 更新时间，unix 时间戳，精确到秒 |