付録D Red Hat Update Infrastructure における API リファレンス

この呼び出しは、Pulp に新しいリポジトリーを作成し、インポーターとディストリビューターの設定用のオプションのパラメーターを受け入れます。これらのパラメーターの詳細な説明は、インポーターまたはディストリビューターを既存のリポジトリーに関連付ける API のドキュメントを参照してください。これらのパラメーターが渡されない場合、呼び出しはパルプにのみリポジトリーを作成します。リポジトリーの実際の機能は、インポーターとディストリビューターが追加されるまで定義されません。リポジトリー ID は、サーバーの全リポジトリーで一意でなければなりません。

方法: POST

パス: /pulp/api/v2/repositories/

パーティション: create

戻り値: 作成されたリポジトリーのデータベース表現

要求のサンプル:

{
 "display_name": "Harness Repository: harness_repo_1",
 "id": "harness_repo_1",
 "importer_type_id": "harness_importer",
 "importer_config": {
   "num_units": "5",
   "write_files": "true"
 },
 "distributors": [{
               "distributor_id": "dist_1",
               "distributor_type_id": "harness_distributor",
               "distributor_config": {
               "publish_dir": "/tmp/harness-publish",
               "write_files": "true"
               },
               "auto_publish": false
       }],
}

201 応答の本文のサンプル:

{
 "scratchpad": {},
 "display_name": "Harness Repository: harness_repo_1",
 "description": null,
 "_ns": "repos",
 "notes": {},
 "content_unit_counts": {},
 "_id": {
   "$oid": "52280416e5e71041ad000066"
 },
 "id": "harness_repo_1",
 "_href": "/pulp/api/v2/repositories/harness_repo_1/"
}

(関連するインポーター/ディストリビューターと比較して) リポジトリーの作成が単にリポジトリーメタデータに関連しているように、更新リポジトリーの呼び出しは、そのメタデータのみの更新に重点が置かれます。

方法: PUT

Path: /pulp/api/v2/repositories/<repo_id>/

パーティション: update

戻り値: (更新による変更後の) リポジトリーのデータベース表現と、リポジトリーのコンシューマーバインディングを適用するために生成されたタスクが含まれる Call Report。生成されるバインディングタスクの詳細は、コンシューマーをリポジトリーにバインド を参照してください。

要求のサンプル:

{
 "delta": {
  "display_name" : "Updated"
 },
 "importer_config": {
  "demo_key": "demo_value"
 },
 "distributor_configs": {
  "demo_distributor": {
    "demo_key": "demo_value"
  }
 }
}

結果値のサンプル: Call Report の結果フィールドに、リポジトリーのデータベース表現が含まれます。

{
...
"result": {
   "display_name": "zoo",
   "description": "foo",
   "_ns": "repos",
   "notes": {
     "_repo-type": "rpm-repo"
   },
   "content_unit_counts": {
     "package_group": 2,
     "package_category": 1,
     "rpm": 32,
     "erratum": 4
   },
   "_id": {
     "$oid": "5328b2983738202945a3bb47"
   },
   "id": "zoo",
   "_href": "/pulp/api/v2/repositories/zoo/"

 },
 ...
}

この呼び出しは、以前に作成されたパルプリポジトリーの インポーター を設定します。各リポジトリーは、インポーターの設定を維持します。これは、インポーターがコンテンツを同期する際にどのように動作するかを決定するために使用されます。可能な設定値は、追加するインポーターのタイプによって決まります。インポーターの各タイプは、その機能に関係する異なる値のセットをサポートします。

インポーターは、特定のタイミングでリポジトリーに関連付けられるだけです。リポジトリーにすでに関連付けられたインポーターがある場合、以前の関連付けは削除されます。この削除は、新しいインポーターが初期化される前に実行されるため、新しいインポーターの初期化に失敗した場合は、インポーターなしでリポジトリーが残される可能性があります。

インポーターを追加すると、追加を確認する前に以下の検証ステップが実行されます。

追加されたインポーターの詳細が呼び出しから返されます。

方法: POST

Path: /pulp/api/v2/repositories/<repo_id>/importers/

パーティション: create

戻り値: 関連タスクの現在の状態が含まれる Call Report。

要求のサンプル:

{
 "importer_type_id": "harness_importer",
 "importer_config": {
   "num_units": "5",
   "write_files": "true"
 }
}

Task Report の結果値のサンプル: Task Report の結果フィールドには、インポーターのデータベース表現 (完全なリポジトリーの詳細ではなく、インポーターのみ) が含まれます。

