All Products
Search
Document Center

HTTPDNS:Common parameters

Last Updated:Sep 19, 2022

Common request parameters

Common request parameters are required in all HTTPDNS API requests.

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. The value is in the YYYY-MM-DD format. Set the value to 2016-02-01.

AccessKeyId

String

Yes

The AccessKey ID provided to you by Alibaba Cloud.

Signature

String

Yes

The signature string of the current request. For more information about how signatures are calculated, see Signature method.

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. For example, you can set this parameter to 2016-02-25T12:00:00Z, which indicates 12:00:00 on February 25, 2016 in UTC.

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.

Examples

https://httpdns-api.aliyuncs.com/
?Format=XML
&Version=2016-02-01
&AccessKeyId=testid
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&Timestamp=2016-02-25T12:00:00Z
&<Operation-specific parameters>
…

Common response parameters

The system returns a unique identifier (RequestId) for each API request, regardless of whether the API operation was called successfully.

XML format

<?xml version="1.0" encoding="UTF-8"?>
<!-Result Root Node-->
<Interface Name+Response>
    <!-Return Request Tag-->
    <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
    <!-Return Result Data-->
</Interface Name+Response>

JSON format

{
    "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
    /* Return Result Data */
}