スロットルと次への使用

この例では、GET アラームを使用してすべてのアラームを取得し、スロットルと[次へ]リンクを使用する方法を示します。
casp1032
この例では、GET アラームを使用してすべてのアラームを取得し、スロットルと[次へ]リンクを使用する方法を示します。
以下の手順に従います。
  1. 以下の要求を使用します。これは、すべてのアラームを返すように要求しますが、一度に 3 つのアラームしか返されません。
    http://comp001/spectrum/restful/alarms?throttlesize=3
    この要求では、以下に注意してください。
    • throttlesize
      一度に返す項目数を示します。 この例では、一度に 3 つのアラームを返すように要求します。
    SpectroSERVER
    から以下の応答が返されます。 この応答は、合計 5 つのアラームが存在し、3 つのみが返されることを示します。 リスト内の次の項目を指す相対リンクが提供されます。
    <?xml version="1.0" encoding="UTF-8" standalone="yes" ?> - <alarm-response-list xmlns="http://www.ca.com/spectrum/restful/schema/response" throttle="3" total-alarms="5"> - <alarm-responses> <alarm id="4e77f4fd-1c9b-1000-0336-000874f00c29" /> <alarm id="4e77f4fe-1ca2-1000-0336-000874f00c29" /> <alarm id="4e80da2b-a48e-1001-0336-000874f00c29" /> </alarm-responses> <link rel="next" href="http://comp001/spectrum/restful/alarms?id=c6a367df-0b3e-4461-aa8d- aad451a45bf7&start=3&throttlesize=3" type="application/xml" /> </alarm-response-list>
    この応答では、以下に注意してください。
    • throttle
      この応答で返される項目の数を示します。 この例では、3 つのアラームがこのレスポンスで返されました。
    • total-alarms
      結果セット内の項目の合計数を示します。 この例では、結果セット内に合計 5 つのアラームがあります。
    • link rel="next"
      結果セット内の次の項目を取得する URL を示します。 このリンクは、クライアントまたはブラウザで使用して[次へ]要求を発行できます。
      • id=<
        result_set_ID
        >
        OneClick サーバでの結果セットの場所を指定します。 データは、非アクティブ状態が 10 分続くと期限切れになります。
      • start=<
        element_num
        >
        結果セット内の位置を示します。
  2. 前の応答から[次へ]相対リンクを使用して、結果セット内の次の 3 つの項目を要求します。
    http://comp001/spectrum/restful/alarms?id=c6a367df-0b3e-4461-aa8d- aad451a45bf7&start=3&throttlesize=3
    SpectroSERVER
    から以下の応答が返されます。
    <?xml version="1.0" encoding="UTF-8" standalone="yes" ?> - <alarm-response-list xmlns="http://www.ca.com/spectrum/restful/schema/response" error="EndOfResults" throttle="2" total-alarms="5"> - <alarm-responses> <alarm id="4e83d694-18e1-1002-0336-000874f00c29" /> <alarm id="4e77f4fe-1c9e-1000-0336-000874f00c29" /> </alarm-responses> </alarm-response-list>
    この応答では、以下に注意してください。
    error="EndOfResults"
    リスト内のすべての項目が取得されたことを示します。