Oracle Enterprise ManagerのREST API

一定期間の数値メトリックのデータ・ポイントの取得

get

http://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/metricTimeSeries

指定された期間にわたる数値メトリックのデータ・ポイントを取得します。キーがないメトリックについては、単一の時系列を提供します。キーがあるメトリックについては、複数の時系列を提供します。期間がRAWメトリック・データ保存期間(デフォルトは先週)に含まれている場合は、返される時系列にRAWデータ・ポイントが含まれます。期間がRAWメトリック・データ保存期間に含まれておらず、毎時ロールアップのメトリック・データ保存期間(デフォルトは1か月)に含まれている場合は、返される時系列に毎時平均データ・ポイントが含まれます。期間が毎時ロールアップのメトリック・データ保存期間に含まれていない場合は、返される時系列に日次平均データ・ポイントが含まれます。オプションの問合せパラメータinclude=currentThresholdSettingsが渡された場合、時系列ごとに、関連する現在のしきい値設定情報も含まれます

リクエスト

問合せパラメータ

include: string[]
最大長: 32

オプションのパラメータ。include=currentThresholdSettings問合せパラメータが指定されている場合、レスポンスには現在のしきい値設定情報が含まれます。
- 指定可能な値: [ "currentThresholdSettings" ]
```
[
    "currentThresholdSettings"
]
```
例:
```
currentThresholdSettings
```
key_<name>: string
オプションのパラメータ。メトリックにキーが関連付けられている場合は、key_<name>という形式の名前が付いた問合せパラメータを使用して特定のキーをフィルタできます。
例:
```
key_mountPoint=/scratch&key_mountPoint=/
```
limit: integer(int32)

最小値: 1

最大値: 20

現在のコールで返されるアイテムの数を制限します。アイテムを追加でフェッチするには、レスポンスからのself/previous/nextリンクを使用します。

デフォルト値: 10
metricGroupName(必須): string
最大長: 64

メトリック・グループ名
例:
```
Filesystems
```
metricName(必須): string
最大長: 64

メトリック名
例:
```
size
```
page: string
取得するアイテムのセットを特定します。レスポンスのlinksリストのhref要素により、このパラメータのエンコードされた値が提供されます。href要素の値は、それぞれのアイテム・セットをフェッチする場合はそのまま使用する必要があります。
例:
```
MQ%3D%3D
```
sort: string
最大長: 256

1つ以上のキー列で結果をソートします。列の順序は<key_column>:<sortDirection>として指定する必要があります。key_columnは、問合せ内のメトリックの有効なキー列である必要があります。sortDirectionとしてはASC (つまり、昇順)またはDESC (つまり、降順)を指定でき、指定しない場合はデフォルトでASCになります。複数列にわたりソートするには、カンマ(,)で区切って複数の列の順序を指定します。
例:
```
mountPoint:DESC
```
targetId: string
最大長: 32

ターゲットID (つまり、ターゲットGUID)。ターゲット・スコープは、targetNameおよびtargetTypeName問合せパラメータ、またはtargetId問合せパラメータのどちらかで指定する必要があります。
例:
```
CF99A10F233254B78ED96ED1B5C15140
```
targetName: string
最大長: 256

ターゲット名。ターゲット・スコープは、targetNameおよびtargetTypeName問合せパラメータ、またはtargetId問合せパラメータのどちらかで指定する必要があります。
例:
```
myhost.mydomain.com
```
targetTypeName: string
最大長: 64

ターゲット・タイプ。ターゲット・スコープは、targetNameおよびtargetTypeName問合せパラメータ、またはtargetId問合せパラメータのどちらかで指定する必要があります。
例:
```
host
```
timeCollectedGreaterThanOrEqualTo(required): string(日時)
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'という形式で、UTCでの時系列で返される、データ・ポイントの収集時間の下限。
例:
```
2021-07-18T18:00:00.000Z
```
timeCollectedLessThan(required): string(日時)
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'という形式で、UTCでの時系列で返される、データ・ポイントの収集時間の上限。
例:
```
2021-07-23T23:00:00.000Z
```

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

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

application/json

200レスポンス

ルート・スキーマ : MetricTimeSeriesCollection

型: object

メトリック時系列オブジェクトのリスト。データが存在しない場合は空になります。

ソースの表示

