Subscription Asset Manager の REST API

Red Hat Subscription Management 1

利用可能な REST メソッド

April 30, 2014

概要

本ガイドでは、REST API のリファレンスを提供します。

1. Subscription Asset Manager REST API

1.1. 情報

1.1.1. インデックス

GET /api/about

システムおよびそのサブコンポーネントのステータスを表示します。

このサービスは認証ユーザーのみが使用できます。

1.2. アクティベーションキー

1.2.1. インデックス

GET /api/activation_keys

アクティベーションキーを一覧表示します。

GET /api/organizations/:organization_id/activation_keys

アクティベーションキーを一覧表示します。

表1 パラメーター

パラメーター任意または必須値
name任意
アクティベーションキー名で一覧表示します。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。

1.2.2. 表示

GET /api/activation_keys/:id

アクティベーションキーを表示します。

表2 パラメーター

パラメーター任意または必須値
name任意
アクティベーションキー名で一覧表示します。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。

1.2.3. 作成

POST /api/activation_keys

アクティベーションキーを作成します。

表3 パラメーター

パラメーター任意または必須値
activation_key必須ハッシュ。
activation_key[name]必須
アクティベーションキー ID (英数字、空白、「_」、および「-」)。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
activation_key[description]任意。空にすることもできます。文字列。
activation_key[content_view_id]必須
コンテンツビュー ID。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。

1.2.4. 更新

PUT /api/activation_keys/:id

アクティベーションキーを更新します。

例1 コード例

PUT /api/activation_keys/2/
{
  "activation_key": {
    "environment_id": 9
  }
}
200
{
  "description": null,
  "environment_id": 9,
  "organization_id": 4,
  "system_template_id": null,
  "id": 2,
  "updated_at": "2012-08-10T13:54:45Z",
  "user_id": 1,
  "usage_count": 0,
  "name": "ak1_227e003",
  "created_at": "2012-08-10T13:54:45Z",
  "usage_limit": -1,
  "pools": []
}

表4 パラメーター

パラメーター任意または必須値
activation_key必須ハッシュ。
activation_key[name]任意
アクティベーションキー ID (英数字、空白、「_」、および「-」)。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
activation_key[description]任意。空にすることもできます。文字列。
activation_key[content_view_id]任意
コンテンツビュー ID。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
activation_key[environment_id]任意。空にすることもできます。2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。

1.2.5. 破棄

DELETE /api/activation_keys/:id

アクティベーションキーを破棄します。

1.2.6. プールの追加

POST /api/activation_keys/:id/pools

アクティベーションキーにエンタイトルメントプールを作成します。

例2 コード例

POST /api/activation_keys/2/pools
{
  "poolid": "ff8080813910c3d3013910d0e0390063"
}
200
{
  "description": null,
  "environment_id": 9,
  "organization_id": 4,
  "system_template_id": null,
  "id": 2,
  "updated_at": "2012-08-10T13:54:45Z",
  "user_id": 1,
  "usage_count": 0,
  "name": "ak1_227e003",
  "created_at": "2012-08-10T13:54:45Z",
  "usage_limit": -1,
  "pools": []
}

1.2.7. プールの削除

DELETE /api/activation_keys/:id/pools/:poolid

アクティベーションキーからエンタイトルメントプールを削除します。

1.2.8. システムグループの追加

POST /api/organizations/:organization_id/activation_keys/:id/system_groups

システムグループをキーに追加します。

1.2.9. システムグループの削除

DELETE /api/organizations/:organization_id/activation_keys/:id/system_groups

キーからシステムグループを削除します。

1.3. CRL

1.3.1. インデックス

GET /api/crls

X.509 CRL を直ちに再生成し、返します。

1.4. カスタム情報

1.4.1. 作成

POST /api/custom_info/:informable_type/:informable_id

カスタム情報を作成します。

表5 パラメーター

パラメーター任意または必須値
informable_type必須
リソースの名前。
文字列。
informable_id必須
リソース識別子。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
keyname必須文字列。
value必須文字列。

1.4.2. インデックス

GET /api/custom_info/:informable_type/:informable_id

カスタム情報の一覧を表示します。

表6 パラメーター

