Common parameters-Identity as a Service(IDaaS)-阿里云帮助中心

This topic describes common parameters, including common request parameters and common response parameters. Common parameters are required by all API operations.

Common request parameters

Parameter	Type	Required	Description
Format	String	No	The return value that is in the JSON format or XML format.
Version	String	Yes	The version number of the API. The value is in the YYYY-MM-DD format. Set the value to 2020-05-21.
AccessKeyId	String	Yes	The AccessKey ID provided to you by Alibaba Cloud.
Signature	String	Yes	The signature string of the request. For information about how to calculate a signature for a request, see Signature.
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, a value of `2013-08-15T12:00:00Z` indicates 20:00:00 on August 15, 2013, UTC+8.
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

Every response returns a unique request ID (indicated by RequestId) regardless of whether the request is successful.

Request example

https://dg.aliyuncs.com/
?Format=xml
&Version=2020-05-21
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D 
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&OwnerId=12345678
&Timestamp=2014-10-10T12:00:00Z

Response example

API responses use the HTTP response format where a 2xx status code indicates a successful call and a 4xx or 5xx status code indicates a failed call. For a successful call, the returned data is in the JSON format. For an external system, you can configure a parameter to specify the format of returned data when you configure request parameters. For ease of reading, the sample responses are formatted. The actual responses do not include line breaks or indentations.

XML format

<?xml version="1.0" encoding="utf-8"?> 
<!--Root node of the response-->
<API operation name + Response>
    <!--Return request tag-->
    <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
    <!--Return data-->
</API operation name + Response>

JSON format

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