All Products
Document Center

Response structure

Last Updated: Jan 22, 2019

All data returned by the API use the following format:

  • If a 2xx HTTP status code is returned, the request is successful.
  • If a 4xx HTTP status code is returned, the request is failed.

The returned data for successful requests is encoded in JSON format.

Returned data for a successful request

JSON example:

  1. {
  2. "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
  3. /* Returned data */
  4. }

Returned data for a failed request

When a request failed, an HTTP response containing an HTTP status code (4xx or 5xx) is returned. The body of the response contains an error code and the error information. You can inspect the cause based on the error code. The response also contains the ID of the request (RequestId, globally unique) and the ID of the server (HostId) that you need to access. If you cannot find the cause, contact Customer Support or submit a ticket, and send your HostId and RequestId as requested to resolve the problem.

JSON example:

  1. {
  2. "RequestId": "8906582E-6722-409A-A6C4-0E7863B733A5",
  3. "HostId": "",
  4. "Code": "BadRequest",
  5. "Message": "The request has invalid parameters."
  6. }