公共参数

<p class="shortdesc"></p> <section class="section" id="CommonParameters__section_oc5_hw3_mlb"><h2 class="doc-tairway">公共请求参数</h2> <p class="p">公共请求参数是指每个接口都需要使用到的请求参数。</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">名称</p> </th> <th class="entry" id="CommonParameters__table_oms_3w3_mlb__entry__2"> <p class="p">类型</p> </th> <th class="entry" id="CommonParameters__table_oms_3w3_mlb__entry__3"> <p class="p">是否必须</p> </th> <th class="entry" id="CommonParameters__table_oms_3w3_mlb__entry__4"> <p class="p">描述</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">是</p> </td> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__4 "> <p class="p">API 版本号,为日期形式:YYYY-MM-DD,本版本对应为 2017-01-01</p> </td> </tr> <tr class="row"> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__1 "> <p class="p">accessKeyId</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">是</p> </td> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__4 "> <p class="p">平安云颁发给用户的访问服务所用的密钥 ID。</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">是</p> </td> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__4 "> <p class="p">签名结果串。关于签名的计算方法,请参见签名机制</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">是</p> </td> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__4 "> <p class="p">签名方式,目前支持HMAC-SHA1</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">是</p> </td> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__4 "> <p class="p">签名算法版本,目前版本是 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">是</p> </td> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__4 "> <p class="p">签名随机数,一个随机的Long值</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">是</p> </td> <td class="entry" headers="CommonParameters__table_oms_3w3_mlb__entry__4 "> <p class="p">当前时间的毫秒时间戳转成String</p> </td> </tr> </tbody></table> <p class="p">示例:</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">公共返回参数</h2> <p class="p">用户发送的每次接口调用请求,无论成功与否,系统都会返回一个唯一识别码requestId给用户。</p> <p class="p">示例:</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">名称</p> </th> <th class="entry" id="CommonParameters__table_pjy_mw3_mlb__entry__2"> <p class="p">参数是否参与计算签名</p> </th> </tr> </thead><tbody class="tbody"> <tr class="row"> <td class="entry" headers="CommonParameters__table_pjy_mw3_mlb__entry__1 "> <p class="p">accessKeyId</p> </td> <td class="entry" headers="CommonParameters__table_pjy_mw3_mlb__entry__2 "> <p class="p">是</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">否</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">是</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">是</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">是</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">是</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">是</p> </td> </tr> <tr class="row"> <td class="entry" headers="CommonParameters__table_pjy_mw3_mlb__entry__1 "> <p class="p">具体业务接口参数</p> </td> <td class="entry" headers="CommonParameters__table_pjy_mw3_mlb__entry__2 "> <p class="p">是</p> </td> </tr> </tbody></table> </section>
以上内容是否解决了您的问题?
请补全提交信息!
咨询·建议

电话咨询 - 7x24 小时

400-151-8800

邮件咨询

cloud@pingan.com

在线客服

7x24 小时,急速解答

工单支持

解决云产品相关技术问题