Red Hat Subscription Management 統合ガイド

Red Hat Subscription Management 1

アプリケーションを Red Hat Subscription Management に統合するためのガイド

Red Hat Subscription Management Documentation Team

概要

本ガイドは、お客様のケースをクエリーして更新するために、Red Hat Subscription Management が公開する API を使用するための情報を提供します。

1. はじめに

http://access.redhat.com で XML ベースの REST API[1] を使用してカスタマーポータルと統合させることができるようになりました。本ガイドでは、一般的なユースケースと、一般的なクライアントとフレームワークを使用した例を紹介します。公式の API ドキュメントは https://access.redhat.com/site/documentation/Red_Hat_Customer_Portal/ で提供されており、そこでは、XML スキーマと RESTful リソース情報などが紹介されています。

2. クライアント

カスタマーポータルの API は、元々、クライアントに依存しません。XML データの送受信を行う一連のリソース URL として表現されます。一般的なクライアントおよびプラットフォームが含まれますが、それに制限されるわけではありません。
クライアント
プラットフォーム/環境
コメント
cURL [a]
コマンドライン (Linux、UNIX、Mac OS X、Microsoft Windows)
コマンドをテストし、簡易統合を行うための簡単で透過的な方法。
Apache HttpComponents [b]
Java
HTTP と対話する最も一般的な Java ライブラリー。XML の組み込みバインディング。
RESTeasy クライアント[c]
Java
Java モデルの完全統合。HTTP または XML を考慮する必要はありません。下部の Apache HTTP Client を使用します。

3. Red Hat Subscription Management における API コマンド

表1 アクティベーションキー

コマンド詳細情報
GET/activation_keysアクティベーションキーの一覧を表示します。
DELETE/activation_keys/{activation_key_id}アクティベーションキーを削除します。
GET/activation_keys/{activation_key_id}アクティベーションキーの一覧を表示します。
PUT/activation_keys/{activation_key_id}アクティベーションキーを更新します。
GET/activation_keys/{activation_key_id}/poolsアクティベーションキーのプールの一覧を表示します。
DELETE/activation_keys/{activation_key_id}/pools/{pool_id}アクティベーションキーからプールを削除します。
PUT/activation_keys/{activation_key_id}/pools/{pool_id}アクティベーションキーからプールを更新します。
DELETE/activation_keys/{activation_key_id}/product/{product_id}アクティベーションキーから製品を削除します。
POST/activation_keys/{activation_key_id}/product/{product_id}製品をアクティベーションキーに追加します。

表2 管理

コマンド詳細情報
DELETE/admin/cache/product製品キャッシュを削除します。
GET/admin/initCandlepin データベースを初期化します。
GET/admin/queuesHornetQ キューの基本情報を取得します。

表3 Atom

コマンド詳細情報
GET/atomイベントの Atom フィードを取得します。

表4 CDN

コマンド詳細情報
GET/cdnCDN の一覧を取得します。
DELETE/cdn/{label}CDN を削除します。
POST/cdn/{label}CDN @return を CDN オブジェクトに更新します。

表5 コンシューマー

コマンド詳細情報
GET/consumersコンシューマーの一覧を取得します。
POST/consumersコンシューマーを作成します。
GET/consumers/{consumer_uuid}1 台のコンシューマーを取得します。
POST/consumers/{consumer_uuid}コンシューマーを更新します。
DELETE/consumers/{consumer_uuid}コンシューマーを削除します。
POST/consumers/{consumer_uuid}1 台のコンシューマーを取得します。
GET/consumers/{consumer_uuid}/accessible contentコンシューマーの Content Access Certificate の本文を取得します。
GET/consumers/{consumer_uuid}/atomコンシューマーのイベントフィードを取得します。
PUT/consumers/{consumer_uuid}/certificatesコンシューマーのエンタイトルメント証明書を生成します。
GET/consumers/{consumer_uuid}/certificatesコンシューマーのエンタイトルメント証明書を取得します。
DELETE/consumers/{consumer_uuid}/certificates/{serial}証明書のシリアルを使用してエンタイトルメント証明書を削除します。
GET/consumers/{consumer_uuid}/certificates/serialsコンシューマーに対する証明書シールのクライアントメタデータの一覧を取得します。
GET/{consumer_uuid}/complianceコンシューマーのコンプライアンスステータスを取得します。
DELETE/consumers/{consumer_uuid}/deletionrecord許可されたコンシューマーの削除レコードを取得します。
GET/consumers/{consumer_uuid}/entitlementsコンシューマーのエンタイトルメントの一覧を取得します。
DELETE/consumers/{consumer_uuid}/entitlementsコンシューマーのエンタイトルメントのバインドを解除します。
GET/consumers/{consumer_uuid}/entitlements/dry-run自動バインディングを行うプールと数量の一覧を取得します。
DELETE/consumers/{consumer_uuid}/entitlements/pool/{pool_id}コンシューマーのエンタイトルメントをすべて削除します。
PUT/entitlements/product/{product_id}製品のエンタイトルメント証明書を再作成します。

