Cloud Services API ReferenceAdvanced Device ServicesExtension APIsRobot Vacuum Open APIsLaser Robot VacuumGet Link of Real-Time Map

Get Link of Real-Time Map

Last Updated on : 2023-06-20 14:54:03

Get the link of a specified real-time map file based on the device ID. The link is valid for 1 hour.

API address

GET: /v1.0/users/sweepers/file/{device_id}/realtime-map

Request parameter

Parameter name	Type	IN	Required	Description
device_id	String	uri	true	The device ID.

Return parameter

Parameter name	Type	Description
result	List	The returned result.

Description of result

Parameter name	Type	Description
map_type	Integer	The file type. Valid values: `0`: layout map. `1`: path map. `2`: incremental path map. `3`: planning map.
map_url	String	The temporary link of a specified file.

Request example

GET: /v1.0/users/sweepers/file/6c6561cfb316df6e7a****/realtime-map

Return example

{
    "result": [
        {
            "map_url": "https://****.com/f94e56-12852922-yxzne56c96fb00522aa7/common/layout/lay.bin?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKIDopcCYgw0qRoyV5qfKjvg2pPkqESnb5zI%26q-sign-time%3D1641884412%3B1641888012%26q-key-time%3D1641884412%3B1641888012%26q-header-list%3Dhost%26q-url-param-list%3D%26q-signature%3Dbca0788638264679917eb09123c3ee8edb93****",
            "map_type": 0
        },
        {
            "map_url": "https://****.com/f94e56-12852922-yxzne56c96fb00522aa7/common/route/rou.bin?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKIDopcCYgw0qRoyV5qfKjvg2pPkqESnb5zI%26q-sign-time%3D1641884412%3B1641888012%26q-key-time%3D1641884412%3B1641888012%26q-header-list%3Dhost%26q-url-param-list%3D%26q-signature%3D357b8c12a9e38cc40c9d948e09be7459bae4****",
            "map_type": 1
        }
    ],
    "t": 1641884412821,
    "success": true
}

Error code

For more information, see error code.

Prev DocModify Cleaning Map Name

Next DocDelete Cleaning Map