ターゲットのリスト
get
https://EM_HOST:8080/em/api/targets
このAPIは、指定された基準でフィルタしてターゲットのリストを返します。
リクエスト
問合せパラメータ
- displayName: array[string]
ターゲットの表示名
- displayNameMatches: array[string]
ターゲットの表示名パターン
- exclude: string
バインド変数をカンマで区切ったリストによる除外ID。これは、登録済のSQL問合せを使用してターゲットを結果セットから除外します。これはEMコンソールUIをサポートしています。例:
notThisTypeExcludeId,host
- include: string
ステータスまたは結果の合計数を返すかどうかを示すカンマ区切りリスト。有効な値は、targetStatusとtotalです。例:
targetStatus,total
- limit: integer(int32)
最小値:
1
最大値:2000
返される行の数を制限するため。結果セットがそれより大きい場合は、結果内のpreviousリンクとnextリンクに従います。例:20
- name: array[string]
ターゲットの名前
- nameMatches: array[string]
ターゲットの名前パターン例:
my_target_%
- owner: array[string]
ターゲット所有者
- page: string
self、nextおよびpreviousリンクにおいて使用されるシステム生成ページ・トークン。
- sort: string
ソート・フィールドと方向のカンマ区切りリスト。指定可能なソート・フィールドは、name、type、displayName、typeDisplayName、ownerおよびstatusです。指定可能な方向はDESCとASCです例:
type:ASC,name:DESC
- status: array[]
ターゲットのステータス
- typeDisplayName: array[string]
クライアント・ロケールでのタイプ表示名
- typeDisplayNameMatches: array[string]
クライアント・ロケールでのタイプ表示名パターン
- typeName: array[string]
ターゲットのタイプ
- typeNameMatches: array[string]
タイプ・パターン
この操作にはリクエスト本文はありません。
先頭に戻るレスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
OK
ルート・スキーマ: TargetCollection
型:
object
これはターゲット参照のリストを表すものです。
ソースの表示
-
count(必須): integer
このページにあるアイテムの数例:
20
-
items(必須): array items
ターゲット参照
-
links(必須): object links
結果セットのナビゲーション・リンク
-
total: integer
結果の合計数例:
42
ネストされたスキーマ: TargetSummary
型:
object
これはターゲット参照です。
ソースの表示
-
displayName(必須): string
ターゲットの表示例:
My Database Instance
-
id(必須): string
ターゲットID例:
D91786E288D35455C3ADA1B329B49BB5
-
links: object links
ターゲット関連リンク
-
name(必須): string
ターゲット名例:
my_database
-
owner(必須): string
ターゲットの所有者例:
scott
-
status: string
指定可能な値:
[ "DOWN", "UP", "METRIC_ERROR", "AGENT_DOWN", "UNREACHABLE", "BLACKOUT", "PENDING", "REMOTE_HOST_UNREACHABLE" ]
これはターゲット・ステータスを表すものです。 -
typeDisplayName(必須): string
ターゲットのタイプ表示名例:
Datenbankinstanz
-
typeName: string
ターゲット・タイプ名例:
oracle_database
ネストされたスキーマ: Link
型:
object
リンクを表します(self、previous、nextのいずれか)
ソースの表示
-
href: string
リンクのためのURL例:
/em/api/<resources>?page=b2Zmc2V0OjA&limit=0
400レスポンス
サポートされていないソート方向など、無効な引数の場合
ルート・スキーマ: ErrorResponse
型:
object
エラー・レスポンス
ソースの表示
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列
401レスポンス
クライアントが認証されていません
ルート・スキーマ: ErrorResponse
型:
object
エラー・レスポンス
ソースの表示
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列
500レスポンス
リクエスト処理中の内部エラー
ルート・スキーマ: ErrorResponse
型:
object
エラー・レスポンス
ソースの表示
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列
503レスポンス
必要なサービスが使用不可であることを示しています。
ルート・スキーマ: ErrorResponse
型:
object
エラー・レスポンス
ソースの表示
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列