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

IoT Platform:BatchCheckVehicleDevice

最終更新日:Apr 17, 2025

クラウドゲートウェイ製品に追加された複数のデバイスを一度に検証します。

使用方法

BatchCheckVehicleDevice 操作は、JT/T 808 クラウドゲートウェイ製品または GB/T 32960 クラウドゲートウェイ製品に追加された複数のデバイスを一度に検証する場合に適しています。

QPS 制限

この操作は、アカウントごとに 1 秒あたり最大 100 回呼び出すことができます。

説明

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

デバッグ

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

リクエストパラメーター

パラメーター

タイプ

必須

説明

Action

String

はい

BatchCheckVehicleDevice

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

IotInstanceId

String

はい

iot-1n8t****

インスタンスの ID。インスタンスの ID は、IoT Platform コンソールの [概要] タブで確認できます。

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

ProductKey

String

はい

a1Bw****

デバイスが属する製品の ProductKey。

DeviceList.N.Manufacturer

String

いいえ

mf0001

デバイスの製造 ID。BatchCheckVehicleDevice 操作を呼び出して JT/T 808 クラウドゲートウェイに追加されたデバイスを検証する場合は、このパラメーターを設定する必要があります。

ID は 4 ~ 11 文字で、文字、数字、およびハイフン (-) を含めることができます。

説明

1 回の呼び出しで最大 10,000 個のデバイス製造 ID を指定できます。デバイス製造 ID の数が制限を超えると、超過分のデバイス製造 ID は破棄されます。

DeviceList.N.DeviceModel

String

いいえ

dm0001

デバイスのデバイスモデル。BatchCheckVehicleDevice 操作を呼び出して JT/T 808 クラウドゲートウェイに追加されたデバイスを検証する場合は、このパラメーターを設定する必要があります。

デバイスモデルは 4 ~ 30 文字で、文字、数字、およびハイフン (-) を含めることができます。

説明

1 回の呼び出しで最大 10,000 個のデバイスモデルを指定できます。デバイスモデルの数が制限を超えると、超過分のデバイスモデルは破棄されます。

DeviceList.N.DeviceId

String

いいえ

di0001

デバイスの ID。BatchCheckVehicleDevice 操作を呼び出して JT/T 808 クラウドゲートウェイに追加されたデバイスを検証する場合は、このパラメーターを設定する必要があります。

ID は 4 ~ 30 文字で、文字、数字、およびハイフン (-) を含めることができます。

説明

1 回の呼び出しで最大 10,000 個のデバイス ID を指定できます。デバイス ID の数が制限を超えると、超過分のデバイス ID は破棄されます。

DeviceList.N.DeviceName

String

いいえ

vin0001

デバイスの DeviceName。BatchCheckVehicleDevice 操作を呼び出して GB/T 32960 クラウドゲートウェイに追加されたデバイスを検証する場合は、このパラメーターを設定する必要があります。

DeviceName は 1 ~ 17 文字で、文字と数字を含めることができます。

説明

1 回の呼び出しで最大 10,000 個の DeviceName を指定できます。DeviceName の数が制限を超えると、超過分の DeviceName は破棄されます。

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

レスポンスパラメーター

パラメーター

タイプ

説明

Code

String

iot.system.SystemException

呼び出しが失敗した場合に返されるエラーコード。詳細については、このトピックの「エラーコード」セクションをご参照ください。

Data

Struct

呼び出しが成功した場合に返されるデータ。データには、検証に失敗したデバイスに関する情報が含まれます。

InvalidDetailList

InvalidDetailList の配列

返された無効なデバイスの詳細。

DeviceId

String

di_*0001

JT/T 808 クラウドゲートウェイデバイスの ID。

DeviceModel

String

dm_*0001

JT/T 808 クラウドゲートウェイデバイスのデバイスモデル。

DeviceName

String

device_*0001

GB/T 32960 クラウドゲートウェイデバイスの DeviceName。

ErrorMsg

String

デバイス名は無効です。

デバイスの検証に失敗した場合に返されるエラーメッセージ。

Manufacturer

String

mf_*0001

JT/T 808 クラウドゲートウェイデバイスの製造 ID。

InvalidDeviceIdList

List

{ "InvalidDeviceIdList": [ "DEVIC^*$" ] }

システムがデバイスの詳細の検証に失敗した場合に返される、無効な JT/T 808 クラウドゲートウェイデバイス ID。

InvalidDeviceModelList

List

{ "InvalidDeviceModelList": [ "DEM$", "DE" ] }

システムがデバイスの詳細の検証に失敗した場合に返される、無効な JT/T 808 クラウドゲートウェイデバイスモデル。

InvalidDeviceNameList

List

{ "InvalidDeviceNameList": [ "APT$", "aw" ] }

システムがデバイスの詳細の検証に失敗した場合に返される、無効な GB/T 32960 クラウドゲートウェイ DeviceName。

InvalidManufacturerList

List

{ "InvalidManufacturerList": [ "manufacturer#&_", "aw" ] }

システムがデバイスの詳細の検証に失敗した場合に返される、無効な JT/T 808 クラウドゲートウェイデバイス製造 ID。

RepeatedDeviceIdList

List

{ "RepeatedDeviceIdList": [ "deviceId01", "deviceId02" ] }

システムがデバイスの詳細の検証に失敗した場合に返される、重複した JT/T 808 クラウドゲートウェイデバイス ID。

RepeatedDeviceNameList

List

{ "RepeatedDeviceNameList": [ "abcd", "asdf" ] }

システムがデバイスの詳細の検証に失敗した場合に返される、重複した GB/T 32960 クラウドゲートウェイデバイス ID。

ErrorMessage

String

システム例外が発生しました。

呼び出しが失敗した場合に返されるエラーメッセージ。

Success

Boolean

true

呼び出しが成功したかどうかを示します。有効な値:

  • true: 呼び出しは成功しました。

  • false: 呼び出しは失敗しました。

RequestId

String

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

リクエストの ID。

リクエストの例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=BatchCheckVehicleDevice
&DeviceList.1.DeviceModel=dm0001
&DeviceList.1.Manufacturer=mf0001
&DeviceList.1.DeviceId=di0001
&ProductKey=a1BwAGV****
&IotInstanceId=iot-cv3********
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<BatchCheckVehicleDeviceResponse>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <Code></Code>
  <Success>true</Success>
</BatchCheckVehicleDeviceResponse>

JSON 形式

{
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "Code": "",
    "Success": true
}

エラーコード

HttpCode

エラーコード

エラーメッセージ

説明

400

iot.device.TooManyDeviceNamesPerRequest

クエリ対象のデバイスが最大数を超えています。

リクエストで指定した DeviceName の数が制限を超えています。

400

iot.device.NoneDeviceNameElement

DeviceName リストが空です。

DeviceName が指定されていません。

400

iot.device.InvalidDeviceParams

リクエストパラメーターが無効です。

リクエストパラメーターの値が無効です。

エラーコードのリストについては、「サービスエラーコード」をご参照ください。