缓存管理接口

刷新缓存

本接口用于清除已经缓存的文件,支持批量提交,一次最多提交100个url,用户24小时之内最多提交20000个URL刷新请求或者200个目录刷新请求。

Method Path 说明
POST /v2/cache/purge 提交purge任务

请求体(Request Body)

参数 可选 类型 说明
tasks 必选 list类型,PurgeTask内容项解释如下:
- url:必选项,String类型,表示需要purge的URL,如果type为directory,必须以/结尾。
- type:可选项,String类型,可选值为file/directory,默认为file。
提交的purge任务列表详情

响应码 (Http Status Code)

HTTP Status Code 说明
201 成功

响应体 (Response Body)

参数 类型 说明
id String 本次Purge任务的Id,可用于查询任务状态

请求示例

POST /v2/cache/purge HTTP/1.1
Host: cdn.baidubce.com
Content-Length: 145
Content-Type: text/json;utf-8

{
    "tasks":
    [
        {
            "url":"http://my.domain.com/path/to/purge/1.data"
        },
        {
            "url":"http://my.domain.com/path/to/purege/dir/",
            "type":"directory"
        }
    ]
}

响应示例

HTTP/1.1 201 Created
Content-Length: 91
Content-Type: application/json;utf-8
x-bce-request-id: 81d0b05f-5ad4-1f22-8068-d5c9de60a1d7
Server: BCE-CDN
{
    "id": "5fea77560ea4451aa703a558b933e274"
}

查询刷新状态

Method Path Action
GET /v2/cache/purge 查询purge任务

URL参数:

参数 类型 可选 说明
id String 查询指定purge task id
endTime Timestamp 查询的时间范围结束值,默认为当前时间。
startTime Timestamp 查询的时间范围起始值,默认为endTime前推24小时。endTime与startTime最大时间跨度90天
url String 查询指定url的purge请求,支持通配符*
marker String 用户上次调用本接口返回的nextMarker值,作为本次查询的起点

响应体 (Response Body)

参数 类型 说明
details list类型,PurgeStatus内容项详细解释如下:
- status:String类型,取值为in-progress / completed / failed
- task:PurgeTask类型,表示task信息。
- createdAt:Timestamp类型,表示purge任务的创建时间。
- startedAt:Timestamp类型,表示purge任务开始执行的时间。
- finishedAt:Timestamp类型,表示purge任务的结束时间,结束可能是Completed/Failed。如果任务未结束,则不返回该项。
- progress:Int类型,表示进度百分比。
提交的purge任务详情
isTruncated Bool true表示后面还有数据,false表示已经是最后一页。
nextMarker String 当isTruncated为false时,该域不出现。用户通过在下次调用本接口时指定该marker标记来获取后续的列表。

请求示例

GET /v2/cache/purge?id=5fea77560ea4451aa703a558b933e274 HTTP/1.1
Host: cdn.baidubce.com

响应示例

HTTP/1.1 200 OK
Content-Length: 190
Content-Type: application/json;utf-8
x-bce-request-id: 81d0b05f-5ad4-1f22-8068-d5c9de60a1d7
Server: BCE-CDN
{
    "details": 
    [
        {
            "status": "completed",
            "createdAt": "2015-08-24T12:20:32Z",
            "finishedAt": "2015-08-24T12:21:45Z",
            "progress": 100,
            "task":
            {
                "url": "http://my.domain.com/path/to/purge/1.data"
            }
        }
        {
            "status": "in-process",
            "createdAt": "2015-08-24T12:20:32Z",
            "finishedAt": "2015-08-24T12:21:49Z",
            "progress": 87,
            "task":
            {
                "url": "http://my.domain.com/path/to/purge/dir",
                "type": "directory"
            }
        }
    ]
}

预加载缓存

本接口用于通知CDN提前缓存指定的URL,支持批量提交,一次最多提交100个url,用户24小时之内最多提交20000个URL。

Method Path 说明
POST /v2/cache/prefetch 提交prefetch任务

请求体(Request Body)

参数 可选 类型 说明
tasks 必选 list类型,PrefetchTask内容项解释如下:
- url:必选项,String类型,表示需要prefetch的URL。
- speed:可选项,Int类型,表示prefetch的限速,单位为byte/s,默认为0(不限制)。
- startTime:可选项,Timestamp类型,startTime必须是大于当前时间,并且在24小时内的时间,否则失败。格式为:2016-04-16Z23:00:00T, 默认为立即执行。
提交的prefetch任务列表详情

