FastOSAPI——云服务快速接口

# 一、请求地址
http://FastOSAPI服务端IP(域名):端口/api/service/服务类型.方法
#二、参数请求方法
###### 1、GET
支持Url正常格式进行传参
###### 2、POST
PostForm方式提交，Content-Type为application/x-www-form-urlencoded
#三、公共请求参数
##### 1、公共参数列表
|参数名|数据类型|默认值|是否必填|参数描述|
| ------------ | ------------ | ------------ | ------------ | ------------ |
|_RPW_BindId|String|-|必填|服务端ID，在FastOSAPI服务端上可以复制|
|_RPW_IsAsyn|Int|1|必填|是否为异步请求，1为异步，0为同步|
|_RPW_Sign|String|-|必填|签名，[点击查看签名算法](#2、签名算法 "点击查看签名算法")|
|_RPW_QueueId|String|-|必填|异步请求队列ID，_RPW_IsAsyn=1时有效，每次请求值不可重复|
##### 2、签名算法
###### a、接口秘钥
FastOSAPI服务端上设置的**API秘钥**，假设为**FastOSAPISecret**

###### b、拼装参数
`_RPW_QueueId=20220823175918831&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&par1=val1&par2=val2&_RPW_IsAsyn=0`

###### c、参数名进行排序
`_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_IsAsyn=0&_RPW_QueueId=20220823175918831&par1=val1&par2=val2`

###### d、拼接秘钥
`_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_IsAsyn=0&_RPW_QueueId=20220823175918831&par1=val1&par2=val2&FastOSAPISecret`

###### e、MD5加密（大写）
加密后得到值即为签名
[点击此处查看C#版签名算法代码](/doc/api/sourcecode.html#3%E3%80%81%E7%AD%BE%E5%90%8D%E7%AE%97%E6%B3%95CSharp%E7%89%88 "点击此处查看C#版签名算法代码")
# 四、返回格式
###### 1、服务端以JSON格式返回，JSON实体说明

|字段名称|数据类型|字段描述|
| ------------ | ------------ | ------------ |
|aqid|String|异步队列ID|
|state|Boolean|操作状态|
|count|Int|总记录数|
|err|ErrorObject|错误对象|
|code|Int|错误代码|
|msg|String|返回说明|
|data|Object|返回数据|

**ErrorObject**
```json
{"code":Int,"msg":String}
```

###### 2、返回示例
```json
{"aqid":0,"state":false,"err":{"code":600010,"msg":"接口格式有误"},"count":0,"code":600010,"msg":"接口格式有误","data":null}
```
###### 3、异步返回示例
```json
{"aqid":"20220830220931247","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":"服务端执行命令已接收，结果请等待通知"}
```
###### 4、异步回调内容
FastOSAPI在收到异步请求后，执行请求任务，在任务完成时通过POST Form方式提交数据到FastOSAPI服务端设置的通知地址。

|字段名|数据类型|描述|
| ------------ | ------------ | ------------ |
|_RPW_QueueId|String|异步队列ID，本ID与接口请求时发送过来的数值一致|
|_RPW_ExecuteResult|[ReturnObject](#%E5%9B%9B%E3%80%81%E8%BF%94%E5%9B%9E%E6%A0%BC%E5%BC%8F "ReturnObject")|接口执行结果|
|_RPW_NotifyType|String|通知类型，1为回调，2为通知|
|_RPW_Sign|JsonArray|签名String集合，共2个签名结果，一个是UrlEncode大写签名结果，一个是UrlEncode小写签名结果，可在回调接收端验证是否来自服务端，在验证时，只要2个结果与开发结果其中一个一致即表示签名正确，[点击查看签名算法](#2%E3%80%81%E7%AD%BE%E5%90%8D%E7%AE%97%E6%B3%95 "点击查看签名算法")|
###### 5、公共错误代码列表
|代码|描述|
| ------------ | ------------ |
|600003|接口不存在|
|600004|接口类型错误|
|600005|执行接口出现错误|
|600009|接口路径有误|
|600010|接口格式有误|
|600011|接口格式有误|
|600012|命令执行失败|