This topic describes the request parameters and response parameters that are required for all Alibaba Cloud Marketplace operations.
Common request parameters
Common request parameters must be included in all Alibaba Cloud Marketplace API requests.
Parameter | Type | Required | Description |
Format | String | Yes | 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 in the YYYY-MM-DD format. The current version is 2015-11-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, May 26, 2014, 20:00:00 UTC+8 is written as 2014-05-26T12:00:00Z. |
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
https://market.ap-southeast-1.aliyuncs.com/
? Format=xml
&Version=2015-11-01
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2012-06-01T12:00:00Z
Common response parameters
API responses use the HTTP response format. Responses can be returned in either the
JSON or XML format. You can specify the response format in the request. The default
response format is XML. Every response returns a unique RequestID regardless of whether the call is successful.
- A
2xx
HTTP status code indicates a successful call. - A
4xx
or5xx
HTTP status code indicates a failed call.
The following are sample responses:
- XML format
<? xml version="1.0" encoding="UTF-8"? > <! --Result Root Node--> <Operation Name+Response> <! --Return Request Tag--> <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId> <! --Return Result Data--> </Operation Name+Response>
- JSON format
{ "RequestId": "4C467B38-3910-447D-87BC-AC049166F216", /* Return Result Data */ }