GET /katello/api/sync_plans
列出同步計劃

GET /katello/api/organizations/:organization_id/sync_plans

參數

參數名字 描述
organization_id
必填

以組織名稱或是標籤來篩選同步計劃

Validations:

  • number.

name
選填

用名稱篩選

Validations:

  • String

sync_date
選填

用同步日期篩選

Validations:

  • String

interval
選填

用間隔篩選

Validations:

  • Must be one of: hourly, daily, weekly.

search
選填

搜尋字串

Validations:

  • String

page
選填

頁數,從 1 開始

Validations:

  • number.

per_page
選填

每頁要傳回的結果數量

Validations:

  • number.

order
選填

排序欄位與次序,例如「name DESC」

Validations:

  • String

full_result
選填

是否顯示所有結果

Validations:

  • boolean

sort
選填

「order」參數的雜湊版本

Validations:

  • Hash

sort[by]
選填

用來排序結果的欄位

Validations:

  • String

sort[order]
選填

如何排序結果的順序(比方說 ASC 從下到上)

Validations:

  • String


GET /katello/api/organizations/:organization_id/sync_plans/:id
顯示同步計畫

GET /katello/api/sync_plans/:id
顯示同步計畫

參數

參數名字 描述
organization_id
選填

以組織名稱或是標籤來篩選同步計劃

Validations:

  • number.

id
必填

同步計畫的數字型態識別子

Validations:

  • number.


POST /katello/api/organizations/:organization_id/sync_plans
建立同步計劃

參數

參數名字 描述
organization_id
必填

以組織名稱或是標籤來篩選同步計劃

Validations:

  • number.

name
必填

同步計畫的名稱

Validations:

  • String

interval
必填

多久同步一次

Validations:

  • Must be one of: hourly, daily, weekly.

sync_date
必填

開始同步的日期與時間

Validations:

  • String

description
選填

同步計畫的描述

Validations:

  • String

enabled
必填

啟用或停用同步

Validations:

  • boolean


PUT /katello/api/organizations/:organization_id/sync_plans/:id
更新同步計畫

PUT /katello/api/sync_plans/:id
更新同步計畫

參數

參數名字 描述
organization_id
選填

以組織名稱或是標籤來篩選同步計劃

Validations:

  • number.

id
必填

同步計畫的數字型態識別子

Validations:

  • number.

name
選填

同步計畫的名稱

Validations:

  • String

interval
選填

多久同步一次

Validations:

  • Must be one of: hourly, daily, weekly.

sync_date
選填

開始同步的日期與時間

Validations:

  • String

description
選填

同步計畫的描述

Validations:

  • String

enabled
選填

啟用或停用同步

Validations:

  • boolean


DELETE /katello/api/organizations/:organization_id/sync_plans/:id
銷毀同步計劃

DELETE /katello/api/sync_plans/:id
銷毀同步計劃

參數

參數名字 描述
organization_id
選填

以組織名稱或是標籤來篩選同步計劃

Validations:

  • number.

id
選填

同步計畫的數字型態識別子

Validations:

  • number.


PUT /katello/api/organizations/:organization_id/sync_plans/:id/add_products
新增產品至同步計劃

參數

參數名字 描述
id
必填

同步計劃的 ID

Validations:

  • String

product_ids
必填

將加入同步計劃中的產品 ID 清單

Validations:

  • Must be an array of any type


PUT /katello/api/organizations/:organization_id/sync_plans/:id/remove_products
從同步計畫中移除產品

參數

參數名字 描述
id
必填

同步計劃的 ID

Validations:

  • String

product_ids
必填

將由同步計劃中移除的產品 ID 清單

Validations:

  • Must be an array of any type


PUT /katello/api/sync_plans/:id/sync
Initiate a sync of the products attached to the sync plan

PUT /katello/api/organizations/:organization_id/sync_plans/:id/sync
Initiate a sync of the products attached to the sync plan

參數

參數名字 描述
id
必填

同步計劃的 ID

Validations:

  • String