Red Hat Summit Red Hat Summitサポートコンソール開発者トライアルの開始お問い合わせ

第3章 API 構文

API リクエストと JSON レスポンスの基本的な構文を確認できます。

重要

Satellite 6 API のバージョン 1 と 2 が利用可能ですが、Red Hat はバージョン 2 のみをサポートしています。

3.1. API リクエストの構成
リンクのコピー

Satellite に含まれている API リファレンスは、HTTP メソッドの後に API ルートまたはパスを記載します。 

HTTP_METHOD API_ROUTE
Copy to Clipboard Toggle word wrap

API を使用するには、curl コマンド構文と当リファレンスドキュメントの API ルートを使用して、コマンドを構築します。 

$ curl \
--request HTTP_METHOD \
1 

--insecure \
2 

--user My_User_Name:My_Password \
3 

--data @My_Input_File.json \
4 

--header "Accept:application/json" \
5 

--header "Content-Type:application/json" \
6 

--output My_Output_File
7 

API_ROUTE \
8 

| python3 -m json.tool
9
Copy to Clipboard Toggle word wrap
1
API 呼び出しに curl を使用するには、HTTP 動詞に --request オプションを指定します。(例: --request POST)。
2
--insecure オプションを追加して、SSL ピア証明書の検証確認をスキップします。Red Hat では、SSL 認証を設定し、セキュリティーで保護された呼び出しを使用することを推奨します。詳細は、「SSL 認証の概要」 を参照してください。
3
--user オプションを使用して Satellite ユーザーの認証情報を指定します。
4
POST および PUT リクエストの場合、--data オプションを使用して JSON 形式のデータを渡します。詳細は、「API 要求への JSON データの指定」 を参照してください。
5 6
--data オプションを指定して JSON データを渡す場合は、--header オプションを指定して以下のヘッダーを指定する必要があります。詳細は、「API 要求への JSON データの指定」 を参照してください。
7
Satellite Server からコンテンツをダウンロードする場合は、--output オプションを使用して出力ファイルを指定します。
8
https://satellite.example.com/katello/api/activation_keys 形式の API ルートを使用します。Satellite 6 では、API のバージョン 2 がデフォルトです。したがって、API 呼び出しの URL に v2 を指定する必要はありません。
9
Python json.tool モジュールに出力をリダイレクトして、出力の可読性を向上します。

3.1.1. HTTP メソッド (GET) の使用
リンクのコピー

HTTP メソッド (GET) を使用して、既存のエントリーまたはリソースに関するデータを API から取得します。この例では、登録されたホストの数を要求します。

API 要求

$ curl \
--request GET \
--user My_User_Name:My_Password \
https://satellite.example.com/api/hosts \
| python3 -m json.tool
Copy to Clipboard Toggle word wrap

API 応答

{
  "total": 2,
  "subtotal": 2,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results":
    output truncated
}
Copy to Clipboard Toggle word wrap

API からの応答により、結果数が合計 2 つ、これらは結果の 1 ページ目に表示され、ページごとの最大結果数は 20 に設定されていることが分かります。詳細は、「JSON 応答形式」 を参照してください。

3.1.2. HTTP メソッド (POST) の使用
リンクのコピー

HTTP 動詞 (POST) を使用して、データを API に送信してエントリーまたはリソースを作成します。JSON 形式でデータを送信する必要があります。詳細は、「API 要求への JSON データの指定」 を参照してください。

API の手順

  1. 以下のコンテンツを含めて、activation-key.json などのテストファイルを作成します。 

    {"organization_id":1, "name":"TestKey", "description":"Just for testing"}
    Copy to Clipboard Toggle word wrap

  2. activation-key.json ファイルにデータを適用してアクティベーションキーを作成します。

    要求例: 

    $ curl \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--request POST \
