システム管理

この REST API を使用して、システム・リソースを管理します。

制約事項: 一部の REST API は IBM® Cloud Pak System W4600 に適用されず、値を返しません。
HTTP 要求を生成するときは、認証、許可、およびコンテンツ・ネゴシエーションのために所定のヘッダーが必要です。 詳しくは、 HTTP ヘッダー要求を参照してください。

共通パラメーター

以下のパラメーターは、システム機能全体に関する一般的な状況を示します。 これらのフィールドは、すべての REST API 呼び出しで一般的に使用されます。
created_time
オブジェクトが作成された時刻。
updated_time
オブジェクトが最後に更新された時刻。
状態
オブジェクトの一般可用性。 値が「pending」の場合、オブジェクトは作成されますが、アクティブ化されません。 「available」の場合、オブジェクトはシステムでアクティブです。
ID
システム内のオブジェクトの固有 ID。
フィールドの複数のオカレンスをリストするには、以下のように同じパラメーターの複数の項目を指定します。
?id=<id1>&id=<id2>

REST API メソッドの説明の 「応答」 セクションには、そのタイプの 1 つのオブジェクトの例を示す部分的な応答のみが表示されます。 一部の記述には、当該オブジェクトの単一インスタンスを取得する構文が含まれています。 応答およびパラメーターの例は提供されていません。これは、その詳細が応答全体の同一のサブセットであるためです。

GET 呼び出しのオプション・パラメーター

GET 呼び出しからの応答を変更するには、以下のオプション・パラメーターを使用します。
  • 単一リソースまたは複数リソースに対する GET 呼び出しの場合:
    resolvechildren=< n>
    1 つ以上の URI パターンを含むフィールドについて、1 つ以上の下位レベルの子テーブル項目を表示します。ここで、 < n> は解決するレベルの数です。 例を以下に示します。
    /resources/{resource}/{id}?resolvechildren=3
    resolveparents=< n>
    1 つ以上の URI パターンを含むフィールドについて、1 つ以上の上位レベルの親表項目を表示します。ここで、 < n> は解決するレベルの数です。 例を以下に示します。
    /resources/{resource}/{id}?resolveparents=3
  • 複数のリソースに対する GET 呼び出しの場合のみ:
    < field>=< 値>
    返されるリソースの数を減らすため、フィルターを指定できます。 このフィルターは、指定したフィールドに指定したフィルター値が存在するレコードのみを返します。 例を以下に示します。
    /resources/{resource}/<field>=<value>
    fuzzy=[true | false]
    返されるレコードの数をさらに絞り込むために、フィールド・フィルターと共にこの属性を指定できます。 fuzzy 属性を true (デフォルト) として指定した場合、フィールド内の任意の場所に指定値があれば検索でマッチングします。 fuzzy を false として指定した場合、指定値の完全一致突き合わせが実行されます。 例を以下に示します。
    /resources/{resource}/<field>=<value>&fuzzy=true
    compare=[gt | gte | lt | lte]
    返されるレコードの数をさらに絞り込むために、フィールド・フィルターと共にこの属性を指定できます。 フィールドに指定する値は、数値でなければなりません。
    • gt は、指定フィールドの値が指定値より大きいリソースを返します。
    • gte は、指定フィールドの値が指定値以上であるリソースを返します。
    • lt は、指定フィールドの値が指定値より小さいリソースを返します。
    • lte は、指定フィールドの値が指定値以下であるリソースを返します。
    例を以下に示します。
    /resources/{resource}/<field>=<value>&compare=gt
    カウント =< n>
    page パラメーターと一緒に使用し、ページ当たり指定数のリソースを返します。 このパラメーターを指定しなかった場合、ページごとに 500 件の戻りコードが返されます。
    ページ =< m>
    count パラメーターと一緒に使用し、指定数のページを返します。 このパラメーターを指定しない場合、count パラメーターで指定した数のリソースを含んだ最初のページだけが返されます。 例を以下に示します。
    /resources/{resource}?count=<n>&page=<m>
    totalcount=[true | false]
    リソース数のカウントが返されます。 例を以下に示します。
    /resources/{resource}?totalcount=true
    順序 = [+ |-]
    このパラメーターをフィールド・フィルターと一緒に使用すると、返されるリソースが、指定フィールドの値を基準として昇順または降順でソートされます。 例を以下に示します。
    /resources/{resource}?order=+<field>