パラメーター任意または必須値
informable_type必須
リソースの名前。
文字列。
informable_id必須
リソース識別子。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。

1.4.3. 表示

GET /api/custom_info/:informable_type/:informable_id/:keyname

カスタム情報を表示します。

表7 パラメーター

パラメーター任意または必須値
informable_type必須
リソースの名前。
文字列。
informable_id必須
リソース識別子。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
keyname必須
カスタム情報キー。
文字列。

1.4.4. 更新

PUT /api/custom_info/:informable_type/:informable_id/:keyname

カスタム情報を更新します。

表8 パラメーター

パラメーター任意または必須値
informable_type必須
リソースの名前。
文字列。
informable_id必須
リソース識別子。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
keyname必須
カスタム情報キー。
文字列。
value必須文字列。

1.4.5. 破棄

DELETE /api/custom_info/:informable_type/:informable_id/:keyname

カスタム情報を削除します。

表9 パラメーター

パラメーター任意または必須値
informable_type必須
リソースの名前。
文字列。
informable_id必須
リソース識別子。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
keyname必須
カスタム情報キー。
文字列。

1.5. 組織のデフォルト情報

1.5.1. 作成

POST /api/organizations/:organization_id/default_info/:informable_type

デフォルト情報を作成します。

表10 パラメーター

パラメーター任意または必須値
informable_type必須
リソースの名前。
文字列。
informable_id必須
リソース識別子。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
keyname必須文字列。

1.5.2. 破棄

DELETE /api/organizations/:organization_id/default_info/:informable_type/:informable_id/:keyname

デフォルト情報を削除します。

表11 パラメーター

パラメーター任意または必須値
informable_type必須
リソースの名前。
文字列。
informable_id必須
リソース識別子。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
keyname必須
カスタム情報キー。
文字列。

1.5.3. すべてに適用

POST /api/organizations/:organization_id/default_info/:informable_type/apply

すべての情報リソースに既存のデフォルト情報を適用します。

表12 パラメーター

パラメーター任意または必須値
informable_type必須
リソースの名前。
文字列。
informable_id必須
リソース識別子。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
async任意
これを非同期に実行するかどうかを指定します。
ブール値。

1.6. 組織

1.6.1. インデックス

GET /api/organizations

組織の一覧を表示します。

表13 パラメーター

パラメーター任意または必須値
name任意
組織の名前。
文字列。
description任意文字列。
label任意
フィルタリングのラベル。
文字列。

1.6.2. 表示

GET /api/organizations/:label

組織を表示します。

1.6.3. 作成

POST /api/organizations

組織を作成します。

表14 パラメーター

パラメーター任意または必須値
name必須
組織の名前。
文字列。
description任意文字列。

1.6.4. 更新

PUT /api/organizations/:id

組織を更新します。

表15 パラメーター

パラメーター任意または必須値
organization任意ハッシュ。
organization[name]任意
組織の名前。
文字列。
organization[description]任意文字列。
organization[service_level]任意
デフォルトのサービスレベル (SLA)。
文字列。

1.6.5. リポジトリーの検出

POST /api/organizations/:id/repo_discover

リポジトリーを検出します。

表16 パラメーター

パラメーター任意または必須値
url任意
リポジトリー検出を実行するベース URL。
文字列。

1.6.6. 破棄

DELETE /api/organizations/:id

組織を破棄します。非同期操作です。

1.6.7. すべてのシステムを自動アタッチ

POST /api/organizations/:id/heal

利用可能なサブスクリプションを組織内のすべてのシステムに自動的に割り当てます。非同期操作です。

1.7. アクセス許可

1.7.1. インデックス

GET /api/roles/:role_id/permissions

ロールに対するパーミッションの一覧を表示します。

表17 パラメーター

パラメーター任意または必須値
name任意
名前でフィルターします。
文字列。
description任意
説明でフィルターします。
文字列。
all_verbs任意
all_verbs フラグでフィルターします。
ブール値。
all_tags任意
all_flags フラグでフィルターします。
ブール値。

1.7.2. 表示

GET /api/roles/:role_id/permissions/:id

パーミッションを表示します。

1.7.3. 作成

POST /api/roles/:role_id/permissions

