This topic describes the common parameters that are used for Alibaba Cloud RTC API calls. Common parameters include request parameters and return parameters.
Common request parameters
Common request parameters are required for every API call.
| Parameter | Type | Required | Description |
| Format | String | No | The format of the response. Valid values: JSON and XML. Default value: XML. |
| Version | String | Yes | The version of the API. The version is in the YYYY-MM-DD format. This version is 2018-01-11. |
| AccessKeyId | String | Yes | The AccessKey ID used to access the service. |
| Signature | String | Yes | The signature string. For more information, see Signature mechanism. |
| SignatureMethod | String | Yes | The signature method. Set the value to HMAC-SHA1. |
| Timestamp | String | Yes | The timestamp of the request. The timestamp must follow the ISO 8601 standard and be in UTC. The format is yyyy-MM-ddTHH:mm:ssZ. For example, 2019-12-29T12:00:00Z is 20:00:00 on December 29, 2019 (UTC+8). |
| SignatureVersion | String | Yes | The signature algorithm version. Set the value to 1.0. |
| SignatureNonce | String | Yes | A unique random number. Use a different nonce for each request to prevent replay attacks. For code examples, see SignatureNonce. |
| SecurityToken | String | No | The temporary security token that is generated by Security Token Service (STS). This parameter is empty by default. For more information, see Account permissions and Use an STS token for temporary access. |
Request example
http://rtc.aliyuncs.com/
?Format=json
&Version=2018-01-11
&Signature=L9o%3D****
&SignatureMethod=Hmac-SHA1
&SignatureNonce=9166ab59-f445-4005-911d-664c1570df0f
&SignatureVersion=1.0
&Action=ModifyApp
&AccessKeyId=testid
&Timestamp=2017-03-29T09%3A22%3A32Z
... Common return parameters
API responses follow a standard format. A 2xx HTTP status code indicates that a call is successful, and a 4xx or 5xx HTTP status code indicates that a call failed. A successful call returns a response in either XML or JSON format. You can specify the format in the request. The default format is XML.
For each API call, the system returns a unique RequestId, regardless of whether the call is successful.
XML format
<?xml version="1.0" encoding="UTF-8"?> <!--The root node of the result.--> <ActionNameResponse> <!--The request ID.--> <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId> <!--The returned data.--> </ActionNameResponse>JSON format
{ "RequestId": "4C467B38-3910-447D-87BC-AC049166F216", /* The returned data. */ }