文档中心 API文档 预取剩余量查询

预取剩余量查询

更新时间:2022-07-28 17:01:52

适用产品

内容管理

接口描述

预取剩余量查询

推荐使用 Open API在线调试

Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试

请求参数

Params 参数

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

返回参数

Body 参数

参数名称描述
supplierString
数据提供方
codeInteger
查询结果,0表示成功,1表示失败
messageString
查询的响应消息
maxRuningFetchInteger
同时最多有多少条url回源预取
fetchCountInteger
当天已经回源预取了多少条url
fetchUpperInteger
当天文件预取任务允许提交的最大数量
fetchRemainInteger
当天文件预取剩余url的数量
fetchSizeUpperInteger
当天允许预取的文件大小,单位MB
fetchSizeRemainInteger
当天剩余可预取的文件大小,单位MB

错误码

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

示例

XML
JSON
XML
请求示例
复制代码 复制成功
#!/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=fetch" \
-X "GET" \
-u "$username:$password" \
-H "Date:$date" \
-H "Content-Type: application/xml"
返回示例
复制代码 复制成功
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}
<?xml version="1.0" encoding="utf-8"?>
<quota-query>
 <supplier>${providercode}</supplier>
    <code>0</code>
    <message>success</message>
    <max-runing-fetch>10</max-runing-fetch>
    <fetch-count>1500</fetch-count>
    <fetch-upper>3000</fetch-upper>
    <fetch-remain>2900</fetch-remain>
    <fetch-size-upper>500000000</fetch-size-upper>
    <fetch-size-remain>5000</fetch-size-remain>
</quota-query>
本篇文档内容对您是否有帮助?
有帮助
我要反馈
提交成功!非常感谢您的反馈,我们会继续努力做到更好!