vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/mrs/api-ref/mrs_02_1019.html
Yang, Tong f1bf1560d6 MRS API Doc 20240802 version 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Yang, Tong <yangtong2@huawei.com>
Co-committed-by: Yang, Tong <yangtong2@huawei.com>
2024-09-28 19:01:52 +00:00

212 lines
26 KiB
HTML
Raw Blame History

<a name="mrs_02_1019"></a><a name="mrs_02_1019"></a>
<h1 class="topictitle1">Introduction to MRS Manager APIs</h1>
<div id="body8662426"><p id="mrs_02_1019__en-us_topic_0125376273_p16836121455419">MRS Manager APIs are provided for you to query basic information about MRS clusters and monitoring status, as well as start and stop services.</p>
<p id="mrs_02_1019__en-us_topic_0125376273_p1283691419541">MRS Manager APIs can be accessed by only nodes in the same VPC as the cluster.</p>
<p id="mrs_02_1019__en-us_topic_0125376273_p5836171455415">Clusters with Kerberos authentication disabled can directly call MRS Manager APIs in the same VPC for access. However, clusters with Kerberos authentication enabled must obtain authentication information before calling MRS Manager APIs.</p>
<p id="mrs_02_1019__en-us_topic_0125376273_aeb2ee03e169641419140ded99288a024">An MRS Manager API request/response consists of the following six parts:</p>
<ul id="mrs_02_1019__en-us_topic_0125376273_ul112091650115719"><li id="mrs_02_1019__en-us_topic_0125376273_li18209650105719">Request URI</li><li id="mrs_02_1019__en-us_topic_0125376273_li38188616585">Request mode</li><li id="mrs_02_1019__en-us_topic_0125376273_li143152445915">Request header</li><li id="mrs_02_1019__en-us_topic_0125376273_li1164219535598">Request body</li><li id="mrs_02_1019__en-us_topic_0125376273_li14667822523">Response header</li><li id="mrs_02_1019__en-us_topic_0125376273_li2015220491921">Response body</li></ul>
<div class="section" id="mrs_02_1019__en-us_topic_0125376273_section181761234145413"><h4 class="sectiontitle">Request URI</h4><p id="mrs_02_1019__en-us_topic_0125376273_a6c00ef9f418b45ae96fe445121955fea">A request URI is in the following format:</p>
<p id="mrs_02_1019__en-us_topic_0125376273_ab6cefc7047344a76afb6285a972c4638"><strong id="mrs_02_1019__en-us_topic_0125376273_ab2b228915f2b4dad88adff64bed832f3">{URI-scheme} :// {<strong id="mrs_02_1019__en-us_topic_0125376273_b8541162311332">MRS </strong>Manager<strong id="mrs_02_1019__en-us_topic_0125376273_b2054120232335"> floating IP address</strong>} <strong id="mrs_02_1019__en-us_topic_0125376273_abe9c1f0324ed4a3bafb1eac9a67bc78d"> :{MRS Manager port}</strong>/ {resource-path} ? {query-string}</strong></p>
<p id="mrs_02_1019__en-us_topic_0125376273_a67a7a812e9f64fc9a9d654ff0d99f56b">Although the request URI is included in the request header, most languages or frameworks require that it be transmitted separately from the request message. Therefore, the request URI is listed independently.</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_1019__en-us_topic_0125376273_t85220210b39647cf81d6a6d96190b3f4" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter description</caption><thead align="left"><tr id="mrs_02_1019__en-us_topic_0125376273_re65b80dc13aa433687077590004f8f31"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.5.2.3.1.1"><p id="mrs_02_1019__en-us_topic_0125376273_abe4e57c399174c5fbff74084162f1e8b">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="80%" id="mcps1.3.6.5.2.3.1.2"><p id="mrs_02_1019__en-us_topic_0125376273_ab9cddd12f37b40979f76eb56011032e5">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_1019__en-us_topic_0125376273_rda9d445b3100462aac07fcb6ec45b563"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.5.2.3.1.1 "><p id="mrs_02_1019__en-us_topic_0125376273_a54b4acac0c9740b1adf56b7af78d4db7">URI-scheme</p>
</td>
<td class="cellrowborder" valign="top" width="80%" headers="mcps1.3.6.5.2.3.1.2 "><p id="mrs_02_1019__en-us_topic_0125376273_ad4b25d7b521c40868fe7852f95b100e8">Protocol used to transmit requests. HTTPS must be used in MRS APIs.</p>
</td>
</tr>
<tr id="mrs_02_1019__en-us_topic_0125376273_ra308b02302184d10ad75a581194c47a2"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.5.2.3.1.1 "><p id="mrs_02_1019__en-us_topic_0125376273_p204706360336">MRS Manager floating IP address</p>
</td>
<td class="cellrowborder" valign="top" width="80%" headers="mcps1.3.6.5.2.3.1.2 "><p id="mrs_02_1019__en-us_topic_0125376273_p1382395814334">IP address for logging in to MRS Manager.</p>
<p id="mrs_02_1019__en-us_topic_0125376273_p782314583331">For clusters that support Kerberos authentication (security clusters), the floating IP address (cluster console address) of the cluster is displayed on the basic cluster information page.</p>
<p id="mrs_02_1019__en-us_topic_0125376273_p1282365813317">For a non-security cluster that does not support Kerberos authentication, you can log in to the Master2 node of the cluster <a href="https://docs.otc.t-systems.com/usermanual/mrs/mrs_01_0083.html" target="_blank" rel="noopener noreferrer">using VNC</a> and run the <strong id="mrs_02_1019__b176455350554">ifconfig </strong>command to view the floating IP address of the cluster. <strong id="mrs_02_1019__b1664613352552">eth0:wsom</strong> indicates the floating IP address of MRS Manager. The value of the <strong id="mrs_02_1019__b1064618356556">inet </strong>parameter is the floating IP address.</p>
<div class="note" id="mrs_02_1019__en-us_topic_0125376273_note166919272362"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="mrs_02_1019__en-us_topic_0125376273_p176922270363">If the floating IP address of MRS Manager cannot be queried on the Master2 node, switch to the Master1 node to query and record the floating IP address.</p>
</div></div>
</td>
</tr>
<tr id="mrs_02_1019__en-us_topic_0125376273_row15259361664"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.5.2.3.1.1 "><p id="mrs_02_1019__en-us_topic_0125376273_p252117171633">MRS Manager port</p>
</td>
<td class="cellrowborder" valign="top" width="80%" headers="mcps1.3.6.5.2.3.1.2 "><p id="mrs_02_1019__en-us_topic_0125376273_p552181711316">Port number for logging in to the MRS Manager. The default value is <strong id="mrs_02_1019__b1548012412403">28443</strong>.</p>
</td>
</tr>
<tr id="mrs_02_1019__en-us_topic_0125376273_r9025f4bb60c24d2895d4abf942f61f95"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.5.2.3.1.1 "><p id="mrs_02_1019__en-us_topic_0125376273_a15ff34de37184f04856ba021a6d96f89">resource-path</p>
</td>
<td class="cellrowborder" valign="top" width="80%" headers="mcps1.3.6.5.2.3.1.2 "><p id="mrs_02_1019__en-us_topic_0125376273_a35f85cbdd89b4e95bf243bd51cf3aefa">The path for accessing an API. Obtain the value from the URI of the API, for example, <strong id="mrs_02_1019__b144345810452849">v3/auth/tokens</strong>.</p>
</td>
</tr>
<tr id="mrs_02_1019__en-us_topic_0125376273_r2d8c4aa44a1647e9b5e33f9c307699d5"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.5.2.3.1.1 "><p id="mrs_02_1019__en-us_topic_0125376273_ab838f891ab5c492daf9c565ba0eaf91d">Query string</p>
</td>
<td class="cellrowborder" valign="top" width="80%" headers="mcps1.3.6.5.2.3.1.2 "><p id="mrs_02_1019__en-us_topic_0125376273_af7c1f60a9272459f9da3b3840c6d9835">Optional. For example, API version or resource selection criterion.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="mrs_02_1019__en-us_topic_0125376273_section1437511065519"><h4 class="sectiontitle">Request Mode</h4><p id="mrs_02_1019__en-us_topic_0125376273_a951435da59ef4e7fb2d48cd4d8d3c6c5">HTTP-based request methods, which are also called operations or actions, specify the type of operations that you are requesting.</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_1019__en-us_topic_0125376273_t918bb5e59b134a739192f8838a37b071" frame="border" border="1" rules="all"><caption><b>Table 2 </b>HTTP method</caption><thead align="left"><tr id="mrs_02_1019__en-us_topic_0125376273_r93e35e0d6bc74d99b6a63f509792c214"><th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.7.3.2.3.1.1"><p id="mrs_02_1019__en-us_topic_0125376273_a4f5d6e9c022a42b0bd1fe3ef73b88372">Method</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="82%" id="mcps1.3.7.3.2.3.1.2"><p id="mrs_02_1019__en-us_topic_0125376273_a320567a925b74bb5b677cb12c2ad9933">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_1019__en-us_topic_0125376273_r67e6bb4864e747528497c8256034803c"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.7.3.2.3.1.1 "><p id="mrs_02_1019__en-us_topic_0125376273_ab4f8d722d29c431cb33cc9edd77c7f78">GET</p>
</td>
<td class="cellrowborder" valign="top" width="82%" headers="mcps1.3.7.3.2.3.1.2 "><p id="mrs_02_1019__en-us_topic_0125376273_a762afdfc07ae4639a252c46e1197a442">Requests the server to return specified resources.</p>
</td>
</tr>
<tr id="mrs_02_1019__en-us_topic_0125376273_r0ca064b7961348b183edf354cac8f1ce"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.7.3.2.3.1.1 "><p id="mrs_02_1019__en-us_topic_0125376273_a7367944bac5a4e81b99773b5938a8434">PUT</p>
</td>
<td class="cellrowborder" valign="top" width="82%" headers="mcps1.3.7.3.2.3.1.2 "><p id="mrs_02_1019__en-us_topic_0125376273_a626f067da1e34c109f38ee6e642ac4d0">Requests the server to update specified resources.</p>
</td>
</tr>
<tr id="mrs_02_1019__en-us_topic_0125376273_r60c6a5fbb933424da2c292f5457325a5"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.7.3.2.3.1.1 "><p id="mrs_02_1019__en-us_topic_0125376273_ac8c9934549344144b06bf2466a1b7437">POST</p>
</td>
<td class="cellrowborder" valign="top" width="82%" headers="mcps1.3.7.3.2.3.1.2 "><p id="mrs_02_1019__en-us_topic_0125376273_a85ca21ab62db4ff38d18ae02611507e8">Requests the server to add resources or perform special operations.</p>
</td>
</tr>
<tr id="mrs_02_1019__en-us_topic_0125376273_rd3ad4679acb3476e89e8e5183d330008"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.7.3.2.3.1.1 "><p id="mrs_02_1019__en-us_topic_0125376273_aeda3833ce0d444d1a19b6aa15759c356">DELETE</p>
</td>
<td class="cellrowborder" valign="top" width="82%" headers="mcps1.3.7.3.2.3.1.2 "><p id="mrs_02_1019__en-us_topic_0125376273_a26bf4ce5b4414338a67aac5e639e5c69">Requests the server to delete specified resources, for example, an object.</p>
</td>
</tr>
<tr id="mrs_02_1019__en-us_topic_0125376273_rebfda88fee954bc2b14c8d59cd490d80"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.7.3.2.3.1.1 "><p id="mrs_02_1019__en-us_topic_0125376273_a6a250d64328c4a3bb7972fd24654fd76">HEAD</p>
</td>
<td class="cellrowborder" valign="top" width="82%" headers="mcps1.3.7.3.2.3.1.2 "><p id="mrs_02_1019__en-us_topic_0125376273_a849d9e541ecc42d39325707e7fc447ef">Same as GET except that the server must return only the response header.</p>
</td>
</tr>
<tr id="mrs_02_1019__en-us_topic_0125376273_r531bd60ebe934ca7b358c8559ff2d68e"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.7.3.2.3.1.1 "><p id="mrs_02_1019__en-us_topic_0125376273_a3ddbfe77ed05471db32a101167690c2f">PATCH</p>
</td>
<td class="cellrowborder" valign="top" width="82%" headers="mcps1.3.7.3.2.3.1.2 "><p id="mrs_02_1019__en-us_topic_0125376273_a7817e14c4815436dbde219726c16cb63">Requests the server to update partial content of a specified resource.</p>
<p id="mrs_02_1019__en-us_topic_0125376273_aeaddfbe2d7904c3bba28c2b4b3825702">If the resource does not exist, a new resource will be created.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="mrs_02_1019__en-us_topic_0125376273_section559515309552"><h4 class="sectiontitle">Request Header</h4><p id="mrs_02_1019__en-us_topic_0125376273_abb6126d236884cdd83af3463e5162cf4">A request header consists of several header fields. Each header field consists of a field name, a colon (:), and a field value.</p>
<p id="mrs_02_1019__en-us_topic_0125376273_a73ee2a1aec814c23ac0404e0e816ff19">Optional additional request header field, such as the field required by a specified URI and HTTP method. <a href="#mrs_02_1019__en-us_topic_0125376273_tb3f5c5f3dfb84fce8aa08057e60545ac">Table 3</a> lists common MRS request headers. For details about the request authentication information, see <a href="mrs_02_0009.html">Authentication</a>.</p>
<div class="tablenoborder"><a name="mrs_02_1019__en-us_topic_0125376273_tb3f5c5f3dfb84fce8aa08057e60545ac"></a><a name="en-us_topic_0125376273_tb3f5c5f3dfb84fce8aa08057e60545ac"></a><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_1019__en-us_topic_0125376273_tb3f5c5f3dfb84fce8aa08057e60545ac" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Common request header fields</caption><thead align="left"><tr id="mrs_02_1019__en-us_topic_0125376273_rb849972ee8c74d759f6fc8b86a8a57e6"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.8.4.2.5.1.1"><p id="mrs_02_1019__en-us_topic_0125376273_a5c386b98502a4beda950b89d96464acb">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.8.4.2.5.1.2"><p id="mrs_02_1019__en-us_topic_0125376273_a138f26b2335841e7ae1fad7e1d2de58b">Description</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.8.4.2.5.1.3"><p id="mrs_02_1019__en-us_topic_0125376273_aade48220e5ef4b9bafbbdcc325a5ff7e">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.8.4.2.5.1.4"><p id="mrs_02_1019__en-us_topic_0125376273_aaefeba1a15d540dfadb3af89c308d430">Example</p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_1019__en-us_topic_0125376273_r501d9bd22d71407084ad2a83519c07a0"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.8.4.2.5.1.1 "><p id="mrs_02_1019__en-us_topic_0125376273_a6819cb341451482d91da271099efbbe5">Content-type</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.8.4.2.5.1.2 "><p id="mrs_02_1019__en-us_topic_0125376273_a18121bc2f94b4a29b6380ec935976930">Specifies the request body MIME type.</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.8.4.2.5.1.3 "><p id="mrs_02_1019__en-us_topic_0125376273_a46beafbd500e4fa58eed8e5001bfb4e1">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.8.4.2.5.1.4 "><p id="mrs_02_1019__en-us_topic_0125376273_a4fbe73e0b8ab4566afe028afe4b086e4">application/json</p>
</td>
</tr>
<tr id="mrs_02_1019__en-us_topic_0125376273_r62435759348941618d567c93e0bd8e05"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.8.4.2.5.1.1 "><p id="mrs_02_1019__en-us_topic_0125376273_a0635f1e462f34d5aa097fc8d31f98b71">Content-Length</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.8.4.2.5.1.2 "><p id="mrs_02_1019__en-us_topic_0125376273_a70178e8313944911997e5789736c231a">Specifies the length of the request body. The unit is byte.</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.8.4.2.5.1.3 "><p id="mrs_02_1019__en-us_topic_0125376273_a7be62605f4254a53b504c35f19f99385">This field is mandatory for POST and PUT requests, but must be left blank for GET requests.</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.8.4.2.5.1.4 "><p id="mrs_02_1019__en-us_topic_0125376273_aba00e8e59f394f0397ab067e18a6ed64">3495</p>
</td>
</tr>
<tr id="mrs_02_1019__en-us_topic_0125376273_rf226614952f44dc3bf8dca12e52b6003"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.8.4.2.5.1.1 "><p id="mrs_02_1019__en-us_topic_0125376273_a0bdd89f7dc6342699176779e2dc28605">X-Language</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.8.4.2.5.1.2 "><p id="mrs_02_1019__en-us_topic_0125376273_a75295e940ff74f35a18f170341929c21">Request language. The options are as follows:</p>
<p id="mrs_02_1019__p18382718182717"><strong id="mrs_02_1019__b119645142652849">en-us</strong>: English</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.8.4.2.5.1.3 "><p id="mrs_02_1019__en-us_topic_0125376273_a3422981cd66b4db08489b0b7b5d9dc25">No</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.8.4.2.5.1.4 "><p id="mrs_02_1019__en-us_topic_0125376273_a1983da4704c44a4ca611ccba526868a2">en-us</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="mrs_02_1019__en-us_topic_0125376273_n6d90240925f94398af6c330d5f549968"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="mrs_02_1019__en-us_topic_0125376273_en-us_topic_0110581851_p256226594657">For details about other headers, see the HTTP protocol.</p>
</div></div>
</div>
<div class="section" id="mrs_02_1019__en-us_topic_0125376273_section1692615591277"><h4 class="sectiontitle">Request Body</h4><p id="mrs_02_1019__en-us_topic_0125376273_a86b17a73645940e096745b17e6371a43">A request body is generally sent in a structured format (for example, JSON or XML). It corresponds to <strong id="mrs_02_1019__b84235270693832">Content-type</strong> in the request header and is used to transfer content other than the request header.</p>
</div>
<div class="section" id="mrs_02_1019__en-us_topic_0125376273_section33899391911"><h4 class="sectiontitle">Response Header</h4><p id="mrs_02_1019__en-us_topic_0125376273_aadeeed00ea7e4f69ac76b9875c0e6ce0">A response header contains the following parts:</p>
<ul id="mrs_02_1019__en-us_topic_0125376273_ua7a1a41ad5264620ac745a1fe8c7feff"><li id="mrs_02_1019__en-us_topic_0125376273_lb1488ce2105b41b68c67be71bf6cd94e">HTTP status code, which consists of three digits (2<em id="mrs_02_1019__i66519803652849">xx</em> to 5<em id="mrs_02_1019__i156681323352849">xx</em>). 2<em id="mrs_02_1019__i83661352552849">xx</em> indicates a success response. 4<em id="mrs_02_1019__i45939564552849">xx</em> or 5<em id="mrs_02_1019__i20540319252849">xx</em> indicates a failure response; Alternatively, a service-defined status code may be returned, as described in this document.</li><li id="mrs_02_1019__en-us_topic_0125376273_l2c4184e773f04ae9831ea1c2ab1bf9e0">Optional additional header fields to support the request's response, such as <strong id="mrs_02_1019__b53540452849">Content-type</strong>. For details about common message headers, see <a href="#mrs_02_1019__en-us_topic_0125376273_ta1929fc30fc14e1ebf1cf848648c76d8">Table 4</a>.
<div class="tablenoborder"><a name="mrs_02_1019__en-us_topic_0125376273_ta1929fc30fc14e1ebf1cf848648c76d8"></a><a name="en-us_topic_0125376273_ta1929fc30fc14e1ebf1cf848648c76d8"></a><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_1019__en-us_topic_0125376273_ta1929fc30fc14e1ebf1cf848648c76d8" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Common response headers</caption><thead align="left"><tr id="mrs_02_1019__en-us_topic_0125376273_re807ee13e4a14507ae7eb50ee27e6243"><th align="left" class="cellrowborder" valign="top" width="24.27%" id="mcps1.3.10.3.2.3.2.5.1.1"><p id="mrs_02_1019__en-us_topic_0125376273_a41658ca83f064ebfb02c33c5be0e703e">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="36.22%" id="mcps1.3.10.3.2.3.2.5.1.2"><p id="mrs_02_1019__en-us_topic_0125376273_ae358ccf6b18542ab9bbc4e296d2ac355">Description</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.3.10.3.2.3.2.5.1.3"><p id="mrs_02_1019__en-us_topic_0125376273_p1856132214418">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="31.990000000000002%" id="mcps1.3.10.3.2.3.2.5.1.4"><p id="mrs_02_1019__en-us_topic_0125376273_ab90bc0aeea65400689bcf5116c65b5a0">Examples</p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_1019__en-us_topic_0125376273_re2211cb0f9e14e8599f835744a3f5a4f"><td class="cellrowborder" valign="top" width="24.27%" headers="mcps1.3.10.3.2.3.2.5.1.1 "><p id="mrs_02_1019__en-us_topic_0125376273_aa8cc5be1a1994ae9af561f4cf4345478">Date</p>
</td>
<td class="cellrowborder" valign="top" width="36.22%" headers="mcps1.3.10.3.2.3.2.5.1.2 "><p id="mrs_02_1019__en-us_topic_0125376273_a6e285d2b752f4170bcd72ee8c33c6e9c">(Standard HTTP header). The time when a response is sent, whose format follows RFC 822.</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.3.10.3.2.3.2.5.1.3 "><p id="mrs_02_1019__en-us_topic_0125376273_p1058172284413">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="31.990000000000002%" headers="mcps1.3.10.3.2.3.2.5.1.4 "><p id="mrs_02_1019__en-us_topic_0125376273_ae93a6c395cbd4826b64e6a9827cd6b0e">Mon, 12 Nov 2007 15:55:01 GMT</p>
</td>
</tr>
<tr id="mrs_02_1019__en-us_topic_0125376273_r8d9260b7191f4f6c9930201ee3101392"><td class="cellrowborder" valign="top" width="24.27%" headers="mcps1.3.10.3.2.3.2.5.1.1 "><p id="mrs_02_1019__en-us_topic_0125376273_a651a11db80104697b6c3c30c95bc263d">Server</p>
</td>
<td class="cellrowborder" valign="top" width="36.22%" headers="mcps1.3.10.3.2.3.2.5.1.2 "><p id="mrs_02_1019__en-us_topic_0125376273_ad99f967ef9ca48a9aa9087694af86a8e">(Standard HTTP header). The software information that the server uses to process the request</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.3.10.3.2.3.2.5.1.3 "><p id="mrs_02_1019__en-us_topic_0125376273_p195816222444">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="31.990000000000002%" headers="mcps1.3.10.3.2.3.2.5.1.4 "><p id="mrs_02_1019__en-us_topic_0125376273_a37374b1afb104a2a9cc43931bc9c5cca">Apache</p>
</td>
</tr>
<tr id="mrs_02_1019__en-us_topic_0125376273_rbe41f12a5f26406eb43cd43e5ced0e88"><td class="cellrowborder" valign="top" width="24.27%" headers="mcps1.3.10.3.2.3.2.5.1.1 "><p id="mrs_02_1019__en-us_topic_0125376273_ade016caaf4954370b7f53b48540d365b">Content-Length</p>
</td>
<td class="cellrowborder" valign="top" width="36.22%" headers="mcps1.3.10.3.2.3.2.5.1.2 "><p id="mrs_02_1019__en-us_topic_0125376273_a523d3a520c104dc694a5bbc70056d308">(Standard HTTP header). The size of a message body in decimal number of bytes</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.3.10.3.2.3.2.5.1.3 "><p id="mrs_02_1019__en-us_topic_0125376273_p14581822124416">No</p>
</td>
<td class="cellrowborder" valign="top" width="31.990000000000002%" headers="mcps1.3.10.3.2.3.2.5.1.4 "><p id="mrs_02_1019__en-us_topic_0125376273_ae65ca61be58e4e0a94e6d02fc9234468">xxx</p>
</td>
</tr>
<tr id="mrs_02_1019__en-us_topic_0125376273_rb698600904774d098bde430fa0e484c5"><td class="cellrowborder" valign="top" width="24.27%" headers="mcps1.3.10.3.2.3.2.5.1.1 "><p id="mrs_02_1019__en-us_topic_0125376273_a916851eb6c8d4b1fb5507470a678180a">Content-type</p>
</td>
<td class="cellrowborder" valign="top" width="36.22%" headers="mcps1.3.10.3.2.3.2.5.1.2 "><p id="mrs_02_1019__en-us_topic_0125376273_a2176f3a4392247d0a68ab4c59bb60a61">(Standard HTTP header) Media type of the message body sent to a receiver</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.3.10.3.2.3.2.5.1.3 "><p id="mrs_02_1019__en-us_topic_0125376273_p16581822194418">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="31.990000000000002%" headers="mcps1.3.10.3.2.3.2.5.1.4 "><p id="mrs_02_1019__en-us_topic_0125376273_a8301f9bb0b9248da88e5ce4ee91fb092">application/json</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="mrs_02_1019__en-us_topic_0125376273_section186021620141012"><h4 class="sectiontitle">Response Body</h4><p id="mrs_02_1019__en-us_topic_0125376273_a0ef370ca24a8435c942c2dfb5031b692">A response body is generally returned in a structured format (for example, JSON or XML). It corresponds to <strong id="mrs_02_1019__b842352706144729">Content-type</strong> in the response header and is used to transfer content other than the response header.</p>
</div>
<div class="section" id="mrs_02_1019__en-us_topic_0125376273_section17323144941019"><h4 class="sectiontitle">Initiating a Request</h4><p id="mrs_02_1019__en-us_topic_0125376273_a0b13016cf8864ce8a86f2a47efe9eb23">You can initiate a request based on the constructed request message using any of the following:</p>
<ul id="mrs_02_1019__en-us_topic_0125376273_uaa72c56e085b4b3ca7cb163cd11b3053"><li id="mrs_02_1019__en-us_topic_0125376273_l3b5a6c22ccfb406ca76ff070409b409a">cURL<p id="mrs_02_1019__en-us_topic_0125376273_adfbab56ceba54d1cb55ded1ed653d776"><a name="mrs_02_1019__en-us_topic_0125376273_l3b5a6c22ccfb406ca76ff070409b409a"></a><a name="en-us_topic_0125376273_l3b5a6c22ccfb406ca76ff070409b409a"></a>cURL is a command-line tool used to perform URL operations and transmit information. It serves as an HTTP client that can send HTTP requests to the server and receive response messages. cURL is applicable to API debugging. For more information about cURL, visit <a href="https://curl.haxx.se/" target="_blank" rel="noopener noreferrer">https://curl.haxx.se/</a>.</p>
</li><li id="mrs_02_1019__en-us_topic_0125376273_lf613a0108a8c4526a927ef397d38bc0f">Encoding<p id="mrs_02_1019__en-us_topic_0125376273_a51ce5d1372cf4ef8ba053e48b9c55687"><a name="mrs_02_1019__en-us_topic_0125376273_lf613a0108a8c4526a927ef397d38bc0f"></a><a name="en-us_topic_0125376273_lf613a0108a8c4526a927ef397d38bc0f"></a>You can call APIs using code to assemble, send, and process request messages.</p>
</li><li id="mrs_02_1019__en-us_topic_0125376273_l05402a75bbcd44ce83c6ff08ac4e0bd1">REST client<p id="mrs_02_1019__en-us_topic_0125376273_a816dcfaad7b84d81b659704ba866dff0"><a name="mrs_02_1019__en-us_topic_0125376273_l05402a75bbcd44ce83c6ff08ac4e0bd1"></a><a name="en-us_topic_0125376273_l05402a75bbcd44ce83c6ff08ac4e0bd1"></a>Both Mozilla Firefox and Google Chrome provide a graphical browser plug-in, that is, REST client, to send and process requests. For Mozilla Firefox, see <a href="https://addons.mozilla.org/en-US/firefox/addon/rest-client-apishub/" target="_blank" rel="noopener noreferrer">Firefox REST Client</a>. For Google Chrome, see <a href="https://code.google.com/archive/p/rest-client" target="_blank" rel="noopener noreferrer">Chrome REST Client</a>.</p>
</li></ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="mrs_02_1018.html">API Usage Guide</a></div>
</div>
</div>
View Git Blame Copy Permalink