ロールのパーミッションを作成します。

表18 パラメーター

パラメーター任意または必須値
description任意。空にすることもできます。文字列。
name必須文字列。
organization_id任意2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
tags任意
タグ ID の配列。
配列。
type必須
リソースの名前または「all」。
文字列。
verbs任意
パーミッションの動詞の配列。
配列。
all_tags任意
パーミッションがすべてのタグを使用する場合は True にします。
ブール値。
all_verbs任意
パーミッションがすべての動詞を使用する場合は True にします。
ブール値。

1.7.4. 破棄

DELETE /api/roles/:role_id/permissions/:id

ロールパーミッションを破棄します。

1.8. ネットワーク接続の確認

1.8.1. インデックス

GET /api/ping

システムとそのサブコンポーネントのステータスを表示します。

このサービスは認証ユーザーのみが使用できます。

1.8.2. サーバーのステータス

GET /api/system_status

バージョン情報を表示します。

このサービスは、未認証ユーザーも使用できます。

1.8.3. バージョン

GET /api/version

名前およびバージョン情報を表示します。

このサービスは認証ユーザーのみが使用できます。

1.9. ロールの LDAP グループ

1.9.1. 作成

POST /api/roles/:role_id/ldap_groups

ロールに関連付けられている LDAP グループの一覧にグループを追加します。

表19 パラメーター

パラメーター任意または必須値
name任意
LDAP グループの名前。
文字列。

1.9.2. 破棄

DELETE /api/roles/:role_id/ldap_groups/:id

ロールに関連付けられている LDAP グループの一覧からグループを削除します。

表20 パラメーター

パラメーター任意または必須値
role_id任意
ロール識別子。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
id任意
ldap グループ (名前)。
文字列。

1.9.3. インデックス

GET /api/roles/:role_id/ldap_groups

ロールに関連付けられた LDAP グループの一覧を表示します。

表21 パラメーター

パラメーター任意または必須値
role_id任意
ロール識別子。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。

1.10. ロール

1.10.1. インデックス

GET /api/roles

ロールの一覧を表示します。

表22 パラメーター

パラメーター任意または必須値
name任意文字列。

1.10.2. 表示

GET /api/roles/:id

ロールを表示します。

1.10.3. 作成

POST /api/roles

ロールを作成します。

表23 パラメーター

パラメーター任意または必須値
role必須ハッシュ。
role[name]必須文字列。
role[description]任意。空にすることもできます。文字列。

1.10.4. 破棄

DELETE /api/roles/:id

ロールを破棄します。

1.10.5. 利用可能な動詞

GET /api/roles/available_verbs

ロールに設定できる動詞の一覧を表示します。

表24 パラメーター

パラメーター任意または必須値
organization_id任意
このオプションを指定すると、一覧表示されたタグが組織に適用されます。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。

1.11. ステータス

1.11.1. メモリー

GET /api/status/memory

デバッグ目的で、メモリー内のオブジェクトの数を数えます。時間がかかる場合があります。

1.12. サブスクリプション

1.12.1. インデックス

GET /api/systems/:system_id/subscriptions

サブスクリプションの一覧を表示します。

システムのサブスクリプション管理。

表25 パラメーター

パラメーター任意または必須値
system_id必須
システムの UUID。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。

1.12.2. 組織のインデックス

GET /api/subscriptions

組織のサブスクリプションを一覧表示します。

1.12.3. 作成

POST /api/systems/:system_id/subscriptions

サブスクリプションを作成します。

システムのサブスクリプション管理。

表26 パラメーター

パラメーター任意または必須値
system_id必須
システムの UUID。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
pool必須
サブスクリプションプール UUID。
文字列。
quantity必須
使用するサブスクリプションの数。
数値。

1.12.4. 破棄

DELETE /api/systems/:system_id/subscriptions/:id

サブスクリプションを削除します。

システムのサブスクリプション管理。

表27 パラメーター

パラメーター任意または必須値
id任意
エンタイトルメント ID。
数値。
system_id必須
システムの UUID。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。

1.12.5. すべて破棄

DELETE /api/systems/:system_id/subscriptions

システムのサブスクリプションをすべて削除します。

