Common parameters include common request parameters and common response parameters. You can call a DCDN API operation by sending an HTTP GET request to the endpoint of the DCDN API. When you call an operation, you need to specify the request parameters as required by the operation.. The system then returns a response after processing the request.

Note The sample requests are presented in an easy-to-read form in this document.
Parameter Type Required Description
Format String No The format in which to return the response. Valid values: JSON and XML. Default value: XML.
Version String Yes The version number of the API, with a date format of YYYY-MM-DD. The current version is 2018-01-15.
AccessKeyId String Yes The AccessKey ID provided to you by Alibaba Cloud.
Signature String Yes The signature string of the current request.
SignatureMethod String Yes The encryption method of the signature string. Set the value to HMAC-SHA1.
Timestamp String Yes The timestamp of the request. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Example: 2018-05-10T12:00:00Z, which represents 20:00:00 on Thursday, May 10, 2018 (UTC+8).
SignatureVersion String Yes The version of the signature encryption algorithm. Set the value to 1.0.
SignatureNonce String Yes A unique, random number used to prevent replay attacks. You must use different numbers for different requests.

Sample request

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

Common response parameters

All API responses use the same format. If a 2XX HTTP status code is returned, the call is successful. If a 4xx or 5xx HTTP status code is returned, the call is failed. The result can be returned in JSON or XML format. You can specify the format of the returned data when sending an API request. The result is returned in XML format by default.

Each time you send a request to call an operation, the system returns a unique identifier RequestId, regardless of whether the request is successful or not.

Sample response in XML format

<? xml version="1.0" encoding="utf-8"? > 
    <!-Response root node-->
    <Operation + Response>
        <!-The request ID-->
        <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
        <!-The response data-->
    </Operation + Response>

Sample response in JSON format

{
    "RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
    /*The response data*/
    }

If a 4xx or 5xx HTTP status code is returned, the call has failed. The request ID, host ID, error code, and error message are returned to you.

You can troubleshoot the error according to the error code. For more information, see Error codes. If the error persists, you can submit a ticket and provide the host ID and request ID to get technical support from Alibaba Cloud.

Sample response in XML format

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

Sample response in JSON format

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