edit-icon download-icon

Common parameters

Last Updated: Apr 02, 2018

Common request parameters

Common request parameters are used in each API.

Name Type Required Description
Format String No The format of the response text. JSON and XML are supported. The default format is XML.
Version String Yes The API version in the format YYYY-MM-DD. The current version is 2016-01-20.
AccessKeyId String Yes An alphanumeric token issued by Alibaba Cloud for user authentication.
Signature String Yes Signing requests. For more information, see Signature.
SignatureMethod String Yes The hash algorithm to create the request signature. HMAC-SHA1 is used.
Timestamp String Yes The date and time at which a request is signed, in the format YYYY-MM-DDThh:mm:ssZ.
Example: 2014-05-26T12:00:00Z
SignatureVersion String Yes The signature version used to sign a request. The current version is 1.0.

Example

  1. https://kms.cn-hangzhou.aliyuncs.com/?
  2. Format=json
  3. &Version=2016-01-20
  4. &AccessKeyId=testid
  5. &Signature=YlrFhyqDZQ1ThNYARrv3Ptaxqfc%3D
  6. &SignatureMethod=HMAC-SHA1
  7. &Timestamp=2016-03-25T09:36:58Z
  8. &SignatureVersion=1.0

Common response parameters

Each time you send an API request, a unique RequestId is returned, whether the request is successful or not.

Example

XMLexample

  1. <KMS>
  2. <RequestId>348d9445-e39a-4d80-907d-298cc6c94447</RequestId>
  3. <!—Returned results-->
  4. </KMS>

JSONexample

  1. {
  2. "RequestId": "284b2b80-9b17-4546-a093-adfbae512a54"
  3. }
Thank you! We've received your feedback.