システムのサブスクリプション管理。

表28 パラメーター

パラメーター任意または必須値
system_id必須
システムの UUID。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。

1.12.6. シリアル番号で破棄

DELETE /api/systems/:system_id/subscriptions/serials/:serial_id

シリアル ID でサブスクリプションを削除します。

システムのサブスクリプション管理。

表29 パラメーター

パラメーター任意または必須値
serial_id任意
サブスクリプションのシリアル ID。
文字列。
system_id必須
システムの UUID。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。

1.13. システムグループのエラータ。

システムグループレベルでエラータを処理する方法。

1.13.1. インデックス

GET /api/organizations/:organization_id/system_groups/:system_group_id/errata

グループに関連付けられているエラータの一覧を取得します。

表30 パラメーター

パラメーター任意または必須値
organization_id必須
組織の識別子。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
system_group_id必須
システムグループ識別子。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
type任意
タイプでエラータをフィルターします。
bugfix、enhancement、security のいずれかを指定します。

1.13.2. 作成

POST /api/organizations/:organization_id/system_groups/:system_group_id/errata

エラータをリモートでインストールします。

表31 パラメーター

パラメーター任意または必須値
organization_id必須
組織の識別子。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
system_group_id必須
システムグループ識別子。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
errata_ids必須
インストールするエラータ ID の一覧を表示します。
配列。

1.14. システムグループのパッケージ

システムグループレベルでパッケージを処理する方法。

1.14.1. 作成

POST /api/organizations/:organization_id/system_groups/:system_group_id/packages

パッケージをリモートからインストールします。

例3 コード例

POST /api/organizations/org_227e003/system_groups/1/packages
{
  "packages": [
    "cheetah"
  ]
}
202
{
  "task_type": "package_install",
  "id": 1,
  "pulp_id": "0384935e-4216-4d38-9832-6be39e379aba",
  "parameters": {
    "packages": [
      "cheetah"
    ]
  },
  "status_message": "Installing Package...",
  "created_at": "2012-08-10T13:48:24Z",
  "finish_time": null,
  "tasks": [
    {
      "uuid": "0e0f181c-e2f2-11e1-85ad-525400b68f90",
      "start_time": null,
      "result": {
        "errors": [
          null,
          null
        ]
      },
      "id": 15,
      "finish_time": null,
      "progress": null,
      "state": "waiting"
    }
  ],
  "state": "running"
}

表32 パラメーター

パラメーター任意または必須値
organization_id必須
組織の識別子。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
system_group_id必須
システムグループ識別子。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
packages任意
パッケージ名の一覧を表示します。
配列。
groups任意
パッケージグループ名の一覧を表示します。
配列。

1.14.2. 更新

PUT /api/organizations/:organization_id/system_groups/:system_group_id/packages

パッケージをリモートから更新します。

例4 コード例

PUT /api/organizations/org_227e003/system_groups/1/packages
{
  "packages": [
    "cheetah"
  ]
}
202
{
  "task_type": "package_update",
  "id": 2,
  "pulp_id": "efe07dec-a694-452e-9de1-a0cf4e429da1",
  "parameters": {
    "packages": [
      "cheetah"
    ]
  },
  "status_message": "Updating Package...",
  "created_at": "2012-08-10T13:48:48Z",
  "finish_time": null,
  "tasks": [
    {
      "uuid": "1cb315cf-e2f2-11e1-a5a0-525400b68f90",
      "start_time": null,
      "result": {
        "errors": [
          null,
          null
        ]
      },
      "id": 16,
      "finish_time": null,
      "progress": null,
      "state": "waiting"
    }
  ],
  "state": "running"
}

表33 パラメーター

パラメーター任意または必須値
organization_id必須
組織の識別子。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
system_group_id必須
システムグループ識別子。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
packages任意
パッケージ名の一覧を表示します。
配列。
groups任意
パッケージグループ名の一覧を表示します。
配列。

1.14.3. 破棄

DELETE /api/organizations/:organization_id/system_groups/:system_group_id/packages

パッケージをリモートからアンインストールします。

例5 コード例