{
 "scratchpad": null,
 "_ns": "repo_importers",
 "importer_type_id": "harness_importer",
 "last_sync": null,
 "repo_id": "harness_repo_1",
 "_id": "bab0f9d5-dfd1-45ef-bd1d-fd7ea8077d75",
 "config": {
   "num_units": "5",
   "write_files": "true"
 },
 "id": "harness_importer"
}

タグ: 作成されたタスクには、pulp:action:update_importer、pulp:repository:<repo_id>、pulp:repository_importer:<importer_type_id> のタグが含まれます。

この呼び出しは、以前に作成されたパルプリポジトリーの ディストリビューター を設定します。各リポジトリーは、ディストリビューターの設定を維持します。これは、ディストリビューターがコンテンツを公開する際にどのように動作するかを決定するために使用されます。可能な設定値は、追加されるディストリビューターのタイプによって異なります。各ディストリビュータータイプは、その機能に関連するさまざまな値のセットをサポートします。

一度に複数のディストリビューターをリポジトリーに関連付けることができます。同じタイプのディストリビューターが複数存在する場合があります。唯一の制限は、ディストリビューション ID が特定のリポジトリーのすべてのディストリビューターで一意である必要があることです。

ディストリビューターを追加すると、追加を確認する前に以下の検証手順が実行されます。

追加されたディストリビューターの詳細が呼び出しから返されます。

方法: POST

Path: /pulp/api/v2/repositories/<repo_id>/distributors/

パーティション: create

戻り値: ディストリビューターのデータベース表現 (完全なリポジトリーの詳細ではなく、ディストリビューターのみ)。

要求のサンプル:

{
 "distributor_id": "dist_1",
 "distributor_type_id": "harness_distributor",
 "distributor_config": {
   "publish_dir": "/tmp/harness-publish",
   "write_files": "true"
 },
 "auto_publish": false
}

201 応答の本文のサンプル:

{
 "scratchpad": null,
 "_ns": "repo_distributors",
 "last_publish": null,
 "auto_publish": false,
 "distributor_type_id": "harness_distributor",
 "repo_id": "harness_repo_1",
 "publish_in_progress": false,
 "_id": "cfdd6ab9-6dbe-4192-bde2-d00db768f268",
 "config": {
   "publish_dir": "/tmp/harness-publish",
   "write_files": "true"
 },
 "id": "dist_1"
}

リポジトリーに関連付けられている インポーター の設定を更新します。

指定されていないインポーター設定値は変更されません。

インポーターの proxy_password フィールドと basic_auth_password フィールドは、入力されている場合は * として返されることに注意してください。これは、セキュリティーの目的で行われます。

方法: PUT

Path: /pulp/api/v2/repositories/<repo_id>/importers/<importer_id>/

パーティション: update

戻り値: Task Report にポーリングする必要がある生成されたタスクが含まれる Call Report。

要求のサンプル:

{
 "importer_config": {
   "demo_key": "demo_value"
 }
}

Task Report の結果値のサンプル: Task Report の結果フィールドには、インポーターのデータベース表現が含まれます。これには、完全なリポジトリー情報が含まれません。

[options="nowrap"]
{
  "scratchpad": null,
  "_ns": "repo_importers",
  "importer_type_id": "demo_importer",
  "last_sync": "2013-10-03T14:08:35Z",
  "scheduled_syncs": [],
  "repo_id": "demo_repo",
  "_id": {
    "$oid": "524db282dd01fb194283e53f"
  },
  "config": {
    "demo_key": "demo_value"
  },
  "id": "demo_importer"
}

タグ: 作成されたタスクには、pulp:action:update_importer、pulp:repository:<repo_id>、pulp:repository_importer:<importer_id> のタグが含まれます。

方法: DELETE

Path: /pulp/api/v2/repositories/<repo_id>/importers/<importer_id>/

パーティション: delete

戻り値: Call Report

タグ: 作成されたタスクには、pulp:action:delete_importer、pulp:repository:<repo_id>、pulp:repository_importer:<importer_id> のタグが含まれます。

リポジトリーに関連付けられているディストリビューターの設定を更新します。これにより、以下のアクションが実行されます。

指定されていないディストリビューターの設定値は変更されず、明示的に None に設定されている値は設定から削除されます。

最初のステップは、Call Report に示されます。ステップ 1 が完了すると、spawned_tasks フィールドに、ステップ 2 を完了するために必要なタスクへのリンクが表示されます。ディストリビューターを更新すると、そのリポジトリーに関連する各バインディングも更新されます。詳細は、コンシューマーのリポジトリーへのバインド を参照してください。

方法: PUT

Path: /pulp/api/v2/repositories/<repo_id>/distributors/<distributor_id>/

パーティション: update

戻り値: Call Report

要求のサンプル:

{
 "distributor_config": {
   "demo_key": "demo_value"
 },
 "delta": {
   "auto_publish": true
 }
}

