Oracle Enterprise ManagerのREST API

グループ内のメトリックの最新の値の取得

get

http://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/targets/{targetId}/metricGroups/{metricGroupName}/latestData

ターゲットのメトリック・グループ内のメトリックについて、EMリポジトリから収集した最新の値を取得します。キーがないメトリック・グループの場合、返される可能性があるのは1行のデータです。キーがあるメトリック・グループの場合は、複数行のデータが返される可能性があります。

リクエスト

パス・パラメータ

metricGroupName(必須): string
メトリック・グループ名
例:
```
Filesystems
```
targetId(必須): string
ターゲットID (つまり、ターゲットGUID)
例:
```
CF99A10F233254B78ED96ED1B5C15140
```

問合せパラメータ

key_<name>: string
オプションのパラメータ。メトリックにキーが関連付けられている場合は、key_<name>という形式の名前が付いた問合せパラメータを使用して特定のキーをフィルタできます。
例:
```
key_mountPoint=/scratch&key_mountPoint=/
```
limit: integer(int32)

最小値: 1

最大値: 500

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

デフォルト値: 50
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
```

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

先頭に戻る

レスポンス

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

application/json

200レスポンス

ルート・スキーマ: MetricGroupLatestData

型: object

ターゲットのメトリック・グループ内のメトリックの最新収集データ。

ソースの表示

count(必須): integer

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

例: 2
items(必須): array items

メトリック・グループの最新アップロードに対応するメトリック・データの行を提供します。キーがないメトリック・グループの場合、返される可能性があるのは1行のデータです。キーがあるメトリック・グループの場合は、複数行のデータが返される可能性があります。行はキー値によって識別されます。データが存在しない場合は、空になります。
links(必須): object links

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

最大長: 64

メトリック・グループ

例: Filesystems
targetId(必須): string

最大長: 32

ターゲットのID

例: CF99A10F233254B78ED96ED1B5C15140
targetName(必須): string

最大長: 256

ターゲット名

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

最大長: 64

ターゲット・タイプ

例: host
timeCollected(必須): string

日時書式 - yyyy-MM-dd'T'HH:mm:ss.SSS'Z'

例: 2021-08-26T21:35:55.000Z

{
    "type":"object",
    "description":"Latest collected data for the metrics in the target's metric group.",
    "required":[
        "targetName",
        "targetTypeName",
        "targetId",
        "metricGroupName",
        "timeCollected",
        "count",
        "items",
        "links"
    ],
    "properties":{
        "targetName":{
            "type":"string",
            "maxLength":"256",
            "description":"target name",
            "example":"myhost.mydomain.com"
        },
        "targetTypeName":{
            "type":"string",
            "maxLength":"64",
            "description":"target type",
            "example":"host"
        },
        "targetId":{
            "type":"string",
            "maxLength":"32",
            "description":"target's ID",
            "example":"CF99A10F233254B78ED96ED1B5C15140"
        },
        "metricGroupName":{
            "type":"string",
            "maxLength":"64",
            "description":"Metric group",
            "example":"Filesystems"
        },
        "timeCollected":{
            "type":"string",
            "description":"date time format - yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "example":"2021-08-26T21:35:55.000Z"
        },
        "count":{
            "type":"integer",
            "description":"Number of rows present in returned items list",
            "example":"2"
        },
        "items":{
            "description":"Provides rows of metric data corresponding to latest upload for the metric group. For a metric group having no keys, single row of data could be returned. For a metric group having key(s), multiple rows of data could be returned. Rows are identified by key values. When no data exists, it would be empty.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MetricRowData"
            },
            "example":[
                {
                    "mountPoint":"/",
                    "available":"29004.7",
                    "fileSystem":"/dev/vda1",
                    "pctAvailable":"60.82",
                    "size":"50267.62"
                },
                {
                    "mountPoint":"/scratch",
                    "available":"65508.38",
                    "fileSystem":"/dev/vdb",
                    "pctAvailable":"28.55",
                    "size":"241776.06"
                }
            ]
        },
        "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/targets/CF99A10F233254B78ED96ED1B5C15140/metricGroups/Filesystems/latestData?limit=1&page=MQ%3D%3D"
                },
                "next":{
                    "href":"/em/api/targets/CF99A10F233254B78ED96ED1B5C15140/metricGroups/Filesystems/latestData?limit=1&page=Mg%3D%3D"
                },
                "previous":{
                    "href":"/em/api/targets/CF99A10F233254B78ED96ED1B5C15140/metricGroups/Filesystems/latestData?limit=1&page=MA%3D%3D"
                }
            }
        }
    }
}

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

型: array

メトリック・グループの最新アップロードに対応するメトリック・データの行を提供します。キーがないメトリック・グループの場合、返される可能性があるのは1行のデータです。キーがあるメトリック・グループの場合は、複数行のデータが返される可能性があります。行はキー値によって識別されます。データが存在しない場合は、空になります。

ソースの表示

配列: object MetricRowData

使用可能なその他のプロパティ: additionalProperties

メトリック・グループに対応する、1行のメトリック・データを表します。行はカンマで区切られた名前/値のペアであり、名前はメトリックまたはキーを示し、値は数値または文字列型です。

{
    "description":"Provides rows of metric data corresponding to latest upload for the metric group. For a metric group having no keys, single row of data could be returned. For a metric group having key(s), multiple rows of data could be returned. Rows are identified by key values. When no data exists, it would be empty.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MetricRowData"
    },
    "example":[
        {
            "mountPoint":"/",
            "available":"29004.7",
            "fileSystem":"/dev/vda1",
            "pctAvailable":"60.82",
            "size":"50267.62"
        },
        {
            "mountPoint":"/scratch",
            "available":"65508.38",
            "fileSystem":"/dev/vdb",
            "pctAvailable":"28.55",
            "size":"241776.06"
        }
    ]
}

例:

[
    {
        "mountPoint":"/",
        "available":"29004.7",
        "fileSystem":"/dev/vda1",
        "pctAvailable":"60.82",
        "size":"50267.62"
    },
    {
        "mountPoint":"/scratch",
        "available":"65508.38",
        "fileSystem":"/dev/vdb",
        "pctAvailable":"28.55",
        "size":"241776.06"
    }
]

ネストされたスキーマ: 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/targets/CF99A10F233254B78ED96ED1B5C15140/metricGroups/Filesystems/latestData?limit=1&page=MQ%3D%3D"
        },
        "next":{
            "href":"/em/api/targets/CF99A10F233254B78ED96ED1B5C15140/metricGroups/Filesystems/latestData?limit=1&page=Mg%3D%3D"
        },
        "previous":{
            "href":"/em/api/targets/CF99A10F233254B78ED96ED1B5C15140/metricGroups/Filesystems/latestData?limit=1&page=MA%3D%3D"
        }
    }
}

例:

{
    "self":{
        "href":"/em/api/targets/CF99A10F233254B78ED96ED1B5C15140/metricGroups/Filesystems/latestData?limit=1&page=MQ%3D%3D"
    },
    "next":{
        "href":"/em/api/targets/CF99A10F233254B78ED96ED1B5C15140/metricGroups/Filesystems/latestData?limit=1&page=Mg%3D%3D"
    },
    "previous":{
        "href":"/em/api/targets/CF99A10F233254B78ED96ED1B5C15140/metricGroups/Filesystems/latestData?limit=1&page=MA%3D%3D"
    }
}

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

型: object

使用可能なその他のプロパティ

ソースの表示

string

{
    "type":"object",
    "description":"Represents one row of metric data corresponding to the metric group. Row is a comma separated name/value pairs, where name identifies metric or key, and value is numeric or string type.",
    "example":{
        "mountPoint":"/",
        "available":"29004.7",
        "fileSystem":"/dev/vda1",
        "pctAvailable":"60.82",
        "size":"50267.62"
    },
    "additionalProperties":{
        "type":"string"
    }
}

メトリック・グループに対応する、1行のメトリック・データを表します。行はカンマで区切られた名前/値のペアであり、名前はメトリックまたはキーを示し、値は数値または文字列型です。

例:

{
    "mountPoint":"/",
    "available":"29004.7",
    "fileSystem":"/dev/vda1",
    "pctAvailable":"60.82",
    "size":"50267.62"
}

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

型: object

すべてに一致

ソースの表示

object Link

リンクを表します(self、previous、nextのいずれか)

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

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

型: object

すべてに一致

ソースの表示

object Link

リンクを表します(self、previous、nextのいずれか)

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

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

型: object

すべてに一致

ソースの表示

object Link

リンクを表します(self、previous、nextのいずれか)

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

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

型: object

リンクを表します(self、previous、nextのいずれか)

ソースの表示

href: string

リンクのためのURL

例: /em/api/<resources>?page=b2Zmc2V0OjA&limit=0

{
    "type":"object",
    "description":"Represents a link(could be self, previous or next)",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for Link",
            "example":"/em/api/<resources>?page=b2Zmc2V0OjA&limit=0"
        }
    }
}

例

400レスポンス

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

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

401レスポンス

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

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

404レスポンス

見つかりません。リクエストされたREST API URLが見つかりません。

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500レスポンス

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

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503レスポンス

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

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

先頭に戻る