CDN公开API目录

• API概览
  • 域名管理
  • 证书管理
  • 刷新预取
  • 用量统计
• 认证方式.md#认证方式)
  • 1.公共请求参数.md#1公共请求参数)
  • 2.签名机制.md#2签名机制)
    • 步骤一：构造规范化请求字符串.md#步骤一构造规范化请求字符串)
    • 步骤二：构造签名字符串.md#步骤二构造签名字符串)
  • 3.获取签名代码.md#2获取签名代码)
• 访问地址
• 域名管理
  • CreateCdn
  • DescribeCdn
  • DescribeCdnInfo
  • ModifyCdn
  • EnableCdn
  • DisableCdn
  • DeleteCdn
  • ModifyProtocol
• 证书管理
  • CreateSsl
  • ModifySsl
  • DescribeSsl
  • DescribeSslInfo
• 刷新预取
  • PrefetchFile
  • ContentRefresh
• 用量统计
  • FlowStatistics
  • DosageAnalysis
  • PathMetering
• 错误码

API概览

CDN产品提供以下相关API接口。

域名管理

证书管理

刷新预取

用量统计

访问地址

域名管理

CreateCdn

Action： CreateCdn

描述： 创建新的加速域名

请求地址： api.capitalonline.net/cdnapi/distribution

请求方法： POST

请求参数：

请求示例：

def create_cdn():
    """
    创建加速域名
    """
    cdn_url = "https://api.capitalonline.net/cdnapi/distribution"
    action = "CreateCdn"
    method = "POST"
    param = {}
    body = {
        "domainname": "openapitest.cdscdntest.com",
        "typeid": "web",
        "regionid": [
            "CN"
        ],
        "protocolid": "http",
        "origin": {
            "originurl": "1.1.1.1",
            "mastersource": "",
            "slavesource": "",
            "originprotocol": "HTTP",
            "originrewrite": "baidu.com",
            "originheader": [
                {
                    "key": "ss",
                    "value": "ss"
                }
            ],
            "originport": "80"
        },
        "cacheconfig": [
            {
                "isnevercache": 1,
                "pathpattern": "/.*\.(html|htm|js|css|txt|shtml|xml)",
                "cachetime": "3600",
                "cachecontrol": 0
            }
        ],
        "filepartstore": False
    }
    url = get_signature(action, AK, AccessKeySecret, method, cdn_url, param)
    resp = requests.post(url, json=body)
    result = json.loads(resp.content)
    result = json.dumps(result)  # json格式化
    print(result)

返回示例：

{
    "code": 200,
    "msg": "成功",
    "data": {
        "formid": 23829,
        "speedid": 3174
    }
}

返回参数说明：

DescribeCdn

Action： DescribeCdn

描述： 获取加速域名列表

请求地址： api.capitalonline.net/cdnapi/distribution

请求方法： GET

请求参数：

请求示例：

def get_cdn_list():
    """
    获取加速域名列表
    """
    cdn_url = "https://api.capitalonline.net/cdnapi/distribution"
    action = "DescribeCdn"
    method = "GET"
    param = {
        "pageindex": "1",
        "pagesize": "10",
        "keyword": "openapitest.cdscdntest.com"
    }
    url = get_signature(action, AK, AccessKeySecret, method, cdn_url, param)
    resp = requests.get(url)
    result = json.loads(resp.content)
    result = json.dumps(result)  # json格式化
    print(result)

返回示例：

{
    "code": 200,
    "msg": "成功",
    "data": {
        "rows": [
            {
                "id": 3174,
                "domainname": "openapitest.cdscdntest.com",
                "statusid": "01",
                "statusname": "启用",
                "typeid": "web",
                "typename": "网页加速",
                "confstatusid": "01",
                "confstatusname": "正在配置",
                "confstatusmsg": "",
                "createtime": "2021-09-26T00:07:57.000Z",
                "updatetime": "2021-09-26T00:08:17.000Z",
                "bizstatusid": "01",
                "bizstatusname": "正常",
                "userid": "13900000800",
                "username": "",
                "customerid": "E020514",
                "moduleid": "CDN",
                "modulename": "CDN",
                "modulecode": "125ee8ab74db11e68a93005056a4567b",
                "protocolid": "http",
                "protocolname": "HTTP",
                "regionname": "中国大陆:883760832745e0a806970c2bcbe2b898.cdscdntest.com"
            }
        ],
        "totalcount": 1,
        "pagesize": "10",
        "pageindex": 0
    }
}

