forked from docs/doc-exports
Liu, Siying
61db61b4e5
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com> Co-authored-by: Liu, Siying <liusiying@noreply.gitea.eco.tsi-dev.otc-service.com> Co-committed-by: Liu, Siying <liusiying@noreply.gitea.eco.tsi-dev.otc-service.com>
46 lines
4.0 KiB
HTML
46 lines
4.0 KiB
HTML
<a name="cts_api_0024"></a><a name="cts_api_0024"></a>
|
|
|
|
<h1 class="topictitle1">Response</h1>
|
|
<div id="body8662426"><div class="section" id="cts_api_0024__en-us_topic_0181150977_section968114282311"><h4 class="sectiontitle">Status Code</h4><p id="cts_api_0024__en-us_topic_0181150977_p4624111624411">After sending a request, you will receive a response, including a status code, response header, and response body.</p>
|
|
<p id="cts_api_0024__en-us_topic_0181150977_p124381044137">A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request.</p>
|
|
<p id="cts_api_0024__en-us_topic_0181150977_p2861496519">For example, if status code <span class="parmvalue" id="cts_api_0024__en-us_topic_0181150977_parmvalue9701630051"><b>201</b></span> is returned for calling the API used to obtain a user token, the request is successful.</p>
|
|
</div>
|
|
<div class="section" id="cts_api_0024__en-us_topic_0181150977_section7804143005810"><h4 class="sectiontitle">Response Header</h4><p id="cts_api_0024__en-us_topic_0181150977_p384320471837">Similar to a request, a response also has a header, for example, <span class="parmvalue" id="cts_api_0024__en-us_topic_0181150977_parmvalue1254412511579"><b>Content-type</b></span>.</p>
|
|
<p id="cts_api_0024__en-us_topic_0181150977_p4430113619484"><a href="#cts_api_0024__en-us_topic_0181150977_fig4865141011511">Figure 1</a> shows the response header fields for the API used to obtain a user token. The <span class="parmname" id="cts_api_0024__en-us_topic_0181150977_parmname9146192903112"><b>x-subject-token</b></span> header field is the desired user token. This token can then be used to authenticate the calling of other APIs.</p>
|
|
<div class="fignone" id="cts_api_0024__en-us_topic_0181150977_fig4865141011511"><a name="cts_api_0024__en-us_topic_0181150977_fig4865141011511"></a><a name="en-us_topic_0181150977_fig4865141011511"></a><span class="figcap"><b>Figure 1 </b>Header fields of the response to the request for obtaining a user token</span><br><span><img id="cts_api_0024__en-us_topic_0181150977_image48651610135113" src="en-us_image_0000001866649757.png" title="Click to enlarge" class="imgResize"></span></div>
|
|
</div>
|
|
<div class="section" id="cts_api_0024__en-us_topic_0181150977_section034615592583"><h4 class="sectiontitle">Response Body (Optional)</h4><p id="cts_api_0024__en-us_topic_0181150977_p133921631940">The body of a response is often returned in structured format as specified in the <strong id="cts_api_0024__en-us_topic_0181150977_b26414111015">Content-type</strong> header field. The response body transfers content except the response header.</p>
|
|
<p id="cts_api_0024__en-us_topic_0181150977_p157041652367">The following is part of the response body for the API used to obtain a user token.</p>
|
|
<pre class="screen" id="cts_api_0024__en-us_topic_0181150977_screen65818201917">{
|
|
"token": {
|
|
"expires_at": "2019-02-13T06:52:13.855000Z",
|
|
"methods": [
|
|
"password"
|
|
],
|
|
"catalog": [
|
|
{
|
|
"endpoints": [
|
|
{
|
|
"region_id": "az-01",
|
|
......</pre>
|
|
<p id="cts_api_0024__en-us_topic_0181150977_p127537375412">If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.</p>
|
|
<pre class="screen" id="cts_api_0024__en-us_topic_0181150977_screen102091730125513">{
|
|
"error_msg": "The format of message is error",
|
|
"error_code": "AS.0001"
|
|
}</pre>
|
|
<p id="cts_api_0024__en-us_topic_0181150977_p1589911464018">In the response body, <strong id="cts_api_0024__en-us_topic_0181150977_b7967251044">error_code</strong> is an error code, and <strong id="cts_api_0024__en-us_topic_0181150977_b697225541">error_msg</strong> provides information about the error.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="cts_api_0006.html">Calling APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<script language="JavaScript">
|
|
<!--
|
|
image_size('.imgResize');
|
|
var msg_imageMax = "view original image";
|
|
var msg_imageClose = "close";
|
|
//--></script> |