View rule list
- Print
- PDF
View rule list
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Summary
Views a list of rules.
Request
Request URL
GET {CLOUD_IOT_CORE_API_URL}/rules
Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}
Request parameters
| Parameter name | Required status | Type | Restrictions | Description |
|---|---|---|---|---|
| page | No | int | Page number. Default: 0 | |
| size | No | int | Size of result list. Default: 10 |
Response
Response body
{
"status": "string",
"body": {
"content": [
{
"name": "string",
"description": "string",
"status": "string",
"query": "string",
"modifyTime": "localDateTime",
"registerTime": "localDateTime",
"filterTopic": "string"
}
],
"page": {
"size": "long",
"totalElements": "long",
"totalPages": "long",
"number": "long"
}
}
}
| Category | Type | Description |
|---|---|---|
| status | string | Indicates whether response was successful |
| body.content[].name | string | Name of the trigger |
| body.content[].description | string | Description of the trigger |
| body.content[].status | string | Rule status |
| body.content[].query | string | Trigger query |
| body.content[].modifyTime | localDateTime | Trigger last modified date |
| body.content[].registerTime | localDateTime | Trigger creation date |
| body.content[].filterTopic | string | Trigger topic |
Example
{
"status": "SUCCESS",
"body": {
"content": [
{
"name": "lux",
"description": "turn off",
"status": "ENABLE",
"query": "select lux, bulb_id from \"myhome100/abc/+/abc\" where lux > -1",
"modifyTime": "2020-09-25 20:10:56",
"registerTime": "2020-09-25 20:10:56",
"filterTopic": "myhome100/abc/+/abc"
}
],
"page": {
"size": 10,
"totalElements": 1,
"totalPages": 1,
"number": 0
}
}
}
Was this article helpful?