返回参数说明：

DescribeCdnInfo

Action： DescribeCdnInfo

描述： 获取加速域名的详细信息

请求地址：api.capitalonline.net/cdnapi/distribution/:domainname

请求方法： GET

请求参数：

无

请求示例：

def get_cdn_info(domain_name):
    """
    获取加速域名的详细信息
    :param domain_name: 加速域名
    """
    cdn_url = "https://api.capitalonline.net/cdnapi/distribution/" + domain_name
    action = "DescribeCdnInfo"
    method = "GET"
    param = {}
    url = get_signature(action, AK, AccessKeySecret, method, cdn_url, param)
    resp = requests.get(url)
    result = json.loads(resp.content)
    result = json.dumps(result)
    print(result)

返回示例：

{
    "code": 200,
    "msg": "成功",
    "data": {
        "id": 82431,
        "moduleid": "CDN",
        "domainname": "openapitest.cdscdntest.com",
        "fullcname": "中国大陆:e31c3f808ebb311766ba4a9e981fbfbc.cdscdscdn.com",
        "statusid": "01",
        "protocolid": "http",
        "typeid": "web",
        "sslid": 0,
        "confstatusid": "02",
        "confstatusmsg": "",
        "bizstatusid": "01",
        "bizstatusmsg": "",
        "testurl": "",
        "ifdel": 0,
        "createtime": "2021-09-28T03:34:13.000Z",
        "updatetime": "2021-09-28T03:40:01.000Z",
        "testcodes": "",
        "filepartstore": 0,
        "remark": "",
        "regionid": [
            "CN"
        ],
        "origin": {
            "originprotocol": "HTTP",
            "originrewrite": "baidu.com",
            "originheader": "[{\"key\":\"ss\",\"value\":\"ss\"}]",
            "originport": "80",
            "originporthttps": "",
            "mastersource": "",
            "slaversource": "",
            "originurl": "1.1.1.1"
        },
        "cacheconfig": [
            {
                "id": 137547,
                "pathpattern": "/.*\\.(html|htm|js|css|txt|shtml|xml)",
                "isnevercache": 1,
                "cachecontrol": 0,
                "cachetime": 3600
            }
        ],
        "ipacl": [
            {
                "ipperiodtypeid": "Allow",
                "iplist": "1.1.1.1",
                "period": []
            }
        ],
        "useragent": [
            {
                "id": 8352,
                "pathpattern": "/.*",
                "useragent": "IE",
                "retstatus": "deny",
                "jumplocation": ""
            }
        ],
        "querystringsettings": [
            {
                "id": 37764,
                "pathpattern": "/.*",
                "isignorequerystring": 1
            }
        ],
        "resheader": [
            {
                "id": 8496,
                "key": "header1",
                "value": "value1"
            }
        ],
        "refereracl": [
            {
                "id": 5562,
                "isopen": 1,
                "isallownullreferer": 1,
                "whitelist": "1.1.1.1",
                "blacklist": "",
                "pathpattern": "/.*"
            }
        ]
    }
}

返回参数说明：

ModifyCdn

Action： ModifyCdn

描述： 修改加速域名

请求地址：api.capitalonline.net/cdnapi/distribution/:domainname

请求方法： PUT

请求参数：

请求示例：

