レスポンス数

レスポンスは XML ドキュメント形式または JSON ドキュメント形式で、いずれになるかはクライアントの Accept ヘッダ値/MIME タイプによって決まります。 このように柔軟な出力であるため、出力データをクライアント開発に容易に統合できます。 レスポンスは、Response.xsd スキーマによって定義されます。
casp1032
レスポンスは XML ドキュメント形式または JSON ドキュメント形式で、いずれになるかはクライアントの Accept ヘッダ値/MIME タイプによって決まります。 このように柔軟な出力であるため、出力データをクライアント開発に容易に統合できます。 レスポンスは、Response.xsd スキーマによって定義されます。
DX NetOps Spectrum
Web サービス API は、Accept ヘッダで application/xml と application/json の両方の MIME タイプをサポートしています。 出力として JSON を選択した場合は、次の要求用に解析を行い、XML を生成する必要がある可能性があります。
次に、レスポンス出力のエレメントについて説明します。
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> <resource-response-list xmlns="http://www.ca.com/spectrum/restful/schema/response" error="<msg>" throttle="<num>" total-resource="<num>"> <resource-responses> ... </resource-responses> <link rel="next" href="http://<hostname><:portnumber>/spectrum/restful/alarms?id=<result_set_ID>&start=3&throttlesize=<num>" type="application/xml" /> </resource-response-list>
  • error="<
    msg
    >"
    操作の全体的な成功または失敗を示します。 障害がある場合は、追加の情報が提供されます。 「EndOfResults」は、結果セット内すべて項目が返されたことを示します。
  • throttle="<
    num
    >"
    要求の throttlesize パラメータでの指定に従って、このレスポンスで返された項目の数を示します。 スロットル数がサーバによって検出された結果の総数よりも小さい場合は、[次へ]リンクが提供されます。 データの完全なセットが返された場合は、[次へ]リンクはありません。
  • total-
    resource
    ="<
    num
    >"
    結果セット内の項目の合計数を示します。
    リソース
    は、要求のタイプ(たとえば、アラーム、ランドスケープ、1 つのモデル、複数のモデルなど)によって異なります。
  • link rel="next" href="<
    URL
    >"
    結果セットにまだ項目が残っている場合にのみ、[次へ]リンクが表示されます。
    結果セットにまだ項目が残っており、スロットル値に従ってそれらを取得するための URL が指定されていることを示します。 このリンクは、HATEOAS (Hypermedia As The Engine Of Application State、アプリケーション状態のエンジンとしてのハイパーメディア)制約に準拠しており、クライアントまたはブラウザで使用して[次へ]要求を発行できます。 このリンクを使用すると、元の呼び出しのすべてのコストを回避できます。 場所は、OneClick サーバにキャッシュされ、非アクティブ状態が 10 分続くと期限切れになります。 期限切れになると、URL は「The cursor is no longer valid (カーソルは無効になりました)」という文字列を返します。
    各 RESTful 呼び出しには、それぞれ独自のキャッシュがあります。
    生成された URL には、以下のパラメータが表示されます。
    • id=<
      result_set_ID
      >
      OneClick サーバでの結果セットの場所を指定します。 データは、非アクティブ状態が 10 分続くと期限切れになります。
    • start=<
      element_num
      >
      結果セット内の開始位置を示します。
    • throttlesize
      次のレスポンスで返す項目の数を示します。
    生成されたリンク内のパラメータの形式は、ご使用の環境によって異なる場合があります。
    たとえば、「&」は「&amp;」として生成される場合があります。これは、XML、HTTP、および JSON 形式標準の間の差異によるものです。