count(必須): integer

返されたアイテム・リスト内に存在する時系列の数

例: 1
items(必須): array items

指定されたメトリックに対応する時系列のコレクションを提供します。メトリックに識別キーがある場合は、結果に複数の時系列が含まれる可能性があります。指定された期間のデータが存在しない場合は、空になります。
links(必須): object links

ナビゲーション・リンク。さらにデータが存在する場合は、ページ分割のpreviousリンクとnextリンクを使用します。

{
    "type":"object",
    "description":"List of metric time series objects. Empty when no data exists.",
    "required":[
        "count",
        "items",
        "links"
    ],
    "properties":{
        "count":{
            "type":"integer",
            "description":"Number of time series present in returned items list",
            "example":"1"
        },
        "items":{
            "description":"Provides collection of time series corresponding to the specified metric. If the metric has identifying key(s), result can have multiple time series. When no data exists for the specified time span, it would be empty.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MetricTimeSeries"
            }
        },
        "links":{
            "type":"object",
            "description":"Navigations links. Use previous and next links for paginating, when more data exists.",
            "properties":{
                "previous":{
                    "type":"object",
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        }
                    ]
                },
                "self":{
                    "type":"object",
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        }
                    ]
                },
                "next":{
                    "type":"object",
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        }
                    ]
                }
            },
            "example":{
                "self":{
                    "href":"/em/api/metricTimeSeries?metricGroup=Filesystems&targetName=myhost.mydomain.com&metric=size&targetType=host&timeCollectedGreaterThanOrEqualTo=2021-08-25T09:00:00.000Z&timeCollectedLessThan=2021-08-25T23:00:00.000Z&page=MQ%3D%3D"
                },
                "next":{
                    "href":"/em/api/metricTimeSeries?metricGroup=Filesystems&targetName=myhost.mydomain.com&metric=size&targetType=host&timeCollectedGreaterThanOrEqualTo=2021-08-25T09:00:00.000Z&timeCollectedLessThan=2021-08-25T23:00:00.000Z&page=Mg%3D%3D"
                },
                "previous":{
                    "href":"/em/api/metricTimeSeries?metricGroup=Filesystems&targetName=myhost.mydomain.com&metric=size&targetType=host&timeCollectedGreaterThanOrEqualTo=2021-08-25T09:00:00.000Z&timeCollectedLessThan=2021-08-25T23:00:00.000Z&page=MA%3D%3D"
                }
            }
        }
    }
}

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

型: array

指定されたメトリックに対応する時系列のコレクションを提供します。メトリックに識別キーがある場合は、結果に複数の時系列が含まれる可能性があります。指定された期間のデータが存在しない場合は、空になります。

ソースの表示

配列: object MetricTimeSeries

EMリポジトリからのメトリック時系列データ。

{
    "description":"Provides collection of time series corresponding to the specified metric. If the metric has identifying key(s), result can have multiple time series. When no data exists for the specified time span, it would be empty.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MetricTimeSeries"
    }
}

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

型: object

ナビゲーション・リンク。さらにデータが存在する場合は、ページ分割のpreviousリンクとnextリンクを使用します。

ソースの表示

next: object next
previous: object previous
self: object self

{
    "type":"object",
    "description":"Navigations links. Use previous and next links for paginating, when more data exists.",
    "properties":{
        "previous":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                }
            ]
        },
        "self":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                }
            ]
        },
        "next":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                }
            ]
        }
    },
    "example":{
        "self":{
            "href":"/em/api/metricTimeSeries?metricGroup=Filesystems&targetName=myhost.mydomain.com&metric=size&targetType=host&timeCollectedGreaterThanOrEqualTo=2021-08-25T09:00:00.000Z&timeCollectedLessThan=2021-08-25T23:00:00.000Z&page=MQ%3D%3D"
        },
        "next":{
            "href":"/em/api/metricTimeSeries?metricGroup=Filesystems&targetName=myhost.mydomain.com&metric=size&targetType=host&timeCollectedGreaterThanOrEqualTo=2021-08-25T09:00:00.000Z&timeCollectedLessThan=2021-08-25T23:00:00.000Z&page=Mg%3D%3D"
        },
        "previous":{
            "href":"/em/api/metricTimeSeries?metricGroup=Filesystems&targetName=myhost.mydomain.com&metric=size&targetType=host&timeCollectedGreaterThanOrEqualTo=2021-08-25T09:00:00.000Z&timeCollectedLessThan=2021-08-25T23:00:00.000Z&page=MA%3D%3D"
        }
    }
}

