Oracle Internet of Things Cloud ServiceのREST API

処理済メッセージ数の取得

get

/iot/api/v2/monitoring/metrics/processedMessageCount

サービス・インスタンスで、指定された統合に送信するために処理されたメッセージの数を返します。問合せパラメータなしのGETリクエストでは、過去24時間のデータが時間単位の粒度で返されます(最大1分のラグの現在の時間のメッセージの累積数を含む)。問合せパラメータを指定して、データ粒度を日単位または月単位に変更したり、指定の時間枠またはデータ・ポイントの数に変更することができます。

リクエスト

問合せパラメータ

limit(optional): integer(int32)

返されるデータ・ポイントのデフォルト数を上書きします。指定された期間の値の乗数として機能します。たとえば、periodをHourlyに、toDateを2015-04-09T08:00:00Zに設定した場合、countを5に設定すると、2015年4月9日の08:00時に終了する過去5時間の時間単位のデータが返されます。
orderBy(optional): string

指定されたキー/値ペアごとに、返されたデータを並べ替えます。タイムスタンプによって結果を並べ替えるには、キーdateTime (大文字/小文字が区別されます)を指定できます。キーの対応する値にはascまたはdesc (両方とも大文字/小文字が区別されます)を指定でき、それぞれ昇順または降順を意味します。指定しない場合、デフォルト値はascです。
period(optional): string

情報を求める期間の粒度を指定します。使用可能な期間は、Hourly、DailyまたはMonthlyです(大/小文字の区別なし)。デフォルト値は、Hourlyです。
periodをHourlyに設定すると、過去24時間のデータが時間単位の粒度で返されます。返されるデータは、1時間の粒度です(たとえば、01:00時、00:00時などのデータが返されます)。
periodをDailyに設定すると、過去30日間のデータが日単位の粒度で返されます。返されるデータは、暦日の粒度です(たとえば、翌日の早朝に計算された全日のデータが返されます)。タイムスタンプは、全日のデータの集計によって日次情報が作成された時間を示します。通常、タイムスタンプは、次の日の早朝です。たとえば、"dateTimeAsString":"2015-06-01T00:00:00-07:00"は、2015年5月31日のデータであることを暗に示しています。当日がまだ終わっていない場合、返されるデータは、その日の経過した時間数の集計です。"dateTimeAsString"には、その日の直近の時間が格納されます。
日次データの集計前に時間単位の集計を必ず完了させるには、日次の集計を毎日01:00時に実行します。
periodをMonthlyに設定すると、過去12か月間のデータが月単位の粒度で返されます。返されるデータは、暦月の粒度です(たとえば、1月、2月などのデータが返されます)。タイムスタンプは、情報が集計された時間を示します。たとえば、dateTimeAsString:"2015-05-01T00:00:00-07:00"は、2015年4月のデータであることを暗に示しています。当月がまだ終わっていない場合、返されるデータは、その月の経過した時間数の集計です。"dateTimeAsString"には、その月の直近の時間が格納されます。
月次データの集計前に日次の集計を必ず完了させるには、月次の集計を新しい暦月の1日の02:00時に実行します。
since(optional): string

情報を求める期間の開始日を、ISO-8601書式の日付文字列またはエポック値として指定します。この値にデータ収集が開始される前の時間を設定した場合は、システムでデータを使用できる期間の情報のみが返されます。
until(optional): string

情報を求める期間の終了日を、ISO-8601書式の日付文字列またはエポック値として指定します。この値を未来の時間に設定すると、現在の時間までの期間の情報のみが返されます。

トップに戻る

レスポンス

サポートされているメディア・タイプ

application/json

200レスポンス

ルート・スキーマ: DateTimeValueList

型: object

メトリック・レコードのリスト

Show Source

items(optional): array items

日付時間およびメトリック値の配列
links(optional): array links

{
    "type":"object",
    "description":"List of metrics records",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DateTimeValue"
            },
            "description":"Array of datetime and metric value"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

ネストされたスキーマ: items

型: array

日付時間およびメトリック値の配列

Show Source

Array of: object DateTimeValue

日付、時間および値

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DateTimeValue"
    },
    "description":"Array of datetime and metric value"
}

ネストされたスキーマ: links

型: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

ネストされたスキーマ: DateTimeValue

型: object

日付、時間および値

Show Source

dateTime(optional): integer(int64)

datetimeをintとして指定します
dateTimeAsString(optional): string(date-time)

日付時間(文字列)

例: 2015-01-29T13:37:26Z
value(optional): integer(int32)

前のオブジェクトのDateTimeValueからこのDateTimeValueまでの期間のメトリック・データ、またはカウントが1の場合はDateTimeValueまでのメトリック・データ。

