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

3.2. JSON 応答形式

API への呼び出しは、JSON 形式の結果を返します。API 呼び出しは、単一オプションの応答または、応答コレクションの結果を返します。

3.2.1. 単一オブジェクトの JSON 応答形式
リンクのコピー

単一オブジェクトで作業するには、単一オブジェクトの JSON 応答を使用します。単一のオブジェクトに対する API 要求では、オブジェクトの一位識別子 :id が必要です。

これは、ID が 23 の Satellite ドメインに対する単一オブジェクトの形式例です。

API 要求

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

API 応答

{
    "id": 23,
    "name": "qa.lab.example.com",
    "fullname": "QA",
    "dns_id": 10,
    "created_at": "2024-08-13T09:02:31Z",
    "updated_at": "2024-08-13T09:02:31Z"
}
Copy to Clipboard Toggle word wrap

3.2.2. コレクション用の JSON 応答形式
リンクのコピー

コレクションは、ホストとドメインなどのオブジェクトリストです。JSON 応答コレクションの形式は、メタデータのフィールドセクションと結果セクションで構成されます。

以下は、Satellite ドメインリストのコレクション要求の形式例です。

API 要求

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

API 応答

{
    "total": 3,
    "subtotal": 3,
    "page": 1,
    "per_page": 20,
    "search": null,
    "sort": {
        "by": null,
        "order": null
    },
    "results": [
        {
            "id": 23,
            "name": "qa.lab.example.com",
            "fullname": "QA",
            "dns_id": 10,
            "created_at": "2024-08-13T09:02:31Z",
            "updated_at": "2024-08-13T09:02:31Z"
        },
        {
            "id": 25,
            "name": "dev.lab.example.com",
            "fullname": "DEVEL",
            "dns_id": 8,
            "created_at": "2024-08-13T08:32:48Z",
            "updated_at": "2024-08-14T07:04:03Z"
        },
        {
            "id": 32,
            "name": "hr.lab.example.com",
            "fullname": "HR",
            "dns_id": 8,
            "created_at": "2024-08-16T08:32:48Z",
            "updated_at": "2024-08-16T07:04:03Z"
        }
    ]
}
Copy to Clipboard Toggle word wrap

3.2.3. JSON 応答メタデータ
リンクのコピー

Satellite API 応答には、以下のメタデータフィールドが含まれます。

total
検索パラメーターのないオブジェクトの合計数。
subtotal
検索パラメーターを指定して返されたオブジェクトの数(検索がない場合には、累計は合計と同じになります)。
page
ページ番号。
per_page
ページごとに返されるオブジェクトの最大数。
limit
コレクションの応答で返すオブジェクトの指定数。
offset
コレクションを返す前に省略するオブジェクト数。
search
scoped_scoped 構文に基づく検索文字列。
sort
  • by: API がコレクションをソートするフィールド別に指定
  • order: ソート順 (ASC は昇順、DESC は降順)
results
オブジェクトのコレクション。
トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

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

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

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

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

会社概要

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

Theme

© 2025 Red Hat