タグ: ディストリビューターを更新するために作成されるタスクには、pulp:action:update_distributor、pulp:repository:<repo_id>、および pulp:repository_distributor:<distributor_id> のタグが含まれます。バインディングタスクに関する情報は、Bind a Consumer to a Repository を参照してください。

ディストリビューターの関連付けを解除すると、以下のアクションが実行します。

最初のステップは、Call Report に示されます。ステップ 1 が完了すると、spawned_tasks フィールドに、ステップ 2 を完了するために必要なタスクへのリンクが表示されます。生成されたタスクの合計数は、リポジトリーにバインドされるコンシューマーの数によって異なります。

方法: DELETE

Path: /pulp/api/v2/repositories/<repo_id>/distributors/<distributor_id>/

パーティション: delete

戻り値: Call Report

タグ: ディストリビューターを削除するために作成されるタスクには、pulp:action:remove_distributor、pulp:repository:<repo_id>、および pulp:repository_distributor:<distributor_id> のタグが含まれます。

リポジトリーが削除されると、データベースから削除され、ローカルの作業ディレクトリーが削除されます。リポジトリー内のコンテンツは削除されません。コンテンツの削除は、孤立したユニット プロセスで処理されます。

リポジトリーの削除は、主に以下の手順で行います。

最初のステップは、Call Report に示されます。ステップ 1 が完了すると、spawned_tasks フィールドに、ステップ 2 を完了するために必要なタスクへのリンクが表示されます。生成されたタスクの合計数は、リポジトリーにバインドされるコンシューマーの数によって異なります。

方法: DELETE

Path: /pulp/api/v2/repositories/<repo_id>/

パーティション: delete

戻り値: Call Report

タグ: リポジトリーを削除するために作成されるタスクには、pulp:action:delete、pulp:repository:<repo_id> のタグが含まれます。

この呼び出しは、単一のパルプリポジトリーに関する情報を取得します。返されるデータには、一般的なリポジトリーメタデータ、リポジトリーに関連付けられているインポーターとディストリビューターを記述するメタデータ、リポジトリーに対してローカルに保存されているコンテンツユニットの数が含まれます。

方法: GET

Path: /pulp/api/v2/repositories/<repo_id>/

パーティション: read

戻り値: 一致するリポジトリーのデータベース表現

200 応答の本文のサンプル:

{
 "display_name": "Harness Repository: harness_repo_1",
 "description": null,
 "distributors": [
   {
     "scratchpad": 1,
     "_ns": "repo_distributors",
     "last_publish": "2012-01-25T15:26:32Z",
     "auto_publish": false,
     "distributor_type_id": "harness_distributor",
     "repo_id": "harness_repo_1",
     "publish_in_progress": false,
     "_id": "addf9261-345e-4ce3-ad1e-436ba005287f",
     "config": {
       "publish_dir": "/tmp/harness-publish",
       "write_files": "true"
     },
     "id": "dist_1"
   }
 ],
 "notes": {},
 "scratchpad": {},
 "content_unit_counts": {},
 "last_unit_added": "2012-01-25T15:26:32Z",
 "last_unit_removed": "2012-01-25T15:26:32Z",
 "importers": [
   {
     "scratchpad": 1,
     "_ns": "repo_importers",
     "importer_type_id": "harness_importer",
     "last_sync": "2012-01-25T15:26:32Z",
     "repo_id": "harness_repo_1",
     "sync_in_progress": false,
     "_id": "bbe81308-ef7c-4c0c-b684-385fd627d99e",
     "config": {
       "num_units": "5",
       "write_files": "true"
     },
     "id": "harness_importer"
   }
 ],
 "id": "harness_repo_1",
 "total_repository_units": 5,
 "locally_stored_units": 3
}

この呼び出しは、パルプサーバー内のすべてのリポジトリーに関する情報を返します。この呼び出しが 404 を返すことは決してないことに注意してください。リポジトリーがない場合は、空の配列が返されます。

方法: GET

パス: /pulp/api/v2/repositories/

パーティション: read

戻り値: 単一リポジトリーの取得と同じ形式です。ただし、戻り値のベースは、それらの配列です。

200 応答の本文のサンプル:

