请求结构

<p>平安云支持基于URL发起的HTTP/HTTPS GET请求,请求参数需要包含在URL中,以下为&ldquo;ListRegions&rdquo;(查询地域列表接口)为例:</p> <table border="1" cellpadding="0" cellspacing="0" style="width:813px"> <tbody> <tr> <td style="background-color:#ededed; vertical-align:top; width:809px"> <p><span style="font-family:Consolas">https://api.yun.pingan.com/api/v1?Action=ListRegions</span></p> <p><span style="font-family:Consolas">&amp;Id= Region-QTLzvswQFr</span></p> <p><span style="font-family:Consolas">&amp;&lt;公共请求参数&gt;</span></p> </td> </tr> </tbody> </table> <ul> <li>https: 指定了请求通信协议。</li> <li>api.yun.pingan.com: 接口的接入网关(Endpoint)。</li> <li>/api/v1: 代表API服务的版本为v1。</li> <li>Action=ListRegions: 指定了要调用的具体API。</li> <li>Id=Region-QTLzvswQFr: 是ListRegions接口的业务请求参数。</li> <li>&lt;公共请求参数&gt;: 是平安云约定的公共参数,与实际业务无关。</li> </ul> <p>&nbsp;</p> <p><span style="font-size:16px"><strong>通信协议</strong></span></p> <p>支持HTTP或HTTPS协议请求通信。为了获得更高的安全性,推荐您使用HTTPS协议发送请求。</p> <p>涉及敏感数据时,如用户密码和SSH密钥对,推荐使用HTTPS协议。例如,在Login中指定Password参数时。</p> <p>&nbsp;</p> <p><span style="font-size:16px"><strong>接入网关</strong></span></p> <p>当前访问需要接入平安云中国大陆的API服务时,请使用:</p> <table border="1" cellpadding="0" cellspacing="0" style="width:806px"> <tbody> <tr> <td style="background-color:#ededed; vertical-align:top; width:138px"> <p><strong>地址(部署位置)</strong></p> </td> <td style="background-color:#ededed; vertical-align:top; width:662px"> <p><strong>接入地址</strong></p> </td> </tr> <tr> <td style="vertical-align:top; width:138px"> <p>平安云(公有云)</p> </td> <td style="vertical-align:top; width:662px"> <p>https://api.yun.pingan.com</p> </td> </tr> <tr> <td style="vertical-align:top; width:138px"> <p>平安云(政务云)</p> </td> <td style="vertical-align:top; width:662px"> <p>https://api.city.pingan.com</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><span style="font-size:16px"><strong>请求参数</strong></span></p> <p>平安云提供命令模式和RESTful两种模式的API接口,其中命令模式的API接口主要是IaaS类产品和部分PaaS类产品,而RESTful接口主要是SaaS类产品和部分PaaS类产品。</p> <p><strong>(1</strong><strong>)命令模式</strong></p> <p>通过Action参数指定目标操作,例如Action=RunInstance。还需要指定接口的其他参数以及公共请求参数,例如:</p> <p>https://api.yun.pingan.com/api/v1?Action=RunInstance&amp;&lt;公共请求参数&gt;</p> <p><strong>(2</strong><strong>)RESTful</strong><strong>模式</strong></p> <p>在RESTful风格的API接口中,每个URL代表一种资源(resource),所以url中不能有动词,只能有名词,例如:</p> <p>GET&nbsp; https://api.yun.pingan.com/rest/v1/payment/{tenantId}/balance 查询租户余额。</p> <p>对于资源的具体操作类型,由HTTP动词表示,常用的HTTP动词有下面四个:</p> <ul> <li>GET(SELECT):从服务器取出资源(一项或多项)。</li> <li>POST(CREATE):在服务器新建一个资源。</li> <li>PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)。</li> <li>DELETE(DELETE):从服务器删除资源。</li> </ul> <p>&nbsp;</p> <p><span style="font-size:16px"><strong>字符编码</strong></span></p> <p>平安云API约定请求及返回结果都使用UTF-8字符集编码。</p>
以上内容是否解决了您的问题?
请补全提交信息!
咨询·建议

电话咨询 - 7x24 小时

400-151-8800

邮件咨询

cloud@pingan.com

在线客服

7x24 小时,急速解答

工单支持

解决云产品相关技术问题