例:

{
    "self":{
        "href":"/em/api/metricTimeSeries?metricGroup=Filesystems&targetName=myhost.mydomain.com&metric=size&targetType=host&timeCollectedGreaterThanOrEqualTo=2021-08-25T09:00:00.000Z&timeCollectedLessThan=2021-08-25T23:00:00.000Z&page=MQ%3D%3D"
    },
    "next":{
        "href":"/em/api/metricTimeSeries?metricGroup=Filesystems&targetName=myhost.mydomain.com&metric=size&targetType=host&timeCollectedGreaterThanOrEqualTo=2021-08-25T09:00:00.000Z&timeCollectedLessThan=2021-08-25T23:00:00.000Z&page=Mg%3D%3D"
    },
    "previous":{
        "href":"/em/api/metricTimeSeries?metricGroup=Filesystems&targetName=myhost.mydomain.com&metric=size&targetType=host&timeCollectedGreaterThanOrEqualTo=2021-08-25T09:00:00.000Z&timeCollectedLessThan=2021-08-25T23:00:00.000Z&page=MA%3D%3D"
    }
}

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

型: object

EMリポジトリからのメトリック時系列データ。

ソースの表示

currentThresholdSettings: object currentThresholdSettings

オプションのパラメータ。include=currentThresholdSettings問合せパラメータが指定されている場合、レスポンスには現在のしきい値設定情報が含まれます。
datapoints(必須): array datapoints

その時系列内のデータ・ポイントのリスト。各データ・ポイントは、timeCollected属性とvalue属性のリストとなります。
displayName(必須): string

時系列の表示名

例: Filesystem Size (MB): /
keyValues: array keyValues

その時系列のキー値のリスト
metricDisplayName(必須): string

メトリック表示名

例: Size
metricGroupDisplayName(必須): string

メトリック・グループ表示名

例: File Systems
metricGroupName(必須): string

最大長: 64

メトリック・グループ名

例: Filesystems
metricName(必須): string

最大長: 64

メトリック名

例: size
targetId: string

最大長: 32

ターゲットID

例: CF99A10F233254B78ED96ED1B5C15140
targetName(必須): string

最大長: 256

ターゲット名

例: myhost.mydomain.com
targetTypeDisplayName(必須): string

ターゲット・タイプ表示名

例: Host
targetTypeName(必須): string

最大長: 64

ターゲット・タイプ名

例: host

{
    "type":"object",
    "description":"Metric time series data from EM repository.",
    "required":[
        "displayName",
        "metricGroupName",
        "metricGroupDisplayName",
        "metricName",
        "metricDisplayName",
        "targetName",
        "targetTypeName",
        "targetTypeDisplayName",
        "datapoints"
    ],
    "properties":{
        "displayName":{
            "description":"Display name for the time series",
            "type":"string",
            "example":"Filesystem Size (MB): /"
        },
        "metricGroupName":{
            "type":"string",
            "maxLength":"64",
            "description":"Metric Group Name",
            "example":"Filesystems"
        },
        "metricGroupDisplayName":{
            "type":"string",
            "description":"Metric Group Display Name",
            "example":"File Systems"
        },
        "metricName":{
            "type":"string",
            "maxLength":"64",
            "description":"Metric Name",
            "example":"size"
        },
        "metricDisplayName":{
            "type":"string",
            "description":"Metric Display Name",
            "example":"Size"
        },
        "targetName":{
            "type":"string",
            "maxLength":"256",
            "description":"Target Name",
            "example":"myhost.mydomain.com"
        },
        "targetTypeName":{
            "type":"string",
            "maxLength":"64",
            "description":"Target Type Name",
            "example":"host"
        },
        "targetId":{
            "type":"string",
            "maxLength":"32",
            "description":"Target ID",
            "example":"CF99A10F233254B78ED96ED1B5C15140"
        },
        "targetTypeDisplayName":{
            "type":"string",
            "description":"Target Type Display Name",
            "example":"Host"
        },
        "keyValues":{
            "type":"array",
            "description":"List of key values for the time series",
            "items":{
                "$ref":"#/components/schemas/MetricKeyValue"
            },
            "example":[
                {
                    "name":"mountPoint",
                    "displayName":"Mount Point",
                    "value":"/"
                }
            ]
        },
        "currentThresholdSettings":{
            "type":"object",
            "description":"Optional parameter. If include=currentThresholdSettings query parameter is specified, response will include current threshold settings information.",
            "items":{
                "$ref":"#/components/schemas/NumericThresholdSettings"
            },
            "example":{
                "warningThreshold":"80",
                "criticalThreshold":"90",
                "operator":">",
                "numOfOccurrences":"2"
            }
        },
        "datapoints":{
            "type":"array",
            "description":"The list of data points in the time series. Each data point is a list of timeCollected/value attributes.",
            "items":{
                "type":"array",
                "items":{
                    "type":"object",
                    "description":"List of timeCollected and value attributes. timeCollected is in UTC, and it has yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format.",
                    "example":[
                        [
                            "2021-08-25T09:35:55.000Z",
                            "241776.06"
                        ],
                        [
                            "2021-08-25T15:35:55.000Z",
                            "241776.06"
                        ],
                        [
                            "2021-08-25T21:35:55.000Z",
                            "241776.06"
                        ]
                    ]
                }
            }
        }
    }
}

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

