调用该接口查询指定解析器的详细信息,包括解析器基本信息、解析脚本、运行状态和关联的数据源等。
QPS限制
单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为10。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetParser |
系统规定参数。取值:GetParser。 |
ParserId | Long | 是 | 1001 |
解析器ID。您可调用接口ListParser,查询解析器列表,获取ParserId。 |
IotInstanceId | String | 否 | iot-n8t*** |
实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID。 注意
实例的更多信息,请参见实例概述。 |
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | iot.system.SystemException |
调用失败时,返回的错误码。更多信息,请参见错误码。 |
Data | Struct |
返回的解析器详细信息。 |
|
DataSourceId | Long | 1003 |
解析器关联的数据源ID。 |
Description | String | 转发数据。 |
解析器描述。 |
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()}); |
解析器已发布脚本。 |
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 |
解析器运行状态。
|
UtcCreated | String | 2022-03-27T12:45:43.000Z |
创建解析器的UTC时间。格式为 |
UtcModified | String | 2022-04-27T12:45:43.000Z |
更新解析器的UTC时间。格式为 |
ErrorMessage | String | 系统异常 |
调用失败时,返回的出错信息。 |
RequestId | String | E4C0FF92-2A86-41DB-92D3-73B60310D25E |
阿里云为该请求生成的唯一标识符。 |
Success | Boolean | true |
表示是否调用成功。
|
示例
请求示例
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=GetParser
&ParserId=1001
&<公共请求参数>
正常返回示例
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>转发数据。</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": "转发数据。",
"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
}