All Products
Search

This Product

    IoT Platform:BatchCheckVehicleDevice

    Document Center

    IoT Platform:BatchCheckVehicleDevice

    Last Updated:Nov 28, 2023

    Verifies multiple devices that are added to a cloud gateway product at a time.

    Usage notes

    The BatchCheckVehicleDevice operation is suitable for scenarios in which you want to verify multiple devices that are added to a JT/T 808 cloud gateway product or a GB/T 32960 cloud gateway product at a time.

    QPS limits

    You can call this operation up to 100 times per second per account.

    Note

    The RAM users of an Alibaba Cloud account share the quota of the account.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code for different SDKs.

    Request parameters

    Parameter

    Type

    Required

    Example

    Description

    Action

    String

    Yes

    BatchCheckVehicleDevice

    The operation that you want to perform. Set the value to BatchCheckVehicleDevice.

    IotInstanceId

    String

    Yes

    iot-1n8t****

    The ID of the instance. You can view the ID of the instance on the Overview tab in the IoT Platform console.

    For more information, see Overview.

    ProductKey

    String

    Yes

    a1Bw****

    The ProductKey of the product to which the device belongs.

    DeviceList.N.Manufacturer

    String

    No

    mf0001

    The manufacture ID of the device. If you want to call the BatchCheckVehicleDevice operation to verify a device that is added to a JT/T 808 cloud gateway, you must configure the parameter.

    The ID must be 4 to 11 characters in length, and can contain letters, digits, and hyphens (-).

    Note

    You can specify up to 10,000 device manufacturer IDs in a single call. If the number of device manufacturer IDs exceeds the limit, the excess device manufacturer IDs are discarded.

    DeviceList.N.DeviceModel

    String

    No

    dm0001

    The device model of the device. If you want to call the BatchCheckVehicleDevice operation to verify a device that is added to a JT/T 808 cloud gateway, you must configure the parameter.

    The device model must be 4 to 30 characters in length, and can contain letters, digits, and hyphens (-).

    Note

    You can specify up to 10,000 device models in a single call. If the number of device models exceeds the limit, the excess device models are discarded.

    DeviceList.N.DeviceId

    String

    No

    di0001

    The ID of the device. If you want to call the BatchCheckVehicleDevice operation to verify a device that is added to a JT/T 808 cloud gateway, you must configure the parameter.

    The ID must be 4 to 30 characters in length, and can contain letters, digits, and hyphens (-).

    Note

    You can specify up to 10,000 device IDs in a single call. If the number of device IDs exceeds the limit, the excess device IDs are discarded.

    DeviceList.N.DeviceName

    String

    No

    vin0001

    The DeviceName of the device. If you want to call the BatchCheckVehicleDevice operation to verify a device that is added to a GB/T 32960 cloud gateway, you must configure the parameter.

    The DeviceName must be 1 to 17 characters in length, and can contain letters and digits.

    Note

    You can specify up to 10,000 DeviceNames in a single call. If the number of DeviceNames exceeds the limit, the excess DeviceNames are discarded.

    In addition to the preceding operation-specific request parameters, you must configure common request parameters when you call this operation. For more information about common request parameters, see Common parameters.

    Response parameters

    Parameter

    Type

    Example

    Description

    Code

    String

    iot.system.SystemException

    The error code returned if the call fails. For more information, see the "Error codes" section of this topic.

    Data

    Struct

    The data returned if the call is successful. The data includes the information about the devices that failed to be verified.

    InvalidDetailList

    Array of InvalidDetailList

    The details of invalid devices returned.

    DeviceId

    String

    di_*0001

    The ID of the JT/T 808 cloud gateway device.

    DeviceModel

    String

    dm_*0001

    The device model of the JT/T 808 cloud gateway device.

    DeviceName

    String

    device_*0001

    The DeviceName of the GB/T 32960 cloud gateway device.

    ErrorMsg

    String

    The device name is illegal.

    The error message returned if the device failed to be verified.

    Manufacturer

    String

    mf_*0001

    The manufacturer ID of the JT/T 808 cloud gateway device.

    InvalidDeviceIdList

    List

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

    The invalid JT/T 808 cloud gateway device IDs returned if the system failed to verify the details of the devices.

    InvalidDeviceModelList

    List

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

    The invalid JT/T 808 cloud gateway device models returned if the system failed to verify the details of the devices.

    InvalidDeviceNameList

    List

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

    The invalid GB/T 32960 cloud gateway DeviceNames returned if the system failed to verify the details of the devices.

    InvalidManufacturerList

    List

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

    The invalid JT/T 808 cloud gateway device manufacturer IDs returned if the system failed to verify the details of the devices.

    RepeatedDeviceIdList

    List

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

    The duplicate JT/T 808 cloud gateway device IDs returned if the system failed to verify the details of the devices.

    RepeatedDeviceNameList

    List

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

    The duplicate GB/T 32960 cloud gateway device IDs returned if the system failed to verify the details of the devices.

    ErrorMessage

    String

    A system exception occurred.

    The error message returned if the call fails.

    Success

    Boolean

    true

    Indicates whether the call was successful. Valid values:

    • true: The call was successful.

    • false: The call failed.

    RequestId

    String

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

    The ID of the request.

    Examples

    Sample requests

    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********
&<Common request parameters>

    Sample success responses

    XML format

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

    JSON format

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

    Error code

    HttpCode

    Error Code

    Error message

    Description

    400

    iot.device.TooManyDeviceNamesPerRequest

    The devices you query exceed the maximum number.

    The number of DeviceNames that you specified in the request exceeds the limit.

    400

    iot.device.NoneDeviceNameElement

    The DeviceName list is empty.

    No DeviceNames are specified.

    400

    iot.device.InvalidDeviceParams

    The request parameters are invalid.

    The value of the request parameter is invalid.

    For a list of error codes, see Service error codes.