[
 {
   "display_name": "Harness Repository: harness_repo_1",
   "description": null,
   "last_unit_added": "2012-01-25T15:26:32Z",
   "last_unit_removed": null,
   "distributors": [
     {
       "scratchpad": 1,
       "_ns": "repo_distributors",
       "last_publish": "2012-01-25T15:26:32Z",
       "auto_publish": false,
       "distributor_type_id": "harness_distributor",
       "repo_id": "harness_repo_1",
       "publish_in_progress": false,
       "_id": "addf9261-345e-4ce3-ad1e-436ba005287f",
       "config": {
         "publish_dir": "/tmp/harness-publish",
         "write_files": "true"
       },
       "id": "dist_1"
     }
   ],
   "notes": {},
   "scratchpad": {},
   "content_unit_counts": {},
   "importers": [
     {
       "scratchpad": 1,
       "_ns": "repo_importers",
       "importer_type_id": "harness_importer",
       "last_sync": "2012-01-25T15:26:32Z",
       "repo_id": "harness_repo_1",
       "sync_in_progress": false,
       "_id": "bbe81308-ef7c-4c0c-b684-385fd627d99e",
       "config": {
         "num_units": "5",
         "write_files": "true"
       },
       "id": "harness_importer"
     }
   ],
   "id": "harness_repo_1"
 }
]

これらの検索の実行方法は、検索 API を参照してください。

この呼び出しは、検索パラメーターに一致するパルプサーバー内のリポジトリーに関する情報を返します。この呼び出しが 404 を返すことは決してないことに注意してください。リポジトリーがない場合は、空の配列が返されます。

方法: POST

パス: /pulp/api/v2/repositories/search/

パーティション: read

戻り値: 単一リポジトリーの取得と同じ形式です。ただし、戻り値のベースは、それらの配列です。

200 応答の本文のサンプル:

[
 {
   "display_name": "Harness Repository: harness_repo_1",
   "description": null,
   "distributors": [
     {
       "scratchpad": 1,
       "_ns": "repo_distributors",
       "last_publish": "2012-01-25T15:26:32Z",
       "auto_publish": false,
       "distributor_type_id": "harness_distributor",
       "repo_id": "harness_repo_1",
       "publish_in_progress": false,
       "_id": "addf9261-345e-4ce3-ad1e-436ba005287f",
       "config": {
         "publish_dir": "/tmp/harness-publish",
         "write_files": "true"
       },
       "id": "dist_1"
     }
   ],
   "notes": {},
   "scratchpad": {},
   "content_unit_counts": {},
   "last_unit_added": null,
   "last_unit_removed": null,
   "importers": [
     {
       "scratchpad": 1,
       "_ns": "repo_importers",
       "importer_type_id": "harness_importer",
       "last_sync": "2012-01-25T15:26:32Z",
       "repo_id": "harness_repo_1",
       "sync_in_progress": false,
       "_id": "bbe81308-ef7c-4c0c-b684-385fd627d99e",
       "config": {
         "num_units": "5",
         "write_files": "true"
       },
       "id": "harness_importer"
     }
   ],
   "id": "harness_repo_1"
 }
]

この呼び出しは、検索パラメーターに一致するパルプサーバー内のリポジトリーに関する情報を返します。この呼び出しが 404 を返すことは決してないことに注意してください。リポジトリーがない場合は、空の配列が返されます。

一部のフィルター式はクエリーパラメーターとしてシリアル化できない場合があるため、この方法は POST の代替方法よりも制限があります。

方法: GET

パス: /pulp/api/v2/repositories/search/

パーティション: read

クエリーパラメーターは、Search Criteria で定義されている Criteria オブジェクトの属性と一致する必要があります。例外は fields パラメーターで、これは単数形で指定する必要があります。例: /v2/repository/search/?field = id&field = display_name&limit =20'。

戻り値: 単一リポジトリーの取得と同じ形式です。ただし、戻り値のベースは、それらの配列です。

200 応答の本文のサンプル:

[
 {
   "display_name": "Harness Repository: harness_repo_1",
   "description": null,
   "distributors": [
     {
       "scratchpad": 1,
       "_ns": "repo_distributors",
       "last_publish": "2012-01-25T15:26:32Z",
       "auto_publish": false,
       "distributor_type_id": "harness_distributor",
       "repo_id": "harness_repo_1",
       "publish_in_progress": false,
       "_id": "addf9261-345e-4ce3-ad1e-436ba005287f",
       "config": {
         "publish_dir": "/tmp/harness-publish",
         "write_files": "true"
       },
       "id": "dist_1"
     }
   ],
   "notes": {},
   "scratchpad": {},
   "content_unit_counts": {},
   "last_unit_added": null,
   "last_unit_removed": null,
   "importers": [
     {
       "scratchpad": 1,
       "_ns": "repo_importers",
       "importer_type_id": "harness_importer",
       "last_sync": "2012-01-25T15:26:32Z",
       "repo_id": "harness_repo_1",
       "sync_in_progress": false,
       "_id": "bbe81308-ef7c-4c0c-b684-385fd627d99e",
       "config": {
         "num_units": "5",
         "write_files": "true"
       },
       "id": "harness_importer"
     }
   ],
   "id": "harness_repo_1"
 }
]

