<p class="shortdesc"></p> <section class="section" id="CommonParameters__section_oc5_hw3_mlb"><h2 class="doc-tairway">Public Request Parameters </h2> <p class="p">Public request parameters refer to the request parameters that each API needs to use. </p> <table class="table" id="CommonParameters__table_oms_3w3_mlb"><caption></caption><colgroup><col><col><col><col></colgroup><thead class="thead"> <tr class="row"> <th class="entry" id="CommonParameters__table_oms_3w3_mlb__entry__1"> <p class="p">Name </p> </th> <th class="entry" id="CommonParameters__table_oms_3w3_mlb__entry__2"> <p class="p">Type </p> </th> <th class="entry" id="CommonParameters__table_oms_3w3_mlb__entry__3"> <p class="p">Necessary or Not </p> </th> <th class="entry" id="CommonParameters__table_oms_3w3_mlb__entry__4"> <p class="p">Description </p> </th> </tr> </thead><tbody class="tbody"> <tr class="row"> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__1 "> <p class="p">version </p> </td> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__2 "> <p class="p">String </p> </td> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__3 "> <p class="p">Yes </p> </td> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__4 "> <p class="p">Version number of the API in the format of YYYY-MM-DD (date). The number of the current version is 2017-01-01. </p> </td> </tr> <tr class="row"> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__1 "> <p class="p">AccessKey </p> </td> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__2 "> <p class="p">String </p> </td> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__3 "> <p class="p">Yes </p> </td> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__4 "> <p class="p">Key ID issued by Ping An Cloud for service access. </p> </td> </tr> <tr class="row"> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__1 "> <p class="p">signature </p> </td> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__2 "> <p class="p">String </p> </td> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__3 "> <p class="p">Yes </p> </td> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__4 "> <p class="p">Signature string. For more information about signature calculation, see <strong class="ph b">Signature Mechanism</strong>. </p> </td> </tr> <tr class="row"> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__1 "> <p class="p">signatureMethod </p> </td> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__2 "> <p class="p">String </p> </td> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__3 "> <p class="p">Yes </p> </td> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__4 "> <p class="p">Signature method. KMS currently supports the HMAC-SHA1 algorithm. </p> </td> </tr> <tr class="row"> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__1 "> <p class="p">signatureVersion </p> </td> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__2 "> <p class="p">String </p> </td> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__3 "> <p class="p">Yes </p> </td> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__4 "> <p class="p">Signature algorithm version. KMS currently uses version 1.0. </p> </td> </tr> <tr class="row"> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__1 "> <p class="p">signatureNonce </p> </td> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__2 "> <p class="p">Long </p> </td> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__3 "> <p class="p">Yes </p> </td> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__4 "> <p class="p">Random number of the signature. It is a random Long value. </p> </td> </tr> <tr class="row"> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__1 "> <p class="p">timestamp </p> </td> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__2 "> <p class="p">String </p> </td> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__3 "> <p class="p">Yes </p> </td> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__4 "> <p class="p">String converted from the current millisecond timestamp. </p> </td> </tr> </tbody></table> <p class="p">Example: </p> <pre class="pre codeblock"><code>https://kms-cn-shanghai.yun.pingan.com/?version=2017-01-01 &accessKeyId=testid &signature=YlrFhyqDZQ1ThNYARrv3Ptaxqfc%3D &signatureMethod=HMAC-SHA1 &signatureNonce= 1542160932207 &timestamp= 1542160932207 &signatureVersion=1.0 </code></pre> </section> <section class="section" id="CommonParameters__section_bnj_lw3_mlb"><h2 class="doc-tairway">Return Parameters </h2> <p class="p">For each API request you send, the system returns a requestId (a unique identifier) to you no matter the request is accepted or denied. </p> <p class="p">Example: </p> <pre class="pre codeblock"><code>{    "requestId":"53912b71-3435-409e-ad05-1882ced04f1f" } </code></pre> <table class="table" id="CommonParameters__table_pjy_mw3_mlb"><caption></caption><colgroup><col><col></colgroup><thead class="thead"> <tr class="row"> <th class="entry" id="CommonParameters__table_pjy_mw3_mlb__entry__1"> <p class="p">Name </p> </th> <th class="entry" id="CommonParameters__table_pjy_mw3_mlb__entry__2"> <p class="p">Calculate the Signature with the Parameter or Not </p> </th> </tr> </thead><tbody class="tbody"> <tr class="row"> <td class="entry" headers="CommonParameters__table_pjy_mw3_mlb__entry__1 "> <p class="p">AccessKey </p> </td> <td class="entry" headers="CommonParameters__table_pjy_mw3_mlb__entry__2 "> <p class="p">Yes </p> </td> </tr> <tr class="row"> <td class="entry" headers="CommonParameters__table_pjy_mw3_mlb__entry__1 "> <p class="p">signature </p> </td> <td class="entry" headers="CommonParameters__table_pjy_mw3_mlb__entry__2 "> <p class="p">No </p> </td> </tr> <tr class="row"> <td class="entry" headers="CommonParameters__table_pjy_mw3_mlb__entry__1 "> <p class="p">signatureMethod </p> </td> <td class="entry" headers="CommonParameters__table_pjy_mw3_mlb__entry__2 "> <p class="p">Yes </p> </td> </tr> <tr class="row"> <td class="entry" headers="CommonParameters__table_pjy_mw3_mlb__entry__1 "> <p class="p">signatureVersion </p> </td> <td class="entry" headers="CommonParameters__table_pjy_mw3_mlb__entry__2 "> <p class="p">Yes </p> </td> </tr> <tr class="row"> <td class="entry" headers="CommonParameters__table_pjy_mw3_mlb__entry__1 "> <p class="p">signatureNonce </p> </td> <td class="entry" headers="CommonParameters__table_pjy_mw3_mlb__entry__2 "> <p class="p">Yes </p> </td> </tr> <tr class="row"> <td class="entry" headers="CommonParameters__table_pjy_mw3_mlb__entry__1 "> <p class="p">timestamp </p> </td> <td class="entry" headers="CommonParameters__table_pjy_mw3_mlb__entry__2 "> <p class="p">Yes </p> </td> </tr> <tr class="row"> <td class="entry" headers="CommonParameters__table_pjy_mw3_mlb__entry__1 "> <p class="p">version </p> </td> <td class="entry" headers="CommonParameters__table_pjy_mw3_mlb__entry__2 "> <p class="p">Yes </p> </td> </tr> <tr class="row"> <td class="entry" headers="CommonParameters__table_pjy_mw3_mlb__entry__1 "> <p class="p">API parameter of a specific service </p> </td> <td class="entry" headers="CommonParameters__table_pjy_mw3_mlb__entry__2 "> <p class="p">Yes </p> </td> </tr> </tbody></table> </section>