...
| Paste code macro | ||||||
|---|---|---|---|---|---|---|
| ||||||
#latest#API versionForm https://api.machbasecloud.com/ #specific version 1 https://api.machbasecloud.com/v1/${CloudVendor}.${CountryCode}.machlake.com/ |
CloudVendor
This value is displayed as the serial number of the cloud operator where machlake is installed. For example, aws1 for Amazon, azure2 for MS, etc.
The serial number is given for each specific region, and the detailed information is indicated with the location and serial number when creating a lake.
CountryCode
Country codes are specific symbols assigned to each region.
For example, us for Unite States, uk for Unite Kingdom, cn for China, and so on.
In this information, you can check the access URL of the lake in the user screen of machlake.
Example
Headers
| Paste code macro | ||||
|---|---|---|---|---|
| ||||
Content-Type: application/json; charset=utf8
x-api-key: {API Key} |
...
When setting up a JSON API, you'll have all kinds of different types of calls and responses. JSend separates responses into some basic types, and defines required and optional keys for each type:
Type | Description | Required Keys | Optional Keys |
|---|---|---|---|
Success | All went well, and (usually) some data was returned. | status, data | |
Fail | There was a problem with the data submitted, or some pre-condition of the API call wasn't satisfied | status, data | |
Error | An error occurred in processing the request, i.e. an exception was thrown | status, data | code, data |
Example response type
Success
...