Oracle Enterprise ManagerのREST API

ターゲットのメトリック・グループの取得

get

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

指定されたターゲットのすべてのメトリック・グループを、メトリック・グループの名前順にリストします。include= metricsを指定すると、グループ内のメトリックの詳細が含まれます。

リクエスト

パス・パラメータ

targetId(必須): string
ターゲットID (つまり、ターゲットGUID)
例:
```
CF99A10F233254B78ED96ED1B5C15140
```

問合せパラメータ

include: string[]
最大長: 32

オプションのパラメータ。include= metricsを指定すると、グループ内のメトリックの詳細が含まれます。
- 指定可能な値: [ "metrics" ]
```
[
    "metrics"
]
```
例:
```
metrics
```

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

先頭に戻る

レスポンス

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

application/json

200レスポンス

ルート・スキーマ: MetricGroupCollection

型: object

名前順のメトリック・グループのリスト。

ソースの表示

count(必須): integer

返されたリスト内のメトリック・グループの数

例: 10
items(必須): array items

名前順のメトリック・グループのリスト。
links(必須): object links

ナビゲーション・リンク

{
    "type":"object",
    "description":"List of metric groups ordered by name.",
    "required":[
        "count",
        "items",
        "links"
    ],
    "properties":{
        "count":{
            "type":"integer",
            "description":"Number of metric groups in returned list",
            "example":"10"
        },
        "items":{
            "description":"List of metric groups ordered by name.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MetricGroup"
            }
        },
        "links":{
            "type":"object",
            "description":"Navigations links",
            "properties":{
                "self":{
                    "type":"object",
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        }
                    ]
                }
            },
            "example":{
                "self":{
                    "href":"/em/api/targets/CF99A10F233254B78ED96ED1B5C15140/metricGroups"
                }
            }
        }
    }
}

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

型: array

名前順のメトリック・グループのリスト。

ソースの表示

配列: object MetricGroup

メトリック・グループ・メタデータ

{
    "description":"List of metric groups ordered by name.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MetricGroup"
    }
}

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

型: object

ナビゲーション・リンク

ソースの表示

self: object self

{
    "type":"object",
    "description":"Navigations links",
    "properties":{
        "self":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                }
            ]
        }
    },
    "example":{
        "self":{
            "href":"/em/api/targets/CF99A10F233254B78ED96ED1B5C15140/metricGroups"
        }
    }
}

例:

{
    "self":{
        "href":"/em/api/targets/CF99A10F233254B78ED96ED1B5C15140/metricGroups"
    }
}

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

型: object

メトリック・グループ・メタデータ

ソースの表示

displayName(必須): string

ローカライズされたメトリック・グループ名

例: File Systems
id(必須): string

最大長: 32

メトリック・グループID

例: 34E542C4F1CF2743327ED2F8563D1E4B
isMetricExtension(必須): boolean

デフォルト値: false

これがメトリック拡張の場合はTrue、そうでない場合はfalse
keys: array keys

(オプション)このメトリック・グループのキーのリスト(存在する場合)。問合せパラメータinclude= metricsが指定されている場合に含まれます。
links(必須): object links

ナビゲーション・リンク
metrics: array metrics

(オプション)このメトリック・グループ内に存在するメトリックのリスト。問合せパラメータinclude= metricsが指定されている場合に含まれます。
name(必須): string

最大長: 64

メトリック・グループ名

例: Filesystems