この呼び出しは、リポジトリーに関連付けられている インポーター (存在する場合) を取得します。配列は空 (インポーターが設定されていない) になるか、単一のエントリーが含まれます。

方法: GET

Path: /pulp/api/v2/repositories/<repo_id>/importers/

パーティション: read

クエリーパラメーター: なし

戻り値: リポジトリーのインポーターまたは空の一覧のデータベース表現。

200 応答の本文のサンプル:

[
   {
       "_href": "/pulp/api/v2/repositories/zoo/importers/yum_importer/",
       "_id": {
           "$oid": "563c82fa45ef48043f026c32"
       },
       "_ns": "repo_importers",
       "config": {
           "feed": "http://example.com/repos/zoo/"
       },
       "id": "yum_importer",
       "importer_type_id": "yum_importer",
       "last_sync": "2015-11-06T10:38:23Z",
       "repo_id": "zoo",
       "scratchpad": {
           "repomd_revision": 1331832478
       }
   }
]

この呼び出しは、リポジトリーに関連付けられている特定の インポーター (存在する場合) を取得します。

方法: GET

Path: /pulp/api/v2/repositories/<repo_id>/importers/<importer_id>/

パーティション: read

クエリーパラメーター: なし

戻り値: リポジトリーのインポーターのデータベース表現

200 応答の本文のサンプル:

{
   "_href": "/pulp/api/v2/repositories/zoo/importers/yum_importer/",
   "_id": {
       "$oid": "563c82fa45ef48043f026c32"
   },
   "_ns": "repo_importers",
   "config": {
       "feed": "http://example.com/repos/zoo/"
   },
   "id": "yum_importer",
   "importer_type_id": "yum_importer",
   "last_sync": "2015-11-06T10:38:23Z",
   "repo_id": "zoo",
   "scratchpad": {
       "repomd_revision": 1331832478
   }
}

この呼び出しは、リポジトリーに関連付けられているすべての ディストリビューター を取得します。リポジトリーに関連するディストリビューターがない場合は、空の配列が返されます。

方法: GET

Path: /pulp/api/v2/repositories/<repo_id>/distributors/

パーティション: read

クエリーパラメーター: なし

戻り値: リポジトリー上のすべてのディストリビューターのデータベース表現

200 応答の本文のサンプル:

[
 {
   "scratchpad": 1,
   "_ns": "repo_distributors",
   "last_publish": "2012-01-25T15:26:32Z",
   "auto_publish": false,
   "distributor_type_id": "harness_distributor",
   "repo_id": "harness_repo_1",
   "publish_in_progress": false,
   "_id": "addf9261-345e-4ce3-ad1e-436ba005287f",
   "config": {
     "publish_dir": "/tmp/harness-publish",
     "write_files": "true"
   },
   "id": "dist_1"
 }
]

この呼び出しは、リポジトリーに関連付けられた単一の ディストリビューター を取得します。

方法: GET

Path: /pulp/api/v2/repositories/<repo_id>/distributors/<distributor_id>/

パーティション: read

クエリーパラメーター: なし

戻り値: ディストリビューターのデータベース表現

200 応答の本文のサンプル:

{
  "scratchpad": 1,
  "_ns": "repo_distributors",
  "last_publish": "2012-01-25T15:26:32Z",
  "auto_publish": false,
  "distributor_type_id": "harness_distributor",
  "repo_id": "harness_repo_1",
  "publish_in_progress": false,
  "_id": {"$oid": "addf9261-345e-4ce3-ad1e-436ba005287f"},
  "config": {
    "publish_dir": "/tmp/harness-publish",
    "write_files": "true"
  },
  "id": "dist_1"
}

これらの検索の実行方法は、検索 API を参照してください。

この呼び出しは、検索パラメーターに一致するパルプサーバーのディストリビューターに関する情報を返します。この呼び出しが 404 を返すことは決してないことに注意してください。ディストリビューターがない場合は、空の配列が返されます。

方法: POST

パス: /pulp/api/v2/distributors/search/

パーティション: read

要求ボディーの内容: なし

戻り値: ディストリビューターオブジェクトの一覧

200 応答の本文のサンプル:

[
  {
    "repo_id": "el7",
    "last_publish": "2015-04-28T18:19:01Z",
    "auto_publish": null,
    "scheduled_publishes": [],
    "distributor_type_id": "ostree_web_distributor",
    "scratchpad": null,
    "config": {
      "relative_path": "/opt/content/ostree/el7"
    },
    "id": "ostree_web_distributor_name_cli"
  },
  {
    "repo_id": "el6",
    "last_publish": "2015-5-28T18:18:01Z",
    "auto_publish": null,
    "scheduled_publishes": [],
    "distributor_type_id": "ostree_web_distributor",
    "scratchpad": null,
    "config": {
      "relative_path": "/opt/content/ostree/el6"
    },
    "id": "ostree_web_distributor_name_cli"
  }
]