DELETE /api/organizations/org_227e003/system_groups/1/packages
{
  "packages": [
    "cheetah"
  ]
}
202
{
  "task_type": "package_remove",
  "id": 3,
  "pulp_id": "c5846b6b-7415-4fb1-b7ca-1b6fec9d7520",
  "parameters": {
    "packages": [
      "cheetah"
    ]
  },
  "status_message": "Removing Package...",
  "created_at": "2012-08-10T13:48:51Z",
  "finish_time": null,
  "tasks": [
    {
      "uuid": "1e087d07-e2f2-11e1-ae5e-525400b68f90",
      "start_time": null,
      "result": {
        "errors": [
          null,
          null
        ]
      },
      "id": 17,
      "finish_time": null,
      "progress": null,
      "state": "waiting"
    }
  ],
  "state": "running"
}

表34 パラメーター

パラメーター任意または必須値
organization_id必須
組織の識別子。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
system_group_id必須
システムグループ識別子。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
packages任意
パッケージ名の一覧を表示します。
配列。
groups任意
パッケージグループ名の一覧を表示します。
配列。

1.15. システムグループ

1.15.1. インデックス

GET /api/organizations/:organization_id/system_groups

システムグループの一覧を表示します。

表35 パラメーター

パラメーター任意または必須値
organization_id必須
組織 ID
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
name任意
フィルターを指定するシステムグループ名。
文字列。

1.15.2. 表示

GET /api/organizations/:organization_id/system_groups/:id

システムグループを表示します。

表36 パラメーター

パラメーター任意または必須値
organization_id必須
組織 ID
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
id必須
システムグループの ID。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。

1.15.3. 更新

PUT /api/organizations/:organization_id/system_groups/:id

システムグループを更新します。

表37 パラメーター

パラメーター任意または必須値
organization_id必須
組織 ID
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
id必須
システムグループの ID。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
system_group必須ハッシュ。
system_group[name]任意
システムグループ名。
文字列。
system_group[description]任意。空にすることもできます。文字列。
system_group[max_systems]任意。空にすることもできます。
グループ内のシステムの最大数。
整数。

1.15.4. システム

GET /api/organizations/:organization_id/system_groups/:id/systems

グループ内のシステムの一覧表示します。

表38 パラメーター

パラメーター任意または必須値
organization_id必須
組織 ID
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
id必須
システムグループの ID。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。

1.15.5. システムの追加

POST /api/organizations/:organization_id/system_groups/:id/add_systems

グループにシステムを追加します。

表39 パラメーター

パラメーター任意または必須値
organization_id必須
組織 ID
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
id必須
システムグループの ID。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
system_group必須ハッシュ。
system_group[system_ids]任意
システム ID の配列。
配列。

1.15.6. システムの削除

POST /api/organizations/:organization_id/system_groups/:id/remove_systems

グループからシステムを削除します。

例6 コード例

POST /api/organizations/org_227e003/system_groups/1/remove_systems
{
  "system_group": {
    "system_ids": [
      "3050eb45-0ec4-43ea-8913-83635f06a2b7"
    ]
  }
}
200
[

]

表40 パラメーター

パラメーター任意または必須値
organization_id必須
組織 ID
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
id必須
システムグループの ID。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
system_group必須ハッシュ。
system_group[system_ids]任意
システム ID の配列。
配列。

1.15.7. 履歴

GET /api/organizations/:organization_id/system_groups/:id/history

システムグループで実行したジョブの履歴。

表41 パラメーター

パラメーター任意または必須値
organization_id必須
組織 ID
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
id必須
システムグループの ID。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。

1.15.8. 表示

GET /api/organizations/:organization_id/system_groups/:id/history

システムグループで実行したジョブの履歴。

例7 コード例

GET /api/organizations/org_227e003/system_groups/1/history/1
200
{
  "task_type": "package_install",
  "id": 1,
  "pulp_id": "0384935e-4216-4d38-9832-6be39e379aba",
  "parameters": {
    "packages": [
      "cheetah"
    ]
  },
  "status_message": "Installing Package...",
  "created_at": "2012-08-10T13:48:24Z",
  "finish_time": null,
  "tasks": [
    {
      "uuid": "0e0f181c-e2f2-11e1-85ad-525400b68f90",
      "start_time": "2012-08-10T13:48:24Z",
      "result": {
        "errors": [
          null,
          null
        ]
      },
      "id": 15,
      "finish_time": null,
      "progress": null,
      "state": "running"
    }
  ],
  "state": "running"
}

