すべてのプロダクト
Search
ドキュメントセンター

IoT Platform:GetParser

最終更新日:Apr 17, 2025

パーサーの詳細をクエリします。詳細には、基本情報、解析スクリプト、ステータス、および関連付けられているデータソースが含まれます。

QPS 制限

各 Alibaba Cloud アカウントは、最大 10 クエリ/秒(QPS)を実行できます。

説明 Alibaba Cloud アカウントの RAM ユーザーは、Alibaba Cloud アカウントのクォータを共有します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメータータイプ必須説明
ActionStringはいGetParser

実行する操作。値を GetParser に設定します。

ParserIdIntegerはい1001

ListParser 操作を呼び出してパーサーをクエリし、パーサー の ID を取得できます。

IotInstanceIdStringいいえiot-n8t***

インスタンスの ID。IoT Platform コンソールの 概要 ページでインスタンスの ID を表示できます。

重要
  • インスタンスに ID がある場合は、このパラメーターに ID を指定する必要があります。指定しないと、呼び出しは失敗します。
  • インスタンスに対して 概要 ページまたは ID が生成されていない場合は、このパラメーターを設定する必要はありません。

詳細については、「概要」をご参照ください。

上記の操作固有のリクエストパラメーターに加えて、この操作を呼び出すときは、共通のリクエストパラメーターを設定する必要があります。詳細については、「共通リクエストパラメーター」をご参照ください。

レスポンスパラメーター

パラメータータイプ説明
CodeStringiot.system.SystemException

呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。

DataStruct

パーサーの詳細。

DataSourceIdLong1003

パーサーに関連付けられているデータソースの ID。

DescriptionStringForward data.

パーサーの説明。

NameStringDataParser

パーサーの名前。

ParserIdLong1001

パーサーの ID。

ScriptStringvar 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()});

パーサーにリリースされた解析スクリプト。

ScriptDraftStringvar 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()});

解析スクリプトのドラフト。

StatusStringSTOP

パーサーのステータス。有効な値:

  • RUNNING: パーサーは実行中です。
  • STOP: パーサーは無効になっています。
  • ABNORMAL: パーサーは異常です。
UtcCreatedString2022-03-27T12:45:43.000Z

パーサーが作成された時刻。時刻は UTC で表示されます。フォーマット:yyyy-MM-dd'T'HH:mm:ss.SSS'Z'

UtcModifiedString2022-04-27T12:45:43.000Z

パーサーが更新された時刻。時刻は UTC で表示されます。フォーマット:yyyy-MM-dd'T'HH:mm:ss.SSS'Z'

ErrorMessageStringA system exception occurred.

リクエストが失敗した場合に返されるエラーメッセージ。

RequestIdStringE4C0FF92-2A86-41DB-92D3-73B60310D25E

リクエストの ID。

SuccessBooleantrue

呼び出しが成功したかどうかを示します。

  • true: 呼び出しは成功しました。
  • false: リクエストは失敗しました。

リクエストの例

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>Forward data. </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": "Forward data.",
        "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
}

エラーコード

HttpCodeエラーコードエラーメッセージ説明
400iot.system.SystemExceptionAn internal error occurred. Try again later.システム例外が発生したために返されたエラーメッセージ。
400iot.common.InvalidFormattedParameterThe parameter format is invalid.パラメーター形式が無効なために返されたエラーメッセージ。
400iot.rule.QueryRuleFailedAn error occurred while querying the rule.ルールをクエリできなかったために返されたエラーメッセージ。

エラーコードの一覧については、API エラーセンターをご覧ください。