{
    "description":"Metric group metadata",
    "type":"object",
    "required":[
        "id",
        "name",
        "displayName",
        "isMetricExtension",
        "links"
    ],
    "properties":{
        "id":{
            "type":"string",
            "maxLength":"32",
            "description":"Metric group ID",
            "example":"34E542C4F1CF2743327ED2F8563D1E4B"
        },
        "name":{
            "type":"string",
            "maxLength":"64",
            "description":"Metric group name",
            "example":"Filesystems"
        },
        "displayName":{
            "type":"string",
            "description":"Localized Metric group name",
            "example":"File Systems"
        },
        "isMetricExtension":{
            "type":"boolean",
            "default":false,
            "description":"True if this is a metric extension, false otherwise"
        },
        "links":{
            "type":"object",
            "description":"Navigations links",
            "properties":{
                "self":{
                    "type":"object",
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        }
                    ]
                }
            },
            "example":{
                "self":{
                    "href":"/em/api/targets/CF99A10F233254B78ED96ED1B5C15140/metricGroups/Filesystems"
                }
            }
        },
        "keys":{
            "type":"array",
            "description":"(Optional) List of keys for this metric group, if present. Included if query parameter include=metrics is specified.",
            "items":{
                "$ref":"#/components/schemas/MetricKey"
            },
            "example":[
                {
                    "name":"mountPoint",
                    "displayName":"Mount Point"
                }
            ]
        },
        "metrics":{
            "type":"array",
            "description":"(Optional) List of metrics present in this metric group. Included if query parameter include=metrics is specified.",
            "items":{
                "$ref":"#/components/schemas/Metric"
            },
            "example":[
                {
                    "id":"6E65075DA52ACA744B4B8C3FCB018289",
                    "name":"pctAvailable",
                    "displayName":"Filesystem Space Available (%)",
                    "dataType":"NUMBER",
                    "categoryName":"Utilization",
                    "unitDisplayName":"%"
                },
                {
                    "id":"162045AD9191652427CAC47D8BA40671",
                    "name":"size",
                    "displayName":"Filesystem Size (MB)",
                    "dataType":"NUMBER",
                    "unitDisplayName":"MB"
                },
                {
                    "id":"E8838C71E687BF0A9E02FFACC0C9AC80",
                    "name":"available",
                    "displayName":"Filesystem Space Available (MB)",
                    "dataType":"NUMBER",
                    "categoryName":"Utilization",
                    "unitDisplayName":"MB"
                },
                {
                    "id":"C80F6EAA9145C76D30DE8705346D5AAA",
                    "name":"fileSystem",
                    "displayName":"Filesystem",
                    "dataType":"STRING"
                }
            ]
        }
    }
}

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

型: array

(オプション)このメトリック・グループのキーのリスト(存在する場合)。問合せパラメータinclude= metricsが指定されている場合に含まれます。

ソースの表示

配列: object MetricKey

メトリック・キー・メタデータ

{
    "type":"array",
    "description":"(Optional) List of keys for this metric group, if present. Included if query parameter include=metrics is specified.",
    "items":{
        "$ref":"#/components/schemas/MetricKey"
    },
    "example":[
        {
            "name":"mountPoint",
            "displayName":"Mount Point"
        }
    ]
}

例:

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

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

型: object

ナビゲーション・リンク

ソースの表示

self: object self

{
    "type":"object",
    "description":"Navigations links",
    "properties":{
        "self":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                }
            ]
        }
    },
    "example":{
        "self":{
            "href":"/em/api/targets/CF99A10F233254B78ED96ED1B5C15140/metricGroups/Filesystems"
        }
    }
}

例:

{
    "self":{
        "href":"/em/api/targets/CF99A10F233254B78ED96ED1B5C15140/metricGroups/Filesystems"
    }
}

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

型: array

(オプション)このメトリック・グループ内に存在するメトリックのリスト。問合せパラメータinclude= metricsが指定されている場合に含まれます。

ソースの表示

配列: object Metric

メトリック・メタデータ

