Common Parameters
Common Parameters
Common request and response parameters must be included in all APIrequests.
End Point
de444sda1231291212312312.apigateway.res.openbill.com
Request parameters
The following table describes the common parameters that are used when you call API operations supported by the CRE API
| Name | Location | Type | Required | Sample Value | Description |
|---|---|---|---|---|---|
| Host | Header | String | Yes | de444sda1231291212312312.apigateway.res.openbill.com | The Request URL endpoint |
| Date | Header | String | Yes | Mon, 22 Aug 2016 11:21:04 GMT | The date passed in by the API caller |
| User-Agent | Header | String | Yes | Apache-HttpClient/4.1.2 (java 1.6) | The application, operating system, and/or version of the requesting user agent |
| Content-Type | Header | String | Yes | application/x-www-form-urlencoded; charset=UTF-8 | The media type of resource |
| Accept | Header | String | Yes | application/json | The response body type |
| X-Ca-Version | Header | String | Yes | 1 | The API version number. Currently, all APIs support only version 1 hence default version number is 1 |
| X-Ca-Signature-Headers | Header | String | Yes | X-Ca-Key,X-Ca-Stage,X-Ca-Timestamp,X-Ca-Request-Mode | The header string for signature calculation. The keys of the header parameters used for Headers signature calculation must be separated with commas (,) |
| X-Ca-Key | Header | String | Yes | 166626688517370 | AppKey |
| Content-MD5 | Header | String | Yes | 1B2M2Y8AsgTpgAmY7PhCfg== | The MD5 value of the request body |
| X-Ca-Timestamp | Header | String | Yes | 1671538946068 | The timestamp passed in by the API caller. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. The timestamp is valid for 15 minutes by default. |
| X-Ca-Nonce | Header | String | Yes | af937af9-b692-4b63-9831-7a3afb038ab8 | The UUID generated by the API caller to prevent replay attacks |
| X-Ca-Signature | Header | String | Yes | e1QkImX1Xib+hKYd+qH6TVdhiPORNbm4/XYieQhdbdU=" | The signature string |
| UserEmail | Header | String | Yes | support@openbill.com | The CRE user email. This is the identification of the CRE user CRE Admin should be able to inquiry and manage ALL CRE users CRE and Apsara resources via APIs |
| CREversion | Header | String | Yes | 1 | The CRE function version number. Currently, CRE function support version 1 |
| domain | Header | String | Yes | C | The domain is to indicate the Admin or End User CRE functions Admin: S End User: C |
Response parameters
Responses are returned only in the JSON format. If a return code is greater than or equal to 200 and less than 300, a successful response is returned. Otherwise, an errorresponse is returned. The following table describes the common parameters that are used when you call API operations supported by the CRE API
| Name | Description |
|---|---|
| X-Ca-Request-Id | The unique ID of the request. When CRE API receives a request, it generates a request ID and returns the request ID to the client in the X-Ca-Request-Id header. We recommend that you record the request ID in both the client and your backend service for troubleshooting and tracking |
| X-Ca-Error-Message | The error message was returned by CRE API. If a request fails, CRE API returns the error message to the client in the X-Ca-Error-Message header |
| X-Ca-Error-Code | The error code of a system error in CRE API. If a request is blocked by CRE API due to an error, CRE API returns the corresponding error code in the X-Ca-Error-Code header.If the X-Ca-Error-Code header is empty, the HTTP error code is generated by CRE Service. APIGateway transparently transmits the error message from CRE service, else X-CA-Error-Code value is returned by CRE API. The error code is six characters in length. |