Get Monitored Object List on Pages

Last Updated on : 2023-06-21 07:13:09download

Get a list of monitored objects on pages based on the types and names of the monitored objects. The returned result includes the name of the monitored object and a list of linked devices.

API address

GET: /v1.0/iot-03/si/monitor-object/page

Request parameter

Parameter name	Type	IN	Required	Description
req	MonitorObjectQueryDTO	query	true	The query criteria.

Description of req

Parameter name	Type	Required	Description
monitor_object_type	String	false	The type of a specified monitored object.
monitor_object_name	String	false	The name of a specified monitored object.
page_no	Long	true	The page number.
page_size	Long	true	The number of items returned on each page.

Return parameter

Parameter name	Type	Description
result	Page	The returned result.

Description of result

Parameter name	Type	Description
total	Long	The total number of results.
list	List	The list of results.
has_more	Boolean	Specifies whether to return the next page.

Description of list

Parameter name	Type	Description
monitor_object_id	String	The ID of a specified monitored object.
monitor_object_name	String	The name of a specified monitored object.
remark	String	The remarks.
monitor_object_type	String	The type of a specified monitored object.

Request example

GET: /v1.0/iot-03/si/monitor-object/page?monitor_object_type=environment&pageNo=1&pageSize=1

Return example

{
  "result": {
    "total": 22,
    "has_more": true,
    "list": [
      {
        "monitor_object_id": "197***",
        "monitor_object_name": "Grand Center",
        "remark": "Remarks of Grand Center"
        "monitor_object_type": "environment"
      }
    ]
  }
}

Error code

For more information, see error code.

Prev DocEnvironmental monitoring object management

Next DocGet Details of Monitored Object