This topic describes common parameters, including common request parameters and common response parameters. Common parameters are required by all API operations.
Common request parameters
Common request parameters are required by all API operations.
Parameter | Type | Required | Description |
---|---|---|---|
RegionId | string | Yes | The region where the Security Center instance is deployed.
Valid values:
|
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 is in the YYYY-MM-DD format.
Set the value to 2018-12-03. |
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, you can set the value to |
SignatureVersion | String | Yes | The version of the signature algorithm. The current version is 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 account that owns the resource to be accessed by this API request. |
https://tds.aliyuncs.com/?Action=DescribeDomainNames
&Timestamp=2014-05-19T10%3A33%3A56Z
&Format=xml
&AccessKeyId=testid
&SignatureMethod=Hmac-SHA1
&SignatureNonce=NwDAxvLU6tFE0DVb
&Version=2018-12-03
&SignatureVersion=1.0
&Signature=Signature
Common response parameters
API responses use the HTTP response format. A 2xx status code indicates a successful call and a 4xx or 5xx status code indicates a failed call.
Responses can be returned in the JSON or XML format. The default response format is JSON. You can specify the format when you call an operation.
Every response returns a unique RequestId regardless of whether the call is successful.- 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", /*The returned result*/ }