API文档>调用方式 > 请求结构

请求结构

发布时间:2021-08-08 10:56

简要描述:

API支持基于URL发起HTTP/HTTPS GET请求。请求参数需要包含在URL中。本文列举了GET请求中的结构解释,并提供了服务器的服务接入地址

通信方式:

以下为Start一条未编码的URL请求示例:
https://www.lanmicloud.com/api/<api类型>/<action>?<公共参数>
&productId=117
&appid=*
&time=1585280982
&domain=www.lanmicloud.com
&sign=

https指定了请求通信协议。
lanmicloud.com指定了ECS的服务接入地址。
api类型根据API类型的不同,分为三大类,分别是operate(业务操作类,如开机,关机),product(产品操作类,如下单,续费,升级等等),business(产品信息类,如产品同步)
action指定了要调用的API
productId指的是产品ID
appid指的是用户在后台API信息申请的appid
time指的是用户请求API时的时间戳
domain指的是用户请求API的服务器域名
sign指的是根据appid,domain,time,以及appkey通过md5加密生成的一串秘钥
md5(appid domain time appkey)

通信协议:

支持HTTP或HTTPS协议请求通信。为了获得更高的安全性,推荐您使用HTTPS协议发送请求

请求参数:

您需要通过Action参数指定目标操作,例如Action=Start。还需要指定接口的其他参数以及公共请求参数,详情请参见公共请求参数。

字符编码:

请求及返回结果都使用UTF-8字符集编码

本文导读