この呼び出しは、リポジトリーの インポーター を使用して、フィードソースからリポジトリーにコンテンツを同期します。

方法: POST

Path: /pulp/api/v2/repositories/<repo_id>/actions/sync/

パーティション: execute

戻り値: Call Report

要求のサンプル:

{
  "override_config": {"verify_checksum": false,
                      "verify_size": false},
}

タグ: 作成されたタスクには、pulp:action:sync、pulp:repository:<repo_id> のタグが含まれます。

同期時に遅延したリポジトリーにコンテンツをダウンロードします。これは、download_policy=(background | on_demand) で設定されたインポーターを含むリポジトリーで役に立ちます。ダウンロード済みのコンテンツは再度ダウンロードされません。

方法: POST

パス: /pulp/api/v2/repositories/<repo_id>/actions/download/

パーティション: execute

戻り値: Call Report

要求のサンプル:

{
  "verify_all_units": false
}

タグ: 作成されたタスクには、pulp:action:download_repo、pulp:repository:<repo_id> のタグが含まれます。

リポジトリーは、iso8601 の間隔 を使用して自動的に同期できます。スケジュールされた同期を作成するには、間隔、同期オーバーライド設定、およびその他のスケジュールオプションをリポジトリーの インポーター に設定する必要があります。

方法: POST

Path: /pulp/api/v2/repositories/<repo_id>/importers/<importer_id>/schedules/sync/

パーティション: create

failure_threshold (数値) (任意) スケジュールが設定されたこの同期が無効になる前に連続して失敗が可能な回数

戻り値: スケジュールを設定した呼び出しの現在の状態を表すスケジュールレポート

要求のサンプル:

{
 "override_config": {},
 "schedule": "00:00:00Z/P1DT",
 "failure_threshold": 3,
}

201 応答の本文のサンプル:

{
 "next_run": "2014-01-27T21:41:50Z",
 "task": "pulp.server.tasks.repository.sync_with_auto_publish",
 "last_updated": 1390858910.292712,
 "first_run": "2014-01-27T21:41:50Z",
 "schedule": "PT1H",
 "args": [
   "demo"
 ],
 "enabled": true,
 "last_run_at": null,
 "_id": "52e6d29edd01fb70bd0d9c37",
 "total_run_count": 0,
 "failure_threshold": 3,
 "kwargs": {
   "overrides": {}
 },
 "resource": "pulp:importer:demo:puppet_importer",
 "remaining_runs": null,
 "consecutive_failures": 0,
 "_href": "/pulp/api/v2/repositories/demo/importers/puppet_importer/schedules/sync/52e6d29edd01fb70bd0d9c37/"
}

スケジュールされた同期の作成に使用されるパラメーターはいつでも更新できます。

方法: PUT

パス: /pulp/api/v2/repositories/<repo_id>/importers/<importer_id>/schedules/sync/<schedule_id>/

パーティション: create

failure_threshold (数値) (任意) スケジュールが設定されたこの同期が無効になる前に新たに連続して失敗が可能な回数

戻り値: スケジュールが設定された呼び出しの現在の状態を表すスケジュールレポート (詳細は、同期のスケジュール設定の応答例を参照してください)。

スケジュールが設定された同期を削除して、インポータ―から永続的に削除します。

方法: DELETE

パス: /pulp/api/v2/repositories/<repo_id>/importers/<importer_id>/schedules/sync/<schedule_id>/

パーティション: delete

戻り値: null

指定のインポーターに対してスケジュールが設定された同期がすべて表示されます。

方法: GET

Path: /pulp/api/v2/repositories/<repo_id>/importers/<importer_id>/schedules/sync/

パーティション: read

戻り値: スケジュールが設定されたすべての同期のスケジュールレポートの配列

200 応答の本文のサンプル:

[
   {
       "_href": "/pulp/api/v2/repositories/test/importers/yum_importer/schedules/sync/54d8852245ef4876fade7cc2/",
       "_id": "54d8852245ef4876fade7cc2",
       "args": [
           "test"
       ],
       "consecutive_failures": 0,
       "enabled": true,
       "failure_threshold": null,
       "first_run": "2015-02-09T10:00:02Z",
       "kwargs": {
           "overrides": {}
       },
       "last_run_at": "2015-02-09T10:00:23Z",
       "last_updated": 1423476133.825821,
       "next_run": "2015-02-10T10:00:02Z",
       "remaining_runs": null,
       "resource": "pulp:importer:test:yum_importer",
       "schedule": "P1DT",
       "task": "pulp.server.tasks.repository.sync_with_auto_publish",
       "total_run_count": 1
   }
]