def modify_cdn(domain_name):
    """
    修改加速域名
    :param domain_name: 加速域名
    """
    cdn_url = "https://api.capitalonline.net/cdnapi/distribution/" + domain_name
    action = "ModifyCdn"
    method = "PUT"
    param = {}
    body = {
        "domainname": "openapitest.cdscdntest.com",
        "typeid": "web",
        "regionid": [
            "CN"
        ],
        "protocolid": "http",
        "origin": {
            "originurl": "1.1.1.1",
            "mastersource": "",
            "slaversource": "",
            "originprotocol": "HTTP",
            "originrewrite": "baidu.com",
            "originheader": [
                {
                    "key": "ss",
                    "value": "ss"
                },
                {
                    "key": "key",
                    "value": "value"
                }
            ],
            "originport": "80",
            "originporthttps": ""
        },
        "cacheconfig": [
            {
                "pathpattern": "/.*\.(html|htm|js|css|txt|shtml|xml)",
                "isnevercache": 1,
                "cachecontrol": 0,
                "cachetime": 3600
            },
            {
                "pathpattern": "/.*",
                "isnevercache": 1,
                "cachecontrol": 1,
                "cachetime": 100
            }
        ],
        "filepartstore": 1,
        "ipacl": [
            {
                "ipperiodtypeid": "Allow",
                "iplist": "1.1.1.1",
                "period": [
                    {
                        "ipstart": "1.1.1.1",
                        "ipend": "2.2.2.2"
                    }
                ]
            }
        ],
        "useragent": [
            {
                "pathpattern": "/.*",
                "useragent": "IE",
                "retstatus": "deny",
                "jumplocation": ""
            },
            {
                "pathpattern": "/.*",
                "useragent": "Google",
                "retstatus": "allow",
                "jumplocation": "http://www.baidu.com"
            }
        ],
        "querystringsettings": [
            {
                "pathpattern": "/.*",
                "isignorequerystring": 1
            }
        ],
        "resheader": [
            {
                "key": "header1",
                "value": "value1"
            },
            {
                "key": "key",
                "value": "value"
            }
        ],
        "refereracl": [
            {
                "isopen": 1,
                "isallownullreferer": 1,
                "whitelist": "1.1.1.1",
                "blacklist": "",
                "pathpattern": "/.*"
            },
            {
                "isopen": 1,
                "isallownullreferer": 1,
                "whitelist": "2.2.2.2",
                "blacklist": "",
                "pathpattern": "/.*"
            }
        ]
    }
    url = get_signature(action, AK, AccessKeySecret, method, cdn_url, param)
    resp = requests.put(url, json=body)
    result = json.loads(resp.content)
    result = json.dumps(result)
    print(result)

返回示例：

{
    "code": 200,
    "msg": "成功",
    "data": {
        "formid": 534564
    }
}

返回参数说明：

EnableCdn

Action： EnableCdn

描述： 启用加速域名

请求地址：api.capitalonline.net/cdnapi/distribution/:domainname/enable

请求方法： PUT

请求参数：

无

请求示例：

def enable_cdn(domain_name):
    """
    启用加速域名
    :param domain_name: 加速域名
    """
    cdn_url = "https://api.capitalonline.net/cdnapi/distribution/" + domain_name + "/enable"
    action = "EnableCdn"
    method = "PUT"
    param = {}
    url = get_signature(action, AK, AccessKeySecret, method, cdn_url, param)
    resp = requests.put(url)
    result = json.loads(resp.content)
    result = json.dumps(result)
    print(result)

返回示例：

{
    "code": 200,
    "msg": "成功",
    "data": {
        "formid": 534591
    }
}

返回参数说明：

DisableCdn

Action： DisableCdn

描述： 禁用加速域名

请求地址： api.capitalonline.net/cdnapi/distribution/:domainname/disable

请求方法： PUT

请求参数：

无

请求示例：

def disable_cdn(domain_name):
    """
    禁用加速域名
    :param domain_name: 加速域名
    """
    cdn_url = "https://api.capitalonline.net/cdnapi/distribution/" + domain_name + "/disable"
    action = "DisableCdn"
    method = "PUT"
    param = {}
    url = get_signature(action, AK, AccessKeySecret, method, cdn_url, param)
    resp = requests.put(url)
    result = json.loads(resp.content)
    result = json.dumps(result)
    print(result)

返回示例：

{
    "code": 200,
    "msg": "成功",
    "data": {
        "formid": 534600
    }
}

返回参数说明：

DeleteCdn

Action： DeleteCdn

描述： 删除加速域名

请求地址：api.capitalonline.net/cdnapi/distribution/:domainname

请求方法： DELETE

请求参数：

无

请求示例：

def delete_cdn(domain_name):
    """
    删除加速域名
    :param domain_name: 加速域名
    """
    cdn_url = "https://api.capitalonline.net/cdnapi/distribution/" + domain_name
    action = "DeleteCdn"
    method = "DELETE"
    param = {}
    url = get_signature(action, AK, AccessKeySecret, method, cdn_url, param)
    resp = requests.delete(url)
    result = json.loads(resp.content)
    result = json.dumps(result)
    print(result)

