All Products
Search
Document Center

Common parameters

Last Updated: Jan 10, 2022

Common parameters include common request parameters and common response parameters.

Common request parameters

Common request parameters must be included in all CDT API requests. The following table describes the common request parameters.

Name

Type

Required

Description

Format

String

No

The response format.

Valid values: JSON and XML. Default value: JSON.

Version

String

Yes

The version number of the API. The value is in the YYYY-MM-DD format.

Set the value to 2021-08-13.

AccessKeyId

String

Yes

The AccessKey ID provided to you by Alibaba Cloud.

Signature

String

Yes

The signature string of the request.

SignatureMethod

String

Yes

The encryption algorithm 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, 2021-01-10T12:00:00Z indicates the timestamp 20:00:00 (UTC+8) on January 10, 2021.

SignatureVersion

String

Yes

The version of the signature encryption algorithm.

Set the value to 1.0.

SignatureNonce

String

Yes

A unique, random number that is used to prevent replay attacks.

You must use different numbers for different requests.

 

Common response parameters

API responses use the HTTP response format. A 2XX status code indicates a successful call. A 4XX or 5XX status code indicates a failed call. Responses can be returned in the JSON or XML format. The default response format is JSON. You can specify the response format when you call an operation.

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

JSON format

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