Query Automation List

Last Updated on : 2023-06-15 05:04:45

Query a list of automations on the pages.

API address

GET: /v2.0/iot-03/automations

Request parameter

Parameter name	Type	IN	Required	Description
page_no	Integer	query	false	The page number. Default value: `10`.
page_size	Integer	query	false	The number of items returned on each page. The value ranges from `1` to `100`. Default value: `20`.

Return parameter

Parameter name	Type	Description
result	AutomationsRes	The returned result.

Description of result

Parameter name	Type	Description
page_no	Integer	The page number.
page_size	Integer	The number of items returned on each page.
data	List	The list of data.
total	Long	The total number of items to be returned.

Description of data

Parameter name	Type	Description
name	String	The name of a specified automation.
status	Integer	The status of automation.Valid values: `0`: disabled. `1`: enabled.
create_time	Long	The time when it is created.
modify_time	Long	The last update time.
automation_id	String	The ID of a specified automation.
automation_type	String	The type of automation. Valid values: `local`: local automation. `lan`: automation over LAN. `cloud`: automation in the cloud.

Request example

GET: /v2.0/iot-03/automations

Return example

{
    "result": {
        "data": [
            {
                "create_time": 1635389147428,
                "modify_time": 1635389264298,
                "automation_id": "L7lYM2ZEsonW****",
                "automation_type": "cloud",
                "name": "This is an automation",
                "status": 0
            }
        ],
        "page_no": 1,
        "total": 100,
        "page_size": 20
    },
    "t": 1635389462960,
    "success": true
}

Error code

For more information, see error code.

Prev DocUpdate Automation

Next DocQuery Automation Details