--user My_User_Name:My_Password \
--data @activation-key.json \
https://satellite.example.com/katello/api/activation_keys \
| python3 -m json.tool
    Copy to Clipboard Toggle word wrap

    応答例: 

    {
    "id": 2,
    "name": "TestKey",
    "description": "Just for testing",
    "unlimited_hosts": true,
    "auto_attach": true,
    "content_view_id": null,
    "environment_id": null,
    "usage_count": 0,
    "user_id": 3,
    "max_hosts": null,
    "release_version": null,
    "service_level": null,
    "content_overrides": [

    ],
    "organization": {
        "name": "Default Organization",
        "label": "Default_Organization",
        "id": 1
    },
    "created_at": "2024-02-16 12:37:47 UTC",
    "updated_at": "2024-02-16 12:37:48 UTC",
    "content_view": null,
    "environment": null,
    "products": null,
    "host_collections": [

    ],
    "permissions": {
        "view_activation_keys": true,
        "edit_activation_keys": true,
        "destroy_activation_keys": true
    }
}
    Copy to Clipboard Toggle word wrap

検証

  • Satellite Web UI で、Content > Lifecycle > Activation Keys に移動して、アクティベーションキーを表示します。

3.1.3. HTTP メソッド (PUT) の使用
リンクのコピー

HTTP メソッド (PUT) を使用して、既存の値を変更するか、既存のリソースに追加します。JSON 形式でデータを送信する必要があります。詳細は、「API 要求への JSON データの指定」 を参照してください。

この例では、1 つ前の例で作成した TestKey アクティベーションキーを更新します。

API の手順

  1. 先ほど作成した activation-key.json ファイルを以下のように編集します。 

    {"organization_id":1, "name":"TestKey", "description":"Just for testing","max_hosts":"10" }
    Copy to Clipboard Toggle word wrap

  2. JSON ファイルの変更を適用します。

    要求例: 

    $ curl \
--request PUT \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--user My_User_Name:My_Password \
--data @activation-key.json \
https://satellite.example.com/katello/api/activation_keys/2 \
| python3 -m json.tool
    Copy to Clipboard Toggle word wrap

    応答例: 

    {
    "id": 2,
    "name": "TestKey",
    "description": "Just for testing",
    "unlimited_hosts": false,
    "auto_attach": true,
    "content_view_id": null,
    "environment_id": null,
    "usage_count": 0,
    "user_id": 3,
    "max_hosts": 10,
    "release_version": null,
    "service_level": null,
    "content_overrides": [

    ],
    "organization": {
        "name": "Default Organization",
        "label": "Default_Organization",
        "id": 1
    },
    "created_at": "2024-02-16 12:37:47 UTC",
    "updated_at": "2024-02-16 12:46:17 UTC",
    "content_view": null,
    "environment": null,
    "products": null,
    "host_collections": [

    ],
    "permissions": {
        "view_activation_keys": true,
        "edit_activation_keys": true,
        "destroy_activation_keys": true
    }
}
    Copy to Clipboard Toggle word wrap
  3. Satellite Web UI で、Content > Lifecycle > Activation Keys に移動して変更を確認します。

3.1.4. HTTP メソッド (DELETE) の使用
リンクのコピー

リソースを削除するには、削除するリソース ID を含む API ルートと DELETE メソッドを使用します。この例では、ID が 2 の TestKey アクティベーションキーを削除します。

API 要求

$ curl \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--request DELETE \
--user My_User_Name:My_Password \
https://satellite.example.com/katello/api/activation_keys/2 \
| python3 -m json.tool
Copy to Clipboard Toggle word wrap

API 応答

output omitted
    "started_at": "2024-02-16 12:58:17 UTC",
    "ended_at": "2024-02-16 12:58:18 UTC",
    "state": "stopped",
    "result": "success",
    "progress": 1.0,
    "input": {
        "activation_key": {
            "id": 2,
            "name": "TestKey"
output truncated
Copy to Clipboard Toggle word wrap

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat