调用ListDevices查询设备列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListDevices |
系统规定参数。取值:ListDevices。 |
| DeviceModel | String | 否 | ROEWE RX5 |
设备型号名,支持模糊查询 |
| DeviceModelId | Integer | 否 | 10 |
设备型号ID |
| Length | String | 否 | 20 |
返回结果列表最大长度 |
| ProjectId | String | 否 | projectTest |
项目ID |
| RegionId | String | 否 | cn-shanghai |
地域ID |
| Start | String | 否 | 1 |
返回结果列表起始位置 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Devices |
返回内容 |
||
| DeviceBrand | String | ROEWE |
设备品牌 |
| DeviceId | String | cn.1234567890 |
设备ID |
| DeviceModel | String | ROEWE RX5 |
设备型号 |
| DeviceModelId | Long | 10 |
设备型号ID |
| DeviceType | String | car_auto |
设备类型 |
| HardwareId | String | xxxxxxxx |
硬件ID |
| MacAddress | String | 00:00:00:00:00:00 |
MAC地址 |
| Name | String | 我的设备 |
设备昵称 |
| ProjectId | String | projectTest |
项目ID |
| Region | String | cn |
设备所在国家代码 |
| SerialNumber | String | xxxxxxxx |
设备序列号 |
| SoftwareId | String | xxxxxxxx |
软件ID |
| Status | String | 0 |
设备状态 |
| UsageType | Integer | 0 |
设备使用性质。 0表示私人设备,1表示运营或共享设备。 |
| UsageTypeDesc | String | private |
设备使用性质描述。 private表示私人设备,business表示运营或共享设备。 |
| Uuid | String | xxxxxxxx |
设备UUID |
| Vin | String | xxxxxxxx |
设备车架号(汽车相关产品使用) |
| RequestId | String | 9c7a3b09-a69a-43f5-8bf2-84f7119810eb |
请求ID |
示例
请求示例
http(s)://[Endpoint]/?Action=ListDevices
&DeviceModelId=10
&Length=20
&ProjectId=projectTest
&Start=1
&<公共请求参数>
正常返回示例
XML 格式
<ListDevicesResponse>
<Devices>
<DeviceBrand>ROEWE</DeviceBrand>
<DeviceId>cn.1234567890</DeviceId>
<DeviceModel>ROEWE RX5</DeviceModel>
<DeviceModelId>10</DeviceModelId>
<DeviceType>car_auto</DeviceType>
<HardwareId>xxxxxxx</HardwareId>
<MacAddress>00:00:00:00:00:00</MacAddress>
<Name>我的设备</Name>
<ProjectId>projectTest</ProjectId>
<Region>cn</Region>
<SerialNumber>xxxxxx</SerialNumber>
<SoftwareId>xxxxxx</SoftwareId>
<UsageType>0</UsageType>
<UsageTypeDesc>private</UsageTypeDesc>
<Status>0</Status>
<Uuid>xxxxxx</Uuid>
</Devices>
<RequestId>E94C9864-56FB-44AD-AC0C-A1CEFB332254</RequestId>
</ListDevicesResponse>
JSON 格式
{
"RequestId":"E94C9864-56FB-44AD-AC0C-A1CEFB332254",
"Devices":[
{
"Uuid":"xxxxxx",
"DeviceId":"cn.1234567890",
"DeviceBrand":"ROEWE",
"SoftwareId":"xxxxxx",
"DeviceModelId":10,
"DeviceType":"car_auto",
"UsageType":0,
"DeviceModel":"ROEWE RX5",
"Name":"我的设备",
"SerialNumber":"xxxxxx",
"Status":0,
"UsageTypeDesc":"private",
"MacAddress":"00:00:00:00:00:00",
"Region":"cn",
"HardwareId":"xxxxxxx",
"ProjectId":"projectTest"
}
]
}
错误码
访问错误中心查看更多错误码。