ルールリストの照会

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

概要

ルールリストを照会します。

リクエスト

リクエスト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}

リクエストパラメーター

パラメーター名	必須の有無	タイプ	制約事項	説明
page	No	int		ページ番号。基本値: 0
size	No	int		結果リストのサイズ基本値: 10

レスポンス

レスポンスボディ

{
    "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"
        }
    }
}

項目	タイプ	説明
status	string	レスポンスの成否
body.content[].name	string	ルール名
body.content[].description	string	ルール説明
body.content[].status	string	ルールの状態
body.content[].query	string	ルールクエリ
body.content[].modifyTime	localDateTime	ルールの最終修正日
body.content[].registerTime	localDateTime	ルールの作成日
body.content[].filterTopic	string	ルールトピック

例

{
    "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
        }
    }
}

この記事は役に立ちましたか?

What's Next

ルールの作成

概要
リクエスト
レスポンス
例

タグ

Cloud IoT Core