All Products
Search
Document Center

:Common parameters

Last Updated:Apr 21, 2025

This topic describes the common request and response parameters.

Common request parameters

Parameter

Type

Required

Description

Format

String

No

The format in which to return the response. Default value: XML. Valid values:

  • JSON

  • XML (default)

Version

String

Yes

The version number of the API. Specify the version number in the YYYY-MM-DD format. Set the value to 2019-09-10.

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.

SignatureNonce

String

Yes

A unique, random number used to prevent replay attacks. You must use different numbers for different requests.

SignatureVersion

String

Yes

The version of the signature encryption algorithm. Set the value to 1.0.

AccessKeyId

String

Yes

The AccessKey ID provided to you by Alibaba Cloud.

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, 2013-01-10T12:00:00Z specifies 20:00:00 on January 10, 2013 (UTC+8).

Sample requests

http(s)://ros.aliyuncs.com/?Action=CreateStack
&Format=xml
&Version=2019-09-10
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dg****
&SignatureMethod=HMAC-SHA1
&SignatureNonce=1521552885****
&SignatureVersion=1.0
&AccessKeyId=LTAI****************
&Timestamp=2020-06-01T12:00:00Z

Common response parameters

Responses can be returned in the JSON or XML format. You can specify the response format in the request. The default response format is JSON. Every response returns a unique RequestId value regardless of whether the call is successful.

  • A 2xx HTTP status code indicates a successful call.

  • A 4xx or 5xx HTTP status code indicates a failed call.

Sample responses

  • XML format

    <?xml version="1.0" encoding="utf-8"?> 
        ><!--Result root node-->
        <Operation name + Response>
            <!--Response request tag-->
            <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
            <!--Returned data-->
        </Operation name + Response>                        
  • JSON format

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