Help Center/ GeminiDB/ API Reference/ Calling APIs/ Returned Values
Updated on 2023-04-21 GMT+08:00
View PDF
Share

Returned Values

Status Code

After you send a request, you will receive a response, including a status code, response header, and response body.

A status code is a group of digits ranging from 1xx to 5xx. It indicates the status of a response. For more information, see Status Codes.

If status code 201 is returned for calling the API used to obtain a user token, the request is successful.

Response Header

Similar to a request, a response also has a header, for example, Content-Type.

Figure 1 shows the response header for the API used to obtain a user token, in which x-subject-token is the required user token. Then, this token can be used to authenticate the calling of other APIs.

Figure 1 Response header for the API used to obtain a user token

(Optional) Response Body

This part is optional. A response body is generally returned in a structured format (for example, JSON or XML), corresponding to Content-Type in the response header, and is used to transfer content other than the response header.

If the following information is returned for calling the API used to obtain a user token, the request is successful. The following describes part of the request body.

{
    "token": {
        "expires_at": "2019-02-13T06:52:13.855000Z",
        "methods": [
            "password"
        ],
        "catalog": [
            {
                "endpoints": [
                    {
                        "region_id": "aaa",
......

If an error occurs during API calling, an error code and error message will be displayed. The following is an error response body:

{
    "error_msg": "Parameter error",
    "error_code": "DBS.200001"
}

In the response, error_code indicates an error code, and error_msg describes the error.

Parent topic: Calling APIs