forked from docs/doc-exports
qiujiandong1
535e30e292
Reviewed-by: Gergo-Bence Lorincz <a200452876@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: qiujiandong1 <qiujiandong1@huawei.com> Co-committed-by: qiujiandong1 <qiujiandong1@huawei.com>
60 lines
6.6 KiB
HTML
60 lines
6.6 KiB
HTML
<a name="ucs_api_0010"></a><a name="ucs_api_0010"></a>
|
|
|
|
<h1 class="topictitle1">Response</h1>
|
|
<div id="body0000001506054465"><div class="section" id="ucs_api_0010__en-us_topic_0170155703_section968114282311"><h4 class="sectiontitle">Status Code</h4><p id="ucs_api_0010__en-us_topic_0170155703_p4624111624411">After sending a request, you will receive a response, including a status code, response header, and response body.</p>
|
|
<p id="ucs_api_0010__en-us_topic_0170155703_p124381044137">A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see <a href="ucs_api_0016.html">Status Codes</a>.</p>
|
|
<p id="ucs_api_0010__en-us_topic_0170155703_p2861496519">For example, if status code <span class="parmvalue" id="ucs_api_0010__parmvalue127731734154617"><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="ucs_api_0010__en-us_topic_0170155703_en-us_topic_0113746487_section61333484715"><h4 class="sectiontitle">Response Header</h4><p id="ucs_api_0010__en-us_topic_0170155703_p384320471837">Similar to a request, a response also has a header, for example, <strong id="ucs_api_0010__en-us_topic_0170155703_b1985552133610">Content-Type</strong>.</p>
|
|
<p id="ucs_api_0010__en-us_topic_0170155703_p4430113619484"><a href="#ucs_api_0010__en-us_topic_0170155703_fig4865141011511">Figure 1</a> shows the response header fields for the API used to obtain a user token. The <strong id="ucs_api_0010__b623772585018">X-Subject-Token</strong> header field is the desired user token. This token can then be used to authenticate the calling of other APIs.</p>
|
|
<div class="note" id="ucs_api_0010__en-us_topic_0170155703_note29537174719"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="ucs_api_0010__en-us_topic_0170155703_p595414144718">For security purposes, you are advised to set the token in ciphertext in configuration files or environment variables and decrypt it when using it.</p>
|
|
</div></div>
|
|
<div class="fignone" id="ucs_api_0010__en-us_topic_0170155703_fig4865141011511"><a name="ucs_api_0010__en-us_topic_0170155703_fig4865141011511"></a><a name="en-us_topic_0170155703_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="ucs_api_0010__en-us_topic_0170155703_image1197523984615" src="en-us_image_0000002302431861.png"></span></div>
|
|
</div>
|
|
<div class="section" id="ucs_api_0010__en-us_topic_0170155703_en-us_topic_0113746487_section2045571671419"><h4 class="sectiontitle">(Optional) Response Body</h4><p id="ucs_api_0010__en-us_topic_0170155703_en-us_topic_0113746487_p64711881416">The body of a response is often returned in structured format (for example, JSON or XML) as specified in the <strong id="ucs_api_0010__b172451451165113">Content-Type</strong> header field. The response body transfers content except the response header.</p>
|
|
</div>
|
|
<p id="ucs_api_0010__en-us_topic_0170155703_p157041652367">The following shows part of the response body for the API used to obtain a user token.</p>
|
|
<div class="codecoloring" codetype="Java" id="ucs_api_0010__en-us_topic_0170155703_screen65818201917"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal"> 1</span>
|
|
<span class="normal"> 2</span>
|
|
<span class="normal"> 3</span>
|
|
<span class="normal"> 4</span>
|
|
<span class="normal"> 5</span>
|
|
<span class="normal"> 6</span>
|
|
<span class="normal"> 7</span>
|
|
<span class="normal"> 8</span>
|
|
<span class="normal"> 9</span>
|
|
<span class="normal">10</span>
|
|
<span class="normal">11</span>
|
|
<span class="normal">12</span></pre></div></td><td class="code"><div><pre><span></span><span class="p">{</span>
|
|
<span class="w"> </span><span class="s">"token"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
|
<span class="w"> </span><span class="s">"expires_at"</span><span class="p">:</span><span class="w"> </span><span class="s">"2019-02-13T06:52:13.855000Z"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="s">"methods"</span><span class="p">:</span><span class="w"> </span><span class="o">[</span>
|
|
<span class="w"> </span><span class="s">"password"</span>
|
|
<span class="w"> </span><span class="o">]</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="s">"catalog"</span><span class="p">:</span><span class="w"> </span><span class="o">[</span>
|
|
<span class="w"> </span><span class="p">{</span>
|
|
<span class="w"> </span><span class="s">"endpoints"</span><span class="p">:</span><span class="w"> </span><span class="o">[</span>
|
|
<span class="w"> </span><span class="p">{</span>
|
|
<span class="w"> </span><span class="s">"region_id"</span><span class="p">:</span><span class="w"> </span><span class="s">"az-01"</span><span class="p">,</span>
|
|
<span class="p">......</span>
|
|
</pre></div></td></tr></table></div>
|
|
</div>
|
|
<p id="ucs_api_0010__en-us_topic_0170155703_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>
|
|
<div class="codecoloring" codetype="Java" id="ucs_api_0010__en-us_topic_0170155703_screen102091730125513"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
|
|
<span class="normal">2</span>
|
|
<span class="normal">3</span>
|
|
<span class="normal">4</span></pre></div></td><td class="code"><div><pre><span></span><span class="p">{</span>
|
|
<span class="w"> </span><span class="s">"error_msg"</span><span class="p">:</span><span class="w"> </span><span class="s">"The request message format is invalid."</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="s">"error_code"</span><span class="p">:</span><span class="w"> </span><span class="s">"IMG.0001"</span>
|
|
<span class="p">}</span>
|
|
</pre></div></td></tr></table></div>
|
|
</div>
|
|
<p id="ucs_api_0010__en-us_topic_0170155703_p1589911464018">In the response body, <strong id="ucs_api_0010__en-us_topic_0170155703_b1022472112479">error_code</strong> is an error code, and <strong id="ucs_api_0010__en-us_topic_0170155703_b18234321154714">error_msg</strong> provides information about the error.</p>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="ucs_api_0007.html">Calling APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|