규칙 조회

인쇄
공유
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

개요

규칙을 조회합니다

요청

요청 URL

GET {CLOUD_IOT_CORE_API_URL}/rules/{ruleName}

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}

Path Variables

항목	필수 여부	타입	설명
ruleName	Yes	string	규칙 이름

응답

응답 바디

{
    "status": "string",
    "body": {
        "rule": {
            "name": "string",
            "description": "string",
            "status": "string",
            "query": "string",
            "modifyTime": "localDateTime",
            "registerTime": "localDateTime",
            "filterTopic": "string"
        },
        "actions": {
            "matchActionList": [
                {
                    "type": "string",
                    "relatedProduct": "string",
                    "displayName": "string",
                    "modifyTime": "localDateTime",
                    "registerTime": "localDateTime",
                    "relatedProductAction": "json"
                }
            ],
            "errorAction": {
                "type": "string",
                "relatedProduct": "string",
                "displayName": "string",
                "modifyTime": "localDateTime",
                "registerTime": "localDateTime",
                "relatedProductAction": "json"
            }
        }
    }
}

항목	타입	설명
status	string	응답 성공 여부
body.content[].rule.name	string	규칙 이름
body.content[].rule.description	string	규칙 설명
body.content[].rule.status	string	규칙 상태
body.content[].rule.query	string	규칙 쿼리
body.content[].rule.modifyTime	localDateTime	최근 수정날짜
body.content[].rule.registerTime	localDateTime	규칙 생성날짜
body.content[].rule.filterTopic	string	규칙 토픽
body.content[].actions.matchActionList[].type	string	액션 역할 (M: matchedAction, E: errorAction)
body.content[].actions.matchActionList[].relatedProduct	string	액션 종류
body.content[].actions.matchActionList[].displayName	string	액션 대표 이름
body.content[].actions.matchActionList[].modifyTime	string	액션 최근 수정날짜
body.content[].actions.matchActionList[].registerTime	string	액션 생성날짜
body.content[].actions.matchActionList[].relatedProductAction	json	액션 상세
body.content[].actions.errorAction.type	string	액션 역할 (M: matchedAction, E: errorAction)
body.content[].actions.errorAction.relatedProduct	string	에러 액션 종류
body.content[].actions.errorAction.displayName	string	에러 액션 대표 이름
body.content[].actions.errorAction.modifyTime	string	에러 액션 최근 수정날짜
body.content[].actions.errorAction.registerTime	string	에러 액션 생성날짜
body.content[].actions.errorAction.relatedProductAction	json	에러 액션 상세

응답 예시

{
    "status": "SUCCESS",
    "body": {
        "rule": {
            "name": "lux",
            "description": "turn off",
            "status": "ENABLE",
            "query": "select lux, bulb_id from \"myhome100/abc/+/abc\" where lux > -1",
            "modifyTime": "2020-09-27 12:52:08",
            "registerTime": "2020-09-27 12:52:08",
            "filterTopic": "myhome100/abc/+/abc"
        },
        "actions": {
            "matchActionList": [
                {
                    "type": "M",
                    "relatedProduct": "REPUBLISH",
                    "displayName": "republish_a",
                    "modifyTime": "2020-09-27 12:52:08",
                    "registerTime": "2020-09-27 12:52:08",
                    "relatedProductAction": {
                        "topic": "republish_a",
                        "version": 1
                    }
                }
            ],
            "errorAction": {
                "type": "E",
                "relatedProduct": "REPUBLISH",
                "displayName": "republish_a",
                "modifyTime": "2020-09-27 12:52:08",
                "registerTime": "2020-09-27 12:52:08",
                "relatedProductAction": {
                    "topic": "republish_a",
                    "version": 1
                }
            }
        }
    }
}

이 문서가 도움이 되었습니까?

What's Next

규칙 수정

개요
요청
응답
응답 예시

태그

Cloud IoT Core