Go to main content

Oracle® ZFS Storage Appliance RESTful API ガイド、Release OS8.8.x

印刷ビューの終了

更新: 2021 年 8 月
 
 

問合せパラメータ

一部のリクエストは、返されるデータや操作されるデータを選択するオプションの問合せパラメータを受け取ることができます。このセクションでは、複数のタイプのリソースで使用できる問合せパラメータについて説明します。各リソースに固有の問合せパラメータ、およびこのセクションで説明する問合せパラメータの特殊な使用方法については、各リソースのドキュメントを参照してください。

表 2  一般的な問合せパラメータ
パラメータ
説明
props=true
リソースのプロパティーメタデータを一覧表示します。デフォルト値は false です。
start=index
指定された時間またはオブジェクトIDの後に返す最も古いデータまたはオブジェクトを指定します。
end=index
指定された時間またはオブジェクトIDの前に返す最も新しいデータまたはオブジェクトを指定します。
limit=n
n 個未満のリスト要素を返します。
depth=n
返されるデータの詳細レベルを指定します。
match_property-name=value
指定されたプロパティーを指定された値で持っているリストオブジェクトを返します。

問合せパラメータ: props

props 問合せパラメータは、プロパティーメタデータ値を表示します。データを変更したり、新しいデータを作成したりする操作で props=true を使用すると、プロパティーとメタデータが表示され、操作は実行されません。これにより、リソースの変更や作成に役立つ現在のデータ値を表示できます。

表 3  プロパティーメタデータ値
プロパティー
説明
name
プロパティー名
label
プロパティーの説明
immutable
プロパティーを変更できないことを示すフラグ
type
プロパティーの型 (String、Integer、Boolean、ChooseOne など)
choices
列挙されたプロパティーの場合、使用可能な値の配列

問合せパラメータ: start

start 問合せパラメータには、オブジェクト索引番号または時間を指定します。

  • オブジェク索引番号を指定すると、その索引によって選択されたオブジェクトと、その指定されたオブジェクトの作成後に作成された最も古いオブジェクトを含むリストを返します。

  • UTC 時間を指定して、指定した時刻以降に作成された最も古いオブジェクトまたはデータのリストを返します。一部のリソースは、start 問合せパラメータの時間値をサポートしていません。

時間値は、次の表に示す形式で UTC 時間で表す必要があります。

サービスのバージョン
時間値の形式
時間値の例
v1 paths
%Y%m%dT%H:%M:%SZ
20200723T14:11:49
v2 paths
%Y-%m-%dT%H:%M:%SZ
2020-07-23T14:11:49Z

start 問合せパラメータを使用した例については、次のセクションを参照してください。

問合せパラメータ: end

end 問合せパラメータには、オブジェクト索引番号または時間を指定します。

  • オブジェク索引番号を指定すると、その索引によって選択されたオブジェクトと、その指定されたオブジェクトの作成前に作成された最も新しいオブジェクトを含むリストを返します。

  • UTC 時間を指定して、指定した時刻以前に作成された最も新しいオブジェクトまたはデータのリストを返します。

    時間値は、%Y-%m-%dT%H:%M:%SZ の形式で UTC 時間で表す必要があります。

end 問合せパラメータの使用例については、クラウドバックアップの一覧表示を参照してください。

問合せパラメータ: limit

limit 問合せパラメータは、返す要素の最大数を指定します。

startend も指定されていない場合、limit=nn 個の最新の要素を返します。

問合せパラメータ: depth

depth 問合せパラメータは、返されるリソースのリストの詳細レベルを指定します。次の表に示すように、depth の値が大きいほど、より詳細な情報が返されます。

depth の値
リストに返される情報
depth=0
ノードのプロパティーおよび子の名前
depth=1
ノードのプロパティー、子の名前とプロパティー、および孫の名前
depth=2
ノードのプロパティー、子の名前とプロパティー、孫の depth=0 出力

注 -  depth 問合せパラメータは、/api/log/v{1|2} を使用したログの一覧表示、または /api/storage/v{1|2} を使用したプール、プロジェクト、ファイルシステム、または LUN の一覧表示ではサポートされていません。

問合せパラメータ depth を使用したユーザーのリストのリクエストの例:

GET /api/user/v1/users?depth=2 HTTP/1.1
Host: zfs-storage.example.com:215
X-Auth-User: root
X-Auth-Key: password-xxx

レスポンスの例:

簡潔にするために、追加のユーザーは省略しています。

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1558
X-Zfssa-Access-Api: 1.0

{
  "users": [
    {
      "name": "root",
...
    },
    {
      "name": "firstlast",
      "properties": {
        "logname": "firstlast",
        "type": "directory",
        "uid": uid,
        "fullname": "First Last",
        "require_annotation": false,
        "roles": [
          "basic"
        ],
        "kiosk_mode": false,
        "kiosk_screen": "status/dashboard"
      },
      "children": [
        {
          "name": "exceptions",
          "properties": {},
          "children": [],
          "list": [
            {
              "name": "auth-000",
              "properties": {
                "scope": "ad",
                "name": "*",
                "allow_domain": true,
                "allow_workgroup": false
              },
              "children": [],
              "list": []
            },
            {
              "name": "auth-001",
              "properties": {
                "scope": "alert",
                "allow_configure": true,
                "allow_post": true
              },
              "children": [],
              "list": []
            }
          ]
        },
        {
          "name": "preferences",
          "properties": {
            "locale": "C",
            "login_screen": "configuration/preferences",
            "session_timeout": 15,
            "cli_idle_timeout": "infinite",
            "advanced_analytics": false
          },
          "children": [
            {
              "name": "keys",
              "properties": {},
              "children": [],
              "list": []
            },
            {
              "name": "tokens",
              "properties": {},
              "children": [],
              "list": []
            }
          ],
          "list": []
        }
      ],
      "list": [],
      "href": "/api/user/v1/users/firstlast"
    },
    {
...
    }
  ]
}

問合せパラメータ: match

matchproperty-name=value 問合せパラメータは、指定されたプロパティー名を指定された値で持つリソースのリストを返します。

次の例では、kiosk_mode プロパティーの値が true であるユーザーのリストを返します。

match_kiosk_mode=true

次の例では、roles プロパティーの値が super を含み、require_annotation プロパティーの値が true であるユーザーのリストを返します。

match_roles='*super*'&match_require_annotation=true

注 -  match_property-name=value 問合せパラメータは、/api/log/v{1|2} を使用したログの一覧表示、または /api/storage/v{1|2} を使用したプール、プロジェクト、ファイルシステム、または LUN の一覧表示ではサポートされていません。