{
    "type":"object",
    "description":"Date, time and value",
    "properties":{
        "dateTimeAsString":{
            "type":"string",
            "format":"date-time",
            "example":"2015-01-29T13:37:26Z",
            "description":"Date Time as String"
        },
        "dateTime":{
            "type":"integer",
            "format":"int64",
            "description":"Specifies the datetime as int"
        },
        "value":{
            "type":"integer",
            "format":"int32",
            "description":"Metric data up to the time period of DateTimeValue from DateTimeValue of the previous object or up to the DateTimeValue if count is 1."
        }
    }
}

ネストされたスキーマ : リンク

型: object

Show Source

href(optional): string

例: https://iotserver/iot/api/v2/monitoring/metrics/test
rel(optional): string

例: canonical

{
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"https://iotserver/iot/api/v2/monitoring/metrics/test"
        }
    }
}

401レスポンス

未認可。このエラーは、アクセス・トークンが有効でないか、期限切れである場合に返されます。

403レスポンス

禁止。このエラーは、操作がリクエストに対して許可されない場合に返されます。

トップに戻る

例

次の例では、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、様々な問合せパラメータを使用してIoT Cloud Serviceインスタンスの処理済メッセージの数を表示する方法を示しています。 cURLの詳細は、「cURLの使用」を参照してください。

ノート:

リクエストとレスポンスでは、iotserverは、割り当てられたOracle IoT Cloud Serviceインスタンスの名前とポートに置き換えられます。 Cloud Serviceインスタンスの形式は myinstance-myidentitydomain.iot.us.oraclecloud.comであり、デフォルトのポートは443です

例1

次の例では、cURLを使用してIoT Cloud Serviceインスタンスの処理済メッセージの合計数を表示する方法を示しています。次のコマンドを単一の行で入力します。

curl -X GET -k -H 'Accept: application/json'-u username@example.com:passowrd http://iotserver/iot/api/v2/monitoring/metrics/processedMessageCount

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。

HTTP/1.1 200 OK
Content-Type: application/json

レスポンス本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。

{
    "items":[
        {
            "dateTimeAsString":"2016-07-18T10:49:00Z",
            "dateTime":"1468838940964",
            "value":"3000"
        },
        ...
        {
            "dateTimeAsString":"2016-07-17T12:30:00Z",
            "dateTime":"1468758600000",
            "value":"500"
        }
    ],
    "links":[
        {
            "rel":"canonical",
            "href":"http://iotserver/iot/api/v2/monitoring/metrics/processedMessageCount"
        },
        {
            "rel":"self",
            "href":"http://iotserver/iot/api/v2/monitoring/metrics/processedMessageCount"
        }
    ]
}

例2

次の例では、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、問合せパラメータperiodを使用してCloud Serviceインスタンスの処理済メッセージの数を表示する方法を示しています。

問合せパラメータで、情報を求める期間の粒度を指定します。使用可能な期間は、hourly、dailyまたはmonthlyです(大/小文字の区別なし)。デフォルト値は、hourlyです。

periodをhourlyに設定すると、過去24時間のデータが時間単位の粒度で返されます。返されるデータは、1時間の粒度です(たとえば、01:00時、00:00時などのデータが返されます)。

periodをdailyに設定すると、過去30日間のデータが日単位の粒度で返されます。返されるデータは、暦日の粒度です(たとえば、翌日の早朝に計算された全日のデータが返されます)。タイムスタンプは、全日のデータの集計によって日次情報が作成された時間を示します。通常、タイムスタンプは、次の日の早朝です。たとえば、"dateTimeAsString":"2015-06-01T00:00:00-07:00"は、2015年5月31日のデータであることを暗に示しています。当日がまだ終わっていない場合、返されるデータは、その日の経過した時間数の集計です。dateTimeAsStringには、その日の直近の時間が格納されます。

日次データの集計前に時間単位の集計を必ず完了させるには、日次の集計を毎日01:00時に実行します。 periodをmonthlyに設定すると、過去12か月間のデータが月単位の粒度で返されます。返されるデータは、暦月の粒度です(たとえば、1月、2月などのデータが返されます)。

タイムスタンプは、情報が集計された時間を示します。たとえば、dateTimeAsString:"2015-05-01T00:00:00-07:00"は、2015年4月のデータであることを暗に示しています。当月がまだ終わっていない場合、返されるデータは、その月の経過した時間数の集計です。"dateTimeAsString"には、その月の直近の時間が格納されます。

月次データの集計前に日次の集計を必ず完了させるには、月次の集計を新しい暦月の1日の02:00時に実行します。

curl -X GET -k -H 'Accept: application/json' -u username@example.com:password http://iotserver/iot/api/v2/monitoring/monitoring/metrics/processedMessageCount?period=daily

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。

HTTP/1.1 200 OK
Content-Type: application/json

レスポンス本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。