表42 パラメーター

パラメーター任意または必須値
organization_id必須
組織 ID
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
id必須
システムグループの ID。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
job_id任意
フィルタリングするジョブの ID。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。

1.15.9. 作成

POST /api/organizations/:organization_id/system_groups

システムグループを作成します。

表43 パラメーター

パラメーター任意または必須値
organization_id必須
組織 ID
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
system_group必須ハッシュ。
system_group[name]必須
システムグループ名。
文字列。
system_group[description]任意。空にすることもできます。文字列。
system_group[max_systems]任意。空にすることもできます。
グループ内のシステムの最大数。
整数。

1.15.10. コピー

POST /api/organizations/:organization_id/system_groups/:id/copy

システムグループのコピーを作成します。

表44 パラメーター

パラメーター任意または必須値
organization_id必須
組織 ID
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
id必須
システムグループの ID。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
system_group必須ハッシュ。
system_group[new_name]任意
システムグループ名。
文字列。
system_group[description]任意。空にすることもできます。文字列。
system_group[max_systems]任意。空にすることもできます。
グループ内のシステムの最大数。
整数。

1.15.11. 破棄

DELETE /api/organizations/:organization_id/system_groups/:id

システムグループを破棄します。

表45 パラメーター

パラメーター任意または必須値
organization_id必須
組織 ID
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
id必須
システムグループの ID。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。

1.15.12. システムの破棄

DELETE /api/organizations/:organization_id/system_groups/:id/destroy_systems

システムグループとそのシステムを破棄します。

表46 パラメーター

パラメーター任意または必須値
organization_id必須
組織 ID
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
id必須
システムグループの ID。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。

1.15.13. システムの更新

PUT /api/organizations/:organization_id/system_groups/:id/update_systems

システムグループ内のシステムを更新します。

表47 パラメーター

パラメーター任意または必須値
organization_id必須
組織 ID
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
id必須
システムグループの ID。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
system_group任意ハッシュ。
system_group[content_view_id]任意
システムを設定するコンテンツビューの ID。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
system_group[environment_id]任意
システムを設定する環境の ID。
2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。

1.16. システム

1.16.1. ハイパーバイザーのアップデート

POST /api/hypervisors

環境に対してハイパーバイザーの情報を更新します。 

{ "host-uuid": ["guest-uuid-1", "guest-uuid-2"] }
詳細は virt-who ツールを参照してください。

1.16.2. アクティベート (レガシー)

POST /api/consumers

アクティベーションキーを使用してシステムを登録します (互換性)。

1.16.3. activate

POST /api/organizations/:organization_id/systems

アクティベーションキーを使用してシステムを登録します。

表48 パラメーター

パラメーター任意または必須値
activation_keys必須文字列。
facts任意。空にすることもできます。
システム固有の情報について、キーと値のハッシュ。
ハッシュ。
installedProducts任意。空にすることもできます。
システムにインストールされている製品の一覧を表示します。
配列。
name必須
システムの名前。
文字列。
type必須
システムの種類。常に「system」にする必要があります。
文字列。
serviceLevel任意。空にすることもできます。
自動修復プロセスのサービスレベル。例: SELF-SUPPORT
文字列。
location任意
システムの物理的な場所。
文字列。
content_view_id任意2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
environment_id任意2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。

1.16.4. 識別証明書の再生成

POST /api/consumers/:id

コンシューマー ID を再生成します。

コンシューマーの識別証明書の再生成をスケジュールします。

表49 パラメーター

パラメーター任意または必須値
id任意
コンシューマーの UUID。
文字列。

1.16.5. 更新 (レガシー)

PUT /api/consumers/:id

システム情報を更新します (互換性)。

1.16.6. 更新

PUT /api/systems/:id

システム情報を更新します。

表50 パラメーター

