CDN加速

文档中心 API文档 内容管理 推送剩余量查询

推送剩余量查询

更新时间:2021-06-03 10:12:12
适用产品:通用功能

接口描述

推送剩余量查询

请求参数

参数名称类型必填描述
typestring用于指定查询哪种业务类型的每日资源上限,可选值有: purge:表示查询每日刷新缓存的数量限制 fetch:表示查询每日预取文件的数量、大小限制

返回参数

参数名称类型描述
x-cnc-request-idString本次请求的唯一标识,当接口调用异常时,可将requestID提供给技术支持人员,便于排查接口的访问日志。
supplierString数据提供方
codeInt查询结果,0表示成功,1表示失败
messageString查询的响应消息
urlUpperInt当天url刷新任务允许提交的最大数量
dirUpperInt当天目录刷新任务允许提交的最大数量
urlRemainInt当天url刷新任务允许提交的剩余数量
dirRemainInt当天目录刷新任务允许提交的剩余数量
maxRuningFetchInt同时最多有多少条url回源预取
fetchCountInt当天已经回源预取了多少条url
fetchUpperInt当天文件预取任务允许提交的最大数量
fetchRemainInt当天文件预取剩余url的数量
fetchSizeUpperInt当天允许预取的文件大小,单位MB
fetchSizeRemainInt当天剩余可预取的文件大小,单位MB

错误码

错误代码(code)描述(message)HTTP状态码语义
0success200查询成功
1username is error200用户名为空、用户未启用或用户配置不存在
1query type is required200您输入参数缺少查询类型,即缺少type入参
1query type is error200您要查询的类型不属于purge、fetch其中之一
1system error200系统错误

示例

示例说明
请求示例
复制
#!/bin/bash
username="{username}"
apiKey="{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://open.chinanetcenter.com/ccm/upperQuery?type=purge" \
-X "GET" \
-u "$username:$password" \
-H "Date:$date" \
-H "Content-Type: application/json"
返回示例
复制
HTTP/1.1 200 OK
Date: Fri, 26 Oct 2012 06:33:26 GMT
Content-Type: application/json;charset=UTF-8
x-cnc-request-id:{id string auto generated by cloud server}
{
 "supplier":"${providercode}",
    "code": 0,
    "message": "success",
    "urlUpper": 3000,
    "urlRemain": 2900,
    "dirUpper": 500,
    "dirRemain": 500
}