表6 環境

コマンド詳細情報
GET/environments環境一覧を取得します。
DELETE/environments/{env_id}環境を削除します。
GET/environments/{env_id}1 台の環境を取得します。
POST/environments/{env_id}/consumers環境を作成します。
DELETE/environments/content環境からコンテンツをデモートします。
POST/environments/contentコンテンツを環境にプロモートします。

表7 イベント

コマンド詳細情報
GET/eventsイベントの一覧を取得します。
GET/events/{uuid}1 つのイベントを取得します。

表8 ハイパーバイザー

コマンド詳細情報
POST/hypervisors/{owner}ホストの情報を更新するために、virt-who などのエージェントを許可するハイパーバイザーホストの一覧を作成または更新します。

表9 ジョブ

コマンド詳細情報
GET/jobsジョブステータスの一覧を取得します。
DELETE/jobs/{job_id}1 つのジョブを削除します。
POST/jobs/{job_id}ジョブステータスを取得し、完了している場合は削除します。
POST/jobs/schedule/{task}特定のタスクを開始します。
GET/jobs/schedulerスケジューラーステータスを取得します。
POST/jobs/schedulerスケジューラーステータスを更新します。

表10 所有者

コマンド詳細情報
GET/owners所有者の一覧を取得します。
POST/owners所有者を作成します。
DELETE/owners/{owner_key}所有者を削除します。
GET/owners/{owner_key}1 人の所有者を取得します。
PUT/owners/{owner_key}所有者を更新します。
GET/owners/{owner_key}/activation_keys所有者のアクティベーションキーの一覧を取得します。
POST/owners/{owner_key}/activation_keys所有者のアクティベーションキーを作成します。
GET/owners/{owner_key}/atom所有者のイベントの Atom フィードを取得します。
GET/owners/{owner_key}/consumers所有者のコンシューマーの一覧を取得します。
GET/owners/{owner_key}/consumers/count所有者のコンシューマーの数を取得します。
GET/owners/{owner_key}/contentコンテンツの一覧を取得します。
POST/owners/{owner_key}/contentコンテンツを作成します。
DELETE/owners/{owner_key}/content/{content_id}コンテンツを削除します。
GET/owners/{owner_key}/content/{content_id}1 つのコンテンツを取得します。
PUT/owners/{owner_key}/content/{content_id}コンテンツを更新します。
POST/owners/{owner_key}/content/batch大量のコンテンツを作成します。
GET/owners/{owner_key}/entitlements所有者のエンタイトルメントの一覧を取得します。
POST/owners/{owner_key}/entitlements所有者に対して非同期の自動修復を開始します。
GET/owners/{owner_key}/environments所有者の環境の一覧を取得します。
POST/owners/{owner_key}/environments所有者の環境を作成します。
GET/owners/{owner_key}/events所有者に対してイベントの一覧を取得します。
GET/owners/{owner_key}/hypervisor所有者に対してハイパーバイザーの一覧を取得します。
DELETE/owners/{owner_key}/imports所有者に対するインポートを削除します。
GET/owners/{owner_key}/imports所有者に対してインポートレコードの一覧を取得します。
POST/owners/{owner_key}/imports/async指定した組織に対して非同期マニフェストのインポートを開始します。
GET/owners/{owner_key}/info所有者の情報を取得します。
DELETE/owners/{owner_key}/log所有者のログレベルを削除します。
PUT/owners/{owner_key}/log所有者のログレベルを設定します。
GET/owners/{owner_key}/pools所有者に対してプールの一覧を取得します。
POST/owners/{owner_key}/pools所有者に対してカスタムプールを作成します。
PUT/owners/{owner_key}/pools所有者に対してプールを更新します。
GET/owners/{owner_key}/products製品の一覧を取得します。
POST/owners/{owner_key}/products製品を作成します。
DELETE/owners/{owner_key}/products/{product_id}製品を削除します。
GET/owners/{owner_key}/products/{product_id}1 つの製品を取得します。
PUT/owners/{owner_key}/products/{product_id}製品を更新します。
POST/owners/{owner_key}/products/{product_id}/batch_content製品バッチノードにコンテンツを追加します。
GET/owners/{owner_key}rActivation Keys/products/{product_id}/certificate製品の証明書を取得します。
DELETE/owners/{owner_key}/products/{product_id}/content/{condent_id}製品からコンテンツを削除します。
POST/owners/{owner_key}/products/{product_id}/content/{condent_id}製品のシングルモードにコンテンツを追加します。
PUT/owners/{owner_key}/products/{product_id}/content/subscriptions製品別にプールを更新します。
GET/owners/{owner_key}/servicelevelsカスタマーのサポートレベルの一覧を取得します。
GET/owners/{owner_key}/subscriptions所有者に対してサブスクリプションの一覧を取得します。
PUT/owners/{owner_key}subscriptions所有者が持つエンタイトルメントのプールをすべてサブスクリプションと同期します。
GET/owners/{owner_key}/uebercertUeber エンタイトルメントの証明書を取得します。
POST/owners/{owner_key}/uebercertUeber エンタイトルメントの証明書を作成します。
GET/owners/{owner_key}/upstream_customers所有者のアップストリームカスタマーの一覧を取得します。