{
    "items":[
        {
            "dateTimeAsString":"2016-07-20T04:19:01Z",
            "dateTime":"1468988341999",
            "value":"5000"
        },
        ...
        {
            "dateTimeAsString":"2016-07-21T18:30:00Z",
            "dateTime":"1466533800000",
            "value":"2000"
        }
    ],
    "links":[
        {
            "rel":"canonical",
            "href":"http://iotserver/iot/api/v2/monitoring/metrics/processedMessageCount"
        },
        {
            "rel":"self",
            "href":"http://iotserver/iot/api/v2/monitoring/metrics/processedMessageCount"
        }
    ]
}

例3

次の例では、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、問合せパラメータorderByを使用してサービス・インスタンスの処理済メッセージの数を表示する方法を示しています。

返されるデータは、指定されたキー/値ペアごとに並べ替えられます。タイムスタンプによって結果を並べ替えるには、キーdateTime (大文字/小文字が区別されます)を指定できます。キーの対応する値にはascまたはdesc (両方とも大文字/小文字が区別されます)を指定でき、それぞれ昇順または降順を意味します。指定しない場合、デフォルト値はascです。

curl -X GET -k -H 'Accept: application/json' -u username@example.com http://iotserver/iot/api/v2/monitoring/metrics/processedMessageCount?orderBy=dateTime:asc

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。

HTTP/1.1 200 OK
Content-Type: application/json

レスポンス本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。

{
    "items":[
        {
            "dateTimeAsString":"2016-07-19T05:30:00Z",
            "dateTime":"1468906200000",
            "value":"500"
        },
        ...
        {
            "dateTimeAsString":"2016-07-20T04:23:27Z",
            "dateTime":"1468988607273",
            "value":"3000"
        }
    ],
    "links":[
       {
            "rel":"canonical",
            "href":"http://iotserver/iot/api/v2/monitoring/metrics/processedMessageCount"
        },
        {
            "rel":"self",
            "href":"http://iotserver/iot/api/v2/monitoring/metrics/processedMessageCount"
        }
    ]
}

例4

次の例では、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、問合せパラメータsinceおよびuntilを使用してサービス・インスタンスの処理済メッセージの数を表示する方法を示しています。

2つのパラメータの意味は、次のとおりです。

since: 情報を求める期間の開始日を、ISO-8601書式の日付文字列またはエポック値として指定します。この値にデータ収集が開始される前の時間を設定した場合は、システムでデータを使用できる期間の情報のみが返されます。

until: 情報を求める期間の終了日を、ISO-8601書式の日付文字列またはエポック値として指定します。この値を未来の時間に設定すると、現在の時間までの期間の情報のみが返されます。

curl -X GET -k -H 'Accept: application/json' -u username@example.com http://iotserver/iot/api/v2/monitoring/metrics/processedMessageCount?since=1469428200000&until=1469441751129

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。

HTTP/1.1 200 OK
Content-Type: application/json

レスポンス本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。

{
    "items":[
        {
            "dateTimeAsString":"2016-07-19T00:30:00Z",
            "dateTime":"1468888200000",
            "value":"3000"
        },
        ...
        {
            "dateTimeAsString":"2016-07-20T05:43:43Z",
            "dateTime":"1468993423226",
            "value":"500"
        }
    ],
    "links":[
        {
            "rel":"canonical",
            "href":"http://iotserver/iot/api/v2/monitoring/metrics/processedMessageCount"
        },
        {
            "rel":"self",
            "href":"http://iotserver/iot/api/v2/monitoring/metrics/processedMessageCount"
        }
    ]
}

例5

次の例では、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、問合せパラメータlimitを使用してサービス・インスタンスの処理済メッセージの数を表示する方法を示しています。

レスポンスにより、返されるデータ・ポイントのデフォルト数が上書きされます。指定された期間の値の乗数として機能します。たとえば、periodをHourlyに、untilを2015-04-09T08:00:00Zに設定した場合、limitを5に設定すると、2015年4月9日の08:00時に終了する過去5時間の時間単位のデータが返されます。

curl -X GET -k -H 'Accept: application/json' -u username@example.com http://iotserver/iot/api/v2/monitoring/metrics/processedMessageCount?limit=2

レスポンス・ヘッダーの例

レスポンス・ヘッダーの例を次に示します。

HTTP/1.1 200 OK
Content-Type: application/json

レスポンス本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。

{
    "items":[
        {
            "dateTimeAsString":"2016-07-20T05:47:15Z",
            "dateTime":"1468993635632",
            "value":"3000"
        },
        {
            "dateTimeAsString":"2016-07-20T05:30:00Z",
            "dateTime":"1468992600000",
            "value":"2000"
        }
    ],
    "links":[
       {
            "rel":"canonical",
            "href":"http://iotserver/iot/api/v2/monitoring/metrics/processedMessageCount"
        },
        {
            "rel":"self",
            "href":"http://iotserver/iot/api/vprocessedMessageCountng/metrics/alertCount"
        }
    ]
}

トップに戻る