開(kāi)發(fā) - 數(shù)據(jù)操作

應(yīng)用之間共享數(shù)據(jù)時(shí)，需要向提平臺(tái)操作數(shù)據(jù)，或者從平臺(tái)訂閱數(shù)據(jù)。數(shù)據(jù)操作方面，這里主要涉及4個(gè)接口：新增數(shù)據(jù)、查詢數(shù)據(jù)、刪除數(shù)據(jù)、修改數(shù)據(jù)。詳見(jiàn)后面的API參考。同時(shí)，為了便于應(yīng)用開(kāi)發(fā)，平臺(tái)提供了SDK，簡(jiǎn)化開(kāi)發(fā)。

SDK介紹

一. Java SDK

1. 依賴

<dependency>    <groupId>com.aliyun.api.gateway</groupId>    <artifactId>sdk-core-java</artifactId>    <version>1.0.4</version></dependency>

2. 示例代碼

SyncApiClientsyncClient=SyncApiClient.newBuilder().appKey("1234567").appSecret("6726732dsfdsdsfdsfds").build();IoTApiRequestrequest=newIoTApiRequest();//設(shè)置api的版本request.setApiVer("0.1.0");// 接口參數(shù)request.putParam("json","{}");request.putParam("productKey","a1ILGykZVhP");request.putParam("deviceName","Dxb3lv1E78mg5dsVLUQW");request.putParam("serviceName","kkp");//請(qǐng)求參數(shù)域名、path、requestApiResponseresponse=syncClient.postBody("test123-cn-shanghai.alicloudapi.com","/invokeThingService",request);System.out.println("response code = "+response.getStatusCode()+" response content = "+newString(response.getBody(),"utf-8"));

二. Python SDK

1. 依賴：無(wú)

2. 示例代碼  Step 1：下載示例工程代碼。示例工程在基于Python 2.7，Python3請(qǐng)自行適配。

Step 2：修改signature_composer.py文件第49行

修改前:string_to_sign.append(_build_resource(uri=uri,body=body))修改后:string_to_sign.append(uri)

Step 3: 修改ClientDemo.py如下，執(zhí)行調(diào)用

#!/usr/bin/env python# -*- coding: utf-8 -*-importosimportsysimportjsonsys_path=sys.path[0]ifnotos.path.isdir(sys_path):sys_path=os.path.dirname(sys_path)os.chdir(sys_path)fromcom.aliyun.api.gateway.sdkimportclientfromcom.aliyun.api.gateway.sdk.httpimportrequestfromcom.aliyun.api.gateway.sdk.commonimportconstanthost="https://api.link.aliyun.com"url="/data/model/data/query"cli=client.DefaultClient(app_key="1234567",app_secret="abcdefghijklmnopq")req_post=request.Request(host=host,protocol=constant.HTTPS,url=url,method="POST",time_out=30000)req_post.set_content_type(constant.CONTENT_TYPE_STREAM)body={    "request":    "apiVer":"0.0.2    "params":{        "modelId":"EMPLOYEE",        "returnFields":["employee_no","name"],        "conditions":[{"fieldName":"id","value":"1","operate":"mt"}],        "pageSize":100,        "pageNum":1    },    "version":"1.0"}bb=json.dumps(body).encode("utf-8")req_post.set_body(bb)print'==================================================='printstr(cli.execute(req_post)).decode('string_escape')print'==================================================='

三. JS SDK

1. 依賴

$# save into package.json dependencies with -S$ npm install aliyun-api-gateway-S$# you can use cnpm for fast install$ cnpm install aliyun-api-gateway-S

2. 示例代碼

'use strict';constco=require('co');constClient=require('aliyun-api-gateway').Client;constclient=newClient('YOUR_APP_KEY','YOUR_APP_SECRET');co(function*(){    varurl='http://apiqingdaohttps.foundai.com/test1234';    varresult=yield client.post(url,{        data:{        'testtest':'query1Value'        },        headers:{            accept:'application/json'        }    });    console.log(JSON.stringify(result));});

數(shù)據(jù)操作API

一. API 描述

二. API 約定

1. 日期類型的參數(shù)傳入格式：當(dāng)前時(shí)間到格林威治時(shí)間1970年01月01日00時(shí)00分00秒的毫秒數(shù)。