返回示例：

{
    "code": 200,
    "msg": "成功",
    "data": {
        "formid": 534645
    }
}

返回参数说明：

ModifyProtocol

Action： ModifyProtocol

描述： 修改加速域名的协议为https协议

请求地址：api.capitalonline.net/cdnapi/distribution/https/:domainname/:sslid

请求方法： PUT

请求参数：

无

请求示例：

def modify_protocol(domain_name, ssl_id):
    """
    修改加速域名的协议为https协议
    :param domain_name: 加速域名
    :param ssl_id: 证书id
    """
    cdn_url = "https://api.capitalonline.net/cdnapi/distribution/https/" + domain_name + "/" + ssl_id
    action = "ModifyProtocol"
    method = "PUT"
    param = {}
    url = get_signature(action, AK, AccessKeySecret, method, cdn_url, param)
    resp = requests.put(url)
    result = json.loads(resp.content)
    result = json.dumps(result)
    print(result)

返回示例：

{
    "code": 200,
    "msg": "成功",
    "data": {
        "formid": 534636
    }
}

返回参数说明：

证书管理

CreateSsl

Action： CreateSsl

描述： 创建证书

请求地址： api.capitalonline.net/cdnapi/ssl

请求方法： POST

请求参数：

请求示例：

def create_ssl():
    """
    创建证书
    """
    cdn_url = "https://api.capitalonline.net/cdnapi/ssl"
    action = "CreateSsl"
    method = "POST"
    param = {}
    body = {
        "name": "create-test",
        "publickey": "*******",
        "privatekey": "*******"
    }
    url = get_signature(action, AK, AccessKeySecret, method, cdn_url, param)
    resp = requests.post(url, json=body)
    result = json.loads(resp.content)
    result = json.dumps(result)
    print(result)

返回示例：

{
    "code": 200,
    "msg": "成功",
    "data": {
        "id": 11142
    }
}

返回参数说明：

ModifySsl

Action： ModifySsl

描述： 修改证书

请求地址：api.capitalonline.net/cdnapi/ssl/:id

请求方法： PUT

请求参数：

请求示例：

def modify_ssl(ssl_id):
    """
    修改证书
    :param ssl_id: 证书id
    """
    cdn_url = "https://api.capitalonline.net/cdnapi/ssl/" + ssl_id
    action = "ModifySsl"
    method = "PUT"
    param = {}
    body = {
        "name": "create-test",
        "publickey": "*******",
        "privatekey": "*******"
    }
    url = get_signature(action, AK, AccessKeySecret, method, cdn_url, param)
    resp = requests.put(url, json=body)
    result = json.loads(resp.content)
    result = json.dumps(result)
    print(result)

返回示例：

{
    "code": 200,
    "msg": "成功",
    "data": {}
}

返回参数说明：

DescribeSsl

Action： DescribeSsl

描述： 获取证书列表

请求地址：api.capitalonline.net/cdnapi/ssl

请求方法： GET

请求参数：

请求示例：

def get_ssl_list():
    """
    获取证书列表
    """
    cdn_url = "https://api.capitalonline.net/cdnapi/ssl"
    action = "DescribeSsl"
    method = "GET"
    param = {
        "pageindex": "1",
        "pagesize": "10"
    }
    url = get_signature(action, AK, AccessKeySecret, method, cdn_url, param)
    resp = requests.get(url)
    result = json.loads(resp.content)
    result = json.dumps(result)
    print(result)

返回示例：

{
    "code": 200,
    "msg": "成功",
    "data": {
        "rows": [
            {
                "id": 11142,
                "name": "create-test",
                "moduleid": "CDN",
                "modulename": "CDN",
                "createtime": "2021-09-28T10:36:53.000Z",
                "updatetime": "2021-09-28T10:49:04.000Z",
                "authname": "cmyalidt.cdscdntest.com",
                "bindname": "",
                "billstatus": 0,
                "endtime": "2022-08-06T06:33:34.000Z",
                "ifdel": 0,
                "customerid": "E020514",
                "userid": "13900000800",
                "username": "",
                "statusid": "01",
                "statusname": "未使用"
            }
        ],
        "totalcount": 1,
        "pagesize": "10"
    }
}

返回参数说明：