响应码 (Http Status Code)

HTTP Status Code 说明
201 成功

响应体 (Response Body)

参数 类型 说明
id String 本次Prefetch任务的Id,可用于查询任务状态

请求示例

POST /v2/cache/prefetch HTTP/1.1
Host: cdn.baidubce.com
Content-Length: 145
Content-Type: text/json;utf-8

{
    "tasks":
    [
        {
            "url":"http://my.domain.com/path/to/prefetch/1.data"
        },
        {
            "url":"http://my.domain.com/path/to/prefetch/2.data"
        }
    ]
}

响应示例

HTTP/1.1 201 Created
Content-Length: 91
Content-Type: application/json;utf-8
x-bce-request-id: 81d0b05f-5ad4-1f22-8068-d5c9de60a1d7
Server: BCE-CDN
{
    "id": "419d6f1e9acb0442341e9b8e1e7fbf9f"
}

查询预加载状态

查询指定条件的预加载任务状态,每次请求最多返回1000条记录。

Method Path Action
GET /v2/cache/prefetch 查询prefetch任务

URL参数:

参数 类型 可选 说明
id String 查询指定的prefetch task id
endTime Timestamp 查询的时间范围结束值,默认为当前时间。
startTime Timestamp 查询的时间范围起始值,默认为endTime前推24小时。endTime与startTime最大时间跨度90天
url String 查询指定url的prefetch请求,支持通配符*
marker String 用户上次调用本接口返回的nextMarker值,作为本次查询的起点

响应体 (Response Body)

参数 类型 说明
details list类型,PrefetchStatus内容项解释如下:
- status: String类型,取值为waiting/in-progress / completed / failed。
- task:PrefetchTask类型,表示task信息。
- createdAt:Timestamp类型,表示prefetch任务的创建时间。
- startedAt:Timestamp类型,表示prefetch任务开始执行的时间。
- finshedAt:Timestamp类型,表示prefetch任务的结束时间,结束可能是Completed/Failed。如果任务未结束,则不返回该项。
- progress:Int类型,表示进度百分比。
提交的prefetch任务详情
isTruncated Bool true表示后面还有数据,false表示已经是最后一页。
nextMarker String 当isTruncated为false时,该域不出现。用户通过在下次调用本接口时指定该marker标记来获取后续的列表。

请求示例

GET /v2/cache/prefetch?id=419d6f1e9acb0442341e9b8e1e7fbf9f HTTP/1.1
Host: cdn.baidubce.com

响应示例

HTTP/1.1 200 OK
Content-Length: 190
Content-Type: application/json;utf-8
x-bce-request-id: 81d0b05f-5ad4-1f22-8068-d5c9de60a1d7
Server: BCE-CDN
{
    "details": 
    [
        {
            "status": "completed",
            "createdAt": "2015-08-24T12:20:32Z",
            "startedAt": "2015-08-24T12:20:32Z",
            "finishedAt": "2015-08-24T12:21:45Z",
            "progress": 100,
            "task":
            {
                "url": "http://my.domain.com/path/to/prefetch/1.data"
            }
        }
        {
            "status": "in-process",
            "createdAt": "2015-08-24T12:20:32Z",
            "startedAt": "2015-08-24T12:20:32Z",
            "finishedAt": "2015-08-24T12:21:49Z",
            "progress": 87,
            "task":
            {
                "url": "http://my.domain.com/path/to/prefetch/2.data"
            }
        }
    ]
}

查询限额

本接口用于查询用户当前的限额(Quota)值。

Method Path 说明
GET /v2/cache/quota 查询quota限额值

响应码 (Http Status Code)

HTTP Status Code 说明
200 成功

响应体 (Response Body)

参数 类型 说明
dirRemain int 当日刷新目录限额余量
urlRemain int 当日刷新(含预热)URL限额余量
dirQuota int 刷新目录限额总量
urlQuota int 刷新(含预热)URL限额总量

请求示例

GET /v2/cache/quota HTTP/1.1
Host: cdn.baidubce.com

响应示例

HTTP/1.1 200
Content-Length: 190
Content-Type: application/json;utf-8
x-bce-request-id: 81d0b05f-5ad4-1f22-8068-d5c9de60a1d7
Server: BCE-CDN
{
    "dirRemain":200,
    "urlRemain":2000,
    "dirQuota":200,
    "urlQuota":20000
}