All Products
Search
Document Center

Public parameters

Last Updated: May 13, 2020

Common request parameters

Common request parameters must be included in all Alibaba Cloud Domain Name System (DNS) PrivateZone 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. Specify the version number in the YYYY-MM-DD format. Set the value to 2018-01-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, 2018-01-01T12:00:00Z is a valid timestamp, which indicates 12:00:00 on January 1, 2018 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.

Sample requests

  1. https://pvtz.aliyuncs.com/
  2. ?Format=xml
  3. &Version=2018-01-01
  4. &Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
  5. &SignatureMethod=HMAC-SHA1
  6. &SignatureNonce=15215528852396
  7. &SignatureVersion=1.0
  8. &AccessKeyId=key-test
  9. &Timestamp=2018-01-01T12:00:00Z
  10. ...

Common response parameters

Every response returns a unique request ID regardless of whether the call is successful.

Sample responses

XML format

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-Result root node-->
  3. <Operation name+Response>
  4. <!-Returned request tag-->
  5. <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
  6. <!-Returned result data-->
  7. </Operation name+Response>

JSON format

  1. {
  2. "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
  3. /* Returned result data */
  4. }