forked from docs/doc-exports
Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com> Co-authored-by: Li, Qiao <qiaoli@huawei.com> Co-committed-by: Li, Qiao <qiaoli@huawei.com>
555 lines
44 KiB
HTML
555 lines
44 KiB
HTML
<a name="Sign"></a><a name="Sign"></a>
|
|
|
|
<h1 class="topictitle1">Signing Data</h1>
|
|
<div id="body8662426"><div class="section" id="Sign__en-us_topic_0000001294348474_section28715185330"><h4 class="sectiontitle">Function</h4><ul id="Sign__en-us_topic_0000001294348474_ul158731814338"><li id="Sign__en-us_topic_0000001294348474_li188719186332">This API is used to use the private key of an asymmetric key to digitally sign a message or digest.</li></ul>
|
|
</div>
|
|
<div class="section" id="Sign__en-us_topic_0000001294348474_section198871815331"><h4 class="sectiontitle">Constraints</h4><ul id="Sign__en-us_topic_0000001294348474_ul178813186333"><li id="Sign__en-us_topic_0000001294348474_li1288121815336">Only the asymmetric key whose <strong id="Sign__en-us_topic_0000001294348474_b484417172446">key_usage</strong> is <strong id="Sign__en-us_topic_0000001294348474_b12967192113449">SIGN_VERIFY</strong> can be used for signature.</li></ul>
|
|
</div>
|
|
<div class="section" id="Sign__en-us_topic_0000001294348474_section18891718113319"><h4 class="sectiontitle">URI</h4><p id="Sign__en-us_topic_0000001294348474_p58918183331">POST /v1.0/{project_id}/kms/sign</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="Sign__en-us_topic_0000001294348474_table1590171873312" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="Sign__en-us_topic_0000001294348474_row118951863311"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="Sign__en-us_topic_0000001294348474_p1490111818332">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="Sign__en-us_topic_0000001294348474_p69011863318">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="Sign__en-us_topic_0000001294348474_p19161843317">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="Sign__en-us_topic_0000001294348474_p991201815331">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="Sign__en-us_topic_0000001294348474_row189118203315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="Sign__en-us_topic_0000001294348474_p491218193319">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="Sign__en-us_topic_0000001294348474_p20917184338">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="Sign__en-us_topic_0000001294348474_p39181813339">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="Sign__en-us_topic_0000001294348474_p392218203312">Project ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="Sign__en-us_topic_0000001294348474_section1092111813331"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="Sign__en-us_topic_0000001294348474_en-us_topic_0000001130898006_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="Sign__en-us_topic_0000001294348474_row13923188331"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="Sign__en-us_topic_0000001294348474_p39351883318">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="Sign__en-us_topic_0000001294348474_p493718123312">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="Sign__en-us_topic_0000001294348474_p19941118173311">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="Sign__en-us_topic_0000001294348474_p59419184331">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="Sign__en-us_topic_0000001294348474_row5925186337"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="Sign__en-us_topic_0000001294348474_p1894101813313">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="Sign__en-us_topic_0000001294348474_p1294718103314">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="Sign__en-us_topic_0000001294348474_p1951818113315">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="Sign__en-us_topic_0000001294348474_p179671816337">User token. The token can be obtained by calling the IAM API. (The token is the value of <span class="parmname" id="Sign__en-us_topic_0000001294348474_parmname189961122872749"><b>X-Subject-Token</b></span> in the response header.)</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="Sign__en-us_topic_0000001294348474_en-us_topic_0000001130898006_request_SignRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameter</caption><thead align="left"><tr id="Sign__en-us_topic_0000001294348474_row996418183311"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="Sign__en-us_topic_0000001294348474_p798121819334">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="Sign__en-us_topic_0000001294348474_p17989182334">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="Sign__en-us_topic_0000001294348474_p49841810339">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="Sign__en-us_topic_0000001294348474_p3981518163313">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="Sign__en-us_topic_0000001294348474_row99651813331"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="Sign__en-us_topic_0000001294348474_p1699218103315">key_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="Sign__en-us_topic_0000001294348474_p6991718133319">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="Sign__en-us_topic_0000001294348474_p1199618173312">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="Sign__en-us_topic_0000001294348474_p699118153315">36-byte ID of a CMK that matches the regular expression <span class="parmvalue" id="Sign__en-us_topic_0000001294348474_parmvalue72956981772749"><b>^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</b></span> Example: 0d0466b0-e727-4d9c-b35d-f84bb474a37f</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="Sign__en-us_topic_0000001294348474_row15971618203315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="Sign__en-us_topic_0000001294348474_p29931820334">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="Sign__en-us_topic_0000001294348474_p1310011820331">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="Sign__en-us_topic_0000001294348474_p41001418183318">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="Sign__en-us_topic_0000001294348474_p1710010182332">Message digest or message to be signed. The message must be encoded using Base64 and be less than 4096 bytes.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="Sign__en-us_topic_0000001294348474_row159771853311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="Sign__en-us_topic_0000001294348474_p15100618173320">signing_algorithm</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="Sign__en-us_topic_0000001294348474_p51011518163310">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="Sign__en-us_topic_0000001294348474_p151011318113312">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="Sign__en-us_topic_0000001294348474_p8101181813319">Signature algorithm. Its value can be:</p>
|
|
<ul id="Sign__en-us_topic_0000001294348474_ul171011218163316"><li id="Sign__en-us_topic_0000001294348474_li210111184339">RSASSA_PSS_SHA_256</li><li id="Sign__en-us_topic_0000001294348474_li1610271863310">RSASSA_PSS_SHA_384</li><li id="Sign__en-us_topic_0000001294348474_li181022018183317">RSASSA_PSS_SHA_512</li><li id="Sign__en-us_topic_0000001294348474_li151031918193320">RSASSA_PKCS1_V1_5_SHA_256</li><li id="Sign__en-us_topic_0000001294348474_li15103518163320">RSASSA_PKCS1_V1_5_SHA_384</li><li id="Sign__en-us_topic_0000001294348474_li16103101873313">RSASSA_PKCS1_V1_5_SHA_512</li><li id="Sign__en-us_topic_0000001294348474_li121032184335">ECDSA_SHA_256</li><li id="Sign__en-us_topic_0000001294348474_li1710381813319">ECDSA_SHA_384</li><li id="Sign__en-us_topic_0000001294348474_li16104318193318">ECDSA_SHA_512</li><li id="Sign__en-us_topic_0000001294348474_li1104171893316">SM2DSA_SM3</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="Sign__en-us_topic_0000001294348474_row11971718123319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="Sign__en-us_topic_0000001294348474_p1210418186331">message_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="Sign__en-us_topic_0000001294348474_p16104318103317">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="Sign__en-us_topic_0000001294348474_p5104191811333">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="Sign__en-us_topic_0000001294348474_p11105118183313">Message type. The default value is <strong id="Sign__en-us_topic_0000001294348474_b1860718905511">DIGEST</strong>. Its value can be:</p>
|
|
<ul id="Sign__en-us_topic_0000001294348474_ul81051318143314"><li id="Sign__en-us_topic_0000001294348474_li2105161816331"><strong id="Sign__en-us_topic_0000001294348474_b136596214456">DIGEST</strong> (message digest)</li><li id="Sign__en-us_topic_0000001294348474_li1610571815337"><strong id="Sign__en-us_topic_0000001294348474_b16766318184518">RAW</strong> (original message)</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="Sign__en-us_topic_0000001294348474_row149781813319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="Sign__en-us_topic_0000001294348474_p21051518103310">sequence</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="Sign__en-us_topic_0000001294348474_p1010551853315">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="Sign__en-us_topic_0000001294348474_p110611803312">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="Sign__en-us_topic_0000001294348474_p510611812332">36-byte serial number of a request message. Example: 919c82d4-8046-4722-9094-35c3c6524cff</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="Sign__en-us_topic_0000001294348474_section1106111853317"><h4 class="sectiontitle">Response Parameters</h4><p id="Sign__en-us_topic_0000001294348474_p171069181337"><strong id="Sign__en-us_topic_0000001294348474_b11065189331">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="Sign__en-us_topic_0000001294348474_en-us_topic_0000001130898006_response_SignResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="Sign__en-us_topic_0000001294348474_row1110771833312"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="Sign__en-us_topic_0000001294348474_p110817181334">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="Sign__en-us_topic_0000001294348474_p16108131818334">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="Sign__en-us_topic_0000001294348474_p510815184337">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="Sign__en-us_topic_0000001294348474_row17107218163311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="Sign__en-us_topic_0000001294348474_p1310801816338">key_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="Sign__en-us_topic_0000001294348474_p12108111833316">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="Sign__en-us_topic_0000001294348474_p12112618153312">CMK ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="Sign__en-us_topic_0000001294348474_row910712185336"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="Sign__en-us_topic_0000001294348474_p81131182331">signature</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="Sign__en-us_topic_0000001294348474_p71137186336">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="Sign__en-us_topic_0000001294348474_p411361810339">Signature value, which is encoded using Base64</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="Sign__en-us_topic_0000001294348474_p111310183334"><strong id="Sign__en-us_topic_0000001294348474_b171141718153320">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="Sign__en-us_topic_0000001294348474_en-us_topic_0000001130898006_response_Error" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="Sign__en-us_topic_0000001294348474_row181141318113311"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.1"><p id="Sign__en-us_topic_0000001294348474_p1711531813312">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.2"><p id="Sign__en-us_topic_0000001294348474_p12115418193319">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.5.2.4.1.3"><p id="Sign__en-us_topic_0000001294348474_p61151018193318">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="Sign__en-us_topic_0000001294348474_row9114618123318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="Sign__en-us_topic_0000001294348474_p11115161853316">error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="Sign__en-us_topic_0000001294348474_p711617186337">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="Sign__en-us_topic_0000001294348474_p191161518123314">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="Sign__en-us_topic_0000001294348474_en-us_topic_0000001130898006_response_ErrorDetail" frame="border" border="1" rules="all"><caption><b>Table 6 </b>ErrorDetail</caption><thead align="left"><tr id="Sign__en-us_topic_0000001294348474_row01161618203320"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.1"><p id="Sign__en-us_topic_0000001294348474_p511711816334">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.2"><p id="Sign__en-us_topic_0000001294348474_p1511771814331">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.6.2.4.1.3"><p id="Sign__en-us_topic_0000001294348474_p1311817184336">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="Sign__en-us_topic_0000001294348474_row1211611883315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="Sign__en-us_topic_0000001294348474_p171189184333">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="Sign__en-us_topic_0000001294348474_p131182185337">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="Sign__en-us_topic_0000001294348474_p71181818143311">Error code</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="Sign__en-us_topic_0000001294348474_row1511741823316"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="Sign__en-us_topic_0000001294348474_p211818181332">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="Sign__en-us_topic_0000001294348474_p41196189335">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="Sign__en-us_topic_0000001294348474_p21199182333">Error information</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="Sign__en-us_topic_0000001294348474_p1111991833317"><strong id="Sign__en-us_topic_0000001294348474_b11119101815331">Status code: 401</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="Sign__en-us_topic_0000001294348474_table01191018163313" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="Sign__en-us_topic_0000001294348474_row18120201893312"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.8.2.4.1.1"><p id="Sign__en-us_topic_0000001294348474_p181201318123314">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.8.2.4.1.2"><p id="Sign__en-us_topic_0000001294348474_p121211618123318">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.8.2.4.1.3"><p id="Sign__en-us_topic_0000001294348474_p612120183334">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="Sign__en-us_topic_0000001294348474_row7120201811333"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.1 "><p id="Sign__en-us_topic_0000001294348474_p141211918103310">error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.2 "><p id="Sign__en-us_topic_0000001294348474_p17121318153311">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.8.2.4.1.3 "><p id="Sign__en-us_topic_0000001294348474_p7122111883320">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="Sign__en-us_topic_0000001294348474_table91221818163319" frame="border" border="1" rules="all"><caption><b>Table 8 </b>ErrorDetail</caption><thead align="left"><tr id="Sign__en-us_topic_0000001294348474_row4122118123317"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.1"><p id="Sign__en-us_topic_0000001294348474_p512311813310">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.2"><p id="Sign__en-us_topic_0000001294348474_p81231818163310">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.9.2.4.1.3"><p id="Sign__en-us_topic_0000001294348474_p151230184339">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="Sign__en-us_topic_0000001294348474_row712231812339"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="Sign__en-us_topic_0000001294348474_p1312310181337">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="Sign__en-us_topic_0000001294348474_p151241818123311">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="Sign__en-us_topic_0000001294348474_p141244185331">Error code</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="Sign__en-us_topic_0000001294348474_row1212281811332"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="Sign__en-us_topic_0000001294348474_p171247188336">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="Sign__en-us_topic_0000001294348474_p1312414189334">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="Sign__en-us_topic_0000001294348474_p1712591810335">Error information</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="Sign__en-us_topic_0000001294348474_p171251518203316"><strong id="Sign__en-us_topic_0000001294348474_b1512561843319">Status code: 403</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="Sign__en-us_topic_0000001294348474_table1912513189337" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameter</caption><thead align="left"><tr id="Sign__en-us_topic_0000001294348474_row14125318153318"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.1"><p id="Sign__en-us_topic_0000001294348474_p71261418173314">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.2"><p id="Sign__en-us_topic_0000001294348474_p11127181810332">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.11.2.4.1.3"><p id="Sign__en-us_topic_0000001294348474_p17127171843310">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="Sign__en-us_topic_0000001294348474_row1312561810335"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="Sign__en-us_topic_0000001294348474_p1212701815335">error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="Sign__en-us_topic_0000001294348474_p1112881863313">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="Sign__en-us_topic_0000001294348474_p171281518193317">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="Sign__en-us_topic_0000001294348474_table13128151823318" frame="border" border="1" rules="all"><caption><b>Table 10 </b>ErrorDetail</caption><thead align="left"><tr id="Sign__en-us_topic_0000001294348474_row1712817180338"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.12.2.4.1.1"><p id="Sign__en-us_topic_0000001294348474_p1112911187333">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.12.2.4.1.2"><p id="Sign__en-us_topic_0000001294348474_p151301018173318">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.12.2.4.1.3"><p id="Sign__en-us_topic_0000001294348474_p13130918153315">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="Sign__en-us_topic_0000001294348474_row16129618113312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.12.2.4.1.1 "><p id="Sign__en-us_topic_0000001294348474_p19130918103312">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.12.2.4.1.2 "><p id="Sign__en-us_topic_0000001294348474_p101309185336">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.12.2.4.1.3 "><p id="Sign__en-us_topic_0000001294348474_p713001853314">Error code</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="Sign__en-us_topic_0000001294348474_row312921813319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.12.2.4.1.1 "><p id="Sign__en-us_topic_0000001294348474_p131319185339">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.12.2.4.1.2 "><p id="Sign__en-us_topic_0000001294348474_p713113180335">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.12.2.4.1.3 "><p id="Sign__en-us_topic_0000001294348474_p13131918123318">Error information</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="Sign__en-us_topic_0000001294348474_p11131318153312"><strong id="Sign__en-us_topic_0000001294348474_b613181815332">Status code: 404</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="Sign__en-us_topic_0000001294348474_table191311618143310" frame="border" border="1" rules="all"><caption><b>Table 11 </b>Response body parameter</caption><thead align="left"><tr id="Sign__en-us_topic_0000001294348474_row4132151810339"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.14.2.4.1.1"><p id="Sign__en-us_topic_0000001294348474_p11132131893319">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.14.2.4.1.2"><p id="Sign__en-us_topic_0000001294348474_p5132151814334">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.14.2.4.1.3"><p id="Sign__en-us_topic_0000001294348474_p111331218133311">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="Sign__en-us_topic_0000001294348474_row16132111817336"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.14.2.4.1.1 "><p id="Sign__en-us_topic_0000001294348474_p3133151814339">error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.14.2.4.1.2 "><p id="Sign__en-us_topic_0000001294348474_p81344187339">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.14.2.4.1.3 "><p id="Sign__en-us_topic_0000001294348474_p191343185330">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="Sign__en-us_topic_0000001294348474_table191345186338" frame="border" border="1" rules="all"><caption><b>Table 12 </b>ErrorDetail</caption><thead align="left"><tr id="Sign__en-us_topic_0000001294348474_row1413451817334"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.15.2.4.1.1"><p id="Sign__en-us_topic_0000001294348474_p1913619181333">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.15.2.4.1.2"><p id="Sign__en-us_topic_0000001294348474_p1713612183335">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.15.2.4.1.3"><p id="Sign__en-us_topic_0000001294348474_p131369182332">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="Sign__en-us_topic_0000001294348474_row1813416182332"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.1 "><p id="Sign__en-us_topic_0000001294348474_p113731811331">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.2 "><p id="Sign__en-us_topic_0000001294348474_p15137151813314">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.15.2.4.1.3 "><p id="Sign__en-us_topic_0000001294348474_p2137161812336">Error code</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="Sign__en-us_topic_0000001294348474_row16134618193310"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.1 "><p id="Sign__en-us_topic_0000001294348474_p191381518123314">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.2 "><p id="Sign__en-us_topic_0000001294348474_p141388184337">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.15.2.4.1.3 "><p id="Sign__en-us_topic_0000001294348474_p171382018143311">Error information</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="Sign__en-us_topic_0000001294348474_p313941823313"><strong id="Sign__en-us_topic_0000001294348474_b1113919181330">Status code: 500</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="Sign__en-us_topic_0000001294348474_table1013921863315" frame="border" border="1" rules="all"><caption><b>Table 13 </b>Response body parameters</caption><thead align="left"><tr id="Sign__en-us_topic_0000001294348474_row913919188334"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.17.2.4.1.1"><p id="Sign__en-us_topic_0000001294348474_p4140141853312">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.17.2.4.1.2"><p id="Sign__en-us_topic_0000001294348474_p9140111823316">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.17.2.4.1.3"><p id="Sign__en-us_topic_0000001294348474_p11140141816334">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="Sign__en-us_topic_0000001294348474_row1413981873316"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.17.2.4.1.1 "><p id="Sign__en-us_topic_0000001294348474_p11415181332">error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.17.2.4.1.2 "><p id="Sign__en-us_topic_0000001294348474_p1114111182331">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.17.2.4.1.3 "><p id="Sign__en-us_topic_0000001294348474_p91411718193317">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="Sign__en-us_topic_0000001294348474_table1614216186334" frame="border" border="1" rules="all"><caption><b>Table 14 </b>ErrorDetail</caption><thead align="left"><tr id="Sign__en-us_topic_0000001294348474_row21426183338"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.18.2.4.1.1"><p id="Sign__en-us_topic_0000001294348474_p1114821816332">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.18.2.4.1.2"><p id="Sign__en-us_topic_0000001294348474_p91488186330">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.18.2.4.1.3"><p id="Sign__en-us_topic_0000001294348474_p17148918113312">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="Sign__en-us_topic_0000001294348474_row181421318153315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.18.2.4.1.1 "><p id="Sign__en-us_topic_0000001294348474_p1214991815333">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.18.2.4.1.2 "><p id="Sign__en-us_topic_0000001294348474_p1714981863314">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.18.2.4.1.3 "><p id="Sign__en-us_topic_0000001294348474_p1514913184339">Error code</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="Sign__en-us_topic_0000001294348474_row2014231820339"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.18.2.4.1.1 "><p id="Sign__en-us_topic_0000001294348474_p91491918163310">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.18.2.4.1.2 "><p id="Sign__en-us_topic_0000001294348474_p181501318153310">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.18.2.4.1.3 "><p id="Sign__en-us_topic_0000001294348474_p8150121810339">Error information</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="Sign__en-us_topic_0000001294348474_p1415011843319"><strong id="Sign__en-us_topic_0000001294348474_b12150118153311">Status code: 502</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="Sign__en-us_topic_0000001294348474_table1715061813337" frame="border" border="1" rules="all"><caption><b>Table 15 </b>Response body parameters</caption><thead align="left"><tr id="Sign__en-us_topic_0000001294348474_row2015121853319"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.20.2.4.1.1"><p id="Sign__en-us_topic_0000001294348474_p61515189339">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.20.2.4.1.2"><p id="Sign__en-us_topic_0000001294348474_p4152418133313">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.20.2.4.1.3"><p id="Sign__en-us_topic_0000001294348474_p81521118133313">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="Sign__en-us_topic_0000001294348474_row19151131810336"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.20.2.4.1.1 "><p id="Sign__en-us_topic_0000001294348474_p131524183330">error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.20.2.4.1.2 "><p id="Sign__en-us_topic_0000001294348474_p181521218123319">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.20.2.4.1.3 "><p id="Sign__en-us_topic_0000001294348474_p81521018173316">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="Sign__en-us_topic_0000001294348474_table1215261816333" frame="border" border="1" rules="all"><caption><b>Table 16 </b>ErrorDetail</caption><thead align="left"><tr id="Sign__en-us_topic_0000001294348474_row171531318163317"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.21.2.4.1.1"><p id="Sign__en-us_topic_0000001294348474_p18154151883319">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.21.2.4.1.2"><p id="Sign__en-us_topic_0000001294348474_p7154141883312">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.21.2.4.1.3"><p id="Sign__en-us_topic_0000001294348474_p151541718113319">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="Sign__en-us_topic_0000001294348474_row1315371813335"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.21.2.4.1.1 "><p id="Sign__en-us_topic_0000001294348474_p2154118153319">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.21.2.4.1.2 "><p id="Sign__en-us_topic_0000001294348474_p171543186330">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.21.2.4.1.3 "><p id="Sign__en-us_topic_0000001294348474_p1515411189339">Error code</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="Sign__en-us_topic_0000001294348474_row11153101818335"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.21.2.4.1.1 "><p id="Sign__en-us_topic_0000001294348474_p915521853318">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.21.2.4.1.2 "><p id="Sign__en-us_topic_0000001294348474_p18256131813335">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.21.2.4.1.3 "><p id="Sign__en-us_topic_0000001294348474_p325731813335">Error information</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="Sign__en-us_topic_0000001294348474_p11257018183313"><strong id="Sign__en-us_topic_0000001294348474_b102571218203317">Status code: 504</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="Sign__en-us_topic_0000001294348474_table21560187335" frame="border" border="1" rules="all"><caption><b>Table 17 </b>Response body parameter</caption><thead align="left"><tr id="Sign__en-us_topic_0000001294348474_row1615620181332"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.23.2.4.1.1"><p id="Sign__en-us_topic_0000001294348474_p22583188333">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.23.2.4.1.2"><p id="Sign__en-us_topic_0000001294348474_p925801818337">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.23.2.4.1.3"><p id="Sign__en-us_topic_0000001294348474_p225819186334">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="Sign__en-us_topic_0000001294348474_row17156018113320"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.23.2.4.1.1 "><p id="Sign__en-us_topic_0000001294348474_p1025814187335">error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.23.2.4.1.2 "><p id="Sign__en-us_topic_0000001294348474_p62589187336">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.23.2.4.1.3 "><p id="Sign__en-us_topic_0000001294348474_p42586188338">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="Sign__en-us_topic_0000001294348474_table1157101853318" frame="border" border="1" rules="all"><caption><b>Table 18 </b>ErrorDetail</caption><thead align="left"><tr id="Sign__en-us_topic_0000001294348474_row1815871813315"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.24.2.4.1.1"><p id="Sign__en-us_topic_0000001294348474_p1725812186334">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.24.2.4.1.2"><p id="Sign__en-us_topic_0000001294348474_p132585184339">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.24.2.4.1.3"><p id="Sign__en-us_topic_0000001294348474_p13259141815339">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="Sign__en-us_topic_0000001294348474_row91589189334"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.24.2.4.1.1 "><p id="Sign__en-us_topic_0000001294348474_p2025920189331">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.24.2.4.1.2 "><p id="Sign__en-us_topic_0000001294348474_p5259018113313">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.24.2.4.1.3 "><p id="Sign__en-us_topic_0000001294348474_p102597182334">Error code</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="Sign__en-us_topic_0000001294348474_row7158161853311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.24.2.4.1.1 "><p id="Sign__en-us_topic_0000001294348474_p3259111843311">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.24.2.4.1.2 "><p id="Sign__en-us_topic_0000001294348474_p72591218103315">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.24.2.4.1.3 "><p id="Sign__en-us_topic_0000001294348474_p1125991811332">Error information</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="Sign__en-us_topic_0000001294348474_section2259161893320"><h4 class="sectiontitle">Example Request</h4><p id="Sign__en-us_topic_0000001294348474_p28281534191310">The following uses the RSASSA_PKCS1_V1_5_SHA_256 signature algorithm to sign the raw message.</p>
|
|
<pre class="screen" id="Sign__en-us_topic_0000001294348474_screen11259151811334">{
|
|
"key_id": "968d6cf0-feb6-42c6-bb30-d69f74f2d5f9",
|
|
"message": "aGVsbG8g",
|
|
"signing_algorithm": "RSASSA_PSS_SHA_256",
|
|
"message_type": "RAW"
|
|
}</pre>
|
|
</div>
|
|
<p id="Sign__en-us_topic_0000001294348474_p87631525162613"></p>
|
|
<p id="Sign__en-us_topic_0000001294348474_p1829011543018">The following uses the RSASSA_PKCS1_V1_5_SHA_256 signature algorithm to sign the digest message.</p>
|
|
<pre class="screen" id="Sign__en-us_topic_0000001294348474_screen17555152317198">{
|
|
"key_id": "968d6cf0-feb6-42c6-bb30-d69f74f2d5f9",
|
|
"message": "iNQmb9TmM40TuEX88olXnSCciXgjuSF9o+Fhk28DFYK=",
|
|
"signing_algorithm": "RSASSA_PSS_SHA_256",
|
|
"message_type": "DIGEST"
|
|
}</pre>
|
|
<div class="section" id="Sign__en-us_topic_0000001294348474_section15259918183320"><h4 class="sectiontitle">Example Response</h4><p id="Sign__en-us_topic_0000001294348474_p6259101813332"><strong id="Sign__en-us_topic_0000001294348474_b02461753105518">Status code: 200</strong></p>
|
|
<p id="Sign__en-us_topic_0000001294348474_p32591518193312">The following shows that the request for signing the raw message using the RSASSA_PKCS1_V1_5_SHA_256 signature algorithm is successful.</p>
|
|
<pre class="screen" id="Sign__en-us_topic_0000001294348474_screen2259201843314">{
|
|
"key_id": "968d6cf0-feb6-42c6-bb30-d69f74f2d5f9",
|
|
"signature": "BqhL4PFPMNIXyEld3qviF7uqqnqlm9TcVCUN9FTRCr6KGreHIvwE4YuAc+eLWVSCGRd3bQHhDOQ9GlWjixGengwBix1RPP0qxtn2p7kQxkC2j76VjKCwqAsAy4MyxjN8RNOdnVCpOObDGoLxPHxUwNvSqZ6GxQKZ4cHPXVH0r/jH9csgk6IUr6ATyto+IcNWSvD03LfaNRQ+Rvc5tOzNFpFrMnVl319UG9ANscq1ne67VW2uQIf74Osg9DYzbJTf/xqW5GFi3ZoeQUu+gMxwgQp3pkuYhygjw6a8Qy9ZNMHmWnY199SzHrxgIq3ymQzUU5zrikKMColX2goPXf5fxQ=="
|
|
}</pre>
|
|
</div>
|
|
<p id="Sign__en-us_topic_0000001294348474_p14115246121918"></p>
|
|
<p id="Sign__en-us_topic_0000001294348474_p686319464197">The following shows that the request for signing the digest message using the RSASSA_PKCS1_V1_5_SHA_256 signature algorithm is successful.</p>
|
|
<pre class="screen" id="Sign__en-us_topic_0000001294348474_screen94541512182017">{
|
|
"key_id": "968d6cf0-feb6-42c6-bb30-d69f74f2d5f9",
|
|
"signature": "M8Gqrm7EyyCPckMs90D7IOlUPCMHhoBh+nz9ySvdbOi7JMrl0ei+2lb+CQ2ZJN+pu7mftotq7/sHt0wWsDl8IOywYSBtWEmLW6AHnEPMykG/A9/Dp3kRuuKFoouCzWXeZyhIrzRUunAK5j5njcY/yTf6T8M+zBy1nAApb8WcHUen9/j7+X348iOnsSuWNVfXxy3NX41v9kLn6x115UDA/798VLSoMbsjcXKgdf/3GoZRYjcHxiX6s71/RWsQYme68qQN2B0q8Y9lk6rQxrw/AXHFoeaphYb7PriURRx0GxhOEEHb/9Tcr39Zlh3bbl/2aF3ytJORWIqatLtqgJ4uEA=="
|
|
}</pre>
|
|
<div class="section" id="Sign__en-us_topic_0000001294348474_section025941893319"><h4 class="sectiontitle">Status Code</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="Sign__en-us_topic_0000001294348474_en-us_topic_0000001130898006_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="Sign__en-us_topic_0000001294348474_row516471815338"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.14.2.1.3.1.1"><p id="Sign__en-us_topic_0000001294348474_p72591118203318">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.14.2.1.3.1.2"><p id="Sign__en-us_topic_0000001294348474_p1326013183331">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="Sign__en-us_topic_0000001294348474_row916451815334"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.14.2.1.3.1.1 "><p id="Sign__en-us_topic_0000001294348474_p142600189335">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.14.2.1.3.1.2 "><p id="Sign__en-us_topic_0000001294348474_p1026031810331">The request has succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="Sign__en-us_topic_0000001294348474_row20164518143314"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.14.2.1.3.1.1 "><p id="Sign__en-us_topic_0000001294348474_p122601218123317">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.14.2.1.3.1.2 "><p id="Sign__en-us_topic_0000001294348474_p13260121853319">Invalid request parameters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="Sign__en-us_topic_0000001294348474_row1816411184330"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.14.2.1.3.1.1 "><p id="Sign__en-us_topic_0000001294348474_p1426018187331">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.14.2.1.3.1.2 "><p id="Sign__en-us_topic_0000001294348474_p3260161813317">Username and password are required to access the page requested.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="Sign__en-us_topic_0000001294348474_row171644184331"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.14.2.1.3.1.1 "><p id="Sign__en-us_topic_0000001294348474_p726011187333">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.14.2.1.3.1.2 "><p id="Sign__en-us_topic_0000001294348474_p202607183337">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="Sign__en-us_topic_0000001294348474_row01649185338"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.14.2.1.3.1.1 "><p id="Sign__en-us_topic_0000001294348474_p2260201817338">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.14.2.1.3.1.2 "><p id="Sign__en-us_topic_0000001294348474_p5260181815333">The requested resource does not exist or is not found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="Sign__en-us_topic_0000001294348474_row1116411810332"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.14.2.1.3.1.1 "><p id="Sign__en-us_topic_0000001294348474_p172607186337">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.14.2.1.3.1.2 "><p id="Sign__en-us_topic_0000001294348474_p9260121893314">Internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="Sign__en-us_topic_0000001294348474_row17164618153314"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.14.2.1.3.1.1 "><p id="Sign__en-us_topic_0000001294348474_p1826041810337">502</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.14.2.1.3.1.2 "><p id="Sign__en-us_topic_0000001294348474_p11260171883313">Failed to complete the request. The server receives an invalid response from the upstream server.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="Sign__en-us_topic_0000001294348474_row1116411843315"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.14.2.1.3.1.1 "><p id="Sign__en-us_topic_0000001294348474_p92607189335">504</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.14.2.1.3.1.2 "><p id="Sign__en-us_topic_0000001294348474_p3260518143310">Gateway timed out.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
|
</div>
|
|
</div>
|
|
|