スケジュールが設定された各同期は検査できます。

方法: GET

パーティション: read

パス: /pulp/api/v2/repositories/<repo_id>/importers/<importer_id>/schedules/sync/<schedule_id>/

戻り値: スケジュールが設定された同期のスケジュールレポート

200 応答の本文のサンプル:

{
   "_href": "/pulp/api/v2/repositories/test/importers/yum_importer/schedules/sync/54d8852245ef4876fade7cc2/",
   "_id": "54d8852245ef4876fade7cc2",
   "args": [
       "test"
   ],
   "consecutive_failures": 0,
   "enabled": true,
   "failure_threshold": null,
   "first_run": "2015-02-09T10:00:02Z",
   "kwargs": {
       "overrides": {}
   },
   "last_run_at": "2015-02-09T10:00:23Z",
   "last_updated": 1423476133.825821,
   "next_run": "2015-02-10T10:00:02Z",
   "remaining_runs": null,
   "resource": "pulp:importer:test:yum_importer",
   "schedule": "P1DT",
   "task": "pulp.server.tasks.repository.sync_with_auto_publish",
   "total_run_count": 1
}

この呼び出しは、リポジトリーの同期履歴を取得します。リポジトリーで実行される各同期は履歴エントリーを作成します。

方法: GET

パーティション: read

パス: /pulp/api/v2/repositories/<repo_id>/history/sync/

戻り値: 同期履歴エントリーの配列

200 応答の本文のサンプル:

[
 {
  "result": "success",
  "importer_id": "my_demo_importer",
  "exception": null,
  "repo_id": "demo_repo",
  "traceback": null,
  "started": "1970:00:00T00:00:00Z",
  "completed": "1970:00:00T00:00:01Z",
  "importer_type_id": "demo_importer",
  "error_message": null,
 }
]

この呼び出しは、リポジトリーの ディストリビュータ を使用してリポジトリーからコンテンツを公開します。この呼び出しは常に非同期で実行され、呼び出しレポート を返します。

方法: POST

パス: /pulp/api/v2/repositories/<repo_id>/actions/publish/

パーティション: execute

戻り値: 同期の現在の状態を表す Call Report

要求のサンプル:

{
  "id": "distributor_1",
  "override_config": {},
}

タグ: 作成されたタスクには、pulp:action:publish、pulp:repository:<repo_id> のタグが含まれます。

リポジトリーは、iso8601 の間隔 を使用して自動的に公開できます。スケジュールが設定された公開、間隔、公開のオーバーライド設定、およびその他のスケジュールオプションをリポジトリーの ディストリビューター に設定する必要があります。

方法: POST

パス: /pulp/api/v2/repositories/<repo_id>/distributors/<distributor_id>/schedules/publish/

パーティション: create

戻り値: スケジュールを設定した呼び出しの現在の状態を表すスケジュールレポート

要求のサンプル:

{
 "override_config": {},
 "schedule": "PT1H",
 "failure_threshold": 3,
}

201 応答の本文のサンプル:

{
 "next_run": "2014-01-27T21:27:56Z",
 "task": "pulp.server.tasks.repository.publish",
 "last_updated": 1390858076.682694,
 "first_run": "2014-01-27T21:27:56Z",
 "schedule": "PT1H",
 "args": [
   "demo",
   "puppet_distributor"
 ],
 "enabled": true,
 "last_run_at": null,
 "_id": "52e6cf5cdd01fb70bd0d9c34",
 "total_run_count": 0,
 "failure_threshold": 3,
 "kwargs": {
   "overrides": {}
 },
 "resource": "pulp:distributor:demo:puppet_distributor",
 "remaining_runs": null,
 "consecutive_failures": 0,
 "_href": "/pulp/api/v2/repositories/demo/distributors/puppet_distributor/schedules/publish/52e6cf5cdd01fb70bd0d9c34/"
}

スケジュール済みパブリッシュの作成に使用されるパラメーターはいつでも更新される可能性があります。

方法: PUT

パス: /pulp/api/v2/repositories/<repo_id>/distributors/<distributor_id>/schedules/publish/<schedule_id>/

パーティション: create

400: いずれかのパラメーターが無効になっている場合

404: リポジトリーがない場合は、指定した ID で配布またはスケジュールします。

戻り値: スケジュールが設定された呼び出しの現在の状態を表すスケジュールレポート (詳細は、公開のスケジュール設定の応答例を参照してください)。