DescribeSslInfo

Action： DescribeSslInfo

描述： 获取证书的详细信息

请求地址：api.capitalonline.net/cdnapi/ssl/:id

请求方法： GET

请求参数：

无

请求示例：

def get_ssl_info(ssl_id):
    """
    获取证书的详细信息
    :param ssl_id: 证书id
    """
    cdn_url = "https://api.capitalonline.net/cdnapi/ssl/" + ssl_id
    action = "DescribeSslInfo"
    method = "GET"
    param = {}
    url = get_signature(action, AK, AccessKeySecret, method, cdn_url, param)
    resp = requests.get(url)
    result = json.loads(resp.content)
    result = json.dumps(result)
    print(result)

返回示例：

{
    "code": 200,
    "msg": "成功",
    "data": {
        "rows": {
            "id": 11142,
            "moduleid": "CDN",
            "name": "create-test",
            "publickey": "*******",
            "privatekey": "*******",
            "statusid": "01",
            "statusname": "未使用",
            "createtime": "2021-09-28T10:36:53.000Z",
            "updatetime": "2021-09-28T10:49:04.000Z",
            "authname": "cmyalidt.cdscdntest.com",
            "bindname": "",
            "billstatus": 0,
            "endtime": "2022-08-06T06:33:34.000Z",
            "ifdel": 0,
            "customerid": "E020514",
            "userid": "13900000800",
            "username": ""
        }
    }
}

返回参数说明：

刷新预取

PrefetchFile

预取是主动获取源站新文件至二级缓存服务器，适用于文件发布、更新，降低文件链接放出时可能对源站产生的大量请求和带宽压力。

注意：预取文件的时候将有回源操作，会占用源站带宽。

Action： PrefetchFile

描述： 预取文件

请求地址：api.capitalonline.net/cdnapi/distribution/v4/prefetch

请求方法： POST

请求参数：

填写说明：

1、请输入完整路径，如 http://www.test.com/images/logo.jpg；支持正则表达式，如 http://www.test.com/images/*.jpg。

2、请注意区分 url 中的字母的大小写，错误的大小写会导致预取无效。

3、一次最多提交 99 条 url，以’\n’分隔。

4、文件大的时候，预取有可能占用大量带宽，建议在不影响业务的时候进行预取。

请求示例：

def prefetch_file():
    """
    预取文件
    """
    cdn_url = "https://api.capitalonline.net/cdnapi/distribution/v4/prefetch"
    action = "PrefetchFile"
    method = "POST"
    param = {}
    body = {
        "url": "http://www.test.com/images/a.txt\nhttp://www.test.com/images/test.png"
    }
    url = get_signature(action, AK, AccessKeySecret, method, cdn_url, param)
    resp = requests.post(url, json=body)
    result = json.loads(resp.content)
    print(result)

返回示例：

{
    "code": 200,
    "msg": "成功",
    "data": true
}

返回参数说明：

ContentRefresh

内容刷新功能可从各加速节点上清除指定的目录或者文件缓存，使得用户请求重新回源获取，当您希望用户及时看到最新版本的文件可以采用此手动缓存刷新方式。

Action： ContentRefresh

描述： 内容刷新

请求地址：api.capitalonline.net/cdnapi/distribution/v4/cache

请求方法： POST

请求参数：

填写说明：

1、当前目录为根目录（/），如要刷新目录，请以正斜杠 / 结尾，如 http://www.test.com/images/ ；如要刷新文件，请输入完整路径，如 http://www.test.com/images/logo.jpg；支持正则表达式，如 http://www.test.com/images/*.jpg。

2、请注意区分 url 中的字母的大小写，错误的大小写会导致刷新无效。

3、刷新目录时如果目录有上下级层次关系，本功能会自动同时推送下级子目录，不需要填写下级子目录。

4、一次最多提交 99 条 url，以’\n’分隔。

请求示例：

def content_refresh():
    """
    内容刷新
    """
    cdn_url = "https://api.capitalonline.net/cdnapi/distribution/v4/cache"
    action = "ContentRefresh"
    method = "POST"
    param = {}
    body = {
        "url": "http://www.test.com/images/\nhttp://www.test.com/images/test.png"
    }
    url = get_signature(action, AK, AccessKeySecret, method, cdn_url, param)
    resp = requests.post(url, json=body)
    result = json.loads(resp.content)
    print(result)

