IoT物联网-查询订阅列表:请求参数

时间：2025-01-26 10:34:00

IoT物联网

请求参数

名称	必选/可选	类型	位置	说明
X-Auth-Token	必选	String	Header	用户Token。通过调用 IAM 服务获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。
Instance-Id	可选	String	Header	实例ID。物理多租下各实例的唯一标识，一般华为云租户无需携带该参数，仅在物理多租场景下从管理面访问API时需要携带该参数。
project_id	必选	String	Path	项目ID。获取方法请参见获取项目ID。
resource	可选	String	Query	订阅的资源名称。 device：设备。 device.message：设备消息。 device.data：设备数据。 device.message.status：设备消息状态。 device.status：设备状态。 batchtask.status：批量任务状态。
event	可选	String	Query	订阅的资源事件，取值范围：activate、update。 event需要与resource关联使用，具体的“resource：event”映射关系如下： device：activate（设备激活） device.data：update（设备数据变化） device.message.status：update（设备消息状态） device.message：report（设备消息上报） device.status：update （设备状态变化） batchtask.status：update （批量任务状态变化）
callbackurl	可选	String	Query	订阅的回调地址，用于接收对应资源事件的通知消息，例如：https://host:port/callbackurltest。
app_id	可选	String	Query	资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，可以携带该参数查询指定资源空间下的消息订阅列表，不携带该参数则会查询该用户下所有消息订阅列表。
channel	可选	String	Query	物联网平台推送通知消息时使用的协议通道。使用“http”填充，表示该订阅推送协议通道为http(s)协议。
limit	可选	Integer	Query	分页查询时每页显示的记录数。默认每页10条记录，最大设定每页50条记录，取值范围为1-50的整数。
marker	可选	String	Query	上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。
offset	可选	Integer	Query	表示从marker后偏移offset条记录开始查询。默认为0，取值范围为0-500的整数。当offset为0时，表示从marker后第一条记录开始输出。 - 限制offset最大值是出于API性能考虑，您可以搭配marker使用该参数实现翻页，例如每页50条记录，1-11页内都可以直接使用offset跳转到指定页，但到11页后，由于offset限制为500，您需要使用第11页返回的marker作为下次查询的marker，以实现翻页到12-22页。