データソースからデータを取得するために、データサービス API 操作関連のクエリタスクを実行します。
使用上の注意
この操作は、アカウントごとに 1 秒あたり最大 5 回呼び出すことができます。
Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。
デバッグ
リクエストパラメーター
パラメーター | タイプ | 必須 | 例 | 説明 |
Action | String | はい | ListAnalyticsData | 実行する操作。値を ListAnalyticsData に設定します。 |
ApiPath | String | はい | /iot-cn-npk1v******/system/query/hist_dev_cnt_stat | API 操作のパス。 IoT Platform コンソールで API Path パラメーターの値を取得するには、[データサービス API] ページに移動し、API 操作の詳細ページを表示します。 |
Condition.N.FieldName | String | はい | testCode | API 操作の条件付きカラムの名前。 IoT Platform コンソールで条件付きカラムの値を取得するには、[データサービス API] ページに移動し、API 操作の詳細ページを表示します。 |
Condition.N.Operate | String | はい | = | 比較演算子。 有効値： IoT Platform コンソールで条件付きカラムに使用できる演算子を取得するには、[データサービス API] ページに移動し、API 操作の詳細ページを表示します。
たとえば、データコレクションに 6 つのレコードがあり、各レコードの
説明 Condition.N.Operate パラメーターに |
IotInstanceId | String | はい | iot-cn-npk1u****** | API 操作が属するインスタンスの ID。 詳細については、「インスタンスの ID を取得する」をご参照ください。 |
IsoId | String | いいえ | oxs_iso_id | 論理分離の ID。このパラメーターは無視してください。 |
PageSize | Integer | いいえ | 100 | 1 ページあたりのエントリ数。 有効値：1 ～ 100。デフォルト値：100。 説明 ページネーションを有効にする場合は、このパラメーターを設定する必要があります。 |
Condition.N.Value | String | いいえ | 4 | 条件付きカラムの値。 IoT Platform コンソールで条件付きカラムの値を取得するには、[データサービス API] ページに移動し、API 操作の詳細ページを表示します。 説明 BETWEEN を |
Condition.N.BetweenStart | String | いいえ | 1 | 値の範囲の開始値。 IoT Platform コンソールで条件付きカラムの値の範囲を取得するには、[データサービス API] ページに移動し、API 操作の詳細ページを表示します。 説明 BETWEEN を |
Condition.N.BetweenEnd | String | いいえ | 5 | 値の範囲の終了値。 IoT Platform コンソールで条件付きカラムの値の範囲を取得するには、[データサービス API] ページに移動し、API 操作の詳細ページを表示します。 説明 BETWEEN を |
PageNum | Integer | いいえ | 1 | 返すページの番号。デフォルト値：1。 |
前述の操作固有のリクエストパラメーターに加えて、この操作を呼び出すときは、共通リクエストパラメーターを設定する必要があります。共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。
レスポンスパラメーター
パラメーター | タイプ | 例 | 説明 |
Code | String | Success | レスポンスコード。有効値：
|
Data | Struct | 呼び出しが成功した場合に返されるデータ。 | |
Count | Long | 3 | 返されたエントリの総数。 |
HasNext | Boolean | false | 次のページが存在するかどうかを示します。有効値：
|
PageNum | Integer | 1 | ページ番号。 |
PageSize | Integer | 100 | 1 ページあたりのエントリ数。 |
ResultJson | String | [{\"testCode\":\"TBB186\",\"testLevel\":5,\"testWorkYears\":3,\"testName\":\"Jack\"},{\"testCode\":\"TBB1314\",\"testLevel\":2,\"testWorkYears\":4,\"testName\":\"Tom\"},{\"testCode\":\"TBB8888\",\"testLevel\":2,\"testWorkYears\":5,\"testName\":\"Eric\"}]" | 返されたデータの詳細。 |
ErrorMessage | String | insufficient auth: no access permissions | 呼び出しが失敗した場合に返されるエラーメッセージ。 |
RequestId | String | 7EC5B624-AF1B-4C4D-BA82-A02BA1****** | リクエストの ID。 |
Success | Boolean | false | 呼び出しが成功したかどうかを示します。有効値：
|
例
リクエストの例
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListAnalyticsData
&ApiPath=/iot-cn-npk1v******/system/query/hist_dev_cnt_stat
&Condition.1.FieldName=testCode
&Condition.1.Operate==
&IotInstanceId=iot-cn-npk1u******
&<共通リクエストパラメーター>成功レスポンスの例
XML 形式
<ListAnalyticsDataResponse>
<RequestId> 7EC5B624-AF1B-4C4D-BA82-A02BA1******</RequestId>
<Data>
<ResultJson>[{\"testCode\":\"TBB186\",\"testLevel\":5,\"testWorkYears\":3,\"testName\":\"Jack\"},{\"testCode\":\"TBB1314\",\"testLevel\":2,\"testWorkYears\":4,\"testName\":\"Tom\"},{\"testCode\":\"TBB8888\",\"testLevel\":2,\"testWorkYears\":5,\"testName\":\"Eric\"}]"</ResultJson>
<PageSize>100</PageSize>
<PageNum>1</PageNum>
<Count>3</Count>
<HasNext>false</HasNext>
</Data>
<Code>Success</Code>
<Success>true</Success>
</ListAnalyticsDataResponse>JSON 形式
{
"RequestId": "7EC5B624-AF1B-4C4D-BA82-A02BA1******",
"Data": {
"ResultJson": "[{\"testCode\":\"TBB186\",\"testLevel\":5,\"testWorkYears\":3,\"testName\":\"Jack\"},{\"testCode\":\"TBB1314\",\"testLevel\":2,\"testWorkYears\":4,\"testName\":\"Tom\"},{\"testCode\":\"TBB8888\",\"testLevel\":2,\"testWorkYears\":5,\"testName\":\"Eric\"}]",
"PageSize": 100,
"PageNum": 1,
"Count": 3,
"HasNext": false
},
"Code": "Success",
"Success": true
}エラーコード
エラーコードのリストについては、「サービスエラーコード」をご参照ください。