型: object

オプションのパラメータ。include=currentThresholdSettings問合せパラメータが指定されている場合、レスポンスには現在のしきい値設定情報が含まれます。

ソースの表示

配列: object NumericThresholdSettings

数値メトリックのしきい値設定。

{
    "type":"object",
    "description":"Optional parameter. If include=currentThresholdSettings query parameter is specified, response will include current threshold settings information.",
    "items":{
        "$ref":"#/components/schemas/NumericThresholdSettings"
    },
    "example":{
        "warningThreshold":"80",
        "criticalThreshold":"90",
        "operator":">",
        "numOfOccurrences":"2"
    }
}

例:

{
    "warningThreshold":"80",
    "criticalThreshold":"90",
    "operator":">",
    "numOfOccurrences":"2"
}

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

型: array

その時系列内のデータ・ポイントのリスト。各データ・ポイントは、timeCollected属性とvalue属性のリストとなります。

ソースの表示

配列: array items

{
    "type":"array",
    "description":"The list of data points in the time series. Each data point is a list of timeCollected/value attributes.",
    "items":{
        "type":"array",
        "items":{
            "type":"object",
            "description":"List of timeCollected and value attributes. timeCollected is in UTC, and it has yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format.",
            "example":[
                [
                    "2021-08-25T09:35:55.000Z",
                    "241776.06"
                ],
                [
                    "2021-08-25T15:35:55.000Z",
                    "241776.06"
                ],
                [
                    "2021-08-25T21:35:55.000Z",
                    "241776.06"
                ]
            ]
        }
    }
}

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

型: array

その時系列のキー値のリスト

ソースの表示

配列: object MetricKeyValue

メトリック・キー値

{
    "type":"array",
    "description":"List of key values for the time series",
    "items":{
        "$ref":"#/components/schemas/MetricKeyValue"
    },
    "example":[
        {
            "name":"mountPoint",
            "displayName":"Mount Point",
            "value":"/"
        }
    ]
}

例:

[
    {
        "name":"mountPoint",
        "displayName":"Mount Point",
        "value":"/"
    }
]

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

型: object

数値メトリックのしきい値設定。

ソースの表示

criticalThreshold(必須): string

クリティカルしきい値設定の値を指定します。定義されていない場合は、デフォルトでUNDEFINEDに設定されます。

例: 90
occurrenceCount: integer

イベントをトリガーするためにメトリック値がしきい値を超える必要がある連続回数。

例: 2
operator(必須): string

条件演算子の値を指定します。条件の評価に使用される演算子。定義されていない場合は、デフォルトでUNDEFINEDに設定されます。

例: >
warningThreshold(必須): string

警告しきい値設定の値を指定します。定義されていない場合は、デフォルトでUNDEFINEDに設定されます。

例: 80

