This topic provides the common request parameters and common response parameters of Cloud Enterprise Network (CEN) API operations.
Common request parameters
Common request parameters must be included in all CEN API requests.
Parameter | Type | Required | Description |
---|---|---|---|
Format | String | No | The format in which the response is returned. Valid values:
JSON and XML. Default value: JSON. |
Version | String | Yes | The version number of the API. Format: YYYY-MM-DD . Set the value to
2017-09-12 |
AccessKeyId | String | Yes | The AccessKey ID provided by Alibaba Cloud. |
Signature | String | Yes | The signature string of the API 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.
Example: 2013-01-10T12:00:00Z, which specifies 20:00:00 on January 10, 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 random numbers for different requests. |
https://cbn.aliyuncs.com/?Action=DescribeCens
&TimeStamp=2014-05-19T10%3A33%3A56Z
&Format=xml
&AccessKeyId=testid
&Action=DescribeCens
&SignatureMethod=Hmac-SHA1
&CenId=cen-test
&SignatureNonce=NwDAxvLU6tFE0DVb
&Version=2017-09-12
&SignatureVersion=1.0
&Signature=CT9X0VtwR86fNWSnsc6v8YGOjuE%xx
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 JSON or XML format. The default response format is JSON. You can specify the format when you call an operation.
Each response returns a unique RequestId regardless of whether the call is successful.