2.2. 了解 JSON 响应格式
对 API 的调用返回 JSON 格式的结果。API 调用返回单选项响应或响应集合的结果。
单对象的 JSON 响应格式
您可以使用单对象 JSON 响应来操作单个对象。对单个对象的 API 请求需要对象的唯一标识符 :id。
例如,ID 为 23 的单对象请求的格式:
请求示例:
curl --request GET --insecure --user sat_username:sat_password \ https://satellite.example.com/api/domains/23 | python -m json.tool
$ curl --request GET --insecure --user sat_username:sat_password \
https://satellite.example.com/api/domains/23 | python -m json.tool
响应示例:
集合的 JSON 响应格式
集合是主机和域等对象的列表。集合 JSON 响应的格式由 metadata 字段部分和 results 部分组成。
下面是一个 Satellite 域列表的集合请求的格式示例:
请求示例:
curl --request GET --insecure --user sat_username:sat_password \ https://satellite.example.com/api/domains | python -m json.tool
$ curl --request GET --insecure --user sat_username:sat_password \
https://satellite.example.com/api/domains | python -m json.tool
响应示例:
响应元数据字段
API 响应使用以下元数据字段:
-
total- 不带任何搜索参数的对象总数。 -
Subtotal- 带有给定搜索参数返回的对象数量。如果没有搜索,则小计等于总计。 -
page- 页面号。 -
per_page- 每个页面返回的最大对象数。 -
limit- 在集合响应中返回的指定对象数量。 -
offset- 返回集合前跳过的对象数量。 -
search- 基于scoped_scoped语法的搜索字符串。 排序-
by- 指定 API 对集合进行排序的字段。 -
顺序- 排序顺序,即 ASC 用于升序或 DESC 以降序。
-
-
results- 对象集合。