{
    "type":"object",
    "description":"Threshold settings for a numeric metric.",
    "required":[
        "warningThreshold",
        "criticalThreshold",
        "operator"
    ],
    "properties":{
        "warningThreshold":{
            "description":"Provides value of warning threshold setting. Defaults to UNDEFINED, if it is not defined.",
            "type":"string",
            "example":"80"
        },
        "criticalThreshold":{
            "description":"Provides value of critical threshold setting. Defaults to UNDEFINED, if it is not defined.",
            "type":"string",
            "example":"90"
        },
        "operator":{
            "type":"string",
            "description":"Provides value of condition operator. Operator to be used for evaluating the condition. Defaults to UNDEFINED, if it is not defined.",
            "items":{
                "enum":[
                    "<",
                    ">",
                    "=",
                    "<=",
                    ">=",
                    "!="
                ]
            },
            "example":">"
        },
        "occurrenceCount":{
            "type":"integer",
            "description":"Consecutive number of times the metric value has to cross the threshold for the event to be triggered.",
            "example":"2"
        }
    }
}

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

型: array

ソースの表示

配列: object items

timeCollected属性とvalue属性のリスト。timeCollectedはUTCでyyyy- MM- dd'T'HH:mm:ss.SSS'Z'という形式になります。

{
    "type":"array",
    "items":{
        "type":"object",
        "description":"List of timeCollected and value attributes. timeCollected is in UTC, and it has yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format.",
        "example":[
            [
                "2021-08-25T09:35:55.000Z",
                "241776.06"
            ],
            [
                "2021-08-25T15:35:55.000Z",
                "241776.06"
            ],
            [
                "2021-08-25T21:35:55.000Z",
                "241776.06"
            ]
        ]
    }
}

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

型: object

timeCollected属性とvalue属性のリスト。timeCollectedはUTCでyyyy- MM- dd'T'HH:mm:ss.SSS'Z'という形式になります。

例:

[
    [
        "2021-08-25T09:35:55.000Z",
        "241776.06"
    ],
    [
        "2021-08-25T15:35:55.000Z",
        "241776.06"
    ],
    [
        "2021-08-25T21:35:55.000Z",
        "241776.06"
    ]
]

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

型: object

メトリック・キー値

ソースの表示

displayName(必須): string

キー表示名

例: Mount Point
name(必須): string

最大長: 64

キー名

例: mountPoint
value(必須): string

キー値

例: /

{
    "type":"object",
    "description":"Metric key value",
    "required":[
        "name",
        "displayName",
        "value"
    ],
    "properties":{
        "name":{
            "type":"string",
            "maxLength":"64",
            "description":"Key name",
            "example":"mountPoint"
        },
        "displayName":{
            "type":"string",
            "description":"Key display name",
            "example":"Mount Point"
        },
        "value":{
            "type":"string",
            "description":"Key value",
            "example":"/"
        }
    }
}

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

型: object

すべてに一致

ソースの表示

object Link

REST APIを参照するリンク。

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        }
    ]
}

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

型: object

すべてに一致

ソースの表示

object Link

REST APIを参照するリンク。

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        }
    ]
}

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

型: object

すべてに一致

ソースの表示

object Link

REST APIを参照するリンク。

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        }
    ]
}

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

型: object

REST APIを参照するリンク。

ソースの表示

href: string

リンクURL

{
    "x-em-sdk-level":"emSDK",
    "description":"A link referencing a REST API.",
    "type":"object",
    "properties":{
        "href":{
            "description":"Link URL",
            "type":"string"
        }
    }
}

例

400レスポンス

不正なリクエスト。ペイロードがnullであるか、一部のパラメータがありません

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

code: string

エラーのステータス・コード。

例: IllegalArgument
message: string

説明的なエラー・メッセージ

例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

401レスポンス

未認可。ユーザーにはリクエストされた操作を実行する権限がありません

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

code: string

エラーのステータス・コード。

例: IllegalArgument
message: string

説明的なエラー・メッセージ

例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

500レスポンス

内部サーバー・エラー。REST APIの実行中に例外が発生しました。

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

code: string

エラーのステータス・コード。

例: IllegalArgument
message: string

説明的なエラー・メッセージ

例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

503レスポンス

サービスが使用できません。サーバーはリクエストを処理できません。

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

code: string

エラーのステータス・コード。

例: IllegalArgument
message: string

説明的なエラー・メッセージ

例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

先頭に戻る