This topic describes the common request and response parameters that are included in all Elastic Desktop Service (EDS) API requests and responses.
Common request parameters
Common request parameters must be included in all EDS API requests. The following table describes the common request parameters that can be used when you call EDS API operations by sending GET requests over URLs.
Parameter | Type | Required | Description |
---|---|---|---|
Format | String | No | The format in which to return the response. Valid values: JSON and XML. Default value: JSON. |
Version | String | Yes | The version number of the API. The value must be in the YYYY-MM-DD format. Set the value to 2020-09-30. |
AccessKeyId | String | Yes | The AccessKey ID provided to you by Alibaba Cloud. |
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. |
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, use 2013-01-10T12:00:00Z to indicate January 10, 2013, 20:00:00 (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 used to prevent replay attacks.
You must use different numbers for different requests. |
ResourceOwnerAccount | String | No | The owner account (logon username) of the resource that you want to access by using this API request. |
Product | String | Yes | The name of Elastic Desktop Service. Set the value to ecd. |
Sample requests
https://ecd.cn-hangzhou.aliyuncs.com/?Action=<API Name>
&TimeStamp=2014-05-19T10%3A33%3A56Z
&Format=xml
&AccessKeyId=testid
&SignatureMethod=Hmac-SHA1
&SignatureNonce=NwDAxvLU6tFE0DVb
&Version=2020-09-30
&SignatureVersion=1.0
&Signature=Signature
&ResourceOwnerAccount=123456
&Product=ecd
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 XML. Every response returns
a unique RequestId regardless of whether the call is successful.
Parameter | Type | Description |
---|---|---|
RequestId | String | The ID of the request. This parameter is returned regardless of whether the call is successful. |
Sample responses
Sample success responses
- XML format
<?xml version="1.0" encoding="utf-8"?> <!--Result Root Node--> <Interface Name+Response> <!--Return Request Tag--> <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId> <!--Return Result Data--> </Interface Name+Response>
- JSON format
{ "RequestId":"4C467B38-3910-447D-87BC-AC049166F216", /*Return Result Data*/ }