ListParser - IoT Platform - Alibaba Cloud ドキュメントセンター

パーサーの詳細をクエリします。詳細には、基本情報、ステータス、作成時間、変更時間が含まれます。

QPS 制限

Alibaba Cloud アカウントごとに、最大 10 クエリ/秒（QPS）を実行できます。

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

デバッグ

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

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	Yes	ListParser	実行する操作。値を ListParser に設定します。
CurrentPage	Integer	Yes	1	返すページ番号。有効な値：1～100。
PageSize	Integer	Yes	10	各ページに返すエントリの数。最大値：100。
IotInstanceId	String	No	iot-n8t****	インスタンスの ID。IoT Platform コンソールの [概要] ページでインスタンスの [ID] を表示できます。重要インスタンスに ID がある場合は、このパラメーターに ID を指定する必要があります。指定しないと、呼び出しは失敗します。インスタンスに対して [概要] ページまたは ID が生成されていない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。
SearchName	String	No	DataParser	パーサー名と照合するためのキーワードとして使用する文字列。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	ParserList の配列		一致するパーサーの詳細。
ParserList
Description	String	Forward data.	パーサーの説明。
Name	String	DataParser	パーサーの名前。
ParserId	Long	1001	パーサーの ID。
Status	String	STOP	パーサーのステータス。有効な値： RUNNING: パーサーは実行中です。 STOP: パーサーは無効になっています。 ABNORMAL: パーサーは異常です。
UtcCreated	String	2022-03-21T12:45:43.000Z	パーサーが作成された日時。時間は UTC で表示されます。フォーマット：`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`。
UtcModified	String	2022-03-25T12:45:43.000Z	パーサーが最後に更新された日時。時間は UTC で表示されます。フォーマット：`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`。
ErrorMessage	String	A system exception occurred.	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	E4C0FF92-2A86-41DB-92D3-73B60310D25E	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。
Total	Integer	100	返されたエントリの総数。

例

リクエストの例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListParser
&CurrentPage=1
&PageSize=10
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<ListParserResponse>
    <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
    <Total>100</Total>
    <Data>
            <ParserList>
                    <Status>STOP</Status>
                    <Description>Forward data. </Description>
                    <UtcCreated>2022-03-21T12:45:43.000Z</UtcCreated>
                    <UtcModified>2022-03-25T12:45:43.000Z</UtcModified>
                    <ParserId>1001</ParserId>
                    <Name>DataParser1</Name>
            </ParserList>
            <ParserList>
                    <Status>STOP</Status>
                    <Description>Forward data. </Description>
                    <UtcCreated>2022-03-21T12:50:43.000Z</UtcCreated>
                    <UtcModified>2022-03-25T12:48:43.000Z</UtcModified>
                    <ParserId>1002</ParserId>
                    <Name>DataParser2</Name>
            </ParserList>
    </Data>
    <Success>true</Success>
</ListParserResponse>

JSON 形式

{
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "Total": 100,
    "Data": {
        "ParserList": [
            {
                "Status": "STOP",
                "Description": "Forward data",
                "UtcCreated": "2022-03-21T12:45:43.000Z",
                "UtcModified": "2022-03-25T12:45:43.000Z",
                "ParserId": 1001,
                "Name": "DataParser1"
            },
            {
                "Status": "STOP",
                "Description": "Forward data.",
                "UtcCreated": "2022-03-21T12:50:43.000Z",
                "UtcModified": "2022-03-25T12:48:43.000Z",
                "ParserId": 1002,
                "Name": "DataParser2"
            }
        ]
    },
    "Success": true
}

エラーコード

HttpCode	エラーコード	エラーメッセージ	説明
400	iot.system.SystemException	An internal error occurred. Try again later.	システム例外が発生したために返されたエラーメッセージ。
400	iot.common.InvalidPageParams	The specified pagination size or pagination parameter is invalid.	指定されたページサイズまたはページ番号が無効なために返されたエラーメッセージ。
400	iot.common.InvalidFormattedParameter	The parameter format is invalid.	パラメーターの形式が無効なために返されたエラーメッセージ。
400	iot.rule.QueryRulePageActionError	An error occurred while querying the rule action list across multiple pages.	システムがルールのクエリに失敗したために返されたエラーメッセージ。

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