Response¶
Status Code¶
After sending 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 request. For more information, see Status Codes.
For the API to obtain request authentication, if the status code 201 is returned after the API is called, 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 fields for the API used to obtain request authentication. The x-subject-token header field is the desired user token. This token can then be used to authenticate the calling of other APIs.
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 (for example, JSON or XML) as specified in the Content-Type header field. The response body transfers content except the response header.
The following shows the response body for the API to obtain request authentication. For the sake of space, only part of the content is displayed here.
{
"token": {
"expires_at": "2019-02-13T06:52:13.855000Z",
"methods": [
"password"
],
"catalog": [
{
"endpoints": [
{
"region_id": "aaa"//The region ID "aaa" is used as an example.
...
If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.
{
"error_msg": "Invalid cluster name.",
"error_code": "12000002"
}
In the response body, error_code is an error code, and error_msg provides information about the error.