JT-T 808 と GB-T 32960 車両デバイス情報の概要 - IoT Platform

クラウドゲートウェイデバイスに関する情報をクエリします。

使用方法

QueryVehicleDevice 操作は、JT/T 808 または GB/T 32960 クラウドゲートウェイデバイスに関する情報をクエリする場合に適しています。

QPS 制限

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

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

デバッグ

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

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	Yes	QueryVehicleDevice	実行する操作。値を QueryVehicleDevice に設定します。
IotInstanceId	String	Yes	iot-2w****	インスタンスの ID。IoT Platform コンソールの [概要] タブでインスタンスの ID を表示できます。詳細については、「概要」をご参照ください。
ProductKey	String	Yes	a1Bw****	デバイスが属するプロダクトの ProductKey。
DeviceName	String	Yes	light	デバイスの名前。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、このトピックの「[エラーコード]」セクションをご参照ください。
Data	Struct		返されるデバイス情報。
CreateTime	Long	1557062301656	デバイスが作成されたタイムスタンプ。単位：ミリ秒。
DeviceName	String	light	デバイスの DeviceName。
IotId	String	dm0001	デバイスの ID。ID は、IoT Platform がデバイスに発行する一意の識別子です。
JtProtocolDeviceData	Struct		返されるデバイスの登録と検証の情報。このパラメーターは、JT/T 808 クラウドゲートウェイデバイスを使用する場合にのみ返されます。
AuthCode	String	*******	デバイスの確認コード。
City	String	Hangzhou	デバイスが登録されている市。
DeviceId	String	di0001	デバイスの ID。
DeviceModel	String	dm0001	デバイスのモデル。
Manufacturer	String	mf0001	デバイスメーカーの ID。
Province	String	Zhejiang	デバイスが登録されている省。
RegisterTime	Long	1517062301656	デバイスが登録されたタイムスタンプ。単位：ミリ秒。
Status	String	create	デバイスのステータス。有効な値： create: デバイスが作成されます。 register: デバイスが登録されます。 unregister: デバイスの登録が解除されます。
VehicleColour	String	1	ナンバープレートの色。値は JT/T 808 プロトコルの要件を満たしている必要があります。詳細については、「JT/T 808-2019」をご参照ください。
VehicleNumber	String	ZheA****	ナンバープレート番号。
ModifiedTime	Long	1657062301656	デバイスが最後に更新されたタイムスタンプ。単位：ミリ秒。
ProductKey	String	a1BwAGV****	デバイスが属するプロダクトの ProductKey。
Protocol	String	gb32960	クラウドゲートウェイのプロトコルタイプ。有効な値： gb32960: GB/T 32960 プロトコル。 jt808: JT/T 808 プロトコル。
ErrorMessage	String	A system exception occurred.	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	E4C0FF92-2A86-41DB-92D3-73B60310D25E	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。有効な値： true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。

例

リクエストの例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryVehicleDevice
&ProductKey=a1Bw****
&DeviceName=light
&IotInstanceId=iot-cv3********
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<QueryVehicleDeviceResponse>
  <RequestId>CF291A12-EBB7-5A38-A087-C8A04450913E</RequestId>
  <Data>
        <IotId>ERfsXh***************wk05dm0</IotId>
        <ModifiedTime>1695274556000</ModifiedTime>
        <CreateTime>1695274556000</CreateTime>
        <Protocol>gb32960</Protocol>
        <ProductKey>k05d******</ProductKey>
        <DeviceName>Device01</DeviceName>
  </Data>
  <Success>true</Success>
</QueryVehicleDeviceResponse>

JSON 形式

{
    "RequestId": "CF291A12-EBB7-5A38-A087-C8A04450913E",
    "Data": {
        "IotId": "ERfsXh***************wk05dm0",
        "ModifiedTime": 1695274556000,
        "CreateTime": 1695274556000,
        "Protocol": "gb32960",
        "ProductKey": "k05d******",
        "DeviceName": "Device01"
    },
    "Success": true
}

エラーコード

HttpCode	エラーコード	エラーメッセージ	説明
400	Iot.Device.NotExistedDevice	The device does not exist.	デバイスが存在しないか、アクティブ化されていません。
400	iot.device.NullDeviceName	The ProductKey or DeviceName parameter cannot be empty.	ProductKey または DeviceName パラメーターが空です。
400	iot.device.NoPermission	The Operation has not permission to the device.	デバイスを管理する権限がありません。
400	Iot.Device.NoVehicleProtocolDevice	The data must be IoV device data.	データは IoV（Internet of Vehicles）デバイスに属していません。

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