1.11. http://localhost:7080/rest/resource : リソースに関連する

メソッド

• 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	リソースが存在せず、検証が設定されている