返回示例：

{
    "code": 200,
    "msg": "成功",
    "data": true
}

返回参数说明：

用量统计

FlowStatistics

Action： FlowStatistics

描述： 获取指定域名在指定时间段内的用量信息

请求地址：api.capitalonline.net/cdnapi/distribution/flow

请求方法： POST

请求参数：

请求示例：

def flow_statistics():
    """
    获取指定域名在指定时间段内的用量信息
    """
    cdn_url = "https://api.capitalonline.net/cdnapi/distribution/flow"
    action = "FlowStatistics"
    method = "POST"
    param = {}
    body = {
        "domainname": ["openapitest.cdscdntest.com", "test.cdscdntest.com"],
        "begindate": "2021-09-29",
        "enddate": "2021-09-30",
        "spacingtype": "01",
        "peaktypeid": "01"
    }
    url = get_signature(action, AK, AccessKeySecret, method, cdn_url, param)
    resp = requests.post(url, json=body)
    result = json.loads(resp.content)
    print(result)

返回示例：

{
    "code": 200,
    "msg": "成功",
    "data": [
        {
            "counttime": "2021-09-29 10:40:00",
            "regionid": "OVS",
            "typeid": "web",
            "protocolid": "http",
            "value": 0.00001
        },
        {
            "counttime": "2021-09-29 10:40:00",
            "regionid": "CN",
            "typeid": "web",
            "protocolid": "http",
            "value": 0.000001
        },
        {
            "counttime": "2021-09-29 10:45:00",
            "regionid": "OVS",
            "typeid": "web",
            "protocolid": "http",
            "value": 0.00008
        }
    ]
}

返回参数说明：

DosageAnalysis

Action： DosageAnalysis

描述： 获取指定域名今天、昨天、本月以及上个月的流量（单位：GB）和带宽（单位：Mb）

请求地址：api.capitalonline.net/cdnapi/distribution/usageinfo

请求方法： POST

请求参数：

请求示例：

def dosage_analysis():
    """
    获取指定域名今天、昨天、本月以及上个月的流量和带宽
    """
    cdn_url = "https://api.capitalonline.net/cdnapi/distribution/usageinfo"
    action = "DosageAnalysis"
    method = "POST"
    param = {}
    body = {
        "domains": ["openapitest.cdscdntest.com", "test.cdscdntest.com"]
    }
    url = get_signature(action, AK, AccessKeySecret, method, cdn_url, param)
    resp = requests.post(url, json=body)
    result = json.loads(resp.content)
    print(result)

返回示例：

{
    "code": 200,
    "msg": "成功",
    "data": {
        "peak": {
            "type": "top_bandwidth",
            "current_month": 7.292106,
            "last_month": 131.640734,
            "today": 0.00216,
            "yesterday": 6.760003
        },
        "flow": {
            "type": "total_flow",
            "current_month": 0.306807789,
            "last_month": 32.707811785,
            "today": 0.000091001,
            "yesterday": 0.280902674
        }
    }
}

返回参数说明：

PathMetering

Action： PathMetering

描述： 获取指定路径下产生的流量

请求地址：api.capitalonline.net/cdnapi/distribution/pathflow

请求方法： POST

请求参数：

请求示例：

def path_metering():
    """
    获取指定路径下产生的流量
    """
    cdn_url = "https://api.capitalonline.net/cdnapi/distribution/pathflow"
    action = "PathMetering"
    method = "POST"
    param = {}
    body = {
        "path": "/test/",
        "begindate": "2021-09-29 00:00:00",
        "enddate": "2021-09-29 23:59:59",
        "interval": "minute"
    }
    url = get_signature(action, AK, AccessKeySecret, method, cdn_url, param)
    resp = requests.post(url, json=body)
    result = json.loads(resp.content)
    print(result)

返回示例：

{
    "code": 200,
    "msg": "成功",
    "data": [
        {
            "counttime": "2021-09-29 15:50:00",
            "domainname": "test.cdscdntest.com",
            "flow": 523600
        },
        {
            "counttime": "2021-09-29 15:55:00",
            "domainname": "test.cdscdntest.com",
            "flow": 7502467.5
        }
    ]
}

返回参数说明：

错误码