パラメーター任意または必須値
facts任意。空にすることもできます。
システム固有の情報について、キーと値のハッシュ。
ハッシュ。
installedProducts任意。空にすることもできます。
システムにインストールされている製品の一覧を表示します。
配列。
name任意
システムの名前。
文字列。
type任意
システムの種類。常に「system」にする必要があります。
文字列。
serviceLevel任意。空にすることもできます。
自動修復プロセスのサービスレベル。例: SELF-SUPPORT
文字列。
location任意
システムの物理的な場所。
文字列。
content_view_id任意2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。
environment_id任意2 文字から 128 文字までの文字列。英数字、空白、「_」、「-」を使用できます。先頭または末尾に空白を使用することはできません。

1.16.7. チェックイン (レガシー)

PUT /api/consumers/:id/checkin

システムのチェックイン時間を更新します (互換性)。

1.16.8. チェックイン

PUT /api/systems/:id/checkin

システムのチェックイン時間を更新します。

表51 パラメーター

パラメーター任意または必須値
date任意
チェックインの時間。
文字列。

1.16.9. インデックス

GET /api/organizations/:organization_id/systems

組織のシステムを一覧表示します。

表52 パラメーター

パラメーター任意または必須値
name任意
システムを名前でフィルターします。
文字列。
pool_id任意
サブスクライブされたプールでシステムをフィルターします。
文字列。
search任意
高度な検索クエリーでシステムをフィルターします。
文字列。
uuid任意
UUID でシステムをフィルターします。
文字列。

1.16.10. 表示

GET /api/systems/:id

システムを表示します。

表53 パラメーター

パラメーター任意または必須値
id必須
システムの UUID。
文字列。

1.16.11. 破棄 (レガシー)

DELETE /api/consumers/:id

システムの登録を解除します (互換性)。

1.16.12. 破棄

DELETE /api/systems/:id

システムの登録を解除します。

表54 パラメーター

パラメーター任意または必須値
id必須
システムの UUID。
文字列。

1.16.13. サブスクリプションのステータス

GET /api/systems/:id/subscription_status

システムのサブスクリプションのステータスを表示します。

表55 パラメーター

パラメーター任意または必須値
id必須
システムの UUID。
文字列。

1.16.14. プール

GET /api/systems/:id/pools

システムがサブスクライブしているプールの一覧を表示します。

表56 パラメーター

パラメーター任意または必須値
id必須
システムの UUID。
文字列。

1.16.15. リリース

GET /api/systems/:id/releases

システムで利用できるリリースを表示します。

releaseVer パラメーターで正しい値を選択するためのヒント。

表57 パラメーター

パラメーター任意または必須値
id必須
システムの UUID。
文字列。

1.16.16. パッケージプロファイル

GET /api/systems/:id/packages

システムにインストールされているパッケージの一覧を表示します。

表58 パラメーター

パラメーター任意または必須値
id必須
システムの UUID。
文字列。

1.16.17. エラータ

GET /api/systems/:id/errata

システムに利用可能なエラータの一覧を表示します。

表59 パラメーター

パラメーター任意または必須値
id必須
システムの UUID。
文字列。

1.16.18. パッケージプロファイルのアップロード

PUT /api/consumers/:id/profile

インストールしたパッケージを更新します。

表60 パラメーター

パラメーター任意または必須値
id必須
システムの UUID。
文字列。

1.16.19. レポート

GET /api/organizations/:organization_id/systems/report

組織のシステムレポートを取得します。

1.16.20. タスク

GET /api/systems/:id/tasks

システムの非同期タスクの一覧を表示します。

1.16.21. 有効なリポジトリー

PUT /api/systems/:id/enabled_repos

有効なリポジトリーに関する情報を更新します。

有効なリポジトリーに関する情報を最新にするために、katello-agent によって使用されます。この情報は、システムに利用可能なエラータを計算するために使用されます。

例8 コード例

PUT /api/systems/82b34fd1-8758-493d-8fa6-5b2b1bf8559d/enabled_repos
{
  "enabled_repos": {
    "repos": [
      {
        "repositoryid": "zoo-enterprise"
      }
    ]
  }
}
200
{
  "processed_ids": [
    "org_manifest_227e003-env_manifest_227e003-Zoo_Enterprise-Zoo_Enterprise_x86_64_6_2"
  ],
  "result": "ok",
  "unknown_labels": [],
  "error_ids": []
}