2. 數(shù)量查詢的一些約定：

   1. 單次查詢最多返回200條數(shù)據(jù)，未指定分頁(yè)參數(shù)情況下，查詢返回滿足條件的前200條，可根據(jù)返回參數(shù)中的hasNext判斷是否有更多數(shù)據(jù)。

   2. 若需要按照指定條件返回?cái)?shù)據(jù)總數(shù)，則指定返回參數(shù)為COUNT，API返回參數(shù)中會(huì)帶有COUNT以及對(duì)應(yīng)的值。

   3. 若需要按照指定條件，及按照字段分組進(jìn)行數(shù)量查詢，則指定返回參數(shù)為COUNT（分組字段1，分組字段2），API返回參數(shù)中會(huì)帶有COUNT以及對(duì)應(yīng)的值。

3. 更新刪除的約定：?jiǎn)未尾僮?，最多支?00條數(shù)據(jù)。

4. 運(yùn)算符定義：

數(shù)據(jù)包括系統(tǒng)屬性，API中不允許賦值和更新系統(tǒng)屬性，系統(tǒng)屬性如下：

三. 數(shù)據(jù)新增API

1. 請(qǐng)求參數(shù)：

2. 返回參數(shù)

3. 請(qǐng)求示例

{    "request":{    "apiVer":"0.0.3"http://api版本號(hào)    },    "id":1508212818676,//request里的全局唯一id透?jìng)?   "params":{        "modelId":"XXX123",//數(shù)據(jù)模型id        "scopeId":"fdbsdj1dfjdubgxxx",//數(shù)據(jù)模型id        "properties":{            "BRAND":"BMW",            "MODE":"5",            "CREATE_DATE":1526969423,            "LONG_SIZE":3.3,            "LONG_SIZE":2.2        }    },    "version":"1.0"http://請(qǐng)求協(xié)議版本}

4. 返回示例

{    "code":200,    "message":"success",    "localizedMsg":null,    "data":12345}

5. 返回碼

四. 數(shù)據(jù)刪除API

1. 請(qǐng)求參數(shù)

其中condition針對(duì)不同類型的屬性支持的運(yùn)算符：

2. 返回參數(shù)

3. 請(qǐng)求示例

{"request":{"apiVer":"0.1.0"http://api版本號(hào)},"id":1508212818676,//request里的全局唯一id透?jìng)?params":{"modelId":"XXX123","conditions":[{"fieldName":"BRAND","value":"BMW","operate":"eq"},{"fieldName":"MODE","value":"X5","operate":"eq"}]},"version":"1.0"http://請(qǐng)求協(xié)議版本}

4. 返回示例

{"code":200,"message":"success","localizedMsg":null,"data":100}

5. 返回碼

五. 數(shù)據(jù)修改API

1. 請(qǐng)求參數(shù)

其中condition針對(duì)不同類型的屬性支持的運(yùn)算符：

2. 返回參數(shù)

3. 請(qǐng)求示例

{    "request":{        "apiVer":"0.0.3"http://api版本號(hào)    },    "id":1508212818676,//request里的全局唯一id透?jìng)?   "params":{        "modelId":"XXX123",        "conditions":[            {"fieldName":"BRAND","value":"BMW","operate":"eq"},            {"fieldName":"MODE","value":"X5","operate":"eq"}        ],        "updateDetails":{            "LONG_SIZE":4,            "WIDTH_SIZE":3        }    },    "version":"1.0"http://請(qǐng)求協(xié)議版本}

4. 返回示例

{    "code":200,    "message":"success",    "localizedMsg":null,    "data":100}

5. 返回碼

六. 數(shù)據(jù)查詢API

1. 請(qǐng)求參數(shù)

其中returnFields支持的函數(shù)類型：

DATE_FORMAT支持的format修飾符

其中condition針對(duì)不同類型的屬性支持的運(yùn)算符：

2. 返回參數(shù)

3. 請(qǐng)求示例-1

{    "request":{        "apiVer":"0.0.2"http://api版本號(hào)     },    "id":1508212818676,//request里的全局唯一id透?jìng)?   "params":{        "modelId":"XXX123",        "returnFields":["MODE","ENGINE"],        "conditions":[            {"fieldName":"BRAND","value":"BMW","operate":"eq"},            {"fieldName":"WIDTH_SIZE","value":1,"value2":2,"operate":"bt"},            {"fieldName":"LONG_SIZE","value":"3","operate":"mt"}        ],        "orderBy":{            "asc":true,            "orderByFields":["CREATE_DATA","MODE"]        },        "pageNum":1,        "pageSize":10    },    "version":"1.0"http://請(qǐng)求協(xié)議版本}

4. 返回示例-1

{    "code":200,    "localizedMsg":null,    "data":"{\"count\":1,        \"hasNext\":false,        \"items\":[{\"gmt_create\":1551872701000,\"MODE\":\"33\",\"ENGINE\":\"44\",\"id\":2,\"gmt_modified\":1551872714000}],        \"pageNum\":1,        \"pageSize\":10}",    "message":"success"}

5. 請(qǐng)求示例-2

{    "request":{        "apiVer":"0.1.0"http://api版本號(hào)    },    "id":1508212818676,//request里的全局唯一id透?jìng)?   "params":{        "modelId":"XXX123",        "returnFields":["COUNT",        "conditions":[            {"fieldName":"BRAND","value":"BMW","operate":"eq"},            {"fieldName":"WIDTH_SIZE","value":1,"value2":2,"operate":"bt"},            {"fieldName":"LONG_SIZE","value":"3","operate":"mt"}        ],        "pageNum":1,        "pageSize":10    },    "version":"1.0"http://請(qǐng)求協(xié)議版本}

6. 返回示例-2

{    "code":200,    "localizedMsg":null,    "data":"{        \"hasNext\":false,        \"items\":[{            \"COUNT\":100        }]    }"    "message":"success"}

7. 請(qǐng)求示例-分組數(shù)量查詢

{    "request":{        "apiVer":"0.1.0"http://api版本號(hào)    },    "id":1508212818676,//request里的全局唯一id透?jìng)?   "params":{        "modelId":"XXX123",        "returnFields":["COUNT(BRAND,NAME)"],        "conditions":[            {"fieldName":"BRAND","value":"BMW","operate":"eq"},            {"fieldName":"WIDTH_SIZE","value":1,"value2":2,"operate":"bt"},            {"fieldName":"LONG_SIZE","value":"3","operate":"mt"}        ],        "pageNum":1,        "pageSize":10    },    "version":"1.0"http://請(qǐng)求協(xié)議版本}

8. 返回示例分組數(shù)量查詢

{    "code":200,    "localizedMsg":null,    "message":"success",    "data":"{        \"hasNext\":false,        \"items\":[        {            \"COUNT\":100,            \"BRAND\":\"BMW\",            \"NAME\":\"X1\"        },{            \"COUNT\":200,            \"BRAND\":\"JEEP\",            \"NAME\":\"M2\"        }]    }"}

9. 返回碼

七. 獲取文件上傳地址API

1. 請(qǐng)求參數(shù)

2. 返回參數(shù)

3. 請(qǐng)求示例

{    "request":{        "apiVer":"0.0.1"http://api版本號(hào)    },    "id":1508212818671,//request里的全局唯一id透?jìng)?   "params":{        "modelId":"XXX123",//數(shù)據(jù)模型id        "fileSize":"3.2",//文件大小        "attrName":"name",//屬性名稱        "fileType":"jpg",//文件類型        "version":"1.0",//模型版本    },    "version":"1.0"http://請(qǐng)求協(xié)議版本}

4. 返回示例

{    "code":200,//返回是否成功，只要不是200說(shuō)明返回不成功    "message":"success",//如果失敗會(huì)返回失敗的信息描述    "localizedMsg":null,    "data":{"url":"http://xxx.xxx.xx","fileName":"xxx.jpg"}返回的數(shù)據(jù)}

5. 返回碼

八. 獲取文件下載地址API

1. 請(qǐng)求參數(shù)

2. 返回參數(shù)

3. 請(qǐng)求示例

{    "request":{        "apiVer":"0.0.1"http://api版本號(hào)    },    "id":1508212818671,//request里的全局唯一id透?jìng)?   "params":{        "modelId":"XXX123",//數(shù)據(jù)模型id        "scopeId":"fdbsdj1dfjdubgxxx",//業(yè)務(wù)隔離id        "attrName":"name",//屬性名稱        "fileName":"xdsfxv.jpg",//文件類型        "version":"1.0",//模型版本    },    "version":"1.0"http://請(qǐng)求協(xié)議版本}

4. 返回示例

{    "code":200,//返回是否成功，只要不是200說(shuō)明返回不成功    "message":"success",//如果失敗會(huì)返回失敗的信息描述    "localizedMsg":null,    "data":{"url":"http://xxx.xxx.xx"}返回的數(shù)據(jù)下載查看的url}

5. 返回碼

開(kāi)發(fā) - 數(shù)據(jù)訂閱

應(yīng)用可以通過(guò)HTTP2方式，訂閱數(shù)據(jù)的變更消息（新增、刪除、修改）。應(yīng)用自身不需要發(fā)布數(shù)據(jù)的變更消息到通道中，這些消息的產(chǎn)生是由應(yīng)用通過(guò)上面的數(shù)據(jù)操作API，對(duì)數(shù)據(jù)進(jìn)行操作之后，由平臺(tái)產(chǎn)生。平臺(tái)產(chǎn)生時(shí)間之后，會(huì)將消息通過(guò)訂閱關(guān)系發(fā)送到訂閱方。

在這個(gè)消息通信中，每一個(gè)應(yīng)用實(shí)例，由AppKey標(biāo)識(shí)身份。對(duì)于單租戶型的應(yīng)用，每一個(gè)AppKey代表了一次應(yīng)用分發(fā)的實(shí)例；但是，對(duì)于SaaS應(yīng)用，他的一個(gè)AppKey代表了該應(yīng)用對(duì)應(yīng)的所有租戶的身份，因此，在SaaS應(yīng)用按照AppKey得到消息之后，需要自行根據(jù)訂閱到的數(shù)據(jù)內(nèi)容中的AppID字段，將數(shù)據(jù)對(duì)應(yīng)到不用的用戶中。

SDK 介紹

1. 依賴引用

在工程中添加 maven 依賴接入 SDK。

<dependency>    <groupId>com.aliyun.openservices</groupId>    <artifactId>iot-client-message</artifactId>    <version>1.1.3</version></dependency><dependency>    <groupId>com.aliyun</groupId>    <artifactId>aliyun-java-sdk-core</artifactId>    <version>3.7.1</version></dependency>

2. 身份認(rèn)證

使用服務(wù)端訂閱功能，需要基于AppKey進(jìn)行身份認(rèn)證并建立連接。該AppKey根據(jù)應(yīng)用類型不同，有兩種來(lái)源：

• 對(duì)于獨(dú)立單租戶托管并分發(fā)的應(yīng)用，該AppKey是由托管平臺(tái)在應(yīng)用實(shí)例化分發(fā)部署應(yīng)用時(shí)，自動(dòng)產(chǎn)生，并注入在主機(jī)的環(huán)境變量中，應(yīng)用事先并不知道該值，需要?jiǎng)討B(tài)從環(huán)境變量中獲取。

• 對(duì)于共享型應(yīng)用，該AppKey是該SaaS應(yīng)用在注冊(cè)多租戶接口時(shí)，從平臺(tái)創(chuàng)建，并硬編碼在應(yīng)用中。

StringappKey="XXXXXX";StringappSecret="XXXXXXXXXXXXXXXXXXXXXXX";Stringendpoint=String.format("https://%s.iot-as-http2.cn-shanghai.aliyuncs.com:443",appKey);// 連接配置Profileprofile=Profile.getAppKeyProfile(endpoint,appKey,appSecret);// 構(gòu)造客戶端MessageClientclient=MessageClientFactory.messageClient(profile);// 數(shù)據(jù)接收client.connect(messageToken->{    System.out.println(messageToken.getMessage());    returnMessageCallback.Action.CommitSuccess;});Thread.sleep(1000000);

*注意：關(guān)于上述代碼中的“connect”方法，需要額外說(shuō)明的是該方法在未經(jīng)過(guò)授權(quán)的情況下，會(huì)調(diào)用失敗。所以請(qǐng)務(wù)必做好重試邏輯，以便應(yīng)用一旦被授權(quán)之后，可以及時(shí)得到訂閱消息。

3. 設(shè)置消息接受接口

連接建立后，服務(wù)端會(huì)立即向 SDK 推送已訂閱的消息。因此，建立鏈接時(shí)，需要提供消息接收接口，用于處理未設(shè)置回調(diào)的消息。建議在connect之前，調(diào)用 setMessageListener 設(shè)置消息回調(diào)。

您需要通過(guò) MessageCallback 接口的consume方法，和調(diào)用 messageClient 的setMessageListener()方法來(lái)設(shè)置消息接收接口。consume 方法的返回值決定 SDK 是否發(fā)送 ACK。設(shè)置消息接收接口的方法如下：

MessageCallbackmessageCallback=newMessageCallback(){    @Override    publicActionconsume(MessageTokenmessageToken){        Messagem=messageToken.getMessage();        log.info("receive : "+newString(messageToken.getMessage().getPayload()));        // TODO: 處理消息邏輯        returnMessageCallback.Action.CommitSuccess;    }};Stringtopic=String.format("/sys/appkey/%s/dop/model/data/change",appkey);messageClient.setMessageListener(topic,messageCallback);

其中，Message消息字段如下：

// 消息體byte[]payload;// TopicStringtopic;// 消息IDStringmessageId;// QoSintqos;

payload內(nèi)容是一個(gè)JSON對(duì)象字符串，字段信息如下：

// 模型ID 
StringmodelId; 
 
// 變更數(shù)據(jù)的ID 
List<Long>dataIds; 
 
// 操作類型：insert/update/delete 
StringoperateType; 
 
// 訂閱的appId, 以appKey授權(quán)時(shí)為空 
StringappId;