性能魔方系统文档

功能说明

本服务的主要功能为：用户使用网络加速服务时，可以通过调用API查看请求状态，查看加速任务下的所有请求，清除/预推缓存。

API使用说明

本服务提供了Web API接口，开发者可以使用自己熟悉的语言，在Web应用或者客户端程序中方便的调用。下面具体介绍下服务的调用方法及样例：

申请API Token

登陆 http://www.mmtrix.com 并注册账号，在“个人中心”的“接口管理”中生成服务accesskey和securekey。

api使用方法

查看请求状态

http请求路径

http://api.mmtrix.com/proxytask/querystatus

http请求方法

GET

参数名 含义
host 需要查看的cdn域名
request 刷新缓存对应的request_id
type 任务类型，此处传1
ak 申请到的accesskey
sign accesskey,host,request,securekey,type参数按字母顺序连接后的md5值
http返回内容

请求返回内容为JSON，未通过身份认证和频率控制的返回格式如下:

{
    "code": 0,                  //返回状态码
    "msg": ""                   //返回错误消息
}
状态码对应表
状态码 含义
1 参数错误
2 身份认证失败
99999 API调用次数超过限额

正确返回格式如下:

{
    "status": "",                //返回状态
    "url": "",                   //url或目录
    "op":""                      //操作类型，0表示刷新，1代表预推   
}
样例

curl版本

http请求

#!/bin/bash
URL="http://api.mmtrix.com/proxytask/querystatus"
AK="fe8dc959e7f9fa5de6dab87bb9b7d8ca"
HOST="www.mmtrix.com"
SK="e5828c564f71fea3a12dde8bd5d27063"
REQUEST=99
TYPE=1
MD5=`echo -n "ak=${AK}&host=${HOST}&request=${REQUEST}&sk=${SK}&type=${TYPE}"|md5sum|awk '{print $1}'` 
curl "${URL}?host=${HOST}&request=${REQUEST}&type=${TYPE}&ak=${AK}&sign=${MD5}"
exit $?

http返回

{
       "status": "done/error/configuring/pending/unknown/undefinition",                  
       "url": "",  
       "op":""          
}

查看任务下的所有请求

http请求路径

http://api.mmtrix.com/proxytask/queryall

http请求方法

GET

参数名 含义
host 需要查看的cdn域名
type 任务类型，此处传1
ak 申请到的accesskey
sign accesskey,host,type与securekey参数按字母顺序连接后的md5值
http返回内容

请求返回内容为JSON，未通过身份认证和频率控制的返回格式如下:

{
    "code": 0,                  //返回状态码
    "msg": ""                   //返回错误消息
}
状态码对应表
状态码 含义
1 参数错误
2 身份认证失败
99999 API调用次数超过限额

正确返回格式如下:

{
    "statusall": [
                      {
                        "request_id":"",
                        "status":"",
                        "url":"",     //url或目录
                        "op":""       //操作类型，0表示刷新，1表示预推
                      },
                      ...
                 ]
}
样例

curl版本

http请求

#!/bin/bash
URL="http://api.mmtrix.com/proxytask/queryall"
AK="fe8dc959e7f9fa5de6dab87bb9b7d8ca"
SK="e5828c564f71fea3a12dde8bd5d27063"
HOST="www.mmtrix.com"
TYPE=1
MD5=`echo -n "ak=${AK}&host=${HOST}&sk=${SK}&type=${TYPE}"|md5sum|awk '{print $1}'` 
curl "${URL}?ak=${AK}&host=${HOST}&sign=${MD5}&type=${TYPE}" 
exit $?

http返回

{
        "statusall": [
                      {
                        "request_id":"",
                        "status":"",
                        "url": "",
                        "op" : ""
                      },
                      ...
                 ]
}

清除/预推缓存

http请求路径

http://api.mmtrix.com/proxytask/purge

http请求方法

POST

参数名 含义
host 任务域名
purge_url 需要刷新的url
purge_dir 需要刷新的目录
op 0表示清除，1表示预推
ak 申请到的accesskey
sign accesskey,host,op,purge_url,purge_dir,securekey参数按字母数序连接后的md5值
http返回内容

请求返回内容为JSON，未通过身份认证和频率控制的返回格式如下:

{
    "code": 0,                  //返回状态码
    "msg": ""                   //返回错误消息
}
状态码对应表
状态码 含义
1 参数错误
2 身份认证失败
99999 API调用次数超过限额

正确返回格式如下:

{
    "requestid": "",返回的requestid或者error
}
样例

单条url清除缓存

http请求

#!/bin/bash
URL="http://api.mmtrix.com/proxytask/purge"
AK="fe8dc959e7f9fa5de6dab87bb9b7d8ca"
SK="e5828c564f71fea3a12dde8bd5d27063"
HOST="www.mmtrix.com"
PURGEURL="http://www.mmtrix.com"
PURGEDIR="a"
OP=0
MD5=`echo -n "ak=${AK}&host=${HOST}&op=${OP}&purge_dir=${PURGEDIR}&purge_url=${PURGEURL}&sk=${SK}"|md5sum|awk '{print $1}'`
curl -X POST -L "${URL}?ak=${AK}&host=${HOST}&op=${OP}&purge_dir=${PURGEDIR}&purge_url=${PURGEURL}&sign=${MD5}"
exit $?

http返回

{
       "requestid": "119"
}

多条url清除缓存

http请求

#!/bin/bash
URL="http://api.mmtrix.com/proxytask/purge"
AK="fe8dc959e7f9fa5de6dab87bb9b7d8ca"
SK="e5828c564f71fea3a12dde8bd5d27063"
HOST="www.mmtrix.com"
PURGEURL1="http://www.mmtrix.com"
PURGEURL2="http://www.mmtrix.com"
PURGEDIR="a"
OP=0
MD5=`echo -n "ak=${AK}&host=${HOST}&op=${OP}&purge_dir=${PURGEDIR}&purge_url=${PURGEURL1} ${PURGEURL2}&sk=${SK}"|md5sum|awk '{print $1}'`
curl -X POST -L "${URL}?ak=${AK}&host=${HOST}&op=${OP}&purge_dir=${PURGEDIR}&purge_url=${PURGEURL1}+${PURGEURL2}&sign=${MD5}"
exit $?

http返回

{
       "requestid": "119"
}