スケジュールが設定された公開を削除して、ディストリビューターから永続的に削除します。

方法: DELETE

パス: /pulp/api/v2/repositories/<repo_id>/distributors/<distributor_id>/schedules/publish/<schedule_id>/

パーティション: delete

戻り値: null

指定のディストリビューターに対してスケジュールが設定された公開がすべて表示されます。

方法: GET

パス: /pulp/api/v2/repositories/<repo_id>/distributors/<distributor_id>/schedules/publish/

パーティション: read

戻り値: スケジュールが設定されたすべての公開のスケジュールレポートの配列です (詳細は、公開のスケジュール設定の応答例を参照してください)。

200 応答の本文のサンプル:

{
    "_href": "/pulp/api/v2/repositories/test/distributors/yum_distributor/schedules/publish/54d88df045ef4876fb50c994/",
    "_id": "54d88df045ef4876fb50c994",
    "args": [
        "test",
        "yum_distributor"
    ],
    "consecutive_failures": 0,
    "enabled": true,
    "failure_threshold": null,
    "first_run": "2015-02-09T10:37:36Z",
    "kwargs": {
        "overrides": {}
    },
    "last_run_at": "2015-02-09T10:38:23Z",
    "last_updated": 1423478256.805917,
    "next_run": "2015-02-10T10:37:36Z",
    "remaining_runs": null,
    "resource": "pulp:distributor:test:yum_distributor",
    "schedule": "P1DT",
    "task": "pulp.server.tasks.repository.publish",
    "total_run_count": 1
}

スケジュールが設定された各公開は検査できます。

方法: GET

パーティション: read

パス: /pulp/api/v2/repositories/<repo_id>/distributors/<distributor_id>/schedules/publish/<schedule_id>/

戻り値: スケジュールが設定された公開のスケジュールレポート (詳細は、公開のスケジュール設定の応答例を参照してください)。

200 応答の本文のサンプル:

{
   "_href": "/pulp/api/v2/repositories/test/distributors/yum_distributor/schedules/publish/54d88df045ef4876fb50c994/",
   "_id": "54d88df045ef4876fb50c994",
   "args": [
       "test",
       "yum_distributor"
   ],
   "consecutive_failures": 0,
   "enabled": true,
   "failure_threshold": null,
   "first_run": "2015-02-09T10:37:36Z",
   "kwargs": {
       "overrides": {}
   },
   "last_run_at": "2015-02-09T10:38:23Z",
   "last_updated": 1423478256.805917,
   "next_run": "2015-02-10T10:37:36Z",
   "remaining_runs": null,
   "resource": "pulp:distributor:test:yum_distributor",
   "schedule": "P1DT",
   "task": "pulp.server.tasks.repository.publish",
   "total_run_count": 1
}

この呼び出しは、リポジトリーの公開履歴を取得します。リポジトリーで実行される各公開は履歴エントリーを作成します。

方法: GET

パーティション: read

Path: /pulp/api/v2/repositories/<repo_id>/history/publish/<distributor_id>/

start_date (iso8601 日時) (任意) 指定の日付より前のタイムスタンプのエントリーは返されません。

404: 指定したリポジトリー ID が存在しない場合

戻り値: 公開履歴エントリーの配列

200 応答の本文のサンプル:

[
 {
  "result": "success",
  "distributor_id": "my_demo_distributor",
  "distributor_type_id": "demo_distributor",
  "exception": null,
  "repo_id": "demo_repo",
  "traceback": null,
  "started": "1970:00:00T00:00:00Z",
  "completed": "1970:00:00T00:00:01Z",
  "error_message": null,
 }
]

ユニット関連付け基準 を使用して、リポジトリー内でユニットを検索するために使用できます。

方法: POST

パス: /pulp/api/v2/repositories/<repo_id>/search/units/

パーティション: read

戻り値: コンテンツユニット関連付けを表すオブジェクトの配列

要求のサンプル:

{
  "criteria": {
    "fields": {
      "unit": [
        "name",
        "version"
      ]
    },
    "type_ids": [
      "rpm"
    ],
    "limit": 1
  }
}

200 応答の本文のサンプル:

[
  {
    "updated": "2013-09-04T22:12:05Z",
    "repo_id": "zoo",
    "created": "2013-09-04T22:12:05Z",
    "_ns": "repo_content_units",
    "unit_id": "4a928b95-7c4a-4d23-9df7-ac99978f361e",
    "metadata": {
      "_id": "4a928b95-7c4a-4d23-9df7-ac99978f361e",
      "version": "4.1",
      "name": "bear",
      "pulp_user_metadata": {}
    },
    "unit_type_id": "rpm",
    "id": "522777f5e19a002faebebf79"
    }
]