表11 プール

コマンド詳細情報
DELETE/pools/{pool_id}プールを削除します。
GET/pools/{pool_id}1 つのプールを取得します。
GET/pools/{pool_id}/cdnプールの CDN を取得します。
GET/pools/{pool_id}/entitlementsプールのエンタイトルメントの一覧を取得します。

表12 製品

コマンド詳細情報
GET/products/{uuid}1 つの製品を取得します。
GET/products/{product_uuid}/certificate製品の証明書を取得します。
GET/products/owners製品別に所有者の一覧を取得します。
PUT/products/subscriptions製品別にプールを更新します。

表13 ロール

コマンド詳細情報
GET/rolesロールの一覧を取得します。
POST/rolesロールを作成します。
DELETE/roles/{role_id}ロールを削除します。
GET/roles/{role_id}1 つのロールを取得します。
PUT/roles/{role_id}ロールからパーミッションを削除します。
DELETE/roles/{roles_id}permissions/username}ロールからユーザーを削除します。
POST/roles/{roles_id}permissions/username}ユーザーをロールに追加します。

表14 ルール

コマンド詳細情報
DELETE/rulesルールを削除します。
GET/rulesルールを取得します。
POST/rulesルールを更新します。

表15 シリアル

コマンド詳細情報
GET/serials証明書シリアルの一覧を取得します。
GET/serials/{serial_id}1 つの証明書シリアルを取得します。

表16 ステータス

コマンド詳細情報
GET/statusサーバーのステータスを返します。

表17 サブスクリプション

コマンド詳細情報
GET/subscriptionsサブスクリプションの一覧を取得します。
POST/subscriptionsサブスクリプションをアクティベートします。
DELETE/subscriptions/{subsctription_id}サブスクリプションを削除します。
GET/subscription/{subscription_id}1 つのサブスクリプションを取得します。
GET/subscriptions/{subscription_id}/certサブスクリプション証明書を取得します。

表18 ユーザー

コマンド詳細情報
GET/usersユーザーの一覧を取得します。
POST/userユーザーを作成します。
DELETE/users/{username}ユーザーを削除します。
GET/users/{username}1 人のユーザーを取得します。
POST/users/{username}ユーザーを更新します。
GET/users/{username}/ownersユーザーがシステムを登録できる所有者の一覧を取得します。
GET/users/{username}/rolesユーザー別のロールの一覧を取得します。

法律上の通知

Copyright © 2017 Red Hat, Inc..
This document is licensed by Red Hat under the Creative Commons Attribution-ShareAlike 3.0 Unported License. If you distribute this document, or a modified version of it, you must provide attribution to Red Hat, Inc. and provide a link to the original. If the document is modified, all Red Hat trademarks must be removed.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.