表61 パラメーター

パラメーター任意または必須値
enabled_repos必須ハッシュ。
enabled_repos[repos]必須配列。

1.16.22. システムグループの追加

POST /api/systems/:id/system_groups

システムグループの既存のリストを入れ替えます。

表62 パラメーター

パラメーター任意または必須値
system必須ハッシュ。
system[system_group_ids]必須
システムが属するグループ ID を一覧表示します。
配列。

1.16.23. システムグループの削除

DELETE /api/systems/:id/system_groups

グループからシステムを削除します。

表63 パラメーター

パラメーター任意または必須値
system必須ハッシュ。
system[system_group_ids]必須
システムを追加するグループ ID の一覧を表示します。
配列。

1.16.24. サブスクリプションの更新

PUT /api/systems/:id/refresh_subscriptions

サブスクリプションの更新、自動割り当てをトリガーします (有効の場合)。

表64 パラメーター

パラメーター任意または必須値
id必須
システムの UUID。
文字列。

1.16.25. タスク

GET /api/systems/task/:task_id

システムタスクを 1 つ取得します。

表65 パラメーター

パラメーター任意または必須値
task_id必須
タスクの ID。
文字列。

1.17. uber 証明書

1.17.1. 表示

GET /api/organizations/:organization_id/uebercert

組織の uber 証明書を表示します。

表66 パラメーター

パラメーター任意または必須値
regenerate任意
「True」に設定すると、証明書が再発行されます。
ブール値。

1.18. ユーザー

1.18.1. インデックス

GET /api/users

ユーザーの一覧を表示します。

表67 パラメーター

パラメーター任意または必須値
email任意
メールアドレスでフィルターします。
文字列。
disabled任意
無効なフラグでフィルターします。
ブール値。
username任意
ユーザー名でフィルターします。
文字列。

1.18.2. 表示

GET /api/users/:id

ユーザーを表示します。

1.18.3. 作成

POST /api/users

ユーザーを作成します。

表68 パラメーター

パラメーター任意または必須値
username必須文字列。
email必須文字列。
password必須文字列。
default_environment_id任意。空にすることもできます。整数。
disabled任意。空にすることもできます。ブール値。

1.18.4. 更新

PUT /api/users/:id

ユーザーを更新します。

表69 パラメーター

パラメーター任意または必須値
email任意文字列。
password任意文字列。
default_environment_id任意。空にすることもできます。整数。
disabled任意。空にすることもできます。ブール値。

1.18.5. 破棄

DELETE /api/users/:id

ユーザーを破棄します。

1.18.6. ロールの一覧を表示

GET /api/users/:user_id/roles

ユーザーに関連付けられているロールの一覧を表示します。

1.18.7. LDAP ロールの同期

GET /api/users/sync_ldap_roles

LDAP グループを持つすべてのユーザーに対してロールを同期します。

1.18.8. ロールの追加

POST /api/users/:user_id/roles

ロールをユーザーに割り当てます。

表70 パラメーター

パラメーター任意または必須値
role_id任意整数。

1.18.9. ロールの削除

DELETE /api/users/:user_id/roles/:id

ユーザーのロールを削除します。

1.18.10. レポート

GET /api/users/report

「Accept」ヘッダーに基づいたフォーマットで、システムのユーザーをすべてレポートします。対応しているフォーマットは、プレーンテキスト、html、csv、pdf です。

A. 改訂履歴

改訂履歴
改訂 1.3-0.4Thu Jul 5 2018Terry Chuang
翻訳ファイルを XML ソースバージョン 1.3-0 と同期
改訂 1.3-0.3Wed Jul 4 2018Terry Chuang
翻訳ファイルを XML ソースバージョン 1.3-0 と同期
改訂 1.3-0.2Tue Jul 3 2018Terry Chuang
翻訳ファイルを XML ソースバージョン 1.3-0 と同期
改訂 1.3-0.1Tue Jul 3 2018Terry Chuang
翻訳ファイルを XML ソースバージョン 1.3-0 と同期
改訂 1.3-0April 30, 2014Ella Deon Ballard
初版