{
    "type":"array",
    "description":"(Optional) List of metrics present in this metric group. Included if query parameter include=metrics is specified.",
    "items":{
        "$ref":"#/components/schemas/Metric"
    },
    "example":[
        {
            "id":"6E65075DA52ACA744B4B8C3FCB018289",
            "name":"pctAvailable",
            "displayName":"Filesystem Space Available (%)",
            "dataType":"NUMBER",
            "categoryName":"Utilization",
            "unitDisplayName":"%"
        },
        {
            "id":"162045AD9191652427CAC47D8BA40671",
            "name":"size",
            "displayName":"Filesystem Size (MB)",
            "dataType":"NUMBER",
            "unitDisplayName":"MB"
        },
        {
            "id":"E8838C71E687BF0A9E02FFACC0C9AC80",
            "name":"available",
            "displayName":"Filesystem Space Available (MB)",
            "dataType":"NUMBER",
            "categoryName":"Utilization",
            "unitDisplayName":"MB"
        },
        {
            "id":"C80F6EAA9145C76D30DE8705346D5AAA",
            "name":"fileSystem",
            "displayName":"Filesystem",
            "dataType":"STRING"
        }
    ]
}

例:

[
    {
        "id":"6E65075DA52ACA744B4B8C3FCB018289",
        "name":"pctAvailable",
        "displayName":"Filesystem Space Available (%)",
        "dataType":"NUMBER",
        "categoryName":"Utilization",
        "unitDisplayName":"%"
    },
    {
        "id":"162045AD9191652427CAC47D8BA40671",
        "name":"size",
        "displayName":"Filesystem Size (MB)",
        "dataType":"NUMBER",
        "unitDisplayName":"MB"
    },
    {
        "id":"E8838C71E687BF0A9E02FFACC0C9AC80",
        "name":"available",
        "displayName":"Filesystem Space Available (MB)",
        "dataType":"NUMBER",
        "categoryName":"Utilization",
        "unitDisplayName":"MB"
    },
    {
        "id":"C80F6EAA9145C76D30DE8705346D5AAA",
        "name":"fileSystem",
        "displayName":"Filesystem",
        "dataType":"STRING"
    }
]

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

型: object

メトリック・キー・メタデータ

ソースの表示

displayName(必須): string

キー表示名

例: Mount Point
name(必須): string

最大長: 64

キー名

例: mountPoint

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

ネストされたスキーマ: 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"
        }
    }
}

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

型: object

メトリック・メタデータ

ソースの表示

categoryDisplayName: string

メトリック・カテゴリ表示名

例: Utilization
categoryName: string

メトリック・カテゴリ名

例: Utilization
dataType(必須): string

指定可能な値: [ "NUMBER", "STRING" ]

メトリック・データ型。列挙される値は、時間の経過とともに増加する可能性があります。不明な値が見つかった場合は、互換性のためにそれをSTRINGとして扱います。

例: NUMBER
displayName(必須): string

メトリック表示名

例: Filesystem Size (MB)
id(必須): string

最大長: 32

メトリックID

例: E8838C71E687BF0A9E02FFACC0C9AC80
name(必須): string

最大長: 64

メトリック名

例: size
unitDisplayName: string

メトリック単位表示名

例: MB

{
    "type":"object",
    "description":"Metric metadata",
    "required":[
        "id",
        "name",
        "displayName",
        "dataType"
    ],
    "properties":{
        "id":{
            "type":"string",
            "maxLength":"32",
            "description":"Metric ID",
            "example":"E8838C71E687BF0A9E02FFACC0C9AC80"
        },
        "name":{
            "type":"string",
            "maxLength":"64",
            "description":"Metric Name",
            "example":"size"
        },
        "displayName":{
            "type":"string",
            "description":"Metric Display Name",
            "example":"Filesystem Size (MB)"
        },
        "categoryName":{
            "type":"string",
            "description":"Metric Category Name",
            "example":"Utilization"
        },
        "categoryDisplayName":{
            "type":"string",
            "description":"Metric Category Display Name",
            "example":"Utilization"
        },
        "dataType":{
            "type":"string",
            "description":"Metric Data type. Its enumerated values could be expanded over time. If an unknown value is encountered, treat it as STRING for compatibility.",
            "enum":[
                "NUMBER",
                "STRING"
            ],
            "example":"NUMBER"
        },
        "unitDisplayName":{
            "type":"string",
            "description":"Metric Unit Display Name",
            "example":"MB"
        }
    }
}

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

型: object

すべてに一致

ソースの表示

object Link

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

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

例

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

先頭に戻る