forked from docs/gaussdb-mysql
proposalbot
27d4e28e46
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com> Co-authored-by: proposalbot <proposalbot@otc-service.com> Co-committed-by: proposalbot <proposalbot@otc-service.com>
63 lines
2.4 KiB
ReStructuredText
63 lines
2.4 KiB
ReStructuredText
:original_name: gaussdb_03_0006.html
|
|
|
|
.. _gaussdb_03_0006:
|
|
|
|
Response
|
|
========
|
|
|
|
Status Code
|
|
-----------
|
|
|
|
After sending a request, you will receive a response, including the 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 :ref:`Status Codes <gaussdb_10_0002>`.
|
|
|
|
For example, if status code **201** is returned for calling the API used to `obtain a user token <https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html>`__, the request is successful.
|
|
|
|
Response Header
|
|
---------------
|
|
|
|
Similar to a request, a response also has a header, for example, **Content-Type**.
|
|
|
|
:ref:`Figure 1 <gaussdb_03_0006__fig4865141011511>` shows the response header for the API used to `obtain a user token <https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html>`__. The **x-subject-token** header field is the desired user token. This token can then be used to authenticate the calling of other APIs.
|
|
|
|
.. _gaussdb_03_0006__fig4865141011511:
|
|
|
|
.. figure:: /_static/images/en-us_image_0000001372529646.png
|
|
:alt: **Figure 1** Header fields of the response to the request for obtaining a user token
|
|
|
|
**Figure 1** Header fields of the response to the request for obtaining a user token
|
|
|
|
(Optional) Response Body
|
|
------------------------
|
|
|
|
This part is optional. The body of a response is often returned in structured format as specified in the **Content-Type** header field. The response body transfers content except the response header.
|
|
|
|
The following is part of the response body for the API used to `obtain a user token <https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html>`__.
|
|
|
|
.. code-block::
|
|
|
|
{
|
|
"token": {
|
|
"expires_at": "2019-02-13T06:52:13.855000Z",
|
|
"methods": [
|
|
"password"
|
|
],
|
|
"catalog": [
|
|
{
|
|
"endpoints": [
|
|
{
|
|
"region_id": "az-01",
|
|
......
|
|
|
|
If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.
|
|
|
|
.. code-block::
|
|
|
|
{
|
|
"error_code": "AS.0001",
|
|
"error_msg": "The format of message is error"
|
|
}
|
|
|
|
In the response body, **error_code** is an error code, and **error_msg** provides information about the error.
|