Red Hat Training
A Red Hat training course is available for Red Hat JBoss Operations Network
REST API
リモートクライアントの開発
3.3.9 エディッション
Tyler Kelly
tkelly@redhat.comJared Morgan
jmorgan@redhat.comZach Rhoads
zach@redhat.comElla Deon Ballard
dlackey@redhat.com概要
第1章 REST インターフェース
1.1. http://localhost:7080/rest/ : root コンテキストを、検出性のためのアンカーを処理してください。
Defining class: org.rhq.enterprise.server.rest.RootHandlerBean
生成される - application/json、application/xml、text/html、application/vnd.rhq.wrapped+json
メソッド
GET //index
description
REST-resource ツリーのルート /index からリンクを返します。このメソッドにはパラメーターはありません。
return type: javax.ws.rs.core.Response
GET /
description
REST-resource ツリーのルート / からリンクを返します。このメソッドにはパラメーターはありません。
return type: javax.ws.rs.core.Response
1.2. http://localhost:7080/rest/alert : Deal with Alerts
この api は、発生したアラートを処理します。
Defining class: org.rhq.enterprise.server.rest.AlertHandlerBean
生成される - application/json、application/xml、text/html、application/vnd.rhq.wrapped+json
メソッド
GET /alert
description
リソースまたはアラート定義、優先度および開始時間によって制限される可能性のあるすべてのアラートを一覧表示するgzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 page クエリー ページ番号 false int all 0 Size クエリー ページサイズ; '無制限' には -1 を使用します。 false int all 100 prio クエリー 優先度の制限 false string high、Medium、Low、All all slim クエリー 完全なリソースおよび定義を送信する必要がある false ブール値 all false since クエリー null 以外のアラートがこの時間後に発生したアラートのみを送信する場合、エポックからの時間はミリ秒です。 false long all resourceId クエリー 検索を制限するリソースの ID false 整数 all definitionId クエリー 検索するアラート定義の場合 false 整数 all unacknowledgedOnly クエリー 未承認のアラートのみを送信するべき false ブール値 all false return type: List<AlertRest> (multi)
エラーコード:
code reason 406 クエリーパラメーターとして渡される 'resourceId' および 'definitionId' があります。 406 ページサイズが 0 406 ページ番号は < 0 でした。 GET /alert/count
description
基準に応じて、システムのアラートの数を返します。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 since クエリー null 以外のアラートがこの時間後に発生したアラートのみを送信する場合、エポックからの時間はミリ秒です。 false long all 戻りタイプ: IntegerValue
GET /alert/{id}
description
渡された ID で 1 つのアラートを取得します。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 取得するアラートの ID true int all slim クエリー 完全なリソースおよび定義を送信する必要がある false ブール値 all false return type: AlertRest
GET /alert/{id}/conditions
description
指定のアラートの条件ログを返します。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 取得するアラートの ID true int all return type: javax.ws.rs.core.Response
GET /alert/{id}/notifications
description
指定のアラートの通知ログを返します。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 取得するアラートの ID true int all return type: javax.ws.rs.core.Response
put /alert/{id}
description
アラートを(呼び出し元によって)確認応答としてマークします。注記
アラートのスリムバージョンを返します。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 確認応答するアラートの ID true int all return type: AlertRest
DELETE /alert/{id}
description
アラートの一覧からアラートを削除します。注記
この操作はデフォルトでべきべき等で、204. アラートが存在するかどうかを確認する場合は、「validate」クエリーパラメーターを渡す必要があります。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 削除するアラートの ID true int all Validate クエリー アラートが存在するかどうかを検証します。 false ブール値 all false return type: javax.ws.rs.core.Response
エラーコード:
code reason 204 アラートが削除されるか、検証が設定されていない状態で存在しなかった 404 アラートは存在せず、検証済みである GET /alert/{id}/definition
description
アラートのアラート定義(基本)を取得します。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 定義を表示するアラートの ID true int all return type: AlertDefinitionRest
1.3. http://localhost:7080/rest/alert: Deal with Alert Definitions
この api はアラート定義を処理します。
Defining class: org.rhq.enterprise.server.rest.AlertDefinitionHandlerBean
生成される - application/json、application/xml、text/html、application/vnd.rhq.wrapped+json
メソッド
GET /alert/definition
description
/alert/definitions へのリダイレクトこのメソッドにはパラメーターはありません。
return type: javax.ws.rs.core.Response
GET /alert/definitions
description
すべてのアラート定義の一覧表示gzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 FULL クエリー 条件および通知も返されるか? false ブール値 all false page クエリー ページ番号 false 整数 all ps クエリー ページサイズ false int all 20 resourceId クエリー 絞り込むリソース ID false 整数 all return type: AlertDefinitionRest(multi)
GET /alert/definition/{id}
description
id 別に 1 つの AlertDefinition を取得します。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 取得するアラート定義の ID true int all FULL クエリー 条件および通知も返されるか? false ブール値 all true return type: AlertDefinitionRest
エラーコード:
code reason 404 渡された ID の定義はありません。 post /alert/definitions
description
query param として渡される resource/group/resource タイプの AlertDefinition を作成します。いつでも 3 つのパラメーターの 1 つと 1 つのパラメーターのみを指定する必要があります。POST メソッドで条件と通知を確認し、それらのオプションも確認してください。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 resourceId クエリー 定義を割り当てるリソースの ID false 整数 all groupId クエリー 定義をアタッチするグループの ID false 整数 all resourceTypeId クエリー 定義を割り当てるリソースタイプの ID false 整数 all -body- 新規定義のデータ true AlertDefinitionRest all return type: javax.ws.rs.core.Response
エラーコード:
code reason 406 指定の 'resourceId'、'groupId'、または 'resourceTypeId' の 1 つが全くありませんでした。 406 渡された条件の検証に失敗する 406 渡されたグループは、アラート定義を持たない混合グループです。 404 既存のアラート通知送信者以外のリクエストがありました。 404 リカバリーへの参照アラートが存在しません。 put /alert/definition/{id}
description
アラート定義の更新(優先度、有効化、細分化、リカバリー)注記
優先度は HIGH,LOW,MEDIUM である必要があります。指定しない場合は、LOW が想定されます。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 更新するアラート定義の ID true int all -body- 更新のデータ true AlertDefinitionRest all return type: javax.ws.rs.core.Response
エラーコード:
code reason 404 渡された ID を持つ AlertDefinition が存在しない場合 DELETE /alert/definition/{id}
description
アラート定義の削除注記
この操作はデフォルトでべき等で、204. 定義が存在するかどうかを確認する場合は、「validate」クエリーパラメーターを渡す必要があります。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 削除する定義の ID true int all Validate クエリー 定義が存在するかどうかの検証 false ブール値 all false return type: javax.ws.rs.core.Response
エラーコード:
code reason 204 検証が設定されていないため、定義が削除されているか、または存在しない 404 定義は存在せず、検証が設定された。 delete /alert/condition/{cid}
description
アラート条件の削除注記
この操作はデフォルトでべき等で、204. 条件が全く存在するかどうかを確認する場合は、「validate」クエリーパラメーターを渡す必要があります。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 cid path 削除する条件の ID true int all Validate クエリー 条件が存在するかどうかを検証します。 false ブール値 all false return type: javax.ws.rs.core.Response
エラーコード:
code reason 204 検証が設定されていない条件が削除されているか、または存在しない。 404 条件は存在せず、検証済みに設定されました。 POST /alert/definition/{id}/conditions
description
新しいアラート条件の既存のアラート定義への追加注記
各条件はカテゴリーに分類されます。使用できるカテゴリーは AVAILABILITY、AVAIL_DURATION、BASELINE(m)、CHANGE(m)、CONTROL、DRIFT、EVENT、RANGE(m)、RESOURCE_CONFIG、THRESHOLD(m)、TRAIT(m).Categories with metricsDefinition であり、メトリクス定義から取得する必要があるため、名前はありません。パラメーターはカテゴリーによって異なります。- Availability: name は AVAIL_GOES_DOWN、AVAIL_GOES_DISABLED、AVAIL_GOES_UNKNOWN、AVAIL_GOES_NOT_UP、および AVAIL_GOES_UP のいずれかです。
- Avail_DURATION: name は AVAIL_DURATION_DOWN およびAVAIL_DURATION_NOT_UP のいずれかです。オプションは秒単位で時間を指定します。
- ベースライン - オプションは 'min','mean', max' の 1 つで、しきい値はパーセンテージ(0.01=1%)を示し、conarator は '< ','=' および '> ' になります。
- control: オプションを指定すると、Operation ステータス(FAILURE、SUCCESS、INPROGRESS、──CELED)、name は操作の名前(display-name ではありません)を示します。
- event: name は重大度(DEBUG,INFO,WARN,ERROR,FATAL)です。オプションは、照合するオプションの RegEx です。
- drift: name はオプションで、drift-definitions と一致します。オプションはオプションで、ディレクトリーに一致します。
- 範囲: しきい値は下限を持ち、高い境界である Comparator は '< ','<=','>=' または '> '> '> ' になります。
- resource_CONFIG: 追加のパラメーターは必要ありません。
- しきい値: コンタレーターは '< ','=','> '; しきい値を比較する値です。
- trait: オプションは、照合するオプションの RegEx です。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path アラート定義の ID true int all -body- 追加する条件 true AlertConditionRest all return type: javax.ws.rs.core.Response
エラーコード:
code reason 404 渡された ID を持つ AlertDefinition が存在しない場合 406 渡された条件の検証に失敗しました。より詳細なメッセージが提供されます。 put /alert/condition/{cid}
description
アラート定義の既存の条件を更新します。更新によって条件の ID が変更されることに注意してください。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 cid path 更新する条件の ID true int all -body- 更新された条件 true AlertConditionRest all return type: javax.ws.rs.core.Response
エラーコード:
code reason 404 渡された ID の条件が存在しません。 406 渡されたカテゴリーまたは条件 Operator が無効でした。 GET /alert/condition/{cid}
description
条件 id でアラート定義の条件を取得します。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 cid path 取得する条件の ID true int all return type: javax.ws.rs.core.Response
エラーコード:
code reason 404 渡された ID の条件がない GET /alert/notification/{nid}
description
ID で通知定義を返します。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 nid path 取得する通知定義の ID true int all return type: javax.ws.rs.core.Response
エラーコード:
code reason 404 渡された ID の通知が見つからない delete /alert/notification/{nid}
description
通知定義の削除注記
この操作はデフォルトでべき等で、204.の通知が全く存在するかどうかを確認する場合は、「validate」クエリーパラメーターを渡す必要があります。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 nid path 削除する通知定義の ID true int all Validate クエリー 通知が存在するかどうかを検証します。 false ブール値 all false return type: javax.ws.rs.core.Response
エラーコード:
code reason 204 検証が設定されていない通知は削除されているか、または存在しませんでした。 404 通知は存在せず、検証用として設定されました。 put /alert/notification/{nid}
description
通知定義の更新パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 nid path 更新する通知定義の ID true int all -body- 使用する通知定義が更新されました。 true AlertNotificationRest all return type: javax.ws.rs.core.Response
エラーコード:
code reason 404 渡された ID の通知がない POST /alert/definition/{id}/notifications
description
新しい通知定義のアラート定義の追加パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 通知定義を取得する必要のあるアラート定義の ID true int all -body- 追加する通知の定義 true AlertNotificationRest all return type: javax.ws.rs.core.Response
エラーコード:
code reason 404 Requested alert notification sender does not exist(要求されるアラート通知送信者が存在しない) 404 渡された ID が含まれるアラート定義はありません。 GET /alert/senders
description
簡単な説明を含むアラート通知送信者の一覧を返します。一覧には設定定義が含まれません。gzip ed Content-Encoding の返信をサポートします。
このメソッドにはパラメーターはありません。
return type: javax.ws.rs.core.Response
GET /alert/sender/{name}
description
名前でアラート通知送信者を返します。これには、予想される設定に関する情報が含まれます。gzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 Name path 取得する送信元の名前 true string all return type: javax.ws.rs.core.Response
エラーコード:
code reason 404 渡された名前を持つ送信者はありません。
1.4. http://localhost:7080/rest/content : コンテンツ関連
このエンドポイントはコンテンツ(アップロード)を処理します。
Defining class: org.rhq.enterprise.server.rest.ContentHandlerBean
プロデューサー: application/json、application/xml
メソッド
POST /content/fresh
description
サーバーにコンテンツをアップロードします。これにより、後でコンテンツを取得してさらに処理できるハンドルが返されます。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 -body- 保存する application/octet-stream true java.io.InputStream -all- -none- return type: javax.ws.rs.core.Response
GET /content/{handle}/info
description
渡されたハンドルのコンテンツの長さを取得します。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 handle path NONE string -all- -none- 戻りタイプ: IntegerValue
PUT /content/{handle}/plugins
description
アップロードしたコンテンツをプラグインドロップボックスに配置します。注記
このエンドポイントは、以前にアップロードしたコンテンツをプラグインとしてデプロイできるようにします。プラグインの処理が正常に実行されるには、有効なプラグイン(ファイル)名を指定する必要があります。オプションで、プラグインスキャンを開始して、プラグインをシステムに登録するように要求できます。プラグインが自動的にエージェントにプッシュされる遅延(ミリ秒単位)を指定することもできます。負でない「pushOutDelay」は「scan」が true に設定されている場合、サーバーに更新されたプラグインがないため、エージェントで更新が発生することができないことに注意してください。負でない「pushOutDelay」と「scan」が false に設定されている場合、406 エラーが返されます。ハンドルで特定されたコンテンツは削除されません。このメソッドは非推奨となり、PUT から /plugins を使用します。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 handle path アップロードから取得したハンドルの名前 true string all Name クエリー プラグインファイルの名前 false string all scan クエリー 検出スキャンを開始すべきか? false ブール値 all false pushOutDelay クエリー エージェントがプラグインを更新するまでの遅延(ミリ秒単位)。負の値を設定すると、エージェントの自動更新が無効になります。 false long all -1 return type: javax.ws.rs.core.Response
エラーコード:
code reason 406 指定されたパラメーターの名前または無効な組み合わせがない 404 ハンドルが見つからない 403 caller にはプラグインをアップロードする権限がありません。 delete /content/{handle}
description
渡されたハンドルのコンテンツを削除します。注記
この操作はデフォルトでべき等で、204. コンテンツが存在するかどうかを確認する場合は、「validate」クエリーパラメーターを渡す必要があります。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 handle path NONE string -all- -none- Validate クエリー コンテンツが存在するかどうかの検証 false ブール値 all false return type: javax.ws.rs.core.Response
エラーコード:
code reason 204 検証が設定されていないコンテンツが削除されるか、または存在しない 404 コンテンツは存在せず、検証が設定されている
1.5. http://localhost:7080/rest/event : Events を処理する Api(例: snmp トラップ、ログファイル行)
Defining class: org.rhq.enterprise.server.rest.EventHandlerBean
生成される - application/json、application/xml、text/html、application/vnd.rhq.wrapped+json
メソッド
GET /event/{id}/sources
description
リソースの定義されたイベントソースを一覧表示します。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path リソースの ID true int all return type: EventSourceRest(multi)
GET /event/{id}/definitions
description
リソースの定義されたイベントソース定義を一覧表示します。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path リソースの ID true int all return type: EventDefinitionRest(multi)
GET /event/source/{id}
description
渡された ID でイベントソースを取得します。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 取得するソースの ID true int all Return type: EventSourceRest
エラーコード:
code reason 404 渡された ID にはイベントソースがありません。 POST /event/{id}/sources
description
リソースに新しいイベントソースを追加します。これは、異なるログファイルなどにすることができます。ソース名は、このリソースの既存の定義に一致する必要があります。同じ場所にある定義名とリソースのイベントソースがすでに存在する場合、新しいソースは作成されません。注記: この方法で追加したイベントソースは、接続プロパティーには表示されません。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path リソースの ID true int all -body- 追加するイベントソース。 true EventSourceRest -all- -none- Return type: EventSourceRest
エラーコード:
code reason 404 渡された ID のリソースが存在しない 404 渡された名前のイベント定義が見つからない 406 同じ場所に同じ定義にイベントソースを作成しようとします。 DELETE /event/source/{id}
description
渡された ID でイベントソースを削除します。注記
この操作はデフォルトでべき等で、204. ソースが存在しないかどうかを確認する場合は、「validate」クエリーパラメーターを渡す必要があります。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 削除するソースの ID true int all Validate クエリー コンテンツが存在するかどうかの検証 false ブール値 all false return type: javax.ws.rs.core.Response
エラーコード:
code reason 204 検証が設定されていないソースが削除されるか、または存在しない 404 ソースが存在しておらず、検証が設定されている GET /event/source/{id}/events
description
渡された ID でイベントソースのイベントを一覧表示します。時間の範囲を指定しないと、最後の 200 エントリーが表示されます。gzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path NONE int -all- -none- startTime クエリー NONE long -all- -none- endTime クエリー NONE long -all- -none- 重大度 クエリー 表示する重大度を選択します。デフォルトは all を表示します。 false string DEBUG、INFO、WARN、ERROR、FATAL ps クエリー ページングのページサイズ false int all 20 page クエリー ページングのページ 0 ベース false 整数 all return type: EventRest(multi)
GET /event/{id}/events
description
渡された ID でリソースのイベントを一覧表示します。時間の範囲を指定しないと、最後の 200 エントリーが表示されます。gzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path NONE int -all- -none- startTime クエリー NONE long -all- -none- endTime クエリー NONE long -all- -none- ps クエリー ページングのページサイズ false int all 20 page クエリー ページングのページ 0 ベース false 整数 all 重大度 クエリー 表示する重大度を選択します。デフォルトは all を表示します。 false string DEBUG、INFO、WARN、ERROR、FATAL return type: EventRest(multi)
POST /event/source/{id}/events
description
指定された 1 つのイベントソースに複数のイベントを送信します。渡されたイベントのイベントソースは無視されます。アラートが正常に発生するように、タイムスタンプによってイベントが順序付けされていることを確認します。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path データを追加するソースの ID true int all -body- 追加するイベントの一覧。 true List<EventRest> -all- -none- return type: javax.ws.rs.core.Response
1.6. http://localhost:7080/rest/group : グループおよび DynaGroups を使用したデバッグ
リソースグループおよびグループ定義に対応する API
定義クラス: org.rhq.enterprise.server.rest.GroupHandlerBean
生成される - application/json、application/xml、text/html、application/vnd.rhq.wrapped+json
メソッド
GET /group
description
すべてのグループを一覧表示します。gzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 q クエリー グループ名で検索する文字列 false string all ps クエリー ページングのページサイズ false int all 20 page クエリー ページングのページ番号、0 ベース false 整数 all 戻りタイプ: GroupRest(multi)
GET /group/{id}
description
渡された ID でグループを取得します。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path グループの ID true int all return type: javax.ws.rs.core.Response
エラーコード:
code reason 404 渡された ID のグループが見つからない POST /group
description
新規グループの作成パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 -body- グループの名前が少なくとも含まれる GroupRest オブジェクト true GroupRest all return type: javax.ws.rs.core.Response
エラーコード:
code reason 404 指定されたタイプ id のリソースタイプが存在しません。 406 指定されていない 406 指定グループの名前がない PUT /group/{id}
description
渡されたグループを更新します。現時点では、名前の変更のみがサポートされます。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 更新するグループの ID true int all -body- グループの新バージョン true GroupRest all return type: javax.ws.rs.core.Response
エラーコード:
code reason 404 渡された ID を持つグループは存在しません。 406 名前の更新に失敗しました。 /group/{id} の削除
description
渡された ID のグループを削除します。注記
この操作はデフォルトでべきべき等で、204. グループが存在するかどうかを確認する場合は、「validate」クエリーパラメーターを渡す必要があります。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 削除するグループの ID true int all Validate クエリー グループが存在するかどうかを検証します。 false ブール値 all false return type: javax.ws.rs.core.Response
エラーコード:
code reason 204 検証が設定されていないグループが削除されるか、または存在しない 404 グループが存在しておらず、検証が設定されている GET /group/{id}/resources
description
グループのリソースを取得します。gzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path リソースを取得するグループの ID true int all return type: ResourceWithType(multi)
エラーコード:
code reason 404 渡された ID を持つグループは存在しません。 PUT /group/{id}/resource/{resourceId}
description
既存グループにリソースを追加する注記
グループを互換性のあるグループとして作成し、リソースタイプが作成時に提供されている場合は、このタイプを持つリソースのみを追加できます。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 既存グループの ID true int all resourceId path 追加するリソースの ID true int all return type: javax.ws.rs.core.Response
エラーコード:
code reason 404 渡された ID のリソースまたはグループがない場合 409 リソースタイプがグループタイプと一致しません。 DELETE /group/{id}/resource/{resourceId}
description
渡された id を持つリソースをグループから削除します。注記
この操作はデフォルトでべき等で、リソースがグループのメンバーでない場合は 204 even を返します。リソースが全く存在しないかどうかを確認する場合は、「validate」クエリーパラメーターを渡す必要があります。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 既存グループの ID true int all resourceId path 削除するリソースの ID true int all Validate クエリー リソースがグループに存在するかどうかを検証します。 false ブール値 all false return type: javax.ws.rs.core.Response
エラーコード:
code reason 404 渡された ID を持つグループは存在しません。 404 渡された ID のリソースが存在しない 204 リソースがグループから削除されているか、メンバーもありませんでした。検証は設定されませんでした。 404 リソースはグループのメンバーではなく、検証に設定されました。 GET /group/{id}/metricDefinitions
description
渡された ID と互換性のあるグループのメトリクス定義を取得します。gzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path グループの ID true int all return type: javax.ws.rs.core.Response
エラーコード:
code reason 404 渡された ID を持つグループは存在しません。 GET /group/definitions
description
既存の GroupDefinition の一覧表示gzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 q クエリー グループ定義名で検索する文字列 false string all 戻りタイプ: GroupDefinitionRest(multi)
GET /group/definition/{id}
description
id 別に単一の GroupDefinition の取得gzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 取得する定義の ID true int all 戻りタイプ: GroupDefinitionRest
エラーコード:
code reason 404 渡された ID のグループ定義は存在しません。 /group/definition/{id} の削除
description
渡された ID で GroupDefinition を削除します。注記
この操作はデフォルトでべき等で、204. 定義が存在するかどうかを確認する場合は、「validate」クエリーパラメーターを渡す必要があります。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 削除する定義の ID true int all Validate クエリー 定義が存在するかどうかの検証 false ブール値 all false return type: javax.ws.rs.core.Response
エラーコード:
code reason 204 検証が設定されていないため、定義が削除されているか、または存在しない 404 定義は存在せず、検証が設定された。 /group/definitions
description
新規 GroupDefinition を作成します。注記
グループの名前は、渡された定義と空でない式で必要です。recalcInterval が 0 の場合は、再計算しないことを意味します。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 -body- 新規グループに使用するグループ定義。 true GroupDefinitionRest -all- -none- return type: javax.ws.rs.core.Response
エラーコード:
code reason 406 渡されたグループ定義の名前がない 406 渡された式が空である 406 再計算の間隔は < 0 です。 409 この名前の定義がすでに存在します。 406 グループの作成に失敗する PUT /group/definition/{id}
description
既存の GroupDefinition を更新または再計算する注記
クエリー param 'recalculate' が true に設定されている場合、渡された ID のグループは再計算されます。それ以外の場合は、既存のグループが渡された定義で更新されます。定義の式は空である必要があります。名前が emtpy の場合、古い名前は保持されます。recalcInterval が 0 の場合は再計算しないことを意味します。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 更新する定義の ID true int all 再計算 クエリー true の場合、再計算をトリガーします。 false ブール値 all false -body- 更新に使用するグループ定義。これは、再計算が false の場合に必要です。 GroupDefinitionRest -all- -none- return type: javax.ws.rs.core.Response
エラーコード:
code reason 404 渡された ID を持つグループは存在しません。 406 渡された式が空である 406 再計算の間隔は < 0 です。 406 グループメンバーシップの計算に失敗しました。
1.7. http://localhost:7080/rest/metric: Deal with metrics
API のこの部分は、メトリクスのエクスポートおよび追加を処理します。
クラスの定義: org.rhq.enterprise.server.rest.MetricHandlerBean
生成される - application/json、application/xml、text/html
メソッド
GET /metric/data/{scheduleId}
description
スケジュールのバケット化されたメトリクス値を取得します。gzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 scheduleId path クエリーする値のスケジュール true int all startTime クエリー エポックから開始時間。 false long all 終了時間 - 8h endTime クエリー エポックからの経過時間。 false long all now dataPoints クエリー バケットの数 false int all 60 hideEmpty クエリー NaN のみの行の非表示 false ブール値 all false return type: javax.ws.rs.core.Response
エラーコード:
code reason 404 渡された ID のスケジュールがない GET /metric/data/group/{groupId}/{definitionId}
description
グループのメトリクス定義のバケット化されたメトリクス値を取得します。gzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 groupId path 問い合わせるグループの ID true int all definitionId path 取得するメトリクス定義の ID true int all startTime クエリー エポックから開始時間。 false long all 終了時間 - 8h endTime クエリー エポックからの経過時間。 false long all now dataPoints クエリー バケットの数 false int all 60 hideEmpty クエリー NaN のみの行の非表示 false ブール値 all false return type: javax.ws.rs.core.Response
GET /metric/data
description
渡されたスケジュールのバケット化されたメトリックデータ(60 ポイント)を返します。gzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 SID クエリー スケジュール ID のコンマ区切りリスト true string all startTime クエリー エポックからの経過時間(ms)。デフォルトは -8h です。 false long all endTime クエリー エポックからの経過時間(ミリ秒単位)。デフォルトは現在の状態です。 false long all dataPoints クエリー バケットの数 false int all 60 hideEmpty クエリー 空のデータポイントを非表示にする必要があります。 false ブール値 all false return type: javax.ws.rs.core.Response
エラーコード:
code reason 404 渡された ID のスケジュールがない 406 No schedules requesteds(要求されるスケジュールなし) 406 スケジュール ID が数値ではない GET /metric/schedule/{id}
description
渡された ID のメトリクススケジュールを取得します。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path スケジュール ID true int all return type: javax.ws.rs.core.Response
エラーコード:
code reason 404 渡された ID のスケジュールがない GET /metric/data/resource/{resourceId}
description
リソースの高/低/平均/データ集計の一覧の取得gzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 resourceId path 問い合わせるリソースの ID true int all startTime クエリー エポックから開始時間。 false long all 終了時間 - 8h endTime クエリー エポックからの経過時間。 false long all now includeDataPoints クエリー include data point false ブール値 all false dataPoints クエリー バケットの数(データポイントが含まれている場合) false int all 60 hideEmpty クエリー NaN のみの行の非表示 false ブール値 all false return type: List<MetricAggregate>
エラーコード:
code reason 404 渡された ID のリソースが存在しない場合 GET /metric/data/group/{groupId}
description
グループの高/低/平均/データアグリゲートの一覧の取得gzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 groupId path 問い合わせるグループの ID true int all startTime クエリー エポックから開始時間。 false long all 終了時間 - 8h endTime クエリー エポックからの経過時間。 false long all now return type: List<MetricDefinitionAggregate>
エラーコード:
code reason 404 渡された ID のグループはありません。 put /metric/schedule/{id}
description
スケジュールの更新(有効、間隔)パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 更新するスケジュールの ID true int all -body- 新しいスケジュールデータ true MetricSchedule all return type: MetricSchedule
エラーコード:
code reason 404 渡された ID のスケジュールがない GET /metric/definition/{id}
description
定義を取得します。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 取得する定義の ID true int all return type: MetricSchedule
エラーコード:
code reason 404 指定の id の定義はありません。 put /metric/definition/{id}
description
定義を更新します(デフォルトの間隔)。注記
この操作は内部的に完了するのに時間がかかる可能性があるため、この呼び出しによってのみトリガーされます。戻りコード 200 は、操作が正常に送信されたことを示します。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 更新する定義の ID true int all -body- 新規定義データ true MetricSchedule all updateExisting クエリー この定義の既存のスケジュールも更新する false ブール値 all false return type: MetricSchedule
エラーコード:
code reason 404 指定の id の定義はありません。 GET /metric/data/{scheduleId}/raw
description
単一スケジュールの raw メトリクスを公開します。これは生データのみを公開できます。つまり、開始日が 7 日以上かかる場合があります。gzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 scheduleId path NONE true int all startTime クエリー エポックからの開始日 false long all now - 8h endTime クエリー エポックからの経過時間 false long all now duration クエリー TimeSpan(ミリ秒単位) false long all 8h = 28800000ms 戻りタイプ: javax.ws.rs.core.StreamingOutput
エラーコード:
code reason 404 渡された ID のスケジュールがない GET /metric/data/{scheduleId}/callTime
description
特定の scheduleId の callTime データを公開します。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 scheduleId path NONE true int all startTime クエリー エポックからの開始日 false long all now - 8h endTime クエリー エポックからの経過時間 false long all now aggregate クエリー true は callDestination で集約された callTimes を返します。 false ブール値 all true 戻りタイプ: javax.ws.rs.core.StreamingOutput
エラーコード:
code reason 404 渡された ID のスケジュールがない PUT /metric/data/{scheduleId}/callTime
description
callTime メトリクスのサーバーへの送信パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 scheduleId path スケジュールの ID true int all -body- 追加する呼び出し時間値の一覧。 true List<CallTimeValueRest> -all- -none- return type: javax.ws.rs.core.Response
エラーコード:
code reason 404 渡された ID のスケジュールがない 406 beginTime is older than 7 days(beginTime が 7 日より古い) 406 callDestination が null である 406 期間が負の値である PUT /metric/data/{scheduleId}/raw/{timeStamp}
description
1 つの(数値)メトリックをサーバーに送信パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 scheduleId path スケジュールの ID true int all timeStamp path メトリックのタイムスタンプ true long all -body- データ値 true DoubleValue all return type: javax.ws.rs.core.Response
エラーコード:
code reason 404 渡された ID のスケジュールがない 406 タイムスタンプが 7 日よりも古い PUT /metric/data/{scheduleId}/trait/{timeStamp}
description
渡されたスケジュール ID の新しい特性値の送信パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 scheduleId path スケジュールの ID true int all timeStamp path メトリックのタイムスタンプ true long all -body- データ値 true StringValue all return type: javax.ws.rs.core.Response
エラーコード:
code reason 404 渡された ID のスケジュールがない 406 タイムスタンプが 7 日よりも古い GET /metric/data/{scheduleId}/trait
description
渡されたスケジュール ID で特性の現在の値を取得します。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 scheduleId path スケジュールの ID true int all 戻りタイプ : StringValue
エラーコード:
code reason 404 渡された ID のスケジュールがない Post /metric/data/raw
description
サーバーに一連の(数値)メトリック値を送信パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 -body- スケジュール ID が設定されている数値データポイント値のコレクション。 true Collection<NumericDataPoint> -all- -none- 戻りタイプ: 応答なし
エラーコード:
code reason 201 一部の送信済みデータポイントに存在しない scheduleId があり、API は拒否された値をクライアントに戻します。有効な値が許可されます。 403 送信されたすべてのデータポイントに存在しない scheduleId があり、API は拒否された値をクライアントに返します。 POST /metric/data/raw/{resourceId}
description
1 つのリソースの一連の(数値)メトリック値をサーバーに送信するパラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 resourceId path NONE int -all- -none- -body- メトリック定義の名前が設定された数値データポイント値のコレクション。 true Collection<NumericDataPoint> -all- -none- 戻りタイプ: 応答なし
エラーコード:
code reason 403 受信したデータポイントからのメトリックが指定のリソースに存在しない GET /metric/data/{scheduleId}/baseline
description
スケジュールの現在のベースラインを取得します。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 scheduleId path スケジュールの ID true int all 戻りタイプ: ベース ライン
エラーコード:
code reason 404 渡された ID のスケジュールがない PUT /metric/data/{scheduleId}/baseline
description
スケジュールの新しいベースラインの設定パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 scheduleId path スケジュールの ID true int all -body- ベースラインの値。 true ベースライン -all- -none- return type: javax.ws.rs.core.Response
エラーコード:
code reason 404 渡された ID のスケジュールがない 406 ベースラインデータが正しくない
1.8. http://localhost:7080/rest/operation: 操作のエンドポイント。
これらのエンドポイントは、操作のスケジューリングや操作結果の取得を処理します。
クラスの定義: org.rhq.enterprise.server.rest.OperationsHandlerBean
プロデューサー: application/json、application/xml
メソッド
GET /operation/definition/{id}
description
ID で単一の操作定義を取得します。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 取得する定義の ID true int all resourceId クエリー この操作をサポートするリソースの ID false 整数 all return type: javax.ws.rs.core.Response
GET /operation/definitions
description
リソースの操作定義をすべて一覧表示するgzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 resourceId クエリー リソースの ID true 整数 all return type: javax.ws.rs.core.Response
post /operation/definition/{id}
description
渡されたリソースの渡された定義 ID から新しい(ドラフト)操作を作成します。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 定義の ID true int all resourceId クエリー リソースの ID true 整数 all return type: javax.ws.rs.core.Response
GET /operation/{id}
description
(ドラフト)操作を返します。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 取得する操作の ID true int all return type: javax.ws.rs.core.Response
put /operation/{id}
description
(draft)操作を更新します。状態が 'ready' に設定されている場合、操作はスケジュールされます。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 更新する操作の ID true int all -body- 更新に使用する操作定義。 true OperationRest -all- -none- return type: javax.ws.rs.core.Response
エラーコード:
code reason 404 渡された ID のドラフト操作がない 406 スケジューリング用にドラフトが設定されていましたが、パラメーターの検証に失敗しました。 200 Update was successful, operation was scheduled if request delete /operation/{id}
description
(ドラフト)操作の削除パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 削除する操作の ID true int all return type: javax.ws.rs.core.Response
GET /operation/history/{id}
description
スケジュールされた操作の結果を返します。gzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 送信されたジョブの名前。 true string all return type: javax.ws.rs.core.Response
GET /operation/history
description
リソースに対して実行された操作の結果を返します。gzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 resourceId クエリー 制限するリソースの ID false int all ps クエリー ページングのページサイズ false int all 20 page クエリー ページングのページ 0 ベース false 整数 all return type: javax.ws.rs.core.Response
delete /operation/history/{id}
description
渡された ID 操作履歴項目を削除します。注記
この操作はデフォルトでべき等で、204.ジョブがジョブが存在するかどうかを確認する場合は、「validate」クエリーパラメーターを渡す必要があります。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 送信されたジョブの名前 true string all Validate クエリー ジョブが存在するかどうかを検証します。 false ブール値 all false return type: javax.ws.rs.core.Response
エラーコード:
code reason 204 項目が削除されるか、検証が設定されていない状態で存在しなかった 404 アイテムは存在せず、検証が設定されている 406 渡されたジョブ ID が名前の検証をパスしませんでした。
1.9. http://localhost:7080/rest/plugins : プラグイン関連
このエンドポイントは RHQ のプラグインを処理します。
Defining class: org.rhq.enterprise.server.rest.PluginHandlerBean
プロデューサー: application/json、application/xml
メソッド
/plugins の取得
description
現在システムに存在するプラグインを探します。オプションでサーバーのファイルシステムからプラグインを再読み込みします。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 Name クエリー NONE string -all- -none- enabled クエリー 有効であるか、無効であるか、または両方のプラグインを検索しますか? false ブール値 all version クエリー 検索するプラグインのバージョン false string all 削除済み クエリー 削除、インストール済み、または両方のプラグインを検索するかどうか。 false ブール値 all false reload クエリー 検索を実行する前に、ファイルシステムからプラグインを再読み込みするかどうか。これは、サーバーのプラグイン「dropbox」ディレクトリーに手動で配置されたプラグインを有効にするために使用できます。 false ブール値 all ps クエリー ページングのページサイズ false int all 20 page クエリー ページングのページ 0 ベース false 整数 all return type: javax.ws.rs.core.Response
GET /plugins/{id}
description
単一プラグインに関する情報を取得します。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path プラグインの ID true int all return type: javax.ws.rs.core.Response
put /plugins/{id}
description
プラグインの有効化を更新します。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path プラグインの ID true int all enabled クエリー true はプラグインが有効であり、false とはプラグインが無効であることを意味します。 false ブール値 all return type: javax.ws.rs.core.Response
/plugins/{id} の削除
description
1 つのプラグイン(オプションでパージ)を削除します。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path プラグインの ID true int all return type: javax.ws.rs.core.Response
POST /plugins
description
コンテンツハンドルを使用して提供されたプラグインをドロップボックスに配置し、ドロップボックスで変更を検索します。または、dropbox ディレクトリーで登録されていないプラグインがある場合には、提供されたプラグインだけがサーバーに登録されないプラグインよりも多くなる場合があります。ハンドルによって特定された内容は、後で削除されません。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 handle クエリー アップロードから取得したハンドル false string all Name クエリー プラグインファイルの名前 false string all return type: javax.ws.rs.core.Response
/plugins/deploy
description
有効なすべてのプラグインを、その時点で実行中のすべてのエージェントにプッシュします。デフォルトでは、そのプロセスを即座に開始します。返される文字列は、すべてのエージェントが更新されたプラグインを受信するかどうかを確認するために使用できるハンドルです。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 delay クエリー エージェントで更新をトリガーする前の遅延(ミリ秒単位) false long all 0 return type: javax.ws.rs.core.Response
GET /plugins/deploy/{handle}
description
提供されたハンドルで特定されたエージェントへのデプロイメントが完了しているかどうかを確認します。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 handle path デプロイハンドル true string all return type: javax.ws.rs.core.Response
1.10. http://localhost:7080/rest/reports : UI の Report セクションからも実行するレポートを提供します。すべてのレポートは CSV 形式でのみ利用可能
クラスの定義: org.rhq.enterprise.server.rest.ReportsHandlerBean
生成: text/csv
メソッド
GET /reports
description
利用可能なレポートを一覧表示します。このメソッドにはパラメーターはありません。
return type: String(multi)
GET /reports/alertDefinitions
description
AlertDefinition を CSV としてエクスポートgzip ed Content-Encoding の返信をサポートします。
このメソッドにはパラメーターはありません。
return type: String(multi)
GET /reports/configurationHistory
description
設定履歴データを CSV としてエクスポートgzip ed Content-Encoding の返信をサポートします。
このメソッドにはパラメーターはありません。
return type: String(multi)
GET /reports/driftCompliance
description
ドリフトコンプライアンスデータのエクスポートgzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 resourceTypeId クエリー NONE string -all- -none- version クエリー NONE string -all- -none- return type: String(multi)
GET /reports/inventorySummary
description
インベントリーサマリーデータを CSV としてエクスポートgzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 resourceTypeId クエリー NONE string -all- -none- version クエリー NONE string -all- -none- return type: String(multi)
GET /reports/platformUtilization
description
Platform 使用状況データを CSV としてエクスポートgzip ed Content-Encoding の返信をサポートします。
このメソッドにはパラメーターはありません。
return type: String(multi)
GET /reports/recentAlerts
description
Recent Alert データを CSV としてエクスポートgzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 alertPriority クエリー NONE string -all- high、medium、low startTime クエリー NONE long -all- -none- endTime クエリー NONE long -all- -none- return type: String(multi)
GET /reports/recentDrift
description
Recent drift データを CSV としてエクスポートgzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 カテゴリー クエリー 報告するカテゴリーのずれ false string FILE_ADDED、FILE_CHANGED、FILE_REMOVED snapshot クエリー NONE 整数 -all- -none- path クエリー NONE string -all- -none- 定義 クエリー NONE string -all- -none- startTime クエリー NONE long -all- -none- endTime クエリー NONE long -all- -none- return type: String(multi)
エラーコード:
code reason 404 カテゴリーを指定しなかったり、カテゴリーが間違っている場合 GET /reports/recentOperations
description
Recent Operations Data を CSV としてエクスポートgzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 status クエリー 検索するステータス。パラメーターを指定しないと、すべての値が使用されます。 false string all inprogress,success,failure,canceled startTime クエリー エクスポートする時間範囲のエポックからの経過時間(ミリ秒単位)。 false long all endTime クエリー エクスポートする時間範囲のエポックからの経過時間(ms)。開始時間のみが指定される場合、デフォルトは「now」に設定されています。 false long all return type: String(multi)
GET /reports/suspectMetrics
description
Suspect Metrics データを CSV としてエクスポートgzip ed Content-Encoding の返信をサポートします。
このメソッドにはパラメーターはありません。
return type: String(multi)
1.11. http://localhost:7080/rest/resource : リソースに関連する
このエンドポイントは、リソースグループではなく個別のリソースを処理します。
Defining class: org.rhq.enterprise.server.rest.ResourceHandlerBean
生成される - application/json、application/xml、text/html、application/vnd.rhq.wrapped+json
メソッド
GET /resource/{id:\d+}
description
単一リソースの取得パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 取得するリソースの ID true int all return type: ResourceWithType
エラーコード:
code reason 404 渡された ID のリソースが存在しない場合 PUT /resource/{id:\d+}
description
単一のリソースを更新するか、検出キューから新しいリソースをインポートします。注記
インベントリーにあるリソースを更新できます。この場合、fieldname、description、および location を更新できます。または、NEW の状態にあるプラットフォームまたはサーバーリソースをインポートできます。そのためには、COMMITTED 状態で取得したリソースを PUT する必要があります。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path インポートするリソースの ID true int all -body- 更新するリソース true ResourceWithType all return type: ResourceWithType
エラーコード:
code reason 404 渡された ID のリソースが存在しない場合 406 COMMITTED 以外のリソースの更新を試行 GET /resource/search
description
クエリーパラメーターに基づくリソースの検索注記
org.rhq.core.domain.criteria.ResourceCriteria#addFilter*, をベースとするパラメーターを使用できますが、フィルターメソッドに渡される値は 1 つだけです(複数の値をサポートしている可能性もあります)。たとえば、パラメーター name=value 変換を ResourceCriteria#addFilterName(value)、パラメーター pluginName=value 変換を ResourceCriteria#addFilterPluginName(value)に変換します。一部のパラメーター名は、status=inventoryStatus、Availability=currentAvailability、category=resourceCategories、plugin=pluginName、parentId=parentResourceId、parentName=parentResourceName、type=resourceTypeName です。たとえば、プラットフォームで稼働しているすべての AS7 スタンドアロンサーバーが GET /resource/search?parentId=10001&type=JBossAS7 Standalone Server&availability=UP を実行する場合は、以下を実行します。
gzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 ps クエリー ページングのページサイズ false int all 20 page クエリー ページングのページ 0 ベース false 整数 all 0 Strict クエリー 厳密なフィルタリングの有効化 false ブール値 all false return type: ResourceWithType
エラーコード:
code reason 406 渡されたインベントリーのステータスが無効な場合 GET /resource
description
指定の検索文字列でリソースを検索します。場合によっては、カテゴリーおよびページごとに限定される可能性があります。gzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 q クエリー 制限結果をリソース名の param に限定します。 false string all category クエリー カテゴリーに制限(PLATFORM、SERVER、SERVICE) false string all ps クエリー ページングのページサイズ false int all 20 page クエリー ページングのページ 0 ベース false 整数 all 0 status クエリー リソースのインベントリーステータスに制限 false string ALL、NEW、IGNORED、COMMITTED、DELETED、UNINVENTORIED COMMITTED return type: ResourceWithType
エラーコード:
code reason 406 渡されたインベントリーのステータスが無効な場合 GET /resource/platforms
description
システム内のプラットフォームの一覧を表示するgzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 ps クエリー ページングのページサイズ false int all 20 page クエリー ページングのページ 0 ベース false 整数 all 0 return type: ResourceWithType(multi)
GET /resource/{id}/hierarchy
description
渡されたリソースの階層を取得します。gzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 開始するリソースの ID true int all return type: ResourceWithType(multi)
エラーコード:
code reason 404 渡された ID のリソースが存在しない場合 GET /resource/{id}/availability
description
渡されたリソースの現在の可用性を返します。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 問い合わせるリソースの ID true int all return type: AvailabilityRest
エラーコード:
code reason 404 渡された ID のリソースが存在しない場合 GET /resource/{id}/availability/history
description
渡されたリソースの可用性履歴を返します。gzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 問い合わせるリソースの ID true int all start クエリー 開始時間 false long all 30 日前 end クエリー 終了時間 false long all now return type: AvailabilityRest(multi)
エラーコード:
code reason 404 渡された ID のリソースが存在しない場合 GET /resource/{id}/availability/summary
description
渡されたリソースの可用性履歴を返します。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 問い合わせるリソースの ID true int all return type: AvailabilitySummary
エラーコード:
code reason 404 渡された ID のリソースが存在しない場合 put /resource/{id}/availability
description
渡されたリソースの現在の可用性を設定します。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 更新するリソースの ID true int all -body- 新しい可用性設定 true AvailabilityRest all 戻りタイプ: void
GET /resource/{id}/schedules
description
渡されたリソース ID のメトリクススケジュールを取得します。gzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path スケジュールを取得するリソースの ID true int all type クエリー 種類による制限 false string <empty>、all、metric、trait、measurement all enabledOnly クエリー 有効なスケジュールによる制限 false ブール値 all true Name クエリー 名前による制限 false string all return type: MetricSchedule(multi)
エラーコード:
code reason 404 渡された ID のリソースが存在しない場合 GET /resource/{id}/children
description
渡されたリソースの直接子を取得します。gzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 子を取得するリソースの ID true int all ps クエリー ページングのページサイズ false int all 20 page クエリー ページングのページ 0 ベース false 整数 all 0 q クエリー 制限結果をリソース名の param に限定します。 false string all category クエリー カテゴリーに制限(PLATFORM、SERVER、SERVICE) false string all status クエリー リソースのインベントリーステータスに制限 false string ALL、NEW、IGNORED、COMMITTED、DELETED、UNINVENTORIED COMMITTED return type: javax.ws.rs.core.Response
エラーコード:
code reason 404 渡された ID のリソースが存在しない場合 GET /resource/{id}/alerts
description
渡されたリソースのアラートへのリンクの一覧を取得します。gzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path 問い合わせるリソースの ID true int all return type: List<Link>
エラーコード:
code reason 404 渡された ID のリソースが存在しない場合 POST /resource/platform/{name}
description
サーバーに新しいプラットフォームを作成します。プラットフォームがすでに存在する場合、これは no-op です。プラットフォームは内部的に特別な名前を持ち、通常の RHQ エージェントを介して生成されたものと競合しないようにします。非推奨となった POST /platformsパラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 Name path プラットフォームの名前 true string all -body- プラットフォームのタイプ true StringValue Linux,Windows,...TODO return type: javax.ws.rs.core.Response
/resource/platforms
description
サーバーに新しいプラットフォームを作成します。プラットフォームがすでに存在する場合、これは no-op です。プラットフォームは内部的に特別な名前を持ち、通常の RHQ エージェントを介して生成されたものと競合しないようにします。渡されたオブジェクトに resourceName と typeName のみを指定する必要があります。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 -body- プラットフォームに関する情報。タイプ名とリソース名のみを指定する必要があります。 true ResourceWithType all return type: javax.ws.rs.core.Response
POST /resource/{name}
description
特定の親の下に指定されたタイプを持つリソースを作成します。代わりに POST / を非推奨にパラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 Name path 新規リソースの名前 true string all -body- リソースタイプの名前 true StringValue all plugin クエリー タイプを提供するプラグインの名前 false string all parentId クエリー これを添付する将来の親の ID false int all return type: javax.ws.rs.core.Response
POST /resource
description
既存のリソースの子として新しいリソースを作成します。注記
ハンドルを指定すると、コンテンツベースのリソースが作成されます。ハンドルによって識別されたコンテンツは、コンテンツストアから削除されません。ハンドルが指定されていない場合、渡された 'resource' オブジェクトのデータからリソースが作成されます。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 -body- リソースに関する情報。リソース名、リソースタイプ名、プラグイン名、親の ID を指定する必要があります。 true CreateCBResourceRequest all handle クエリー 以前サーバーにアップロードされたコンテンツを特定するハンドル。 false string all return type: javax.ws.rs.core.Response
エラーコード:
code reason 302 作成中です。場所の GET で再度確認します。 GET /resource/creationStatus/{id}
description
コンテンツベースのリソースのリソース作成のステータスを取得します。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path NONE int -all- -none- return type: javax.ws.rs.core.Response
エラーコード:
code reason 302 作成中です。後で同じ URL で再度確認してください。 DELETE /resource/{id}
description
インベントリーからリソースの削除注記
この操作はデフォルトでべきべき等で、204.リソースが全く存在するかどうかを確認する場合は、「validate」クエリーパラメーターを渡す必要があります。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path NONE int -all- -none- physical クエリー NONE false ブール値 all false Validate クエリー リソースが存在することを確認します。 false ブール値 all false return type: javax.ws.rs.core.Response
エラーコード:
code reason 204 検証が設定されていないリソースが削除されるか、または存在しない。 404 リソースが存在せず、検証が設定されている
1.12. http://localhost:7080/rest/resource/type : リソースタイプに関連する
このエンドポイントはリソースタイプを処理します。
Defining class: org.rhq.enterprise.server.rest.ResourceTypeHandlerBean
プロデューサー: application/json、application/xml
メソッド
GET /resource/type/{id}
description
渡された ID でリソースタイプに関する情報を返します。パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path NONE int -all- -none- return type: ResourceTypeRest
エラーコード:
code reason 404 渡された ID のタイプはありません。 GET /resource/type
description
リソースタイプの検索gzip ed Content-Encoding の返信をサポートします。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 q クエリー 制限結果をリソースタイプ名の param に限定します。 false string all plugin クエリー 渡された名前を持つプラグインに結果を制限します。 false string all ps クエリー ページングのページサイズ false int all 20 page クエリー ページングのページ 0 ベース false 整数 all return type: ResourceTypeRest(multi)
1.13. http://localhost:7080/rest/status : システムのステータス情報を提供します。
Defining class: org.rhq.enterprise.server.rest.StatusHandlerBean
生成される - application/json、application/xml、text/html
メソッド
GET /status
description
サーバーの現在設定されている状態と、一部のランタイム情報を取得します。Caller はこのエンドポイントにアクセスするために MANAGE_SETTINGS が必要です。gzip ed Content-Encoding の返信をサポートします。
このメソッドにはパラメーターはありません。
return type: Map 'values' with map of key-value pairs that status
GET /status/server
description
このサーバーの操作モードを取得します。このメソッドにはパラメーターはありません。
戻りタイプ : StringValue
1.14. http://localhost:7080/rest/user : ユーザー関連企業に対応する Api
Defining class: org.rhq.enterprise.server.rest.UserHandlerBean
生成される - application/json、application/xml、text/plain、text/html
メソッド
GET /user/favorites/resource
description
呼び出し元のお気に入りリソースの一覧を返します。gzip ed Content-Encoding の返信をサポートします。
このメソッドにはパラメーターはありません。
return type: ResourceWithType(multi)
GET /user/favorites/group
description
呼び出し元のお気に入りグループの一覧を返します。gzip ed Content-Encoding の返信をサポートします。
このメソッドにはパラメーターはありません。
戻りタイプ: GroupRest(multi)
PUT /user/favorites/resource/{id}
description
呼び出し元にリソースのお気に入りを追加するパラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path リソースの ID true int all 戻りタイプ: void
PUT /user/favorites/group/{id}
description
呼び出し元にグループをお気に入りに追加するパラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path グループの ID true int all 戻りタイプ: void
/user/favorites/resource/{id} の削除
description
お気に入りからリソースを削除する注記
この操作はデフォルトでべき等で、204. リソースがお気に入りであるかどうかを確認する場合は、「validate」クエリーパラメーターを渡す必要があります。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path リソースの ID true int all Validate クエリー リソースがお気に入りであるかどうかの検証 false ブール値 all false 戻りタイプ: void
エラーコード:
code reason 204 リソースが削除されるか、検証が設定されていないのにお気に入りがありませんでした。 404 リソースがお気に入りではなく、検証が設定されませんでした。 /user/favorites/group/{id} の削除
description
お気に入りからグループの削除注記
この操作はデフォルトでべき等で、204.グループがお気に入りであるかどうかを確認する場合は、「validate」クエリーパラメーターを渡す必要があります。
パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path グループの ID true int all Validate クエリー グループがお気に入りであるかどうかの検証 false ブール値 all false 戻りタイプ: void
エラーコード:
code reason 204 グループが削除されるか、検証が設定されていないとお気に入りがありませんでした。 404 グループがお気に入りではなく、検証が設定されませんでした。 GET /user/{id}
description
ユーザーに関する情報の取得パラメーター:
Name P.Type description 必須 type 許可される値 デフォルト値 id path ユーザーのログイン true string all 戻りタイプ: UserRest
第2章 REST API データのクラス
2.1. Data-Class: AlertConditionRest
アラート定義の条件
| Name | type | description |
|---|---|---|
| Name | string | この定義で使用するコンパレーター。詳細は、POST /alert/definition/{id}/condition を参照してください。 |
| category | string | カテゴリー。詳細は、POST /alert/definition/{id}/condition を参照してください。 |
| id | int | 条件の ID。これは安定していないことに注意してください。条件を更新すると、id が変更されます。 |
| しきい値 | double | 比較するしきい値。詳細は、POST /alert/definition/{id}/condition を参照してください。 |
| オプション | string | この条件のオプション。使用されているカテゴリーによって異なります。詳細は、POST /alert/definition/{id}/condition を参照してください。 |
| triggerId | 整数 | |
| Comparator | string | 条件のコンパレーター。詳細は、POST /alert/definition/{id}/condition を参照してください。 |
| measurementDefinition | int | 測定 *definition* の ID。このコンパレーターはに適用されます。メトリクススケジュールは、リソース ID と定義 ID で識別できます。 |
2.2. Data-Class: AlertDefinitionRest
AlertDefinition の表示
| Name | type | description |
|---|---|---|
| id | int | 定義の ID |
| Name | string | 定義の名前 |
| enabled | ブール値 | 定義は有効(=active)か? |
| priority | string | 定義の優先度 |
| recoveryId | int | リカバリーするアラート定義の ID |
| conditionMode | string | 条件ロジックに使用する式 |
| conditions | List<AlertConditionRest> | 条件の一覧。明示的に要求した場合にのみ送信されます。 |
| 通知 | List<AlertNotificationRest> | 通知の一覧。明示的に要求した場合にのみ送信されます。 |
| dampeningCategory | string | 分離のカテゴリー。1 回目は「disable definition after firing」を意味します。 |
| dampeningCount | int | アラート(指定期間内)の発生数。有効な値は > -1 です。 |
| dampeningPeriod | int | イベントをチェックする期間。PARTIAL_COUNT、DURATION_COUNT、INVERSE_COUNT にのみ該当します。 |
| dampeningUnit | string | 破損期間の単位。 |
| links | List<Link> |
2.3. Data-Class: AlertNotificationRest
アラート通知の定義を表します。
| Name | type | description |
|---|---|---|
| id | int | 定義の ID。これは、通知が更新されると変更されます。 |
| senderName | string | プラグイン記述子の <short-name> フィールドから取得した名前 |
| config | map<String,Object> | 定義に渡す必要がある設定。 |
| extraConfig | map<String,Object> |
2.4. Data-Class: AlertRest
このクラスは単一の発行されたアラートを表します。
| Name | type | description |
|---|---|---|
| id | int | アラートの ID |
| Name | string | AlertDefinition から取得されるアラートの名前 |
| alertDefinition | AlertDefinitionRest | アラートが発生した AlertDefinition |
| definitionEnabled | ブール値 | 定義は有効(=active)か? |
| ackBy | string | アラートを承認したユーザー(存在する場合) |
| ackTime | long | 確認応答のタイムスタンプ |
| alertTime | long | アラートが発生した時点のタイムスタンプ |
| description | string | アラートの説明 |
| resource | ResourceWithType | アラートが発生したリソース |
| links | List<Link> |
2.5. Data-Class: AlertSender
| Name | type | description |
|---|---|---|
| senderName | string | アラート送信者の名前 - これは固有の識別子でもあります。 |
| description | string | この送信者の説明 |
| リンク | リンク | |
| configDefinition | map<String,String> | 送信元の設定定義 |
2.6. Data-Class: AvailabilityRest
リソースの可用性を表します。
| Name | type | description |
|---|---|---|
| since | long | type が有効な経過時間 |
| type | string | 可用性の種別 |
| resourceId | int | 可用性を報告するリソースの ID |
| until | long | タイプが有効になるまでの時間。タイプが継続している場合は null である可能性があります。 |
2.7. Data-Class: AvailabilitySummary
リソースの可用性の要約を説明します。
| Name | type | description |
|---|---|---|
| 現在の | org.rhq.core.domain.measurement.AvailabilityType | |
| disabled | int | |
| disabledTime | long | |
| downTime | long | |
| 失敗 | int | |
| lastChange | long | |
| links | List<Link> | |
| currentTime | long | |
| resourceId | int | |
| unknownTime | long | |
| upTime | long | |
| disabledPercentage | double | |
| downPercentage | double | |
| knownTime | long | |
| mtbf | long | |
| mttr | long | |
| upPercentage | double |
2.8. データクラス: ベースライン
メトリックのベースライン/帯域幅の表示
| Name | type | description |
|---|---|---|
| min | double | ベース帯域幅の低い値 |
| max | double | ベース帯域幅の最大値 |
| 平均 | double | 基準値(メトリクスの平均など) |
| computeTime | long | この値が計算された時間 |
2.9. Data-Class: CallTimeValueRest
メトリクスの 1 回 callTime データポイント(スケジュール)
| Name | type | description |
|---|---|---|
| beginTime | long | 要求が発生した時点のエポックからの経過時間(ミリ秒単位) |
| callDestination | string | 要求の宛先 URI |
| duration | long | 時間(ミリ秒単位)- 要求の期間 |
2.10. Data-Class: CreateCBResourceRequest
コンテンツベースのリソースを作成する要求。そのためには、デプロイするコンテンツがすでにサーバーにアップロードされている必要があります。
| Name | type | description |
|---|---|---|
| pluginConfig | map<String,Object> | 接続プロパティーの設定 |
| resourceConfig | map<String,Object> | 作成するリソースの設定 |
2.11. Data-Class: DoubleValue
単純な二重値をカプセル化します。XML では、これは <value value="..."/> で表されます。
| Name | type | description |
|---|---|---|
| 値 | double | 実際の値 |
2.12. Data-Class: EventDefinitionRest
イベント定義
Description: You can retrieve an EventDefinition and with its name create new EventSources for its resource(EventDefinition を取得し、その名前でそのリソースの新規 EventSource を作成できる)
| Name | type | description |
|---|---|---|
| id | int | |
| Name | string | EventSource の作成に使用される定義の名前 |
| displayName | string | |
| description | string |
2.13. Data-Class: EventRest
このクラスは 1 つのイベントを表します。
| Name | type | description |
|---|---|---|
| id | int | rhq-Internal Id of the event |
| 詳細 | string | 送信されるメッセージ |
| sourceId | int | 取得元のソースの ID。新規イベントを追加する場合、このパラメーターは無視されます。 |
| timestamp | long | イベント発生時のエポックからの時間(ミリ秒単位) |
| 重大度 | string | イベントの重大度。使用できる値は DEBUG、INFO、WARN、ERROR、FATAL です。 |
2.14. Data-Class: EventSourceRest
このクラスは、ログファイルなどの EventSource を表します。
| Name | type | description |
|---|---|---|
| id | int | EventSource の ID |
| Name | string | 定義で定義される EventSource の名前。これは、新しい EventSource を追加する場合に必要です。 |
| displayName | string | 定義で定義される EventSource の表示名 |
| location | string | EventSource の 'location'。これは、監視されるログファイルへのパスなどです。これは、新しい EventSource を追加する場合に必要です。 |
| resourceId | int | このリソースの ID |
| description | string | この EventSource の説明 |
2.15. Data-Class: GroupDefinitionRest
1 つの DynaGroup 定義
| Name | type | description |
|---|---|---|
| id | int | 定義の ID |
| Name | string | 定義の名前 |
| description | string | 定義の説明 |
| expression | List<String> | グループ式の個別の行 |
| recalcInterval | long | 式を再評価する間隔(ミリ秒単位)。値が 0 の場合は再計算されないことを意味します。 |
| generatedGroupIds | List<Integer> | このグループ式で生成されるグループの id の一覧 |
| 再帰的 | ブール値 | この定義は再帰グループを生成するか? |
| links | List<Link> |
2.16. データクラス: GroupRest
リソースグループの表示
| Name | type | description |
|---|---|---|
| id | int | グループの ID |
| Name | string | グループの名前 |
| resourceTypeId | 整数 | 互換性のあるグループの ResourceType id |
| 再帰的 | ブール値 | グループが再帰的である場合(例: 子リソースを含む) |
| category | org.rhq.core.domain.resource.group.GroupCategory | グループのカテゴリー。 |
| links | List<Link> | |
| dynaGroupDefinitionId | int | グループが DynaGroup によって定義されている場合の DynaGroup 定義の ID。 |
| explicitCount | int | グループの明示的に追加されたリソースの数 |
| implicitCount | int | グループ内のリソース数(再帰グループの展開 + 子) |
2.17. Data-Class: IntegerValue
単純な整数値をカプセル化します。XML では、これは <value value="..."/> で表されます。
| Name | type | description |
|---|---|---|
| 値 | 整数 | 実際の値 |
2.18. データクラス: リンク
2 つのリソース間のリンク
| Name | type | description |
|---|---|---|
| Rel | string | 関係の名前 |
| href | string | 関係のターゲット |
2.19. データクラス: MetricAggregate
指定のスケジュールのメトリクスデータの集計
| Name | type | description |
|---|---|---|
| dataPoints | List<MetricAggregate.DataPoint> | 個別のデータポイントの一覧 |
| min | double | データの最小値 |
| avg | double | データの平均値 |
| max | double | データの最大値 |
| numDataPoints | int | データポイント数(例: dataPoints リストのサイズ) |
| scheduleId | 整数 | メトリックの ID |
| minTimeStamp | long | リスト内の最も初期のデータポイントのタイムスタンプ |
| maxTimeStamp | long | リスト内の最新のデータポイントのタイムスタンプ |
| group | ブール値 | これがグループのデータであるかどうかを判断します。 |
2.20. Data-Class: MetricDefinitionAggregate
所定のメトリクス定義のメトリクスデータの集計(グループ)
| Name | type | description |
|---|---|---|
| min | double | データの最小値 |
| avg | double | データの平均値 |
| max | double | データの最大値 |
| definitionId | 整数 | メトリクスの ID *definition* |
| minTimeStamp | long | リスト内の最も初期のデータポイントのタイムスタンプ |
| maxTimeStamp | long | リスト内の最新のデータポイントのタイムスタンプ |
2.21. データクラス: MetricSchedule
単一のメトリクススケジュール
説明: スケジュールは、メトリクスのコレクション間隔と、コレクションが有効であるかどうかを表します。
| Name | type | description |
|---|---|---|
| scheduleId | int | スケジュールの ID |
| scheduleName | string | メトリックの名前 |
| enabled | ブール値 | コレクションが有効になっているか? |
| collectionInterval | long | コレクションの間隔(ミリ秒単位) |
| displayName | string | UI に示されているメトリックの名前 |
| unit | string | メトリックのベースユニット |
| type | string | メトリクスのタイプ |
| definitionId | int | |
| mtime | long | スケジュールの最終変更タイムスタンプ |
| links | List<Link> |
2.22. Data-Class: NumericDataPoint
メトリックの 1 つの数値データポイント(スケジュール)
| Name | type | description |
|---|---|---|
| timeStamp | long | メトリックの取得時のタイムスタンプ |
| 値 | double | 数値 |
| scheduleId | int | メトリックの ID |
2.23. Data-Class: OperationDefinitionRest
操作の作成元のテンプレート
| Name | type | description |
|---|---|---|
| Name | string | 定義の名前 |
| id | int | 定義の ID |
| links | List<Link> | |
| params | List<SimplePropDef> | この操作定義のプロパティーのリスト |
2.24. Data-Class: OperationHistoryRest
実行がスケジュールされている操作の結果を示します。
| Name | type | description |
|---|---|---|
| status | string | 履歴のステータス |
| 結果 | map<String,Object> | 操作結果のキー/値のペアを含むマップ |
| errorMessage | string | 操作に成功しなかった場合はエラーメッセージ |
| links | List<Link> | |
| operationName | string | 実行された操作の名前 |
| resourceName | string | 操作が実行されたリソースの名前 |
| lastModified | long | |
| jobId | string | この履歴項目の Job-ID |
2.25. Data-Class: OperationRest
スケジュールする操作を表します。
説明: このオブジェクトを使用して、スケジュールする操作を準備します。オブジェクトは OperationDefinition から派生します。準備ができたら、「readyToSubmit」を true に設定する必要があります。
| Name | type | description |
|---|---|---|
| id | int | 操作スケジュールの ID |
| Name | string | 操作の名前 |
| readyToSubmit | ブール値 | このスケジュールは、最終的に送信される準備ができています(実行をスケジュールされます)。 |
| resourceId | int | 操作が実行されるリソースの ID |
| definitionId | int | このスケジュールが作成された操作定義の ID |
| params | map<String,Object> | パラメーターのキー/値マップ。キーは文字列です。マップは、スケジュールが定義から作成される時点で設定されます。 |
| links | List<Link> |
2.26. データクラス: PluginRest
RHQ にインストールされているエージェントプラグインを表します。
| Name | type | description |
|---|---|---|
| id | int | |
| Name | string | |
| displayName | string | |
| version | string | |
| enabled | ブール値 | |
| status | org.rhq.core.domain.plugin.PluginStatusType | |
| links | List<Link> |
2.27. Data-Class: ResourceTypeRest
リソースタイプ
| Name | type | description |
|---|---|---|
| createPolicy | org.rhq.core.domain.resource.CreateDeletePolicy | |
| dataType | org.rhq.core.domain.resource.ResourceCreationDataType | |
| id | int | |
| links | List<Link> | |
| Name | string | |
| pluginName | string |
2.28. Data-Class: ResourceWithChildren
直接子リソースを持つ 1 つのリソース
| Name | type | description |
|---|---|---|
| id | string | リソースの ID |
| Name | string | リソースの名前 |
| 子 | List<ResourceWithChildren> | 子リソースの一覧 |
2.29. Data-Class: ResourceWithType
1 つのリソース
| Name | type | description |
|---|---|---|
| resourceName | string | リソースの名前 |
| resourceId | int | リソースの ID |
| typeName | string | リソースのリソースタイプの名前 |
| typeId | 整数 | リソースのリソースタイプの ID |
| pluginName | string | リソースタイプを定義するプラグインの名前 |
| parentId | 整数 | 親リソースの ID。親がない場合に null にすることができます(カテゴリーはプラットフォーム)。 |
| status | string | リソースのインベントリーステータス。 |
| links | List<Link> | |
| ancestry | string | ancestry はルートリソースへのパスを提供します。 |
| 可用性 | string | 取得時にリソースの可用性。リソースをキャッシュすると、この値は古くなる可能性があることに注意してください。 |
| location | string | リソースの場所(データセンター/ラックなど) |
| description | string | リソースの説明 |
2.30. Data-Class: SimplePropDef
単純なプロパティー定義
Description: this Bean is e.g for operations for operations(操作のパラメーターに使用されるこの Bean は例)
| Name | type | description |
|---|---|---|
| Name | string | プロパティーの名前 |
| 必須 | ブール値 | プロパティーに値が設定される必要があるかどうかを示します。 |
| type | org.rhq.core.domain.configuration.definition.PropertySimpleType | プロパティーのタイプ |
| defaultValue | string | 定義された場合のデフォルト値の文字列表現。 |
2.31. Data-Class: Status
システムステータスにホルダーを配置する
| Name | type | description |
|---|---|---|
| 値 | map<String,String> | キーと値のペアのステータスが含まれる |
2.32. Data-Class: StringValue
単純な文字列値をカプセル化します。XML では、これは <value value="..."/> で表されます。
| Name | type | description |
|---|---|---|
| 値 | string | 実際の値 |
2.33. Data-Class: UserRest
RHQ のユーザーに関する情報
| Name | type | description |
|---|---|---|
| id | int | ユーザーの ID |
| login | string | ユーザーのログイン名 |
| Tele | string | ユーザーの電話番号 |
| string | ユーザーのメールアドレス | |
| firstName | string | ユーザーの名前 |
| lastName | string | ユーザーの姓 |