公共参数包含公共请求参数和公共返回参数。CDN API接口的调用是通过向API接口的服务端地址发送HTTP GET请求,并按照接口说明在请求中加入相应请求参数完成的。根据请求的处理情况,系统会返回处理结果。

公共请求参数

说明 为了便于您的查看,本文档中的示例都做了格式化处理。
名称 类型 是否必选 描述
Format String 返回值的类型,支持JSON与XML,默认为XML。
Version String API版本号,为日期形式:YYYY-MM-DD,本版本对应为2018-05-10。
AccessKeyId String 阿里云颁发给您的访问服务所用的密钥ID。
Signature String 签名结果串,关于签名的计算方法,请参见RPC API签名
SignatureMethod String 签名方式,目前支持HMAC-SHA1。
Timestamp String 请求的时间戳。日期格式按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。例如,2018-05-10T12:00:00Z(为北京时间2018年5月10日20点0分0秒)。
SignatureVersion String 签名算法版本,目前版本是1.0。
SignatureNonce String 唯一随机数,用于防止网络重放攻击。您在不同请求间要使用不同的随机数值。

请求示例

https://cdn.aliyuncs.com/?Format=xml
&Version=2018-05-10
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2018-05-10T12:00:00Z    

公共返回参数

API返回结果采用统一格式,返回2xx HTTP状态码代表调用成功;返回4xx或5xx HTTP状态码代表调用失败。调用成功返回的数据格式有XML和JSON两种,可以在发送请求时指定返回的数据格式,默认为XML格式。

每次接口调用,无论成功与否,系统都会返回一个唯一识别码RequestId

XML返回示例

<?xml version="1.0" encoding="utf-8"?> 
    <!—结果的根结点-->
    <接口名称+Response>
        <!—返回请求标签-->
        <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
        <!—返回结果数据-->
    </接口名称+Response>

JSON返回示例

{
    "RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
    /*返回结果数据*/
    }

调用API返回4xx或者5xx HTTP状态码代表调用失败,并返回请求ID、HostId、错误代码和错误信息。

您可以根据接口错误码排查错误,详情请参见CDN错误码。当您无法排查错误时,可以提交工单联系我们,并在工单中注明服务节点HostId和RequestId。

XML返回示例

<?xml version=”1.0” encoding=”UTF-8”?>
<Error><RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId>   
<HostId>cdn.aliyuncs.com</HostId>   
<Code>OperationDenied</Code>   
<Message>The specified action is not supported.</Message></Error>

JSON返回示例

{    
“RequestId”: “8906582E-6722-409A-A6C4-0E7863B733A5”,    
“HostId”: “cdn.aliyuncs.com”,    
“Code”: “OperationDenied”,    
“Message”: “The specified action is not supported.”
}