調(diào)用該接口查詢指定解析器的詳細信息,包括解析器基本信息、解析腳本、運行狀態(tài)和關(guān)聯(lián)的數(shù)據(jù)源等。

QPS限制

單個阿里云賬號調(diào)用該接口的每秒請求數(shù)(QPS)最大限制為10。

說明 RAM用戶共享阿里云賬號配額。

調(diào)試

您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數(shù)

名稱 類型 是否必選 示例值 描述
Action String GetParser

系統(tǒng)規(guī)定參數(shù)。取值:GetParser。

ParserId Long 1001

解析器ID。您可調(diào)用接口ListParser,查詢解析器列表,獲取ParserId

IotInstanceId String iot-n8t***

實例ID。您可在物聯(lián)網(wǎng)平臺控制臺的實例概覽頁面,查看當(dāng)前實例的ID

注意
  • 若有ID值,必須傳入該ID值,否則調(diào)用會失敗。
  • 若無ID值,則無需傳入。

實例的更多信息,請參見實例概述

調(diào)用API時,除了本文介紹的該API的特有請求參數(shù),還需傳入公共請求參數(shù)。公共請求參數(shù)說明,請參見公共參數(shù)文檔

返回數(shù)據(jù)

名稱 類型 示例值 描述
Code String iot.system.SystemException

調(diào)用失敗時,返回的錯誤碼。更多信息,請參見錯誤碼

Data Struct

返回的解析器詳細信息。

DataSourceId Long 1003

解析器關(guān)聯(lián)的數(shù)據(jù)源ID。

Description String 轉(zhuǎn)發(fā)數(shù)據(jù)。

解析器描述。

Name String DataParser

解析器名稱。

ParserId Long 1001

解析器ID。

Script String var data = payload("json"); var h = data.items.Humidity.value; var t = data.items.Temperature.value; writeTsdb(1000,timestamp(),"temperature", t , {"deviceName":deviceName()}); writeTsdb(1000,timestamp(),"humidity", h , {"deviceName":deviceName()});

解析器已發(fā)布腳本。

ScriptDraft String var data = payload("json"); var h = data.items.Humidity.value; var t = data.items.Temperature.value; writeTsdb(1000,timestamp(),"temperature", t , {"deviceName":deviceName()}); writeTsdb(1000,timestamp(),"humidity", h , {"deviceName":deviceName()});

解析器腳本的草稿。

Status String STOP

解析器運行狀態(tài)。

  • RUNNING:運行中。
  • STOP:已停止。
  • ABNORMAL:存在異常。
UtcCreated String 2022-03-27T12:45:43.000Z

創(chuàng)建解析器的UTC時間。格式為yyyy-MM-dd'T'HH:mm:ss.SSS'Z'

UtcModified String 2022-04-27T12:45:43.000Z

更新解析器的UTC時間。格式為yyyy-MM-dd'T'HH:mm:ss.SSS'Z'

ErrorMessage String 系統(tǒng)異常

調(diào)用失敗時,返回的出錯信息。

RequestId String E4C0FF92-2A86-41DB-92D3-73B60310D25E

阿里云為該請求生成的唯一標(biāo)識符。

Success Boolean true

表示是否調(diào)用成功。

  • true:調(diào)用成功。
  • false:調(diào)用失敗。

示例

請求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=GetParser
&ParserId=1001
&<公共請求參數(shù)>

正常返回示例

XML格式

<GetParserResponse>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <Data>
        <Status>STOP</Status>
        <Script>var data = payload("json"); var h = data.items.Humidity.value; var t = data.items.Temperature.value; writeTsdb(1000,timestamp(),"temperature", t , {"deviceName":deviceName()}); writeTsdb(1000,timestamp(),"humidity", h , {"deviceName":deviceName()});</Script>
        <Description>轉(zhuǎn)發(fā)數(shù)據(jù)。</Description>
        <UtcCreated>2022-03-27T12:45:43.000Z</UtcCreated>
        <ScriptDraft>var data = payload("json"); var h = data.items.Humidity.value; var t = data.items.Temperature.value; writeTsdb(1000,timestamp(),"temperature", t , {"deviceName":deviceName()}); writeTsdb(1000,timestamp(),"humidity", h , {"deviceName":deviceName()});</ScriptDraft>
        <UtcModified>2022-04-27T12:45:43.000Z</UtcModified>
        <ParserId>1001</ParserId>
        <DataSourceId>1003</DataSourceId>
        <Name>DataParser</Name>
  </Data>
  <Success>true</Success>
</GetParserResponse>

JSON格式

{
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "Data": {
        "Status": "STOP",
        "Script": "var data = payload(\"json\"); var h = data.items.Humidity.value; var t = data.items.Temperature.value; writeTsdb(1000,timestamp(),\"temperature\", t , {\"deviceName\":deviceName()}); writeTsdb(1000,timestamp(),\"humidity\", h , {\"deviceName\":deviceName()});",
        "Description": "轉(zhuǎn)發(fā)數(shù)據(jù)。",
        "UtcCreated": "2022-03-27T12:45:43.000Z",
        "ScriptDraft": "var data = payload(\"json\"); var h = data.items.Humidity.value; var t = data.items.Temperature.value; writeTsdb(1000,timestamp(),\"temperature\", t , {\"deviceName\":deviceName()}); writeTsdb(1000,timestamp(),\"humidity\", h , {\"deviceName\":deviceName()});",
        "UtcModified": "2022-04-27T12:45:43.000Z",
        "ParserId": 1001,
        "DataSourceId": 1003,
        "Name": "DataParser"
    },
    "Success": true
}